asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'master' into develop

Browse Source
This commit is contained in:
olivermrbl
2022-09-14 10:25:03 +02:00
parent 992ef733f4 9be3860fa5
commit b227fcb163
122 changed files with 971 additions and 681 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/admin-spec3.json
+111 -110
View File
@@ -122,7 +122,7 @@ paths:
/apps/authorizations: /apps/authorizations:
post: post:
operationId: PostApps operationId: PostApps
summary: Generates a token for an application. summary: Generate Token for App
description: Generates a token for an application. description: Generates a token for an application.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -188,7 +188,7 @@ paths:
/apps: /apps:
get: get:
operationId: GetApps operationId: GetApps
summary: List applications summary: List Applications
description: Retrieve a list of applications. description: Retrieve a list of applications.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -228,7 +228,7 @@ paths:
/auth: /auth:
post: post:
operationId: PostAuth operationId: PostAuth
summary: Authenticate a User summary: User Login
x-authenticated: false x-authenticated: false
description: Logs a User in and authorizes them to manage Store settings. description: Logs a User in and authorizes them to manage Store settings.
parameters: [] parameters: []
@@ -296,7 +296,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteAuth operationId: DeleteAuth
summary: Delete Session summary: User Logout
x-authenticated: true x-authenticated: true
description: Deletes the current session for the logged in user. description: Deletes the current session for the logged in user.
x-codeSamples: x-codeSamples:
@@ -340,7 +340,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetAuth operationId: GetAuth
summary: Get Session summary: Get Current User
x-authenticated: true x-authenticated: true
description: Gets the currently logged in User. description: Gets the currently logged in User.
x-codeSamples: x-codeSamples:
@@ -393,7 +393,7 @@ paths:
'/batch-jobs/{id}/cancel': '/batch-jobs/{id}/cancel':
post: post:
operationId: PostBatchJobsBatchJobCancel operationId: PostBatchJobsBatchJobCancel
summary: Marks a batch job as canceled summary: Cancel a Batch Job
description: Marks a batch job as canceled description: Marks a batch job as canceled
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -455,7 +455,7 @@ paths:
'/batch-jobs/{id}/confirm': '/batch-jobs/{id}/confirm':
post: post:
operationId: PostBatchJobsBatchJobConfirmProcessing operationId: PostBatchJobsBatchJobConfirmProcessing
summary: Confirm a batch job summary: Confirm a Batch Job
description: Confirms that a previously requested batch job should be executed. description: Confirms that a previously requested batch job should be executed.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -921,7 +921,7 @@ paths:
'/batch-jobs/{id}': '/batch-jobs/{id}':
get: get:
operationId: GetBatchJobsBatchJob operationId: GetBatchJobsBatchJob
summary: Retrieve a Batch Job summary: Get a Batch Job
description: Retrieves a Batch Job. description: Retrieves a Batch Job.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -983,7 +983,7 @@ paths:
'/collections/{id}/products/batch': '/collections/{id}/products/batch':
post: post:
operationId: PostProductsToCollection operationId: PostProductsToCollection
summary: Updates products associated with a Product Collection summary: Update Products
description: Updates products associated with a Product Collection description: Updates products associated with a Product Collection
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1050,7 +1050,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteProductsFromCollection operationId: DeleteProductsFromCollection
summary: Removes products associated with a Product Collection summary: Remove Product
description: Removes products associated with a Product Collection description: Removes products associated with a Product Collection
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1131,7 +1131,7 @@ paths:
/collections: /collections:
post: post:
operationId: PostCollections operationId: PostCollections
summary: Create a Product Collection summary: Create a Collection
description: Creates a Product Collection. description: Creates a Product Collection.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -1213,7 +1213,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetCollections operationId: GetCollections
summary: List Product Collections summary: List Collections
description: Retrieve a list of Product Collection. description: Retrieve a list of Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1373,7 +1373,7 @@ paths:
'/collections/{id}': '/collections/{id}':
delete: delete:
operationId: DeleteCollectionsCollection operationId: DeleteCollectionsCollection
summary: Delete a Product Collection summary: Delete a Collection
description: Deletes a Product Collection. description: Deletes a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1443,7 +1443,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetCollectionsCollection operationId: GetCollectionsCollection
summary: Retrieve a Product Collection summary: Get a Collection
description: Retrieves a Product Collection. description: Retrieves a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1504,7 +1504,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostCollectionsCollection operationId: PostCollectionsCollection
summary: Update a Product Collection summary: Update a Collection
description: Updates a Product Collection. description: Updates a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1592,7 +1592,7 @@ paths:
'/customer-groups/{id}/customers/batch': '/customer-groups/{id}/customers/batch':
post: post:
operationId: PostCustomerGroupsGroupCustomersBatch operationId: PostCustomerGroupsGroupCustomersBatch
summary: 'Add a list of customers to a customer group ' summary: Add Customers
description: 'Adds a list of customers, represented by id''s, to a customer group.' description: 'Adds a list of customers, represented by id''s, to a customer group.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1687,7 +1687,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteCustomerGroupsGroupCustomerBatch operationId: DeleteCustomerGroupsGroupCustomerBatch
summary: 'Remove a list of customers from a customer group ' summary: Remove Customers
description: 'Removes a list of customers, represented by id''s, from a customer group.' description: 'Removes a list of customers, represented by id''s, from a customer group.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1783,7 +1783,7 @@ paths:
/customer-groups: /customer-groups:
post: post:
operationId: PostCustomerGroups operationId: PostCustomerGroups
summary: Create a CustomerGroup summary: Create a Customer Group
description: Creates a CustomerGroup. description: Creates a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: [] parameters: []
@@ -1860,7 +1860,7 @@ paths:
description: Metadata for the customer. description: Metadata for the customer.
get: get:
operationId: GetCustomerGroups operationId: GetCustomerGroups
summary: Retrieve a list of customer groups summary: List Customer Groups
description: Retrieve a list of customer groups. description: Retrieve a list of customer groups.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2038,7 +2038,7 @@ paths:
'/customer-groups/{id}': '/customer-groups/{id}':
delete: delete:
operationId: DeleteCustomerGroupsCustomerGroup operationId: DeleteCustomerGroupsCustomerGroup
summary: Delete a CustomerGroup summary: Delete a Customer Group
description: Deletes a CustomerGroup. description: Deletes a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2110,7 +2110,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetCustomerGroupsGroup operationId: GetCustomerGroupsGroup
summary: Retrieve a CustomerGroup summary: Get a Customer Group
description: Retrieves a Customer Group. description: Retrieves a Customer Group.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2185,7 +2185,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostCustomerGroupsGroup operationId: PostCustomerGroupsGroup
summary: Update a CustomerGroup summary: Update a Customer Group
description: Update a CustomerGroup. description: Update a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2528,7 +2528,7 @@ paths:
'/customers/{id}': '/customers/{id}':
get: get:
operationId: GetCustomersCustomer operationId: GetCustomersCustomer
summary: Retrieve a Customer summary: Get a Customer
description: Retrieves a Customer. description: Retrieves a Customer.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2716,7 +2716,7 @@ paths:
'/discounts/{id}/regions/{region_id}': '/discounts/{id}/regions/{region_id}':
post: post:
operationId: PostDiscountsDiscountRegionsRegion operationId: PostDiscountsDiscountRegionsRegion
summary: Adds Region availability summary: Add Region
description: Adds a Region to the list of Regions that a Discount can be used in. description: Adds a Region to the list of Regions that a Discount can be used in.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2783,7 +2783,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteDiscountsDiscountRegionsRegion operationId: DeleteDiscountsDiscountRegionsRegion
summary: Remove Region availability summary: Remove Region
x-authenticated: true x-authenticated: true
description: >- description: >-
Removes a Region from the list of Regions that a Discount can be used Removes a Region from the list of Regions that a Discount can be used
@@ -2853,7 +2853,7 @@ paths:
'/discounts/{discount_id}/conditions': '/discounts/{discount_id}/conditions':
post: post:
operationId: PostDiscountsDiscountConditions operationId: PostDiscountsDiscountConditions
summary: Create a DiscountCondition summary: Create a Condition
description: >- description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`, Creates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
@@ -3341,10 +3341,11 @@ paths:
'/discounts/{id}/dynamic-codes': '/discounts/{id}/dynamic-codes':
post: post:
operationId: PostDiscountsDiscountDynamicCodes operationId: PostDiscountsDiscountDynamicCodes
summary: Create a dynamic Discount code summary: Create a Dynamic Code
description: >- description: >-
Creates a unique code that can map to a parent Discount. This is useful Creates a dynamic unique code that can map to a parent Discount. This is
if you want to automatically generate codes with the same behaviour. useful if you want to automatically generate codes with the same
behaviour.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -3434,7 +3435,7 @@ paths:
'/discounts/{discount_id}/conditions/{condition_id}': '/discounts/{discount_id}/conditions/{condition_id}':
delete: delete:
operationId: DeleteDiscountsDiscountConditionsCondition operationId: DeleteDiscountsDiscountConditionsCondition
summary: Delete a DiscountCondition summary: Delete a Condition
description: Deletes a DiscountCondition description: Deletes a DiscountCondition
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -3526,7 +3527,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetDiscountsDiscountConditionsCondition operationId: GetDiscountsDiscountConditionsCondition
summary: Gets a DiscountCondition summary: Get a Condition
description: Gets a DiscountCondition description: Gets a DiscountCondition
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -3604,7 +3605,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostDiscountsDiscountConditionsCondition operationId: PostDiscountsDiscountConditionsCondition
summary: Update a DiscountCondition summary: Update a Condition
description: >- description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`, Updates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
@@ -3810,7 +3811,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetDiscountsDiscount operationId: GetDiscountsDiscount
summary: Retrieve a Discount summary: Get a Discount
description: Retrieves a Discount description: Retrieves a Discount
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4086,7 +4087,7 @@ paths:
'/discounts/{id}/dynamic-codes/{code}': '/discounts/{id}/dynamic-codes/{code}':
delete: delete:
operationId: DeleteDiscountsDiscountDynamicCodesCode operationId: DeleteDiscountsDiscountDynamicCodesCode
summary: Delete a dynamic code summary: Delete a Dynamic Code
description: Deletes a dynamic code from a Discount. description: Deletes a dynamic code from a Discount.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4154,7 +4155,7 @@ paths:
'/discounts/code/{code}': '/discounts/code/{code}':
get: get:
operationId: GetDiscountsDiscountCode operationId: GetDiscountsDiscountCode
summary: Retrieve a Discount by code summary: Get Discount by Code
description: Retrieves a Discount by its discount code description: Retrieves a Discount by its discount code
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4495,7 +4496,7 @@ paths:
'/draft-orders/{id}/line-items': '/draft-orders/{id}/line-items':
post: post:
operationId: PostDraftOrdersDraftOrderLineItems operationId: PostDraftOrdersDraftOrderLineItems
summary: Create a Line Item for Draft Order summary: Create a Line Item
description: Creates a Line Item for the Draft Order description: Creates a Line Item for the Draft Order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4662,7 +4663,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetDraftOrdersDraftOrder operationId: GetDraftOrdersDraftOrder
summary: Retrieve a Draft Order summary: Get a Draft Order
description: Retrieves a Draft Order. description: Retrieves a Draft Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4792,7 +4793,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostDraftOrdersDraftOrderLineItemsItem operationId: PostDraftOrdersDraftOrderLineItemsItem
summary: Update a Line Item for a Draft Order summary: Update a Line Item
description: Updates a Line Item for a Draft Order description: Updates a Line Item for a Draft Order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4887,7 +4888,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
'/draft-orders/{id}/pay': '/draft-orders/{id}/pay':
post: post:
summary: Registers a payment for a Draft Order summary: Registers a Payment
operationId: PostDraftOrdersDraftOrderRegisterPayment operationId: PostDraftOrdersDraftOrderRegisterPayment
description: Registers a payment for a Draft Order. description: Registers a payment for a Draft Order.
x-authenticated: true x-authenticated: true
@@ -4950,7 +4951,7 @@ paths:
'/admin/draft-orders/{id}': '/admin/draft-orders/{id}':
post: post:
operationId: PostDraftOrdersDraftOrder operationId: PostDraftOrdersDraftOrder
summary: Update a Draft Order" summary: Update a Draft Order
description: Updates a Draft Order. description: Updates a Draft Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -5313,7 +5314,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetGiftCardsGiftCard operationId: GetGiftCardsGiftCard
summary: Retrieve a Gift Card summary: Get a Gift Card
description: Retrieves a Gift Card. description: Retrieves a Gift Card.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -5655,7 +5656,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetInvites operationId: GetInvites
summary: Lists all Invites summary: Lists Invites
description: Lists all Invites description: Lists all Invites
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -6009,7 +6010,7 @@ paths:
'/notes/{id}': '/notes/{id}':
delete: delete:
operationId: DeleteNotesNote operationId: DeleteNotesNote
summary: Deletes a Note summary: Delete a Note
description: Deletes a Note. description: Deletes a Note.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6079,7 +6080,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetNotesNote operationId: GetNotesNote
summary: Get Note summary: Get a Note
description: Retrieves a single note using its id description: Retrieves a single note using its id
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6140,7 +6141,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostNotesNote operationId: PostNotesNote
summary: Updates a Note summary: Update a Note
x-authenticated: true x-authenticated: true
description: Updates a Note associated with some resource description: Updates a Note associated with some resource
parameters: parameters:
@@ -6506,7 +6507,7 @@ paths:
'/orders/{id}/archive': '/orders/{id}/archive':
post: post:
operationId: PostOrdersOrderArchive operationId: PostOrdersOrderArchive
summary: Archive order summary: Archive Order
description: Archives the order with the given id. description: Archives the order with the given id.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6568,7 +6569,7 @@ paths:
'/orders/{id}/claims/{claim_id}/cancel': '/orders/{id}/claims/{claim_id}/cancel':
post: post:
operationId: PostOrdersClaimCancel operationId: PostOrdersClaimCancel
summary: Cancels a Claim summary: Cancel a Claim
description: Cancels a Claim description: Cancels a Claim
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6637,8 +6638,8 @@ paths:
'/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel': '/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel':
post: post:
operationId: PostOrdersClaimFulfillmentsCancel operationId: PostOrdersClaimFulfillmentsCancel
summary: Cancels a fulfilmment related to a Claim summary: Cancel Claim Fulfillment
description: Registers a Fulfillment as canceled. description: Registers a claim's fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -6713,8 +6714,8 @@ paths:
'/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel': '/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel':
post: post:
operationId: PostOrdersSwapFulfillmentsCancel operationId: PostOrdersSwapFulfillmentsCancel
summary: Cancels a fulfilmment related to a Swap summary: Cancel Swap's Fulfilmment
description: Registers a Fulfillment as canceled. description: Registers a Swap's Fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -6789,7 +6790,7 @@ paths:
'/orders/{id}/fulfillments/{fulfillment_id}/cancel': '/orders/{id}/fulfillments/{fulfillment_id}/cancel':
post: post:
operationId: PostOrdersOrderFulfillmentsCancel operationId: PostOrdersOrderFulfillmentsCancel
summary: Cancels a fulfilmment summary: Cancels a Fulfilmment
description: Registers a Fulfillment as canceled. description: Registers a Fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6992,7 +6993,7 @@ paths:
'/orders/{id}/capture': '/orders/{id}/capture':
post: post:
operationId: PostOrdersOrderCapture operationId: PostOrdersOrderCapture
summary: Capture an Order summary: Capture Order's Payment
description: Captures all the Payments associated with an Order. description: Captures all the Payments associated with an Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -7649,7 +7650,7 @@ paths:
type: string type: string
no_notification: no_notification:
description: >- description: >-
If set to true no notification will be send related to this If set to true no notification will be sent related to this
Claim. Claim.
type: boolean type: boolean
x-codeSamples: x-codeSamples:
@@ -7877,7 +7878,7 @@ paths:
'/orders/{id}/claims/{claim_id}/fulfillments': '/orders/{id}/claims/{claim_id}/fulfillments':
post: post:
operationId: PostOrdersOrderClaimsClaimFulfillments operationId: PostOrdersOrderClaimsClaimFulfillments
summary: Create a Claim Fulfillment summary: Create Claim Fulfillment
description: Creates a Fulfillment for a Claim. description: Creates a Fulfillment for a Claim.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -7961,7 +7962,7 @@ paths:
'/orders/{id}/swaps/{swap_id}/fulfillments': '/orders/{id}/swaps/{swap_id}/fulfillments':
post: post:
operationId: PostOrdersOrderSwapsSwapFulfillments operationId: PostOrdersOrderSwapsSwapFulfillments
summary: Create a Swap Fulfillment summary: Create Swap Fulfillment
description: Creates a Fulfillment for a Swap. description: Creates a Fulfillment for a Swap.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -8045,7 +8046,7 @@ paths:
'/orders/{id}': '/orders/{id}':
get: get:
operationId: GetOrdersOrder operationId: GetOrdersOrder
summary: Retrieve an Order summary: Get an Order
description: Retrieves an Order description: Retrieves an Order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -8106,7 +8107,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostOrdersOrder operationId: PostOrdersOrder
summary: Update an order summary: Update an Order
description: Updates and order description: Updates and order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -8524,7 +8525,7 @@ paths:
'/orders/{id}/swaps/{swap_id}/process-payment': '/orders/{id}/swaps/{swap_id}/process-payment':
post: post:
operationId: PostOrdersOrderSwapsSwapProcessPayment operationId: PostOrdersOrderSwapsSwapProcessPayment
summary: Process a Swap difference summary: Process Swap Payment
description: >- description: >-
When there are differences between the returned and shipped Products in When there are differences between the returned and shipped Products in
a Swap, the difference must be processed. Either a Refund will be issued a Swap, the difference must be processed. Either a Refund will be issued
@@ -9000,7 +9001,7 @@ paths:
'/price-lists/{id}/prices/batch': '/price-lists/{id}/prices/batch':
post: post:
operationId: PostPriceListsPriceListPricesBatch operationId: PostPriceListsPriceListPricesBatch
summary: Batch update prices for a Price List summary: Update Prices
description: Batch update prices for a Price List description: Batch update prices for a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9128,7 +9129,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeletePriceListsPriceListPricesBatch operationId: DeletePriceListsPriceListPricesBatch
summary: Batch delete prices that belong to a Price List summary: Delete Prices
description: Batch delete prices that belong to a Price List description: Batch delete prices that belong to a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9225,7 +9226,7 @@ paths:
/price-lists: /price-lists:
post: post:
operationId: PostPriceListsPriceList operationId: PostPriceListsPriceList
summary: Creates a Price List summary: Create a Price List
description: Creates a Price List description: Creates a Price List
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -9666,7 +9667,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetPriceListsPriceList operationId: GetPriceListsPriceList
summary: Retrieve a Price List summary: Get a Price List
description: Retrieves a Price List. description: Retrieves a Price List.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9877,7 +9878,7 @@ paths:
'/price-lists/{id}/products/{product_id}/prices': '/price-lists/{id}/products/{product_id}/prices':
delete: delete:
operationId: DeletePriceListsPriceListProductsProductPrices operationId: DeletePriceListsPriceListProductsProductPrices
summary: Delete all the prices related to a specific product in a price list summary: Delete Product's Prices
description: Delete all the prices related to a specific product in a price list description: Delete all the prices related to a specific product in a price list
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9960,7 +9961,7 @@ paths:
'/price-lists/{id}/variants/{variant_id}/prices': '/price-lists/{id}/variants/{variant_id}/prices':
delete: delete:
operationId: DeletePriceListsPriceListVariantsVariantPrices operationId: DeletePriceListsPriceListVariantsVariantPrices
summary: Delete all the prices related to a specific variant in a price list summary: Delete Variant's Prices
description: Delete all the prices related to a specific variant in a price list description: Delete all the prices related to a specific variant in a price list
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -10043,7 +10044,7 @@ paths:
'/price-lists/{id}/products': '/price-lists/{id}/products':
get: get:
operationId: GetPriceListsPriceListProducts operationId: GetPriceListsPriceListProducts
summary: List Product in a Price List summary: List Products
description: Retrieves a list of Product that are part of a Price List description: Retrieves a list of Product that are part of a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -10878,7 +10879,7 @@ paths:
same index in the Product's `options` field. same index in the Product's `options` field.
type: string type: string
weight: weight:
description: The wieght of the Product. description: The weight of the Product.
type: number type: number
length: length:
description: The length of the Product. description: The length of the Product.
@@ -10967,7 +10968,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetProducts operationId: GetProducts
summary: List Product summary: List Products
description: Retrieves a list of Product description: Retrieves a list of Product
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -11431,7 +11432,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetProductsProductVariants operationId: GetProductsProductVariants
summary: List a Product's Product Variants summary: List a Product's Variants
description: Retrieves a list of the Product Variants associated with a Product. description: Retrieves a list of the Product Variants associated with a Product.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -11593,7 +11594,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostProductsProductOptionsOption operationId: PostProductsProductOptionsOption
summary: Update a Product Option. summary: Update a Product Option
description: Updates a Product Option description: Updates a Product Option
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -11749,7 +11750,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetProductsProduct operationId: GetProductsProduct
summary: Retrieve a Product summary: Get a Product
description: Retrieves a Product. description: Retrieves a Product.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -12236,7 +12237,7 @@ paths:
Product Variant. Product Variant.
type: boolean type: boolean
weight: weight:
description: The wieght of the Product Variant. description: The weight of the Product Variant.
type: number type: number
length: length:
description: The length of the Product Variant. description: The length of the Product Variant.
@@ -12387,7 +12388,7 @@ paths:
/products/tag-usage: /products/tag-usage:
get: get:
operationId: GetProductsTagUsage operationId: GetProductsTagUsage
summary: List Product Tags Usage Number summary: List Tags Usage Number
description: Retrieves a list of Product Tags with how many times each is used. description: Retrieves a list of Product Tags with how many times each is used.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -12510,7 +12511,7 @@ paths:
'/products/{id}/metadata': '/products/{id}/metadata':
post: post:
operationId: PostProductsProductMetadata operationId: PostProductsProductMetadata
summary: Set Product metadata summary: Set Product Metadata
description: Set metadata key/value pair for Product description: Set metadata key/value pair for Product
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13150,7 +13151,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetRegionsRegion operationId: GetRegionsRegion
summary: Retrieve a Region summary: Get a Region
description: Retrieves a Region. description: Retrieves a Region.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13338,7 +13339,7 @@ paths:
'/regions/{id}/fulfillment-options': '/regions/{id}/fulfillment-options':
get: get:
operationId: GetRegionsRegionFulfillmentOptions operationId: GetRegionsRegionFulfillmentOptions
summary: List Fulfillment Options available in the Region summary: List Fulfillment Options
description: Gathers all the fulfillment options available to in the Region. description: Gathers all the fulfillment options available to in the Region.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13412,7 +13413,7 @@ paths:
'/regions/{id}/countries/{country_code}': '/regions/{id}/countries/{country_code}':
delete: delete:
operationId: PostRegionsRegionCountriesCountry operationId: PostRegionsRegionCountriesCountry
summary: Remove Country summary: Delete Country
x-authenticated: true x-authenticated: true
description: Removes a Country from the list of Countries in a Region description: Removes a Country from the list of Countries in a Region
parameters: parameters:
@@ -13483,7 +13484,7 @@ paths:
'/regions/{id}/fulfillment-providers/{provider_id}': '/regions/{id}/fulfillment-providers/{provider_id}':
delete: delete:
operationId: PostRegionsRegionFulfillmentProvidersProvider operationId: PostRegionsRegionFulfillmentProvidersProvider
summary: Remove Fulfillment Provider summary: Del. Fulfillment Provider
description: Removes a Fulfillment Provider. description: Removes a Fulfillment Provider.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13552,7 +13553,7 @@ paths:
'/regions/{id}/payment-providers/{provider_id}': '/regions/{id}/payment-providers/{provider_id}':
delete: delete:
operationId: PostRegionsRegionPaymentProvidersProvider operationId: PostRegionsRegionPaymentProvidersProvider
summary: Remove Payment Provider summary: Delete Payment Provider
description: Removes a Payment Provider. description: Removes a Payment Provider.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13769,7 +13770,7 @@ paths:
'/return-reasons/{id}': '/return-reasons/{id}':
delete: delete:
operationId: DeleteReturnReason operationId: DeleteReturnReason
summary: Delete a return reason summary: Delete a Return Reason
description: Deletes a return reason. description: Deletes a return reason.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13839,7 +13840,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetReturnReasonsReason operationId: GetReturnReasonsReason
summary: Retrieve a Return Reason summary: Get a Return Reason
description: Retrieves a Return Reason. description: Retrieves a Return Reason.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14235,7 +14236,7 @@ paths:
'/sales-channels/{id}/products/batch': '/sales-channels/{id}/products/batch':
post: post:
operationId: PostSalesChannelsChannelProductsBatch operationId: PostSalesChannelsChannelProductsBatch
summary: Assign a batch of product to a sales channel summary: Add Products
description: Assign a batch of product to a sales channel. description: Assign a batch of product to a sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14330,7 +14331,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteSalesChannelsChannelProductsBatch operationId: DeleteSalesChannelsChannelProductsBatch
summary: Remove a list of products from a sales channel summary: Delete Products
description: Remove a list of products from a sales channel. description: Remove a list of products from a sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14505,7 +14506,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetSalesChannels operationId: GetSalesChannels
summary: List sales channels summary: List Sales Channels
description: Retrieves a list of sales channels description: Retrieves a list of sales channels
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14689,7 +14690,7 @@ paths:
'/sales-channels/{id}': '/sales-channels/{id}':
delete: delete:
operationId: DeleteSalesChannelsSalesChannel operationId: DeleteSalesChannelsSalesChannel
summary: Delete a sales channel summary: Delete a Sales Channel
description: Deletes the sales channel. description: Deletes the sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14759,7 +14760,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetSalesChannelsSalesChannel operationId: GetSalesChannelsSalesChannel
summary: Retrieve a sales channel summary: Get a Sales Channel
description: Retrieves the sales channel. description: Retrieves the sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15196,7 +15197,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetShippingOptionsOption operationId: GetShippingOptionsOption
summary: Retrieve a Shipping Option summary: Get a Shipping Option
description: Retrieves a Shipping Option. description: Retrieves a Shipping Option.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15581,7 +15582,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetShippingProfilesProfile operationId: GetShippingProfilesProfile
summary: Retrieve a Shipping Profile summary: Get a Shipping Profile
description: Retrieves a Shipping Profile. description: Retrieves a Shipping Profile.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15642,7 +15643,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostShippingProfilesProfile operationId: PostShippingProfilesProfile
summary: Update a Shipping Profiles summary: Update a Shipping Profile
description: Updates a Shipping Profile description: Updates a Shipping Profile
parameters: parameters:
- in: path - in: path
@@ -15783,7 +15784,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteStoreCurrenciesCode operationId: DeleteStoreCurrenciesCode
summary: Remove a Currency Code summary: Delete a Currency Code
description: Removes a Currency Code from the available currencies. description: Removes a Currency Code from the available currencies.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15848,7 +15849,7 @@ paths:
/store: /store:
get: get:
operationId: GetStore operationId: GetStore
summary: Retrieve Store details. summary: Get Store details
description: Retrieves the Store details description: Retrieves the Store details
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -15900,7 +15901,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostStore operationId: PostStore
summary: Update Store details. summary: Update Store Details
description: Updates the Store details description: Updates the Store details
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -16002,7 +16003,7 @@ paths:
/store/payment-providers: /store/payment-providers:
get: get:
operationId: GetStorePaymentProviders operationId: GetStorePaymentProviders
summary: Retrieve configured Payment Providers summary: List Payment Providers
description: Retrieves the configured Payment Providers description: Retrieves the configured Payment Providers
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -16059,7 +16060,7 @@ paths:
/store/tax-providers: /store/tax-providers:
get: get:
operationId: GetStoreTaxProviders operationId: GetStoreTaxProviders
summary: Retrieve configured Tax Providers summary: List Tax Providers
description: Retrieves the configured Tax Providers description: Retrieves the configured Tax Providers
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -16116,7 +16117,7 @@ paths:
'/swaps/{id}': '/swaps/{id}':
get: get:
operationId: GetSwapsSwap operationId: GetSwapsSwap
summary: Retrieve a Swap summary: Get a Swap
description: Retrieves a Swap. description: Retrieves a Swap.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -16255,7 +16256,7 @@ paths:
'/tax-rates/{id}/product-types/batch': '/tax-rates/{id}/product-types/batch':
post: post:
operationId: PostTaxRatesTaxRateProductTypes operationId: PostTaxRatesTaxRateProductTypes
summary: Add Tax Rate to Product Types summary: Add to Product Types
description: Associates a Tax Rate with a list of Product Types description: Associates a Tax Rate with a list of Product Types
parameters: parameters:
- in: path - in: path
@@ -16360,7 +16361,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteTaxRatesTaxRateProductTypes operationId: DeleteTaxRatesTaxRateProductTypes
summary: Remove Tax Rate from Product Types summary: Delete from Product Types
description: Removes a Tax Rate from a list of Product Types description: Removes a Tax Rate from a list of Product Types
parameters: parameters:
- in: path - in: path
@@ -16466,7 +16467,7 @@ paths:
'/tax-rates/{id}/products/batch': '/tax-rates/{id}/products/batch':
post: post:
operationId: PostTaxRatesTaxRateProducts operationId: PostTaxRatesTaxRateProducts
summary: Add Tax Rate to Products summary: Add to Products
description: Associates a Tax Rate with a list of Products description: Associates a Tax Rate with a list of Products
parameters: parameters:
- in: path - in: path
@@ -16569,7 +16570,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteTaxRatesTaxRateProducts operationId: DeleteTaxRatesTaxRateProducts
summary: Removes Tax Rate from Products summary: Delete from Products
description: Removes a Tax Rate from a list of Products description: Removes a Tax Rate from a list of Products
parameters: parameters:
- in: path - in: path
@@ -16675,7 +16676,7 @@ paths:
'/tax-rates/{id}/shipping-options/batch': '/tax-rates/{id}/shipping-options/batch':
post: post:
operationId: PostTaxRatesTaxRateShippingOptions operationId: PostTaxRatesTaxRateShippingOptions
summary: Add Tax Rate to Product Types summary: Add to Shipping Options
description: Associates a Tax Rate with a list of Shipping Options description: Associates a Tax Rate with a list of Shipping Options
parameters: parameters:
- in: path - in: path
@@ -16781,8 +16782,8 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteTaxRatesTaxRateShippingOptions operationId: DeleteTaxRatesTaxRateShippingOptions
summary: Removes a Tax Rate from Product Types summary: Del. for Shipping Options
description: Removes a Tax Rate from a list of Product Types description: Removes a Tax Rate from a list of Shipping Options
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -17223,7 +17224,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetTaxRatesTaxRate operationId: GetTaxRatesTaxRate
summary: Get Tax Rate summary: Get a Tax Rate
description: Retrieves a TaxRate description: Retrieves a TaxRate
parameters: parameters:
- in: path - in: path
@@ -17426,7 +17427,7 @@ paths:
/uploads: /uploads:
post: post:
operationId: PostUploads operationId: PostUploads
summary: Uploads a file summary: Upload a file
description: Uploads a file to the specific fileservice that is installed in Medusa. description: Uploads a file to the specific fileservice that is installed in Medusa.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -17594,7 +17595,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetUsers operationId: GetUsers
summary: Retrieve all users summary: List Users
description: Retrieves all users. description: Retrieves all users.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -17719,7 +17720,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetUsersUser operationId: GetUsersUser
summary: Retrieve a User summary: Get a User
description: Retrieves a User. description: Retrieves a User.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -17876,7 +17877,7 @@ paths:
/users/password-token: /users/password-token:
post: post:
operationId: PostUsersUserPasswordToken operationId: PostUsersUserPasswordToken
summary: Generate a password token for a User. summary: Request Password Reset
description: Generates a password token for a User with a given email. description: Generates a password token for a User with a given email.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -17948,7 +17949,7 @@ paths:
/users/reset-password: /users/reset-password:
post: post:
operationId: PostUsersUserPassword operationId: PostUsersUserPassword
summary: Set the password for a User. summary: Reset Password
description: Sets the password for a User given the correct token. description: Sets the password for a User given the correct token.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -18032,7 +18033,7 @@ paths:
/variants: /variants:
get: get:
operationId: GetVariants operationId: GetVariants
summary: List Product Variants. summary: List Product Variants
description: Retrieves a list of Product Variants description: Retrieves a list of Product Variants
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -23005,7 +23006,7 @@ components:
$ref: '#/components/schemas/address' $ref: '#/components/schemas/address'
shipping_methods: shipping_methods:
description: >- description: >-
The Shipping Methods used to fulfill the addtional items purchased. The Shipping Methods used to fulfill the additional items purchased.
Available if the relation `shipping_methods` is expanded. Available if the relation `shipping_methods` is expanded.
type: array type: array
items: items:
docs/api/admin-spec3.yaml
+111 -110
View File
@@ -122,7 +122,7 @@ paths:
/apps/authorizations: /apps/authorizations:
post: post:
operationId: PostApps operationId: PostApps
summary: Generates a token for an application. summary: Generate Token for App
description: Generates a token for an application. description: Generates a token for an application.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -188,7 +188,7 @@ paths:
/apps: /apps:
get: get:
operationId: GetApps operationId: GetApps
summary: List applications summary: List Applications
description: Retrieve a list of applications. description: Retrieve a list of applications.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -228,7 +228,7 @@ paths:
/auth: /auth:
post: post:
operationId: PostAuth operationId: PostAuth
summary: Authenticate a User summary: User Login
x-authenticated: false x-authenticated: false
description: Logs a User in and authorizes them to manage Store settings. description: Logs a User in and authorizes them to manage Store settings.
parameters: [] parameters: []
@@ -296,7 +296,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteAuth operationId: DeleteAuth
summary: Delete Session summary: User Logout
x-authenticated: true x-authenticated: true
description: Deletes the current session for the logged in user. description: Deletes the current session for the logged in user.
x-codeSamples: x-codeSamples:
@@ -340,7 +340,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetAuth operationId: GetAuth
summary: Get Session summary: Get Current User
x-authenticated: true x-authenticated: true
description: Gets the currently logged in User. description: Gets the currently logged in User.
x-codeSamples: x-codeSamples:
@@ -393,7 +393,7 @@ paths:
'/batch-jobs/{id}/cancel': '/batch-jobs/{id}/cancel':
post: post:
operationId: PostBatchJobsBatchJobCancel operationId: PostBatchJobsBatchJobCancel
summary: Marks a batch job as canceled summary: Cancel a Batch Job
description: Marks a batch job as canceled description: Marks a batch job as canceled
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -455,7 +455,7 @@ paths:
'/batch-jobs/{id}/confirm': '/batch-jobs/{id}/confirm':
post: post:
operationId: PostBatchJobsBatchJobConfirmProcessing operationId: PostBatchJobsBatchJobConfirmProcessing
summary: Confirm a batch job summary: Confirm a Batch Job
description: Confirms that a previously requested batch job should be executed. description: Confirms that a previously requested batch job should be executed.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -921,7 +921,7 @@ paths:
'/batch-jobs/{id}': '/batch-jobs/{id}':
get: get:
operationId: GetBatchJobsBatchJob operationId: GetBatchJobsBatchJob
summary: Retrieve a Batch Job summary: Get a Batch Job
description: Retrieves a Batch Job. description: Retrieves a Batch Job.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -983,7 +983,7 @@ paths:
'/collections/{id}/products/batch': '/collections/{id}/products/batch':
post: post:
operationId: PostProductsToCollection operationId: PostProductsToCollection
summary: Updates products associated with a Product Collection summary: Update Products
description: Updates products associated with a Product Collection description: Updates products associated with a Product Collection
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1050,7 +1050,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteProductsFromCollection operationId: DeleteProductsFromCollection
summary: Removes products associated with a Product Collection summary: Remove Product
description: Removes products associated with a Product Collection description: Removes products associated with a Product Collection
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1131,7 +1131,7 @@ paths:
/collections: /collections:
post: post:
operationId: PostCollections operationId: PostCollections
summary: Create a Product Collection summary: Create a Collection
description: Creates a Product Collection. description: Creates a Product Collection.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -1213,7 +1213,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetCollections operationId: GetCollections
summary: List Product Collections summary: List Collections
description: Retrieve a list of Product Collection. description: Retrieve a list of Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1373,7 +1373,7 @@ paths:
'/collections/{id}': '/collections/{id}':
delete: delete:
operationId: DeleteCollectionsCollection operationId: DeleteCollectionsCollection
summary: Delete a Product Collection summary: Delete a Collection
description: Deletes a Product Collection. description: Deletes a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1443,7 +1443,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetCollectionsCollection operationId: GetCollectionsCollection
summary: Retrieve a Product Collection summary: Get a Collection
description: Retrieves a Product Collection. description: Retrieves a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1504,7 +1504,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostCollectionsCollection operationId: PostCollectionsCollection
summary: Update a Product Collection summary: Update a Collection
description: Updates a Product Collection. description: Updates a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1592,7 +1592,7 @@ paths:
'/customer-groups/{id}/customers/batch': '/customer-groups/{id}/customers/batch':
post: post:
operationId: PostCustomerGroupsGroupCustomersBatch operationId: PostCustomerGroupsGroupCustomersBatch
summary: 'Add a list of customers to a customer group ' summary: Add Customers
description: 'Adds a list of customers, represented by id''s, to a customer group.' description: 'Adds a list of customers, represented by id''s, to a customer group.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1687,7 +1687,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteCustomerGroupsGroupCustomerBatch operationId: DeleteCustomerGroupsGroupCustomerBatch
summary: 'Remove a list of customers from a customer group ' summary: Remove Customers
description: 'Removes a list of customers, represented by id''s, from a customer group.' description: 'Removes a list of customers, represented by id''s, from a customer group.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -1783,7 +1783,7 @@ paths:
/customer-groups: /customer-groups:
post: post:
operationId: PostCustomerGroups operationId: PostCustomerGroups
summary: Create a CustomerGroup summary: Create a Customer Group
description: Creates a CustomerGroup. description: Creates a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: [] parameters: []
@@ -1860,7 +1860,7 @@ paths:
description: Metadata for the customer. description: Metadata for the customer.
get: get:
operationId: GetCustomerGroups operationId: GetCustomerGroups
summary: Retrieve a list of customer groups summary: List Customer Groups
description: Retrieve a list of customer groups. description: Retrieve a list of customer groups.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2038,7 +2038,7 @@ paths:
'/customer-groups/{id}': '/customer-groups/{id}':
delete: delete:
operationId: DeleteCustomerGroupsCustomerGroup operationId: DeleteCustomerGroupsCustomerGroup
summary: Delete a CustomerGroup summary: Delete a Customer Group
description: Deletes a CustomerGroup. description: Deletes a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2110,7 +2110,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetCustomerGroupsGroup operationId: GetCustomerGroupsGroup
summary: Retrieve a CustomerGroup summary: Get a Customer Group
description: Retrieves a Customer Group. description: Retrieves a Customer Group.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2185,7 +2185,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostCustomerGroupsGroup operationId: PostCustomerGroupsGroup
summary: Update a CustomerGroup summary: Update a Customer Group
description: Update a CustomerGroup. description: Update a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2528,7 +2528,7 @@ paths:
'/customers/{id}': '/customers/{id}':
get: get:
operationId: GetCustomersCustomer operationId: GetCustomersCustomer
summary: Retrieve a Customer summary: Get a Customer
description: Retrieves a Customer. description: Retrieves a Customer.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2716,7 +2716,7 @@ paths:
'/discounts/{id}/regions/{region_id}': '/discounts/{id}/regions/{region_id}':
post: post:
operationId: PostDiscountsDiscountRegionsRegion operationId: PostDiscountsDiscountRegionsRegion
summary: Adds Region availability summary: Add Region
description: Adds a Region to the list of Regions that a Discount can be used in. description: Adds a Region to the list of Regions that a Discount can be used in.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2783,7 +2783,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteDiscountsDiscountRegionsRegion operationId: DeleteDiscountsDiscountRegionsRegion
summary: Remove Region availability summary: Remove Region
x-authenticated: true x-authenticated: true
description: >- description: >-
Removes a Region from the list of Regions that a Discount can be used Removes a Region from the list of Regions that a Discount can be used
@@ -2853,7 +2853,7 @@ paths:
'/discounts/{discount_id}/conditions': '/discounts/{discount_id}/conditions':
post: post:
operationId: PostDiscountsDiscountConditions operationId: PostDiscountsDiscountConditions
summary: Create a DiscountCondition summary: Create a Condition
description: >- description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`, Creates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
@@ -3341,10 +3341,11 @@ paths:
'/discounts/{id}/dynamic-codes': '/discounts/{id}/dynamic-codes':
post: post:
operationId: PostDiscountsDiscountDynamicCodes operationId: PostDiscountsDiscountDynamicCodes
summary: Create a dynamic Discount code summary: Create a Dynamic Code
description: >- description: >-
Creates a unique code that can map to a parent Discount. This is useful Creates a dynamic unique code that can map to a parent Discount. This is
if you want to automatically generate codes with the same behaviour. useful if you want to automatically generate codes with the same
behaviour.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -3434,7 +3435,7 @@ paths:
'/discounts/{discount_id}/conditions/{condition_id}': '/discounts/{discount_id}/conditions/{condition_id}':
delete: delete:
operationId: DeleteDiscountsDiscountConditionsCondition operationId: DeleteDiscountsDiscountConditionsCondition
summary: Delete a DiscountCondition summary: Delete a Condition
description: Deletes a DiscountCondition description: Deletes a DiscountCondition
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -3526,7 +3527,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetDiscountsDiscountConditionsCondition operationId: GetDiscountsDiscountConditionsCondition
summary: Gets a DiscountCondition summary: Get a Condition
description: Gets a DiscountCondition description: Gets a DiscountCondition
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -3604,7 +3605,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostDiscountsDiscountConditionsCondition operationId: PostDiscountsDiscountConditionsCondition
summary: Update a DiscountCondition summary: Update a Condition
description: >- description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`, Updates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
@@ -3810,7 +3811,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetDiscountsDiscount operationId: GetDiscountsDiscount
summary: Retrieve a Discount summary: Get a Discount
description: Retrieves a Discount description: Retrieves a Discount
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4086,7 +4087,7 @@ paths:
'/discounts/{id}/dynamic-codes/{code}': '/discounts/{id}/dynamic-codes/{code}':
delete: delete:
operationId: DeleteDiscountsDiscountDynamicCodesCode operationId: DeleteDiscountsDiscountDynamicCodesCode
summary: Delete a dynamic code summary: Delete a Dynamic Code
description: Deletes a dynamic code from a Discount. description: Deletes a dynamic code from a Discount.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4154,7 +4155,7 @@ paths:
'/discounts/code/{code}': '/discounts/code/{code}':
get: get:
operationId: GetDiscountsDiscountCode operationId: GetDiscountsDiscountCode
summary: Retrieve a Discount by code summary: Get Discount by Code
description: Retrieves a Discount by its discount code description: Retrieves a Discount by its discount code
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4495,7 +4496,7 @@ paths:
'/draft-orders/{id}/line-items': '/draft-orders/{id}/line-items':
post: post:
operationId: PostDraftOrdersDraftOrderLineItems operationId: PostDraftOrdersDraftOrderLineItems
summary: Create a Line Item for Draft Order summary: Create a Line Item
description: Creates a Line Item for the Draft Order description: Creates a Line Item for the Draft Order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4662,7 +4663,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetDraftOrdersDraftOrder operationId: GetDraftOrdersDraftOrder
summary: Retrieve a Draft Order summary: Get a Draft Order
description: Retrieves a Draft Order. description: Retrieves a Draft Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4792,7 +4793,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostDraftOrdersDraftOrderLineItemsItem operationId: PostDraftOrdersDraftOrderLineItemsItem
summary: Update a Line Item for a Draft Order summary: Update a Line Item
description: Updates a Line Item for a Draft Order description: Updates a Line Item for a Draft Order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4887,7 +4888,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
'/draft-orders/{id}/pay': '/draft-orders/{id}/pay':
post: post:
summary: Registers a payment for a Draft Order summary: Registers a Payment
operationId: PostDraftOrdersDraftOrderRegisterPayment operationId: PostDraftOrdersDraftOrderRegisterPayment
description: Registers a payment for a Draft Order. description: Registers a payment for a Draft Order.
x-authenticated: true x-authenticated: true
@@ -4950,7 +4951,7 @@ paths:
'/admin/draft-orders/{id}': '/admin/draft-orders/{id}':
post: post:
operationId: PostDraftOrdersDraftOrder operationId: PostDraftOrdersDraftOrder
summary: Update a Draft Order" summary: Update a Draft Order
description: Updates a Draft Order. description: Updates a Draft Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -5313,7 +5314,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetGiftCardsGiftCard operationId: GetGiftCardsGiftCard
summary: Retrieve a Gift Card summary: Get a Gift Card
description: Retrieves a Gift Card. description: Retrieves a Gift Card.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -5655,7 +5656,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetInvites operationId: GetInvites
summary: Lists all Invites summary: Lists Invites
description: Lists all Invites description: Lists all Invites
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -6009,7 +6010,7 @@ paths:
'/notes/{id}': '/notes/{id}':
delete: delete:
operationId: DeleteNotesNote operationId: DeleteNotesNote
summary: Deletes a Note summary: Delete a Note
description: Deletes a Note. description: Deletes a Note.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6079,7 +6080,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetNotesNote operationId: GetNotesNote
summary: Get Note summary: Get a Note
description: Retrieves a single note using its id description: Retrieves a single note using its id
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6140,7 +6141,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostNotesNote operationId: PostNotesNote
summary: Updates a Note summary: Update a Note
x-authenticated: true x-authenticated: true
description: Updates a Note associated with some resource description: Updates a Note associated with some resource
parameters: parameters:
@@ -6506,7 +6507,7 @@ paths:
'/orders/{id}/archive': '/orders/{id}/archive':
post: post:
operationId: PostOrdersOrderArchive operationId: PostOrdersOrderArchive
summary: Archive order summary: Archive Order
description: Archives the order with the given id. description: Archives the order with the given id.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6568,7 +6569,7 @@ paths:
'/orders/{id}/claims/{claim_id}/cancel': '/orders/{id}/claims/{claim_id}/cancel':
post: post:
operationId: PostOrdersClaimCancel operationId: PostOrdersClaimCancel
summary: Cancels a Claim summary: Cancel a Claim
description: Cancels a Claim description: Cancels a Claim
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6637,8 +6638,8 @@ paths:
'/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel': '/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel':
post: post:
operationId: PostOrdersClaimFulfillmentsCancel operationId: PostOrdersClaimFulfillmentsCancel
summary: Cancels a fulfilmment related to a Claim summary: Cancel Claim Fulfillment
description: Registers a Fulfillment as canceled. description: Registers a claim's fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -6713,8 +6714,8 @@ paths:
'/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel': '/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel':
post: post:
operationId: PostOrdersSwapFulfillmentsCancel operationId: PostOrdersSwapFulfillmentsCancel
summary: Cancels a fulfilmment related to a Swap summary: Cancel Swap's Fulfilmment
description: Registers a Fulfillment as canceled. description: Registers a Swap's Fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -6789,7 +6790,7 @@ paths:
'/orders/{id}/fulfillments/{fulfillment_id}/cancel': '/orders/{id}/fulfillments/{fulfillment_id}/cancel':
post: post:
operationId: PostOrdersOrderFulfillmentsCancel operationId: PostOrdersOrderFulfillmentsCancel
summary: Cancels a fulfilmment summary: Cancels a Fulfilmment
description: Registers a Fulfillment as canceled. description: Registers a Fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -6992,7 +6993,7 @@ paths:
'/orders/{id}/capture': '/orders/{id}/capture':
post: post:
operationId: PostOrdersOrderCapture operationId: PostOrdersOrderCapture
summary: Capture an Order summary: Capture Order's Payment
description: Captures all the Payments associated with an Order. description: Captures all the Payments associated with an Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -7649,7 +7650,7 @@ paths:
type: string type: string
no_notification: no_notification:
description: >- description: >-
If set to true no notification will be send related to this If set to true no notification will be sent related to this
Claim. Claim.
type: boolean type: boolean
x-codeSamples: x-codeSamples:
@@ -7877,7 +7878,7 @@ paths:
'/orders/{id}/claims/{claim_id}/fulfillments': '/orders/{id}/claims/{claim_id}/fulfillments':
post: post:
operationId: PostOrdersOrderClaimsClaimFulfillments operationId: PostOrdersOrderClaimsClaimFulfillments
summary: Create a Claim Fulfillment summary: Create Claim Fulfillment
description: Creates a Fulfillment for a Claim. description: Creates a Fulfillment for a Claim.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -7961,7 +7962,7 @@ paths:
'/orders/{id}/swaps/{swap_id}/fulfillments': '/orders/{id}/swaps/{swap_id}/fulfillments':
post: post:
operationId: PostOrdersOrderSwapsSwapFulfillments operationId: PostOrdersOrderSwapsSwapFulfillments
summary: Create a Swap Fulfillment summary: Create Swap Fulfillment
description: Creates a Fulfillment for a Swap. description: Creates a Fulfillment for a Swap.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -8045,7 +8046,7 @@ paths:
'/orders/{id}': '/orders/{id}':
get: get:
operationId: GetOrdersOrder operationId: GetOrdersOrder
summary: Retrieve an Order summary: Get an Order
description: Retrieves an Order description: Retrieves an Order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -8106,7 +8107,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostOrdersOrder operationId: PostOrdersOrder
summary: Update an order summary: Update an Order
description: Updates and order description: Updates and order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -8524,7 +8525,7 @@ paths:
'/orders/{id}/swaps/{swap_id}/process-payment': '/orders/{id}/swaps/{swap_id}/process-payment':
post: post:
operationId: PostOrdersOrderSwapsSwapProcessPayment operationId: PostOrdersOrderSwapsSwapProcessPayment
summary: Process a Swap difference summary: Process Swap Payment
description: >- description: >-
When there are differences between the returned and shipped Products in When there are differences between the returned and shipped Products in
a Swap, the difference must be processed. Either a Refund will be issued a Swap, the difference must be processed. Either a Refund will be issued
@@ -9000,7 +9001,7 @@ paths:
'/price-lists/{id}/prices/batch': '/price-lists/{id}/prices/batch':
post: post:
operationId: PostPriceListsPriceListPricesBatch operationId: PostPriceListsPriceListPricesBatch
summary: Batch update prices for a Price List summary: Update Prices
description: Batch update prices for a Price List description: Batch update prices for a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9128,7 +9129,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeletePriceListsPriceListPricesBatch operationId: DeletePriceListsPriceListPricesBatch
summary: Batch delete prices that belong to a Price List summary: Delete Prices
description: Batch delete prices that belong to a Price List description: Batch delete prices that belong to a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9225,7 +9226,7 @@ paths:
/price-lists: /price-lists:
post: post:
operationId: PostPriceListsPriceList operationId: PostPriceListsPriceList
summary: Creates a Price List summary: Create a Price List
description: Creates a Price List description: Creates a Price List
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -9666,7 +9667,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetPriceListsPriceList operationId: GetPriceListsPriceList
summary: Retrieve a Price List summary: Get a Price List
description: Retrieves a Price List. description: Retrieves a Price List.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9877,7 +9878,7 @@ paths:
'/price-lists/{id}/products/{product_id}/prices': '/price-lists/{id}/products/{product_id}/prices':
delete: delete:
operationId: DeletePriceListsPriceListProductsProductPrices operationId: DeletePriceListsPriceListProductsProductPrices
summary: Delete all the prices related to a specific product in a price list summary: Delete Product's Prices
description: Delete all the prices related to a specific product in a price list description: Delete all the prices related to a specific product in a price list
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9960,7 +9961,7 @@ paths:
'/price-lists/{id}/variants/{variant_id}/prices': '/price-lists/{id}/variants/{variant_id}/prices':
delete: delete:
operationId: DeletePriceListsPriceListVariantsVariantPrices operationId: DeletePriceListsPriceListVariantsVariantPrices
summary: Delete all the prices related to a specific variant in a price list summary: Delete Variant's Prices
description: Delete all the prices related to a specific variant in a price list description: Delete all the prices related to a specific variant in a price list
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -10043,7 +10044,7 @@ paths:
'/price-lists/{id}/products': '/price-lists/{id}/products':
get: get:
operationId: GetPriceListsPriceListProducts operationId: GetPriceListsPriceListProducts
summary: List Product in a Price List summary: List Products
description: Retrieves a list of Product that are part of a Price List description: Retrieves a list of Product that are part of a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -10878,7 +10879,7 @@ paths:
same index in the Product's `options` field. same index in the Product's `options` field.
type: string type: string
weight: weight:
description: The wieght of the Product. description: The weight of the Product.
type: number type: number
length: length:
description: The length of the Product. description: The length of the Product.
@@ -10967,7 +10968,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetProducts operationId: GetProducts
summary: List Product summary: List Products
description: Retrieves a list of Product description: Retrieves a list of Product
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -11431,7 +11432,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetProductsProductVariants operationId: GetProductsProductVariants
summary: List a Product's Product Variants summary: List a Product's Variants
description: Retrieves a list of the Product Variants associated with a Product. description: Retrieves a list of the Product Variants associated with a Product.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -11593,7 +11594,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostProductsProductOptionsOption operationId: PostProductsProductOptionsOption
summary: Update a Product Option. summary: Update a Product Option
description: Updates a Product Option description: Updates a Product Option
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -11749,7 +11750,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetProductsProduct operationId: GetProductsProduct
summary: Retrieve a Product summary: Get a Product
description: Retrieves a Product. description: Retrieves a Product.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -12236,7 +12237,7 @@ paths:
Product Variant. Product Variant.
type: boolean type: boolean
weight: weight:
description: The wieght of the Product Variant. description: The weight of the Product Variant.
type: number type: number
length: length:
description: The length of the Product Variant. description: The length of the Product Variant.
@@ -12387,7 +12388,7 @@ paths:
/products/tag-usage: /products/tag-usage:
get: get:
operationId: GetProductsTagUsage operationId: GetProductsTagUsage
summary: List Product Tags Usage Number summary: List Tags Usage Number
description: Retrieves a list of Product Tags with how many times each is used. description: Retrieves a list of Product Tags with how many times each is used.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -12510,7 +12511,7 @@ paths:
'/products/{id}/metadata': '/products/{id}/metadata':
post: post:
operationId: PostProductsProductMetadata operationId: PostProductsProductMetadata
summary: Set Product metadata summary: Set Product Metadata
description: Set metadata key/value pair for Product description: Set metadata key/value pair for Product
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13150,7 +13151,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetRegionsRegion operationId: GetRegionsRegion
summary: Retrieve a Region summary: Get a Region
description: Retrieves a Region. description: Retrieves a Region.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13338,7 +13339,7 @@ paths:
'/regions/{id}/fulfillment-options': '/regions/{id}/fulfillment-options':
get: get:
operationId: GetRegionsRegionFulfillmentOptions operationId: GetRegionsRegionFulfillmentOptions
summary: List Fulfillment Options available in the Region summary: List Fulfillment Options
description: Gathers all the fulfillment options available to in the Region. description: Gathers all the fulfillment options available to in the Region.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13412,7 +13413,7 @@ paths:
'/regions/{id}/countries/{country_code}': '/regions/{id}/countries/{country_code}':
delete: delete:
operationId: PostRegionsRegionCountriesCountry operationId: PostRegionsRegionCountriesCountry
summary: Remove Country summary: Delete Country
x-authenticated: true x-authenticated: true
description: Removes a Country from the list of Countries in a Region description: Removes a Country from the list of Countries in a Region
parameters: parameters:
@@ -13483,7 +13484,7 @@ paths:
'/regions/{id}/fulfillment-providers/{provider_id}': '/regions/{id}/fulfillment-providers/{provider_id}':
delete: delete:
operationId: PostRegionsRegionFulfillmentProvidersProvider operationId: PostRegionsRegionFulfillmentProvidersProvider
summary: Remove Fulfillment Provider summary: Del. Fulfillment Provider
description: Removes a Fulfillment Provider. description: Removes a Fulfillment Provider.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13552,7 +13553,7 @@ paths:
'/regions/{id}/payment-providers/{provider_id}': '/regions/{id}/payment-providers/{provider_id}':
delete: delete:
operationId: PostRegionsRegionPaymentProvidersProvider operationId: PostRegionsRegionPaymentProvidersProvider
summary: Remove Payment Provider summary: Delete Payment Provider
description: Removes a Payment Provider. description: Removes a Payment Provider.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13769,7 +13770,7 @@ paths:
'/return-reasons/{id}': '/return-reasons/{id}':
delete: delete:
operationId: DeleteReturnReason operationId: DeleteReturnReason
summary: Delete a return reason summary: Delete a Return Reason
description: Deletes a return reason. description: Deletes a return reason.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13839,7 +13840,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetReturnReasonsReason operationId: GetReturnReasonsReason
summary: Retrieve a Return Reason summary: Get a Return Reason
description: Retrieves a Return Reason. description: Retrieves a Return Reason.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14235,7 +14236,7 @@ paths:
'/sales-channels/{id}/products/batch': '/sales-channels/{id}/products/batch':
post: post:
operationId: PostSalesChannelsChannelProductsBatch operationId: PostSalesChannelsChannelProductsBatch
summary: Assign a batch of product to a sales channel summary: Add Products
description: Assign a batch of product to a sales channel. description: Assign a batch of product to a sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14330,7 +14331,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteSalesChannelsChannelProductsBatch operationId: DeleteSalesChannelsChannelProductsBatch
summary: Remove a list of products from a sales channel summary: Delete Products
description: Remove a list of products from a sales channel. description: Remove a list of products from a sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14505,7 +14506,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetSalesChannels operationId: GetSalesChannels
summary: List sales channels summary: List Sales Channels
description: Retrieves a list of sales channels description: Retrieves a list of sales channels
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14689,7 +14690,7 @@ paths:
'/sales-channels/{id}': '/sales-channels/{id}':
delete: delete:
operationId: DeleteSalesChannelsSalesChannel operationId: DeleteSalesChannelsSalesChannel
summary: Delete a sales channel summary: Delete a Sales Channel
description: Deletes the sales channel. description: Deletes the sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14759,7 +14760,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetSalesChannelsSalesChannel operationId: GetSalesChannelsSalesChannel
summary: Retrieve a sales channel summary: Get a Sales Channel
description: Retrieves the sales channel. description: Retrieves the sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15196,7 +15197,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetShippingOptionsOption operationId: GetShippingOptionsOption
summary: Retrieve a Shipping Option summary: Get a Shipping Option
description: Retrieves a Shipping Option. description: Retrieves a Shipping Option.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15581,7 +15582,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetShippingProfilesProfile operationId: GetShippingProfilesProfile
summary: Retrieve a Shipping Profile summary: Get a Shipping Profile
description: Retrieves a Shipping Profile. description: Retrieves a Shipping Profile.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15642,7 +15643,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostShippingProfilesProfile operationId: PostShippingProfilesProfile
summary: Update a Shipping Profiles summary: Update a Shipping Profile
description: Updates a Shipping Profile description: Updates a Shipping Profile
parameters: parameters:
- in: path - in: path
@@ -15783,7 +15784,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteStoreCurrenciesCode operationId: DeleteStoreCurrenciesCode
summary: Remove a Currency Code summary: Delete a Currency Code
description: Removes a Currency Code from the available currencies. description: Removes a Currency Code from the available currencies.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15848,7 +15849,7 @@ paths:
/store: /store:
get: get:
operationId: GetStore operationId: GetStore
summary: Retrieve Store details. summary: Get Store details
description: Retrieves the Store details description: Retrieves the Store details
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -15900,7 +15901,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostStore operationId: PostStore
summary: Update Store details. summary: Update Store Details
description: Updates the Store details description: Updates the Store details
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -16002,7 +16003,7 @@ paths:
/store/payment-providers: /store/payment-providers:
get: get:
operationId: GetStorePaymentProviders operationId: GetStorePaymentProviders
summary: Retrieve configured Payment Providers summary: List Payment Providers
description: Retrieves the configured Payment Providers description: Retrieves the configured Payment Providers
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -16059,7 +16060,7 @@ paths:
/store/tax-providers: /store/tax-providers:
get: get:
operationId: GetStoreTaxProviders operationId: GetStoreTaxProviders
summary: Retrieve configured Tax Providers summary: List Tax Providers
description: Retrieves the configured Tax Providers description: Retrieves the configured Tax Providers
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -16116,7 +16117,7 @@ paths:
'/swaps/{id}': '/swaps/{id}':
get: get:
operationId: GetSwapsSwap operationId: GetSwapsSwap
summary: Retrieve a Swap summary: Get a Swap
description: Retrieves a Swap. description: Retrieves a Swap.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -16255,7 +16256,7 @@ paths:
'/tax-rates/{id}/product-types/batch': '/tax-rates/{id}/product-types/batch':
post: post:
operationId: PostTaxRatesTaxRateProductTypes operationId: PostTaxRatesTaxRateProductTypes
summary: Add Tax Rate to Product Types summary: Add to Product Types
description: Associates a Tax Rate with a list of Product Types description: Associates a Tax Rate with a list of Product Types
parameters: parameters:
- in: path - in: path
@@ -16360,7 +16361,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteTaxRatesTaxRateProductTypes operationId: DeleteTaxRatesTaxRateProductTypes
summary: Remove Tax Rate from Product Types summary: Delete from Product Types
description: Removes a Tax Rate from a list of Product Types description: Removes a Tax Rate from a list of Product Types
parameters: parameters:
- in: path - in: path
@@ -16466,7 +16467,7 @@ paths:
'/tax-rates/{id}/products/batch': '/tax-rates/{id}/products/batch':
post: post:
operationId: PostTaxRatesTaxRateProducts operationId: PostTaxRatesTaxRateProducts
summary: Add Tax Rate to Products summary: Add to Products
description: Associates a Tax Rate with a list of Products description: Associates a Tax Rate with a list of Products
parameters: parameters:
- in: path - in: path
@@ -16569,7 +16570,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteTaxRatesTaxRateProducts operationId: DeleteTaxRatesTaxRateProducts
summary: Removes Tax Rate from Products summary: Delete from Products
description: Removes a Tax Rate from a list of Products description: Removes a Tax Rate from a list of Products
parameters: parameters:
- in: path - in: path
@@ -16675,7 +16676,7 @@ paths:
'/tax-rates/{id}/shipping-options/batch': '/tax-rates/{id}/shipping-options/batch':
post: post:
operationId: PostTaxRatesTaxRateShippingOptions operationId: PostTaxRatesTaxRateShippingOptions
summary: Add Tax Rate to Product Types summary: Add to Shipping Options
description: Associates a Tax Rate with a list of Shipping Options description: Associates a Tax Rate with a list of Shipping Options
parameters: parameters:
- in: path - in: path
@@ -16781,8 +16782,8 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteTaxRatesTaxRateShippingOptions operationId: DeleteTaxRatesTaxRateShippingOptions
summary: Removes a Tax Rate from Product Types summary: Del. for Shipping Options
description: Removes a Tax Rate from a list of Product Types description: Removes a Tax Rate from a list of Shipping Options
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -17223,7 +17224,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetTaxRatesTaxRate operationId: GetTaxRatesTaxRate
summary: Get Tax Rate summary: Get a Tax Rate
description: Retrieves a TaxRate description: Retrieves a TaxRate
parameters: parameters:
- in: path - in: path
@@ -17426,7 +17427,7 @@ paths:
/uploads: /uploads:
post: post:
operationId: PostUploads operationId: PostUploads
summary: Uploads a file summary: Upload a file
description: Uploads a file to the specific fileservice that is installed in Medusa. description: Uploads a file to the specific fileservice that is installed in Medusa.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -17594,7 +17595,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetUsers operationId: GetUsers
summary: Retrieve all users summary: List Users
description: Retrieves all users. description: Retrieves all users.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -17719,7 +17720,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetUsersUser operationId: GetUsersUser
summary: Retrieve a User summary: Get a User
description: Retrieves a User. description: Retrieves a User.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -17876,7 +17877,7 @@ paths:
/users/password-token: /users/password-token:
post: post:
operationId: PostUsersUserPasswordToken operationId: PostUsersUserPasswordToken
summary: Generate a password token for a User. summary: Request Password Reset
description: Generates a password token for a User with a given email. description: Generates a password token for a User with a given email.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -17948,7 +17949,7 @@ paths:
/users/reset-password: /users/reset-password:
post: post:
operationId: PostUsersUserPassword operationId: PostUsersUserPassword
summary: Set the password for a User. summary: Reset Password
description: Sets the password for a User given the correct token. description: Sets the password for a User given the correct token.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -18032,7 +18033,7 @@ paths:
/variants: /variants:
get: get:
operationId: GetVariants operationId: GetVariants
summary: List Product Variants. summary: List Product Variants
description: Retrieves a list of Product Variants description: Retrieves a list of Product Variants
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -23005,7 +23006,7 @@ components:
$ref: '#/components/schemas/address' $ref: '#/components/schemas/address'
shipping_methods: shipping_methods:
description: >- description: >-
The Shipping Methods used to fulfill the addtional items purchased. The Shipping Methods used to fulfill the additional items purchased.
Available if the relation `shipping_methods` is expanded. Available if the relation `shipping_methods` is expanded.
type: array type: array
items: items:
docs/api/admin/components/schemas/swap.yaml
+1 -1
View File
@@ -93,7 +93,7 @@ properties:
$ref: ./address.yaml $ref: ./address.yaml
shipping_methods: shipping_methods:
description: >- description: >-
The Shipping Methods used to fulfill the addtional items purchased. The Shipping Methods used to fulfill the additional items purchased.
Available if the relation `shipping_methods` is expanded. Available if the relation `shipping_methods` is expanded.
type: array type: array
items: items:
docs/api/admin/paths/admin_draft-orders_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostDraftOrdersDraftOrder operationId: PostDraftOrdersDraftOrder
summary: Update a Draft Order" summary: Update a Draft Order
description: Updates a Draft Order. description: Updates a Draft Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/apps.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetApps operationId: GetApps
summary: List applications summary: List Applications
description: Retrieve a list of applications. description: Retrieve a list of applications.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
docs/api/admin/paths/apps_authorizations.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostApps operationId: PostApps
summary: Generates a token for an application. summary: Generate Token for App
description: Generates a token for an application. description: Generates a token for an application.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
docs/api/admin/paths/auth.yaml
+3 -3
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostAuth operationId: PostAuth
summary: Authenticate a User summary: User Login
x-authenticated: false x-authenticated: false
description: Logs a User in and authorizes them to manage Store settings. description: Logs a User in and authorizes them to manage Store settings.
parameters: [] parameters: []
@@ -53,7 +53,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteAuth operationId: DeleteAuth
summary: Delete Session summary: User Logout
x-authenticated: true x-authenticated: true
description: Deletes the current session for the logged in user. description: Deletes the current session for the logged in user.
x-codeSamples: x-codeSamples:
@@ -87,7 +87,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetAuth operationId: GetAuth
summary: Get Session summary: Get Current User
x-authenticated: true x-authenticated: true
description: Gets the currently logged in User. description: Gets the currently logged in User.
x-codeSamples: x-codeSamples:
docs/api/admin/paths/batch-jobs_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetBatchJobsBatchJob operationId: GetBatchJobsBatchJob
summary: Retrieve a Batch Job summary: Get a Batch Job
description: Retrieves a Batch Job. description: Retrieves a Batch Job.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/batch-jobs_{id}_cancel.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostBatchJobsBatchJobCancel operationId: PostBatchJobsBatchJobCancel
summary: Marks a batch job as canceled summary: Cancel a Batch Job
description: Marks a batch job as canceled description: Marks a batch job as canceled
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/batch-jobs_{id}_confirm.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostBatchJobsBatchJobConfirmProcessing operationId: PostBatchJobsBatchJobConfirmProcessing
summary: Confirm a batch job summary: Confirm a Batch Job
description: Confirms that a previously requested batch job should be executed. description: Confirms that a previously requested batch job should be executed.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/collections.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostCollections operationId: PostCollections
summary: Create a Product Collection summary: Create a Collection
description: Creates a Product Collection. description: Creates a Product Collection.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -60,7 +60,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetCollections operationId: GetCollections
summary: List Product Collections summary: List Collections
description: Retrieve a list of Product Collection. description: Retrieve a list of Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/collections_{id}.yaml
+3 -3
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeleteCollectionsCollection operationId: DeleteCollectionsCollection
summary: Delete a Product Collection summary: Delete a Collection
description: Deletes a Product Collection. description: Deletes a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetCollectionsCollection operationId: GetCollectionsCollection
summary: Retrieve a Product Collection summary: Get a Collection
description: Retrieves a Product Collection. description: Retrieves a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -103,7 +103,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostCollectionsCollection operationId: PostCollectionsCollection
summary: Update a Product Collection summary: Update a Collection
description: Updates a Product Collection. description: Updates a Product Collection.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/collections_{id}_products_batch.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostProductsToCollection operationId: PostProductsToCollection
summary: Updates products associated with a Product Collection summary: Update Products
description: Updates products associated with a Product Collection description: Updates products associated with a Product Collection
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -56,7 +56,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteProductsFromCollection operationId: DeleteProductsFromCollection
summary: Removes products associated with a Product Collection summary: Remove Product
description: Removes products associated with a Product Collection description: Removes products associated with a Product Collection
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/customer-groups.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostCustomerGroups operationId: PostCustomerGroups
summary: Create a CustomerGroup summary: Create a Customer Group
description: Creates a CustomerGroup. description: Creates a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: [] parameters: []
@@ -55,7 +55,7 @@ post:
description: Metadata for the customer. description: Metadata for the customer.
get: get:
operationId: GetCustomerGroups operationId: GetCustomerGroups
summary: Retrieve a list of customer groups summary: List Customer Groups
description: Retrieve a list of customer groups. description: Retrieve a list of customer groups.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/customer-groups_{id}.yaml
+3 -3
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeleteCustomerGroupsCustomerGroup operationId: DeleteCustomerGroupsCustomerGroup
summary: Delete a CustomerGroup summary: Delete a Customer Group
description: Deletes a CustomerGroup. description: Deletes a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetCustomerGroupsGroup operationId: GetCustomerGroupsGroup
summary: Retrieve a CustomerGroup summary: Get a Customer Group
description: Retrieves a Customer Group. description: Retrieves a Customer Group.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -113,7 +113,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostCustomerGroupsGroup operationId: PostCustomerGroupsGroup
summary: Update a CustomerGroup summary: Update a Customer Group
description: Update a CustomerGroup. description: Update a CustomerGroup.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostCustomerGroupsGroupCustomersBatch operationId: PostCustomerGroupsGroupCustomersBatch
summary: 'Add a list of customers to a customer group ' summary: Add Customers
description: Adds a list of customers, represented by id's, to a customer group. description: Adds a list of customers, represented by id's, to a customer group.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -66,7 +66,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteCustomerGroupsGroupCustomerBatch operationId: DeleteCustomerGroupsGroupCustomerBatch
summary: 'Remove a list of customers from a customer group ' summary: Remove Customers
description: Removes a list of customers, represented by id's, from a customer group. description: Removes a list of customers, represented by id's, from a customer group.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/customers_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetCustomersCustomer operationId: GetCustomersCustomer
summary: Retrieve a Customer summary: Get a Customer
description: Retrieves a Customer. description: Retrieves a Customer.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/discounts_code_{code}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetDiscountsDiscountCode operationId: GetDiscountsDiscountCode
summary: Retrieve a Discount by code summary: Get Discount by Code
description: Retrieves a Discount by its discount code description: Retrieves a Discount by its discount code
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostDiscountsDiscountConditions operationId: PostDiscountsDiscountConditions
summary: Create a DiscountCondition summary: Create a Condition
description: >- description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`, Creates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
+3 -3
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeleteDiscountsDiscountConditionsCondition operationId: DeleteDiscountsDiscountConditionsCondition
summary: Delete a DiscountCondition summary: Delete a Condition
description: Deletes a DiscountCondition description: Deletes a DiscountCondition
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -79,7 +79,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetDiscountsDiscountConditionsCondition operationId: GetDiscountsDiscountConditionsCondition
summary: Gets a DiscountCondition summary: Get a Condition
description: Gets a DiscountCondition description: Gets a DiscountCondition
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -144,7 +144,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostDiscountsDiscountConditionsCondition operationId: PostDiscountsDiscountConditionsCondition
summary: Update a DiscountCondition summary: Update a Condition
description: >- description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`, Updates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
docs/api/admin/paths/discounts_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetDiscountsDiscount operationId: GetDiscountsDiscount
summary: Retrieve a Discount summary: Get a Discount
description: Retrieves a Discount description: Retrieves a Discount
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
+3 -3
View File
@@ -1,9 +1,9 @@
post: post:
operationId: PostDiscountsDiscountDynamicCodes operationId: PostDiscountsDiscountDynamicCodes
summary: Create a dynamic Discount code summary: Create a Dynamic Code
description: >- description: >-
Creates a unique code that can map to a parent Discount. This is useful if Creates a dynamic unique code that can map to a parent Discount. This is
you want to automatically generate codes with the same behaviour. useful if you want to automatically generate codes with the same behaviour.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeleteDiscountsDiscountDynamicCodesCode operationId: DeleteDiscountsDiscountDynamicCodesCode
summary: Delete a dynamic code summary: Delete a Dynamic Code
description: Deletes a dynamic code from a Discount. description: Deletes a dynamic code from a Discount.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostDiscountsDiscountRegionsRegion operationId: PostDiscountsDiscountRegionsRegion
summary: Adds Region availability summary: Add Region
description: Adds a Region to the list of Regions that a Discount can be used in. description: Adds a Region to the list of Regions that a Discount can be used in.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -54,7 +54,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteDiscountsDiscountRegionsRegion operationId: DeleteDiscountsDiscountRegionsRegion
summary: Remove Region availability summary: Remove Region
x-authenticated: true x-authenticated: true
description: Removes a Region from the list of Regions that a Discount can be used in. description: Removes a Region from the list of Regions that a Discount can be used in.
parameters: parameters:
docs/api/admin/paths/draft-orders_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetDraftOrdersDraftOrder operationId: GetDraftOrdersDraftOrder
summary: Retrieve a Draft Order summary: Get a Draft Order
description: Retrieves a Draft Order. description: Retrieves a Draft Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/draft-orders_{id}_line-items.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostDraftOrdersDraftOrderLineItems operationId: PostDraftOrdersDraftOrderLineItems
summary: Create a Line Item for Draft Order summary: Create a Line Item
description: Creates a Line Item for the Draft Order description: Creates a Line Item for the Draft Order
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml
+1 -1
View File
@@ -55,7 +55,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostDraftOrdersDraftOrderLineItemsItem operationId: PostDraftOrdersDraftOrderLineItemsItem
summary: Update a Line Item for a Draft Order summary: Update a Line Item
description: Updates a Line Item for a Draft Order description: Updates a Line Item for a Draft Order
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/draft-orders_{id}_pay.yaml
+1 -1
View File
@@ -1,5 +1,5 @@
post: post:
summary: Registers a payment for a Draft Order summary: Registers a Payment
operationId: PostDraftOrdersDraftOrderRegisterPayment operationId: PostDraftOrdersDraftOrderRegisterPayment
description: Registers a payment for a Draft Order. description: Registers a payment for a Draft Order.
x-authenticated: true x-authenticated: true
docs/api/admin/paths/gift-cards_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetGiftCardsGiftCard operationId: GetGiftCardsGiftCard
summary: Retrieve a Gift Card summary: Get a Gift Card
description: Retrieves a Gift Card. description: Retrieves a Gift Card.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/invites.yaml
+1 -1
View File
@@ -53,7 +53,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetInvites operationId: GetInvites
summary: Lists all Invites summary: Lists Invites
description: Lists all Invites description: Lists all Invites
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
docs/api/admin/paths/notes_{id}.yaml
+3 -3
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeleteNotesNote operationId: DeleteNotesNote
summary: Deletes a Note summary: Delete a Note
description: Deletes a Note. description: Deletes a Note.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetNotesNote operationId: GetNotesNote
summary: Get Note summary: Get a Note
description: Retrieves a single note using its id description: Retrieves a single note using its id
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -103,7 +103,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostNotesNote operationId: PostNotesNote
summary: Updates a Note summary: Update a Note
x-authenticated: true x-authenticated: true
description: Updates a Note associated with some resource description: Updates a Note associated with some resource
parameters: parameters:
docs/api/admin/paths/orders_{id}.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetOrdersOrder operationId: GetOrdersOrder
summary: Retrieve an Order summary: Get an Order
description: Retrieves an Order description: Retrieves an Order
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -47,7 +47,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostOrdersOrder operationId: PostOrdersOrder
summary: Update an order summary: Update an Order
description: Updates and order description: Updates and order
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/orders_{id}_archive.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostOrdersOrderArchive operationId: PostOrdersOrderArchive
summary: Archive order summary: Archive Order
description: Archives the order with the given id. description: Archives the order with the given id.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/orders_{id}_capture.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostOrdersOrderCapture operationId: PostOrdersOrderCapture
summary: Capture an Order summary: Capture Order's Payment
description: Captures all the Payments associated with an Order. description: Captures all the Payments associated with an Order.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostOrdersClaimCancel operationId: PostOrdersClaimCancel
summary: Cancels a Claim summary: Cancel a Claim
description: Cancels a Claim description: Cancels a Claim
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostOrdersOrderClaimsClaimFulfillments operationId: PostOrdersOrderClaimsClaimFulfillments
summary: Create a Claim Fulfillment summary: Create Claim Fulfillment
description: Creates a Fulfillment for a Claim. description: Creates a Fulfillment for a Claim.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
post: post:
operationId: PostOrdersClaimFulfillmentsCancel operationId: PostOrdersClaimFulfillmentsCancel
summary: Cancels a fulfilmment related to a Claim summary: Cancel Claim Fulfillment
description: Registers a Fulfillment as canceled. description: Registers a claim's fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostOrdersOrderFulfillmentsCancel operationId: PostOrdersOrderFulfillmentsCancel
summary: Cancels a fulfilmment summary: Cancels a Fulfilmment
description: Registers a Fulfillment as canceled. description: Registers a Fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostOrdersOrderSwapsSwapFulfillments operationId: PostOrdersOrderSwapsSwapFulfillments
summary: Create a Swap Fulfillment summary: Create Swap Fulfillment
description: Creates a Fulfillment for a Swap. description: Creates a Fulfillment for a Swap.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
post: post:
operationId: PostOrdersSwapFulfillmentsCancel operationId: PostOrdersSwapFulfillmentsCancel
summary: Cancels a fulfilmment related to a Swap summary: Cancel Swap's Fulfilmment
description: Registers a Fulfillment as canceled. description: Registers a Swap's Fulfillment as canceled.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostOrdersOrderSwapsSwapProcessPayment operationId: PostOrdersOrderSwapsSwapProcessPayment
summary: Process a Swap difference summary: Process Swap Payment
description: >- description: >-
When there are differences between the returned and shipped Products in a When there are differences between the returned and shipped Products in a
Swap, the difference must be processed. Either a Refund will be issued or a Swap, the difference must be processed. Either a Refund will be issued or a
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
+1 -1
View File
@@ -33,7 +33,7 @@ post:
type: string type: string
no_notification: no_notification:
description: >- description: >-
If set to true no notification will be send related to this If set to true no notification will be sent related to this
Claim. Claim.
type: boolean type: boolean
x-codeSamples: x-codeSamples:
docs/api/admin/paths/price-lists.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostPriceListsPriceList operationId: PostPriceListsPriceList
summary: Creates a Price List summary: Create a Price List
description: Creates a Price List description: Creates a Price List
x-authenticated: true x-authenticated: true
requestBody: requestBody:
docs/api/admin/paths/price-lists_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetPriceListsPriceList operationId: GetPriceListsPriceList
summary: Retrieve a Price List summary: Get a Price List
description: Retrieves a Price List. description: Retrieves a Price List.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/price-lists_{id}_prices_batch.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostPriceListsPriceListPricesBatch operationId: PostPriceListsPriceListPricesBatch
summary: Batch update prices for a Price List summary: Update Prices
description: Batch update prices for a Price List description: Batch update prices for a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -93,7 +93,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeletePriceListsPriceListPricesBatch operationId: DeletePriceListsPriceListPricesBatch
summary: Batch delete prices that belong to a Price List summary: Delete Prices
description: Batch delete prices that belong to a Price List description: Batch delete prices that belong to a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/price-lists_{id}_products.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetPriceListsPriceListProducts operationId: GetPriceListsPriceListProducts
summary: List Product in a Price List summary: List Products
description: Retrieves a list of Product that are part of a Price List description: Retrieves a list of Product that are part of a Price List
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeletePriceListsPriceListProductsProductPrices operationId: DeletePriceListsPriceListProductsProductPrices
summary: Delete all the prices related to a specific product in a price list summary: Delete Product's Prices
description: Delete all the prices related to a specific product in a price list description: Delete all the prices related to a specific product in a price list
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeletePriceListsPriceListVariantsVariantPrices operationId: DeletePriceListsPriceListVariantsVariantPrices
summary: Delete all the prices related to a specific variant in a price list summary: Delete Variant's Prices
description: Delete all the prices related to a specific variant in a price list description: Delete all the prices related to a specific variant in a price list
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/products.yaml
+2 -2
View File
@@ -215,7 +215,7 @@ post:
index in the Product's `options` field. index in the Product's `options` field.
type: string type: string
weight: weight:
description: The wieght of the Product. description: The weight of the Product.
type: number type: number
length: length:
description: The length of the Product. description: The length of the Product.
@@ -278,7 +278,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetProducts operationId: GetProducts
summary: List Product summary: List Products
description: Retrieves a list of Product description: Retrieves a list of Product
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/products_tag-usage.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetProductsTagUsage operationId: GetProductsTagUsage
summary: List Product Tags Usage Number summary: List Tags Usage Number
description: Retrieves a list of Product Tags with how many times each is used. description: Retrieves a list of Product Tags with how many times each is used.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
docs/api/admin/paths/products_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetProductsProduct operationId: GetProductsProduct
summary: Retrieve a Product summary: Get a Product
description: Retrieves a Product. description: Retrieves a Product.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/products_{id}_metadata.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostProductsProductMetadata operationId: PostProductsProductMetadata
summary: Set Product metadata summary: Set Product Metadata
description: Set metadata key/value pair for Product description: Set metadata key/value pair for Product
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/products_{id}_options_{option_id}.yaml
+1 -1
View File
@@ -69,7 +69,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostProductsProductOptionsOption operationId: PostProductsProductOptionsOption
summary: Update a Product Option. summary: Update a Product Option
description: Updates a Product Option description: Updates a Product Option
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/products_{id}_variants.yaml
+1 -1
View File
@@ -156,7 +156,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetProductsProductVariants operationId: GetProductsProductVariants
summary: List a Product's Product Variants summary: List a Product's Variants
description: Retrieves a list of the Product Variants associated with a Product. description: Retrieves a list of the Product Variants associated with a Product.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml
+1 -1
View File
@@ -119,7 +119,7 @@ post:
Product Variant. Product Variant.
type: boolean type: boolean
weight: weight:
description: The wieght of the Product Variant. description: The weight of the Product Variant.
type: number type: number
length: length:
description: The length of the Product Variant. description: The length of the Product Variant.
docs/api/admin/paths/regions_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetRegionsRegion operationId: GetRegionsRegion
summary: Retrieve a Region summary: Get a Region
description: Retrieves a Region. description: Retrieves a Region.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: PostRegionsRegionCountriesCountry operationId: PostRegionsRegionCountriesCountry
summary: Remove Country summary: Delete Country
x-authenticated: true x-authenticated: true
description: Removes a Country from the list of Countries in a Region description: Removes a Country from the list of Countries in a Region
parameters: parameters:
docs/api/admin/paths/regions_{id}_fulfillment-options.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetRegionsRegionFulfillmentOptions operationId: GetRegionsRegionFulfillmentOptions
summary: List Fulfillment Options available in the Region summary: List Fulfillment Options
description: Gathers all the fulfillment options available to in the Region. description: Gathers all the fulfillment options available to in the Region.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: PostRegionsRegionFulfillmentProvidersProvider operationId: PostRegionsRegionFulfillmentProvidersProvider
summary: Remove Fulfillment Provider summary: Del. Fulfillment Provider
description: Removes a Fulfillment Provider. description: Removes a Fulfillment Provider.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: PostRegionsRegionPaymentProvidersProvider operationId: PostRegionsRegionPaymentProvidersProvider
summary: Remove Payment Provider summary: Delete Payment Provider
description: Removes a Payment Provider. description: Removes a Payment Provider.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/return-reasons_{id}.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeleteReturnReason operationId: DeleteReturnReason
summary: Delete a return reason summary: Delete a Return Reason
description: Deletes a return reason. description: Deletes a return reason.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetReturnReasonsReason operationId: GetReturnReasonsReason
summary: Retrieve a Return Reason summary: Get a Return Reason
description: Retrieves a Return Reason. description: Retrieves a Return Reason.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/sales-channels.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetSalesChannels operationId: GetSalesChannels
summary: List sales channels summary: List Sales Channels
description: Retrieves a list of sales channels description: Retrieves a list of sales channels
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/sales-channels_{id}.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
delete: delete:
operationId: DeleteSalesChannelsSalesChannel operationId: DeleteSalesChannelsSalesChannel
summary: Delete a sales channel summary: Delete a Sales Channel
description: Deletes the sales channel. description: Deletes the sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetSalesChannelsSalesChannel operationId: GetSalesChannelsSalesChannel
summary: Retrieve a sales channel summary: Get a Sales Channel
description: Retrieves the sales channel. description: Retrieves the sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/sales-channels_{id}_products_batch.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostSalesChannelsChannelProductsBatch operationId: PostSalesChannelsChannelProductsBatch
summary: Assign a batch of product to a sales channel summary: Add Products
description: Assign a batch of product to a sales channel. description: Assign a batch of product to a sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -66,7 +66,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteSalesChannelsChannelProductsBatch operationId: DeleteSalesChannelsChannelProductsBatch
summary: Remove a list of products from a sales channel summary: Delete Products
description: Remove a list of products from a sales channel. description: Remove a list of products from a sales channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/shipping-options_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetShippingOptionsOption operationId: GetShippingOptionsOption
summary: Retrieve a Shipping Option summary: Get a Shipping Option
description: Retrieves a Shipping Option. description: Retrieves a Shipping Option.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/shipping-profiles_{id}.yaml
+2 -2
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetShippingProfilesProfile operationId: GetShippingProfilesProfile
summary: Retrieve a Shipping Profile summary: Get a Shipping Profile
description: Retrieves a Shipping Profile. description: Retrieves a Shipping Profile.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -103,7 +103,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostShippingProfilesProfile operationId: PostShippingProfilesProfile
summary: Update a Shipping Profiles summary: Update a Shipping Profile
description: Updates a Shipping Profile description: Updates a Shipping Profile
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/store.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetStore operationId: GetStore
summary: Retrieve Store details. summary: Get Store details
description: Retrieves the Store details description: Retrieves the Store details
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -40,7 +40,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostStore operationId: PostStore
summary: Update Store details. summary: Update Store Details
description: Updates the Store details description: Updates the Store details
x-authenticated: true x-authenticated: true
requestBody: requestBody:
docs/api/admin/paths/store_currencies_{code}.yaml
+1 -1
View File
@@ -50,7 +50,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteStoreCurrenciesCode operationId: DeleteStoreCurrenciesCode
summary: Remove a Currency Code summary: Delete a Currency Code
description: Removes a Currency Code from the available currencies. description: Removes a Currency Code from the available currencies.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/store_payment-providers.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetStorePaymentProviders operationId: GetStorePaymentProviders
summary: Retrieve configured Payment Providers summary: List Payment Providers
description: Retrieves the configured Payment Providers description: Retrieves the configured Payment Providers
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
docs/api/admin/paths/store_tax-providers.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetStoreTaxProviders operationId: GetStoreTaxProviders
summary: Retrieve configured Tax Providers summary: List Tax Providers
description: Retrieves the configured Tax Providers description: Retrieves the configured Tax Providers
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
docs/api/admin/paths/swaps_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetSwapsSwap operationId: GetSwapsSwap
summary: Retrieve a Swap summary: Get a Swap
description: Retrieves a Swap. description: Retrieves a Swap.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/tax-rates_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetTaxRatesTaxRate operationId: GetTaxRatesTaxRate
summary: Get Tax Rate summary: Get a Tax Rate
description: Retrieves a TaxRate description: Retrieves a TaxRate
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostTaxRatesTaxRateProductTypes operationId: PostTaxRatesTaxRateProductTypes
summary: Add Tax Rate to Product Types summary: Add to Product Types
description: Associates a Tax Rate with a list of Product Types description: Associates a Tax Rate with a list of Product Types
parameters: parameters:
- in: path - in: path
@@ -78,7 +78,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteTaxRatesTaxRateProductTypes operationId: DeleteTaxRatesTaxRateProductTypes
summary: Remove Tax Rate from Product Types summary: Delete from Product Types
description: Removes a Tax Rate from a list of Product Types description: Removes a Tax Rate from a list of Product Types
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/tax-rates_{id}_products_batch.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostTaxRatesTaxRateProducts operationId: PostTaxRatesTaxRateProducts
summary: Add Tax Rate to Products summary: Add to Products
description: Associates a Tax Rate with a list of Products description: Associates a Tax Rate with a list of Products
parameters: parameters:
- in: path - in: path
@@ -77,7 +77,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteTaxRatesTaxRateProducts operationId: DeleteTaxRatesTaxRateProducts
summary: Removes Tax Rate from Products summary: Delete from Products
description: Removes a Tax Rate from a list of Products description: Removes a Tax Rate from a list of Products
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml
+3 -3
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostTaxRatesTaxRateShippingOptions operationId: PostTaxRatesTaxRateShippingOptions
summary: Add Tax Rate to Product Types summary: Add to Shipping Options
description: Associates a Tax Rate with a list of Shipping Options description: Associates a Tax Rate with a list of Shipping Options
parameters: parameters:
- in: path - in: path
@@ -79,8 +79,8 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteTaxRatesTaxRateShippingOptions operationId: DeleteTaxRatesTaxRateShippingOptions
summary: Removes a Tax Rate from Product Types summary: Del. for Shipping Options
description: Removes a Tax Rate from a list of Product Types description: Removes a Tax Rate from a list of Shipping Options
parameters: parameters:
- in: path - in: path
name: id name: id
docs/api/admin/paths/uploads.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostUploads operationId: PostUploads
summary: Uploads a file summary: Upload a file
description: Uploads a file to the specific fileservice that is installed in Medusa. description: Uploads a file to the specific fileservice that is installed in Medusa.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
docs/api/admin/paths/users.yaml
+1 -1
View File
@@ -69,7 +69,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetUsers operationId: GetUsers
summary: Retrieve all users summary: List Users
description: Retrieves all users. description: Retrieves all users.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
docs/api/admin/paths/users_password-token.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostUsersUserPasswordToken operationId: PostUsersUserPasswordToken
summary: Generate a password token for a User. summary: Request Password Reset
description: Generates a password token for a User with a given email. description: Generates a password token for a User with a given email.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
docs/api/admin/paths/users_reset-password.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostUsersUserPassword operationId: PostUsersUserPassword
summary: Set the password for a User. summary: Reset Password
description: Sets the password for a User given the correct token. description: Sets the password for a User given the correct token.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
docs/api/admin/paths/users_{id}.yaml
+1 -1
View File
@@ -56,7 +56,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetUsersUser operationId: GetUsersUser
summary: Retrieve a User summary: Get a User
description: Retrieves a User. description: Retrieves a User.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/variants.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetVariants operationId: GetVariants
summary: List Product Variants. summary: List Product Variants
description: Retrieves a list of Product Variants description: Retrieves a list of Product Variants
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/store-spec3.json
+27 -27
View File
@@ -65,7 +65,7 @@ paths:
/auth: /auth:
post: post:
operationId: PostAuth operationId: PostAuth
summary: Authenticate Customer summary: Customer Login
description: >- description: >-
Logs a Customer in and authorizes them to view their details. Successful Logs a Customer in and authorizes them to view their details. Successful
authentication will set a session cookie in the Customer's browser. authentication will set a session cookie in the Customer's browser.
@@ -136,7 +136,7 @@ paths:
description: The Customer's password. description: The Customer's password.
delete: delete:
operationId: DeleteAuth operationId: DeleteAuth
summary: Log out summary: Customer Log out
description: Destroys a Customer's authenticated session. description: Destroys a Customer's authenticated session.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -168,7 +168,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetAuth operationId: GetAuth
summary: Get Session summary: Get Current Customer
description: Gets the currently logged in Customer. description: Gets the currently logged in Customer.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -220,7 +220,7 @@ paths:
'/auth/{email}': '/auth/{email}':
get: get:
operationId: GetAuthEmail operationId: GetAuthEmail
summary: Check if email has account summary: Check if email exists
description: Checks if a Customer with the given email has signed up. description: Checks if a Customer with the given email has signed up.
parameters: parameters:
- in: path - in: path
@@ -667,7 +667,7 @@ paths:
'/carts/{id}/payment-sessions': '/carts/{id}/payment-sessions':
post: post:
operationId: PostCartsCartPaymentSessions operationId: PostCartsCartPaymentSessions
summary: Initialize Payment Sessions summary: Create Payment Sessions
description: >- description: >-
Creates Payment Sessions for each of the available Payment Providers in Creates Payment Sessions for each of the available Payment Providers in
the Cart's Region. the Cart's Region.
@@ -722,7 +722,7 @@ paths:
delete: delete:
operationId: DeleteCartsCartDiscountsDiscount operationId: DeleteCartsCartDiscountsDiscount
description: Removes a Discount from a Cart. description: Removes a Discount from a Cart.
summary: Remove Discount from Cart summary: Remove Discount
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -1052,7 +1052,7 @@ paths:
'/carts/{id}': '/carts/{id}':
get: get:
operationId: GetCartsCart operationId: GetCartsCart
summary: Retrieve a Cart summary: Get a Cart
description: Retrieves a Cart. description: Retrieves a Cart.
parameters: parameters:
- in: path - in: path
@@ -1363,7 +1363,7 @@ paths:
'/collections/{id}': '/collections/{id}':
get: get:
operationId: GetCollectionsCollection operationId: GetCollectionsCollection
summary: Retrieve a Product Collection summary: Get a Collection
description: Retrieves a Product Collection. description: Retrieves a Product Collection.
parameters: parameters:
- in: path - in: path
@@ -1415,7 +1415,7 @@ paths:
/collections: /collections:
get: get:
operationId: GetCollections operationId: GetCollections
summary: List Product Collections summary: List Collections
description: Retrieve a list of Product Collection. description: Retrieve a list of Product Collection.
parameters: parameters:
- in: query - in: query
@@ -1862,7 +1862,7 @@ paths:
/customers/me: /customers/me:
get: get:
operationId: GetCustomersCustomer operationId: GetCustomersCustomer
summary: Retrieves a Customer summary: Get a Customer
description: >- description: >-
Retrieves a Customer - the Customer must be logged in to retrieve their Retrieves a Customer - the Customer must be logged in to retrieve their
details. details.
@@ -1917,7 +1917,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostCustomersCustomer operationId: PostCustomersCustomer
summary: Update Customer details summary: Update Customer
description: Updates a Customer's saved details. description: Updates a Customer's saved details.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -2009,7 +2009,7 @@ paths:
/customers/me/payment-methods: /customers/me/payment-methods:
get: get:
operationId: GetCustomersCustomerPaymentMethods operationId: GetCustomersCustomerPaymentMethods
summary: Retrieve saved payment methods summary: Get Payment Methods
description: >- description: >-
Retrieves a list of a Customer's saved payment methods. Payment methods Retrieves a list of a Customer's saved payment methods. Payment methods
are saved with Payment Providers and it is their responsibility to fetch are saved with Payment Providers and it is their responsibility to fetch
@@ -2078,7 +2078,7 @@ paths:
/customers/me/orders: /customers/me/orders:
get: get:
operationId: GetCustomersCustomerOrders operationId: GetCustomersCustomerOrders
summary: Retrieve Customer Orders summary: List Orders
description: Retrieves a list of a Customer's Orders. description: Retrieves a list of a Customer's Orders.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2303,7 +2303,7 @@ paths:
/customers/password-token: /customers/password-token:
post: post:
operationId: PostCustomersCustomerPasswordToken operationId: PostCustomersCustomerPasswordToken
summary: Creates a reset password token summary: Request Password Reset
description: >- description: >-
Creates a reset password token to be used in a subsequent Creates a reset password token to be used in a subsequent
/reset-password request. The password token should be sent out of band /reset-password request. The password token should be sent out of band
@@ -2370,7 +2370,7 @@ paths:
/customers/password-reset: /customers/password-reset:
post: post:
operationId: PostCustomersResetPassword operationId: PostCustomersResetPassword
summary: Resets Customer password summary: Reset Password
description: >- description: >-
Resets a Customer's password using a password token created by a Resets a Customer's password using a password token created by a
previous /password-token request. previous /password-token request.
@@ -2451,7 +2451,7 @@ paths:
'/gift-cards/{code}': '/gift-cards/{code}':
get: get:
operationId: GetGiftCardsCode operationId: GetGiftCardsCode
summary: Retrieve Gift Card by Code summary: Get Gift Card by Code
description: Retrieves a Gift Card by its associated unqiue code. description: Retrieves a Gift Card by its associated unqiue code.
parameters: parameters:
- in: path - in: path
@@ -2503,7 +2503,7 @@ paths:
'/orders/cart/{cart_id}': '/orders/cart/{cart_id}':
get: get:
operationId: GetOrdersOrderCartId operationId: GetOrdersOrderCartId
summary: Retrieves Order by Cart id summary: Get by Cart ID
description: >- description: >-
Retrieves an Order by the id of the Cart that was used to create the Retrieves an Order by the id of the Cart that was used to create the
Order. Order.
@@ -2557,7 +2557,7 @@ paths:
'/orders/{id}': '/orders/{id}':
get: get:
operationId: GetOrdersOrder operationId: GetOrdersOrder
summary: Retrieves an Order summary: Get an Order
description: Retrieves an Order description: Retrieves an Order
parameters: parameters:
- in: path - in: path
@@ -2684,7 +2684,7 @@ paths:
'/products/{id}': '/products/{id}':
get: get:
operationId: GetProductsProduct operationId: GetProductsProduct
summary: Retrieves a Product summary: Get a Product
description: Retrieves a Product. description: Retrieves a Product.
parameters: parameters:
- in: path - in: path
@@ -2993,7 +2993,7 @@ paths:
'/regions/{id}': '/regions/{id}':
get: get:
operationId: GetRegionsRegion operationId: GetRegionsRegion
summary: Retrieves a Region summary: Get a Region
description: Retrieves a Region. description: Retrieves a Region.
parameters: parameters:
- in: path - in: path
@@ -3148,7 +3148,7 @@ paths:
'/return-reasons/{id}': '/return-reasons/{id}':
get: get:
operationId: GetReturnReasonsReason operationId: GetReturnReasonsReason
summary: Retrieve a Return Reason summary: Get a Return Reason
description: Retrieves a Return Reason. description: Retrieves a Return Reason.
parameters: parameters:
- in: path - in: path
@@ -3357,7 +3357,7 @@ paths:
/shipping-options: /shipping-options:
get: get:
operationId: GetShippingOptions operationId: GetShippingOptions
summary: Retrieve Shipping Options summary: Get Shipping Options
description: Retrieves a list of Shipping Options. description: Retrieves a list of Shipping Options.
parameters: parameters:
- in: query - in: query
@@ -3422,7 +3422,7 @@ paths:
'/shipping-options/{cart_id}': '/shipping-options/{cart_id}':
get: get:
operationId: GetShippingOptionsCartId operationId: GetShippingOptionsCartId
summary: Retrieve Shipping Options for Cart summary: List for Cart
description: Retrieves a list of Shipping Options available to a cart. description: Retrieves a list of Shipping Options available to a cart.
parameters: parameters:
- in: path - in: path
@@ -3606,7 +3606,7 @@ paths:
'/swaps/{cart_id}': '/swaps/{cart_id}':
get: get:
operationId: GetSwapsSwapCartId operationId: GetSwapsSwapCartId
summary: Retrieve Swap by Cart id summary: Get by Cart ID
description: Retrieves a Swap by the id of the Cart used to confirm the Swap. description: Retrieves a Swap by the id of the Cart used to confirm the Swap.
parameters: parameters:
- in: path - in: path
@@ -3658,7 +3658,7 @@ paths:
'/variants/{variant_id}': '/variants/{variant_id}':
get: get:
operationId: GetVariantsVariant operationId: GetVariantsVariant
summary: Retrieve a Product Variant summary: Get a Product Variant
description: Retrieves a Product Variant by id description: Retrieves a Product Variant by id
parameters: parameters:
- in: path - in: path
@@ -3717,7 +3717,7 @@ paths:
/variants: /variants:
get: get:
operationId: GetVariants operationId: GetVariants
summary: Retrieve Product Variants summary: Get Product Variants
description: Retrieves a list of Product Variants description: Retrieves a list of Product Variants
parameters: parameters:
- in: query - in: query
@@ -8629,7 +8629,7 @@ components:
$ref: '#/components/schemas/address' $ref: '#/components/schemas/address'
shipping_methods: shipping_methods:
description: >- description: >-
The Shipping Methods used to fulfill the addtional items purchased. The Shipping Methods used to fulfill the additional items purchased.
Available if the relation `shipping_methods` is expanded. Available if the relation `shipping_methods` is expanded.
type: array type: array
items: items:
docs/api/store-spec3.yaml
+27 -27
View File
@@ -65,7 +65,7 @@ paths:
/auth: /auth:
post: post:
operationId: PostAuth operationId: PostAuth
summary: Authenticate Customer summary: Customer Login
description: >- description: >-
Logs a Customer in and authorizes them to view their details. Successful Logs a Customer in and authorizes them to view their details. Successful
authentication will set a session cookie in the Customer's browser. authentication will set a session cookie in the Customer's browser.
@@ -136,7 +136,7 @@ paths:
description: The Customer's password. description: The Customer's password.
delete: delete:
operationId: DeleteAuth operationId: DeleteAuth
summary: Log out summary: Customer Log out
description: Destroys a Customer's authenticated session. description: Destroys a Customer's authenticated session.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -168,7 +168,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
get: get:
operationId: GetAuth operationId: GetAuth
summary: Get Session summary: Get Current Customer
description: Gets the currently logged in Customer. description: Gets the currently logged in Customer.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -220,7 +220,7 @@ paths:
'/auth/{email}': '/auth/{email}':
get: get:
operationId: GetAuthEmail operationId: GetAuthEmail
summary: Check if email has account summary: Check if email exists
description: Checks if a Customer with the given email has signed up. description: Checks if a Customer with the given email has signed up.
parameters: parameters:
- in: path - in: path
@@ -667,7 +667,7 @@ paths:
'/carts/{id}/payment-sessions': '/carts/{id}/payment-sessions':
post: post:
operationId: PostCartsCartPaymentSessions operationId: PostCartsCartPaymentSessions
summary: Initialize Payment Sessions summary: Create Payment Sessions
description: >- description: >-
Creates Payment Sessions for each of the available Payment Providers in Creates Payment Sessions for each of the available Payment Providers in
the Cart's Region. the Cart's Region.
@@ -722,7 +722,7 @@ paths:
delete: delete:
operationId: DeleteCartsCartDiscountsDiscount operationId: DeleteCartsCartDiscountsDiscount
description: Removes a Discount from a Cart. description: Removes a Discount from a Cart.
summary: Remove Discount from Cart summary: Remove Discount
parameters: parameters:
- in: path - in: path
name: id name: id
@@ -1052,7 +1052,7 @@ paths:
'/carts/{id}': '/carts/{id}':
get: get:
operationId: GetCartsCart operationId: GetCartsCart
summary: Retrieve a Cart summary: Get a Cart
description: Retrieves a Cart. description: Retrieves a Cart.
parameters: parameters:
- in: path - in: path
@@ -1363,7 +1363,7 @@ paths:
'/collections/{id}': '/collections/{id}':
get: get:
operationId: GetCollectionsCollection operationId: GetCollectionsCollection
summary: Retrieve a Product Collection summary: Get a Collection
description: Retrieves a Product Collection. description: Retrieves a Product Collection.
parameters: parameters:
- in: path - in: path
@@ -1415,7 +1415,7 @@ paths:
/collections: /collections:
get: get:
operationId: GetCollections operationId: GetCollections
summary: List Product Collections summary: List Collections
description: Retrieve a list of Product Collection. description: Retrieve a list of Product Collection.
parameters: parameters:
- in: query - in: query
@@ -1862,7 +1862,7 @@ paths:
/customers/me: /customers/me:
get: get:
operationId: GetCustomersCustomer operationId: GetCustomersCustomer
summary: Retrieves a Customer summary: Get a Customer
description: >- description: >-
Retrieves a Customer - the Customer must be logged in to retrieve their Retrieves a Customer - the Customer must be logged in to retrieve their
details. details.
@@ -1917,7 +1917,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostCustomersCustomer operationId: PostCustomersCustomer
summary: Update Customer details summary: Update Customer
description: Updates a Customer's saved details. description: Updates a Customer's saved details.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
@@ -2009,7 +2009,7 @@ paths:
/customers/me/payment-methods: /customers/me/payment-methods:
get: get:
operationId: GetCustomersCustomerPaymentMethods operationId: GetCustomersCustomerPaymentMethods
summary: Retrieve saved payment methods summary: Get Payment Methods
description: >- description: >-
Retrieves a list of a Customer's saved payment methods. Payment methods Retrieves a list of a Customer's saved payment methods. Payment methods
are saved with Payment Providers and it is their responsibility to fetch are saved with Payment Providers and it is their responsibility to fetch
@@ -2078,7 +2078,7 @@ paths:
/customers/me/orders: /customers/me/orders:
get: get:
operationId: GetCustomersCustomerOrders operationId: GetCustomersCustomerOrders
summary: Retrieve Customer Orders summary: List Orders
description: Retrieves a list of a Customer's Orders. description: Retrieves a list of a Customer's Orders.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -2303,7 +2303,7 @@ paths:
/customers/password-token: /customers/password-token:
post: post:
operationId: PostCustomersCustomerPasswordToken operationId: PostCustomersCustomerPasswordToken
summary: Creates a reset password token summary: Request Password Reset
description: >- description: >-
Creates a reset password token to be used in a subsequent Creates a reset password token to be used in a subsequent
/reset-password request. The password token should be sent out of band /reset-password request. The password token should be sent out of band
@@ -2370,7 +2370,7 @@ paths:
/customers/password-reset: /customers/password-reset:
post: post:
operationId: PostCustomersResetPassword operationId: PostCustomersResetPassword
summary: Resets Customer password summary: Reset Password
description: >- description: >-
Resets a Customer's password using a password token created by a Resets a Customer's password using a password token created by a
previous /password-token request. previous /password-token request.
@@ -2451,7 +2451,7 @@ paths:
'/gift-cards/{code}': '/gift-cards/{code}':
get: get:
operationId: GetGiftCardsCode operationId: GetGiftCardsCode
summary: Retrieve Gift Card by Code summary: Get Gift Card by Code
description: Retrieves a Gift Card by its associated unqiue code. description: Retrieves a Gift Card by its associated unqiue code.
parameters: parameters:
- in: path - in: path
@@ -2503,7 +2503,7 @@ paths:
'/orders/cart/{cart_id}': '/orders/cart/{cart_id}':
get: get:
operationId: GetOrdersOrderCartId operationId: GetOrdersOrderCartId
summary: Retrieves Order by Cart id summary: Get by Cart ID
description: >- description: >-
Retrieves an Order by the id of the Cart that was used to create the Retrieves an Order by the id of the Cart that was used to create the
Order. Order.
@@ -2557,7 +2557,7 @@ paths:
'/orders/{id}': '/orders/{id}':
get: get:
operationId: GetOrdersOrder operationId: GetOrdersOrder
summary: Retrieves an Order summary: Get an Order
description: Retrieves an Order description: Retrieves an Order
parameters: parameters:
- in: path - in: path
@@ -2684,7 +2684,7 @@ paths:
'/products/{id}': '/products/{id}':
get: get:
operationId: GetProductsProduct operationId: GetProductsProduct
summary: Retrieves a Product summary: Get a Product
description: Retrieves a Product. description: Retrieves a Product.
parameters: parameters:
- in: path - in: path
@@ -2993,7 +2993,7 @@ paths:
'/regions/{id}': '/regions/{id}':
get: get:
operationId: GetRegionsRegion operationId: GetRegionsRegion
summary: Retrieves a Region summary: Get a Region
description: Retrieves a Region. description: Retrieves a Region.
parameters: parameters:
- in: path - in: path
@@ -3148,7 +3148,7 @@ paths:
'/return-reasons/{id}': '/return-reasons/{id}':
get: get:
operationId: GetReturnReasonsReason operationId: GetReturnReasonsReason
summary: Retrieve a Return Reason summary: Get a Return Reason
description: Retrieves a Return Reason. description: Retrieves a Return Reason.
parameters: parameters:
- in: path - in: path
@@ -3357,7 +3357,7 @@ paths:
/shipping-options: /shipping-options:
get: get:
operationId: GetShippingOptions operationId: GetShippingOptions
summary: Retrieve Shipping Options summary: Get Shipping Options
description: Retrieves a list of Shipping Options. description: Retrieves a list of Shipping Options.
parameters: parameters:
- in: query - in: query
@@ -3422,7 +3422,7 @@ paths:
'/shipping-options/{cart_id}': '/shipping-options/{cart_id}':
get: get:
operationId: GetShippingOptionsCartId operationId: GetShippingOptionsCartId
summary: Retrieve Shipping Options for Cart summary: List for Cart
description: Retrieves a list of Shipping Options available to a cart. description: Retrieves a list of Shipping Options available to a cart.
parameters: parameters:
- in: path - in: path
@@ -3606,7 +3606,7 @@ paths:
'/swaps/{cart_id}': '/swaps/{cart_id}':
get: get:
operationId: GetSwapsSwapCartId operationId: GetSwapsSwapCartId
summary: Retrieve Swap by Cart id summary: Get by Cart ID
description: Retrieves a Swap by the id of the Cart used to confirm the Swap. description: Retrieves a Swap by the id of the Cart used to confirm the Swap.
parameters: parameters:
- in: path - in: path
@@ -3658,7 +3658,7 @@ paths:
'/variants/{variant_id}': '/variants/{variant_id}':
get: get:
operationId: GetVariantsVariant operationId: GetVariantsVariant
summary: Retrieve a Product Variant summary: Get a Product Variant
description: Retrieves a Product Variant by id description: Retrieves a Product Variant by id
parameters: parameters:
- in: path - in: path
@@ -3717,7 +3717,7 @@ paths:
/variants: /variants:
get: get:
operationId: GetVariants operationId: GetVariants
summary: Retrieve Product Variants summary: Get Product Variants
description: Retrieves a list of Product Variants description: Retrieves a list of Product Variants
parameters: parameters:
- in: query - in: query
@@ -8629,7 +8629,7 @@ components:
$ref: '#/components/schemas/address' $ref: '#/components/schemas/address'
shipping_methods: shipping_methods:
description: >- description: >-
The Shipping Methods used to fulfill the addtional items purchased. The Shipping Methods used to fulfill the additional items purchased.
Available if the relation `shipping_methods` is expanded. Available if the relation `shipping_methods` is expanded.
type: array type: array
items: items:
docs/api/store/components/schemas/swap.yaml
+1 -1
View File
@@ -93,7 +93,7 @@ properties:
$ref: ./address.yaml $ref: ./address.yaml
shipping_methods: shipping_methods:
description: >- description: >-
The Shipping Methods used to fulfill the addtional items purchased. The Shipping Methods used to fulfill the additional items purchased.
Available if the relation `shipping_methods` is expanded. Available if the relation `shipping_methods` is expanded.
type: array type: array
items: items:
docs/api/store/paths/auth.yaml
+3 -3
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostAuth operationId: PostAuth
summary: Authenticate Customer summary: Customer Login
description: >- description: >-
Logs a Customer in and authorizes them to view their details. Successful Logs a Customer in and authorizes them to view their details. Successful
authentication will set a session cookie in the Customer's browser. authentication will set a session cookie in the Customer's browser.
@@ -54,7 +54,7 @@ post:
description: The Customer's password. description: The Customer's password.
delete: delete:
operationId: DeleteAuth operationId: DeleteAuth
summary: Log out summary: Customer Log out
description: Destroys a Customer's authenticated session. description: Destroys a Customer's authenticated session.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -83,7 +83,7 @@ delete:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
get: get:
operationId: GetAuth operationId: GetAuth
summary: Get Session summary: Get Current Customer
description: Gets the currently logged in Customer. description: Gets the currently logged in Customer.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
docs/api/store/paths/auth_{email}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetAuthEmail operationId: GetAuthEmail
summary: Check if email has account summary: Check if email exists
description: Checks if a Customer with the given email has signed up. description: Checks if a Customer with the given email has signed up.
parameters: parameters:
- in: path - in: path
docs/api/store/paths/carts_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetCartsCart operationId: GetCartsCart
summary: Retrieve a Cart summary: Get a Cart
description: Retrieves a Cart. description: Retrieves a Cart.
parameters: parameters:
- in: path - in: path
docs/api/store/paths/carts_{id}_discounts_{code}.yaml
+1 -1
View File
@@ -1,7 +1,7 @@
delete: delete:
operationId: DeleteCartsCartDiscountsDiscount operationId: DeleteCartsCartDiscountsDiscount
description: Removes a Discount from a Cart. description: Removes a Discount from a Cart.
summary: Remove Discount from Cart summary: Remove Discount
parameters: parameters:
- in: path - in: path
name: id name: id
docs/api/store/paths/carts_{id}_payment-sessions.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostCartsCartPaymentSessions operationId: PostCartsCartPaymentSessions
summary: Initialize Payment Sessions summary: Create Payment Sessions
description: >- description: >-
Creates Payment Sessions for each of the available Payment Providers in the Creates Payment Sessions for each of the available Payment Providers in the
Cart's Region. Cart's Region.
docs/api/store/paths/collections.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetCollections operationId: GetCollections
summary: List Product Collections summary: List Collections
description: Retrieve a list of Product Collection. description: Retrieve a list of Product Collection.
parameters: parameters:
- in: query - in: query
docs/api/store/paths/collections_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetCollectionsCollection operationId: GetCollectionsCollection
summary: Retrieve a Product Collection summary: Get a Collection
description: Retrieves a Product Collection. description: Retrieves a Product Collection.
parameters: parameters:
- in: path - in: path
docs/api/store/paths/customers_me.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetCustomersCustomer operationId: GetCustomersCustomer
summary: Retrieves a Customer summary: Get a Customer
description: >- description: >-
Retrieves a Customer - the Customer must be logged in to retrieve their Retrieves a Customer - the Customer must be logged in to retrieve their
details. details.
@@ -41,7 +41,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostCustomersCustomer operationId: PostCustomersCustomer
summary: Update Customer details summary: Update Customer
description: Updates a Customer's saved details. description: Updates a Customer's saved details.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
docs/api/store/paths/customers_me_orders.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetCustomersCustomerOrders operationId: GetCustomersCustomerOrders
summary: Retrieve Customer Orders summary: List Orders
description: Retrieves a list of a Customer's Orders. description: Retrieves a list of a Customer's Orders.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/store/paths/customers_me_payment-methods.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetCustomersCustomerPaymentMethods operationId: GetCustomersCustomerPaymentMethods
summary: Retrieve saved payment methods summary: Get Payment Methods
description: >- description: >-
Retrieves a list of a Customer's saved payment methods. Payment methods are Retrieves a list of a Customer's saved payment methods. Payment methods are
saved with Payment Providers and it is their responsibility to fetch saved saved with Payment Providers and it is their responsibility to fetch saved
docs/api/store/paths/customers_password-reset.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostCustomersResetPassword operationId: PostCustomersResetPassword
summary: Resets Customer password summary: Reset Password
description: >- description: >-
Resets a Customer's password using a password token created by a previous Resets a Customer's password using a password token created by a previous
/password-token request. /password-token request.
docs/api/store/paths/customers_password-token.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostCustomersCustomerPasswordToken operationId: PostCustomersCustomerPasswordToken
summary: Creates a reset password token summary: Request Password Reset
description: >- description: >-
Creates a reset password token to be used in a subsequent /reset-password Creates a reset password token to be used in a subsequent /reset-password
request. The password token should be sent out of band e.g. via email and request. The password token should be sent out of band e.g. via email and
docs/api/store/paths/gift-cards_{code}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetGiftCardsCode operationId: GetGiftCardsCode
summary: Retrieve Gift Card by Code summary: Get Gift Card by Code
description: Retrieves a Gift Card by its associated unqiue code. description: Retrieves a Gift Card by its associated unqiue code.
parameters: parameters:
- in: path - in: path
docs/api/store/paths/orders_cart_{cart_id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetOrdersOrderCartId operationId: GetOrdersOrderCartId
summary: Retrieves Order by Cart id summary: Get by Cart ID
description: Retrieves an Order by the id of the Cart that was used to create the Order. description: Retrieves an Order by the id of the Cart that was used to create the Order.
parameters: parameters:
- in: path - in: path
docs/api/store/paths/orders_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetOrdersOrder operationId: GetOrdersOrder
summary: Retrieves an Order summary: Get an Order
description: Retrieves an Order description: Retrieves an Order
parameters: parameters:
- in: path - in: path
docs/api/store/paths/products_{id}.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
get: get:
operationId: GetProductsProduct operationId: GetProductsProduct
summary: Retrieves a Product summary: Get a Product
description: Retrieves a Product. description: Retrieves a Product.
parameters: parameters:
- in: path - in: path

Some files were not shown because too many files have changed in this diff Show More