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

chore(docs): Generated API Reference (#3061)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-01-19 10:06:17 +02:00
committed by GitHub
parent 3a0f37ef02
commit 296d6e229f
375 changed files with 8467 additions and 5775 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/api/admin/paths/admin_draft-orders_{id}.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
draft_order:
$ref: ../components/schemas/DraftOrder.yaml
$ref: ../components/schemas/AdminDraftOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

7
docs/api/admin/paths/apps.yaml
View File

@@ -19,12 +19,7 @@ get:
content:
application/json:
schema:
type: object
properties:
apps:
type: array
items:
$ref: ../components/schemas/OAuth.yaml
$ref: ../components/schemas/AdminAppsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/apps_authorizations.yaml
View File

@@ -24,10 +24,7 @@ post:
content:
application/json:
schema:
type: object
properties:
apps:
$ref: ../components/schemas/OAuth.yaml
$ref: ../components/schemas/AdminAppsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/auth.yaml
View File

@@ -36,10 +36,7 @@ post:
content:
application/json:
schema:
type: object
properties:
user:
$ref: ../components/schemas/User.yaml
$ref: ../components/schemas/AdminAuthRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -111,10 +108,7 @@ get:
content:
application/json:
schema:
type: object
properties:
user:
$ref: ../components/schemas/User.yaml
$ref: ../components/schemas/AdminAuthRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/batch-jobs.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
batch_job:
$ref: ../components/schemas/BatchJob.yaml
$ref: ../components/schemas/AdminBatchJobRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -305,21 +302,7 @@ get:
content:
application/json:
schema:
type: object
properties:
batch_jobs:
type: array
items:
$ref: ../components/schemas/BatchJob.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminBatchJobListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/batch-jobs_{id}.yaml
View File

@@ -30,10 +30,7 @@ get:
content:
application/json:
schema:
type: object
properties:
batch_job:
$ref: ../components/schemas/BatchJob.yaml
$ref: ../components/schemas/AdminBatchJobRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/batch-jobs_{id}_cancel.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
batch_job:
$ref: ../components/schemas/BatchJob.yaml
$ref: ../components/schemas/AdminBatchJobRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/batch-jobs_{id}_confirm.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
batch_job:
$ref: ../components/schemas/BatchJob.yaml
$ref: ../components/schemas/AdminBatchJobRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/collections.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
collection:
$ref: ../components/schemas/ProductCollection.yaml
$ref: ../components/schemas/AdminCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -168,21 +165,7 @@ get:
content:
application/json:
schema:
type: object
properties:
collections:
type: array
items:
$ref: ../components/schemas/ProductCollection.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminCollectionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/collections_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Collection
object:
type: string
description: The type of the object that was deleted.
default: product-collection
deleted:
type: boolean
description: Whether the collection was deleted successfully or not.
default: true
$ref: ../components/schemas/AdminCollectionsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
collection:
$ref: ../components/schemas/ProductCollection.yaml
$ref: ../components/schemas/AdminCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
type: object
properties:
collection:
$ref: ../components/schemas/ProductCollection.yaml
$ref: ../components/schemas/AdminCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/collections_{id}_products_batch.yaml
View File

@@ -31,10 +31,7 @@ post:
content:
application/json:
schema:
type: object
properties:
collection:
$ref: ../components/schemas/ProductCollection.yaml
$ref: ../components/schemas/AdminCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -80,21 +77,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the collection
object:
type: string
description: The type of object the removal was executed on
default: product-collection
removed_products:
description: The IDs of the products removed from the collection
type: array
items:
description: The ID of a Product to add to the Product Collection.
type: string
$ref: ../components/schemas/AdminDeleteProductsFromCollectionRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

16
docs/api/admin/paths/currencies.yaml
View File

@@ -48,18 +48,4 @@ get:
content:
application/json:
schema:
type: object
properties:
currencies:
type: array
items:
$ref: ../components/schemas/Currency.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminCurrenciesListRes.yaml

5
docs/api/admin/paths/currencies_{code}.yaml
View File

@@ -32,7 +32,4 @@ post:
content:
application/json:
schema:
type: object
properties:
currency:
$ref: ../components/schemas/Currency.yaml
$ref: ../components/schemas/AdminCurrenciesRes.yaml

21
docs/api/admin/paths/customer-groups.yaml
View File

@@ -24,10 +24,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer_group:
$ref: ../components/schemas/CustomerGroup.yaml
$ref: ../components/schemas/AdminCustomerGroupsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -196,21 +193,7 @@ get:
content:
application/json:
schema:
type: object
properties:
customer_groups:
type: array
items:
$ref: ../components/schemas/CustomerGroup.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminCustomerGroupsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/customer-groups_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted customer group.
object:
type: string
description: The type of the object that was deleted.
default: customer_group
deleted:
type: boolean
description: Whether the customer group was deleted successfully or not.
default: true
$ref: ../components/schemas/AdminCustomerGroupsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -97,10 +85,7 @@ get:
content:
application/json:
schema:
type: object
properties:
customer_group:
$ref: ../components/schemas/CustomerGroup.yaml
$ref: ../components/schemas/AdminCustomerGroupsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -150,10 +135,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer_group:
$ref: ../components/schemas/CustomerGroup.yaml
$ref: ../components/schemas/AdminCustomerGroupsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

16
docs/api/admin/paths/customer-groups_{id}_customers.yaml
View File

@@ -30,21 +30,7 @@ get:
content:
application/json:
schema:
type: object
properties:
customers:
type: array
items:
$ref: ../components/schemas/Customer.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminCustomersListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
View File

@@ -38,10 +38,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer_group:
$ref: ../components/schemas/CustomerGroup.yaml
$ref: ../components/schemas/AdminCustomerGroupsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -94,10 +91,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
customer_group:
$ref: ../components/schemas/CustomerGroup.yaml
$ref: ../components/schemas/AdminCustomerGroupsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/customers.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/Customer.yaml
$ref: ../components/schemas/AdminCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -92,21 +89,7 @@ get:
content:
application/json:
schema:
type: object
properties:
customers:
type: array
items:
$ref: ../components/schemas/Customer.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminCustomersListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/customers_{id}.yaml
View File

@@ -40,10 +40,7 @@ get:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/Customer.yaml
$ref: ../components/schemas/AdminCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -103,10 +100,7 @@ post:
content:
application/json:
schema:
type: object
properties:
customer:
$ref: ../components/schemas/Customer.yaml
$ref: ../components/schemas/AdminCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/discounts.yaml
View File

@@ -41,10 +41,7 @@ post:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -139,21 +136,7 @@ get:
content:
application/json:
schema:
type: object
properties:
discounts:
type: array
items:
$ref: ../components/schemas/Discount.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminDiscountsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/discounts_code_{code}.yaml
View File

@@ -40,10 +40,7 @@ get:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
View File

@@ -53,10 +53,7 @@ post:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

29
docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
View File

@@ -48,24 +48,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted DiscountCondition
object:
type: string
description: The type of the object that was deleted.
default: discount-condition
deleted:
type: boolean
description: >-
Whether the discount condition was deleted successfully or
not.
default: true
discount:
description: The Discount to which the condition used to belong
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountConditionsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -128,10 +111,7 @@ get:
content:
application/json:
schema:
type: object
properties:
discount_condition:
$ref: ../components/schemas/DiscountCondition.yaml
$ref: ../components/schemas/AdminDiscountConditionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -207,10 +187,7 @@ post:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml
View File

@@ -58,10 +58,7 @@ post:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -134,10 +131,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/discounts_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Discount
object:
type: string
description: The type of the object that was deleted.
default: discount
deleted:
type: boolean
description: Whether the discount was deleted successfully or not.
default: true
$ref: ../components/schemas/AdminDiscountsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -97,10 +85,7 @@ get:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -166,10 +151,7 @@ post:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
View File

@@ -32,10 +32,7 @@ post:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml
View File

@@ -38,10 +38,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml
View File

@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -93,10 +90,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
discount:
$ref: ../components/schemas/Discount.yaml
$ref: ../components/schemas/AdminDiscountsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/draft-orders.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
draft_order:
$ref: ../components/schemas/DraftOrder.yaml
$ref: ../components/schemas/AdminDraftOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -89,21 +86,7 @@ get:
content:
application/json:
schema:
type: object
properties:
draft_orders:
type: array
items:
$ref: ../components/schemas/DraftOrder.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminDraftOrdersListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

19
docs/api/admin/paths/draft-orders_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Draft Order.
object:
type: string
description: The type of the object that was deleted.
default: draft-order
deleted:
type: boolean
description: Whether the draft order was deleted successfully or not.
default: true
$ref: ../components/schemas/AdminDraftOrdersDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
draft_order:
$ref: ../components/schemas/DraftOrder.yaml
$ref: ../components/schemas/AdminDraftOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/draft-orders_{id}_line-items.yaml
View File

@@ -36,10 +36,7 @@ post:
content:
application/json:
schema:
type: object
properties:
draft_order:
$ref: ../components/schemas/DraftOrder.yaml
$ref: ../components/schemas/AdminDraftOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml
View File

@@ -38,10 +38,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
draft_order:
$ref: ../components/schemas/DraftOrder.yaml
$ref: ../components/schemas/AdminDraftOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -100,10 +97,7 @@ post:
content:
application/json:
schema:
type: object
properties:
draft_order:
$ref: ../components/schemas/DraftOrder.yaml
$ref: ../components/schemas/AdminDraftOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

6
docs/api/admin/paths/draft-orders_{id}_pay.yaml
View File

@@ -30,10 +30,8 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/DraftOrder.yaml
$ref: >-
../components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/gift-cards.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
gift_card:
$ref: ../components/schemas/GiftCard.yaml
$ref: ../components/schemas/AdminGiftCardsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -89,21 +86,7 @@ get:
content:
application/json:
schema:
type: object
properties:
gift_cards:
type: array
items:
$ref: ../components/schemas/GiftCard.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminGiftCardsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/gift-cards_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Gift Card
object:
type: string
description: The type of the object that was deleted.
default: gift-card
deleted:
type: boolean
description: Whether the gift card was deleted successfully or not.
default: true
$ref: ../components/schemas/AdminGiftCardsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
gift_card:
$ref: ../components/schemas/GiftCard.yaml
$ref: ../components/schemas/AdminGiftCardsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -142,10 +127,7 @@ post:
content:
application/json:
schema:
type: object
properties:
gift_card:
$ref: ../components/schemas/GiftCard.yaml
$ref: ../components/schemas/AdminGiftCardsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

7
docs/api/admin/paths/invites.yaml
View File

@@ -62,12 +62,7 @@ get:
content:
application/json:
schema:
type: object
properties:
invites:
type: array
items:
$ref: ../components/schemas/Invite.yaml
$ref: ../components/schemas/AdminListInvitesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

18
docs/api/admin/paths/invites_{invite_id}.yaml
View File

@@ -1,7 +1,7 @@
delete:
operationId: DeleteInvitesInvite
summary: Create an Invite
description: Creates an Invite and triggers an 'invite' created event
summary: Delete an Invite
description: Deletes an Invite
x-authenticated: true
parameters:
- in: path
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Invite.
object:
type: string
description: The type of the object that was deleted.
format: invite
deleted:
type: boolean
description: Whether or not the Invite was deleted.
default: true
$ref: ../components/schemas/AdminInviteDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/notes.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
note:
$ref: ../components/schemas/Note.yaml
$ref: ../components/schemas/AdminNotesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,21 +84,7 @@ get:
content:
application/json:
schema:
type: object
properties:
notes:
type: array
items:
$ref: ../components/schemas/Note.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminNotesListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/notes_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Note.
object:
type: string
description: The type of the object that was deleted.
default: note
deleted:
type: boolean
description: Whether or not the Note was deleted.
default: true
$ref: ../components/schemas/AdminNotesDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
note:
$ref: ../components/schemas/Note.yaml
$ref: ../components/schemas/AdminNotesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
type: object
properties:
note:
$ref: ../components/schemas/Note.yaml
$ref: ../components/schemas/AdminNotesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

7
docs/api/admin/paths/notifications.yaml
View File

@@ -77,12 +77,7 @@ get:
content:
application/json:
schema:
type: object
properties:
notifications:
type: array
items:
$ref: ../components/schemas/Notification.yaml
$ref: ../components/schemas/AdminNotificationsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/notifications_{id}_resend.yaml
View File

@@ -38,10 +38,7 @@ post:
content:
application/json:
schema:
type: object
properties:
notification:
$ref: ../components/schemas/Notification.yaml
$ref: ../components/schemas/AdminNotificationsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

20
docs/api/admin/paths/order-edits.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -102,20 +99,7 @@ get:
content:
application/json:
schema:
type: object
properties:
order_edits:
type: array
$ref: ../components/schemas/OrderEdit.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminOrderEditsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/order-edits_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Order Edit.
object:
type: string
description: The type of the object that was deleted.
format: order_edit
deleted:
type: boolean
description: Whether or not the Order Edit was deleted.
default: true
$ref: ../components/schemas/AdminOrderEditDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
get:
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/order-edits_{id}_cancel.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

14
docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml
View File

@@ -38,18 +38,6 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Order Edit Item Change.
object:
type: string
description: The type of the object that was deleted.
format: item_change
deleted:
type: boolean
description: Whether or not the Order Edit Item Change was deleted.
default: true
$ref: ../components/schemas/AdminOrderEditItemChangeDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml

5
docs/api/admin/paths/order-edits_{id}_confirm.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/order-edits_{id}_items.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml
View File

@@ -37,10 +37,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -98,10 +95,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/order-edits_{id}_request.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order_edit:
$ref: ../components/schemas/OrderEdit.yaml
$ref: ../components/schemas/AdminOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/order_{id}_claims.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml
View File

@@ -41,10 +41,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/order_{id}_swaps.yaml
View File

@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

16
docs/api/admin/paths/orders.yaml
View File

@@ -237,21 +237,7 @@ get:
content:
application/json:
schema:
type: object
properties:
orders:
type: array
items:
$ref: ../components/schemas/Order.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminOrdersListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

10
docs/api/admin/paths/orders_{id}.yaml
View File

@@ -30,10 +30,7 @@ get:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -83,10 +80,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_archive.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_cancel.yaml
View File

@@ -33,10 +33,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_capture.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
View File

@@ -38,10 +38,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
View File

@@ -44,10 +44,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
View File

@@ -44,10 +44,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml
View File

@@ -44,10 +44,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_complete.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_fulfillment.yaml
View File

@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
View File

@@ -38,10 +38,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

60
docs/api/admin/paths/orders_{id}_line-items_{line_item_id}_reserve.yaml Normal file
View File

@@ -0,0 +1,60 @@
post:
operationId: PostOrdersOrderLineItemReservations
summary: Create a Reservation for a line item
description: >-
Creates a Reservation for a line item at a specified location, optionally
for a partial quantity.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
schema:
type: string
- in: path
name: line_item_id
required: true
description: The ID of the Line item.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrdersOrderLineItemReservationReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/postundefined
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/orders_{id}_line-items_{line_item_id}_reserve/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Order
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostReservationsReq.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

5
docs/api/admin/paths/orders_{id}_refund.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

57
docs/api/admin/paths/orders_{id}_reservations.yaml Normal file
View File

@@ -0,0 +1,57 @@
get:
operationId: GetOrdersOrderReservations
summary: Get reservations for an Order
description: Retrieves reservations for an Order
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
schema:
type: string
- in: query
name: offset
description: How many reservations to skip before the results.
schema:
type: integer
default: 0
- in: query
name: limit
description: Limit the number of reservations returned.
schema:
type: integer
default: 20
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_reservations/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_reservations/getundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Order
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminGetReservationReservationsReq.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

5
docs/api/admin/paths/orders_{id}_return.yaml
View File

@@ -38,10 +38,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_shipment.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_shipping-methods.yaml
View File

@@ -32,10 +32,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml
View File

@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
View File

@@ -44,10 +44,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
View File

@@ -44,10 +44,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
View File

@@ -41,10 +41,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
View File

@@ -43,10 +43,7 @@ post:
content:
application/json:
schema:
type: object
properties:
order:
$ref: ../components/schemas/Order.yaml
$ref: ../components/schemas/AdminOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/payment-collections_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Payment Collection.
object:
type: string
description: The type of the object that was deleted.
format: payment_collection
deleted:
type: boolean
description: Whether or not the Payment Collection was deleted.
default: true
$ref: ../components/schemas/AdminPaymentCollectionDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -89,10 +77,7 @@ get:
content:
application/json:
schema:
type: object
properties:
payment_collection:
$ref: ../components/schemas/PaymentCollection.yaml
$ref: ../components/schemas/AdminPaymentCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -142,10 +127,7 @@ post:
content:
application/json:
schema:
type: object
properties:
payment_collection:
$ref: ../components/schemas/PaymentCollection.yaml
$ref: ../components/schemas/AdminPaymentCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/payment-collections_{id}_authorize.yaml
View File

@@ -31,10 +31,7 @@ post:
content:
application/json:
schema:
type: object
properties:
payment_collection:
$ref: ../components/schemas/PaymentCollection.yaml
$ref: ../components/schemas/AdminPaymentCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/payments_{id}.yaml
View File

@@ -30,10 +30,7 @@ get:
content:
application/json:
schema:
type: object
properties:
payment:
$ref: ../components/schemas/Payment.yaml
$ref: ../components/schemas/AdminPaymentRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/payments_{id}_capture.yaml
View File

@@ -30,10 +30,7 @@ post:
content:
application/json:
schema:
type: object
properties:
payment:
$ref: ../components/schemas/Payment.yaml
$ref: ../components/schemas/AdminPaymentRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/payments_{id}_refund.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
refund:
$ref: ../components/schemas/Refund.yaml
$ref: ../components/schemas/AdminRefundRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/price-lists.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
price_list:
$ref: ../components/schemas/PriceList.yaml
$ref: ../components/schemas/AdminPriceListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -210,21 +207,7 @@ get:
content:
application/json:
schema:
type: object
properties:
price_lists:
type: array
items:
$ref: ../components/schemas/PriceList.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminPriceListsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/price-lists_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Price List.
object:
type: string
description: The type of the object that was deleted.
default: price-list
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
$ref: ../components/schemas/AdminPriceListDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
price_list:
$ref: ../components/schemas/PriceList.yaml
$ref: ../components/schemas/AdminPriceListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
type: object
properties:
price_list:
$ref: ../components/schemas/PriceList.yaml
$ref: ../components/schemas/AdminPriceListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/price-lists_{id}_prices_batch.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
price_list:
$ref: ../components/schemas/PriceList.yaml
$ref: ../components/schemas/AdminPriceListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -91,21 +88,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
description: The IDs of the deleted Money Amounts (Prices).
object:
type: string
description: The type of the object that was deleted.
default: money-amount
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
$ref: ../components/schemas/AdminPriceListDeleteBatchRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

16
docs/api/admin/paths/price-lists_{id}_products.yaml
View File

@@ -196,21 +196,7 @@ get:
content:
application/json:
schema:
type: object
properties:
products:
type: array
items:
$ref: ../components/schemas/Product.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminPriceListsProductsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

16
docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml
View File

@@ -40,21 +40,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: The price ids that have been deleted.
items:
type: string
object:
type: string
description: The type of the object that was deleted.
default: money-amount
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
$ref: ../components/schemas/AdminPriceListDeleteProductPricesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

16
docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml
View File

@@ -40,21 +40,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: The price ids that have been deleted.
items:
type: string
object:
type: string
description: The type of the object that was deleted.
default: money-amount
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
$ref: ../components/schemas/AdminPriceListDeleteVariantPricesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

14
docs/api/admin/paths/product-categories.yaml
View File

@@ -93,6 +93,20 @@ get:
schema:
type: integer
default: 100
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in the product
category.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in the product
category.
schema:
type: string
x-codeSamples:
- lang: Shell
label: cURL

63
docs/api/admin/paths/product-categories_{id}.yaml
View File

@@ -95,3 +95,66 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostProductCategoriesCategory
summary: Update a Product Category
description: Updates a Product Category.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Product Category.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each product
category.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be retrieved in each product
category.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostProductCategoriesCategoryReq.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories_{id}/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
product_category:
$ref: ../components/schemas/ProductCategory.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

14
docs/api/admin/paths/product-tags.yaml
View File

@@ -113,19 +113,7 @@ get:
content:
application/json:
schema:
type: object
properties:
product_tags:
$ref: ../components/schemas/ProductTag.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminProductTagsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

14
docs/api/admin/paths/product-types.yaml
View File

@@ -113,19 +113,7 @@ get:
content:
application/json:
schema:
type: object
properties:
product_types:
$ref: ../components/schemas/ProductType.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminProductTypesListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/products.yaml
View File

@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -271,21 +268,7 @@ get:
content:
application/json:
schema:
type: object
properties:
products:
type: array
items:
$ref: ../components/schemas/Product.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminProductsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

16
docs/api/admin/paths/products_tag-usage.yaml
View File

@@ -23,21 +23,7 @@ get:
content:
application/json:
schema:
type: object
properties:
tags:
type: array
items:
properties:
id:
description: The ID of the tag.
type: string
usage_count:
description: The number of products that use this tag.
type: string
value:
description: The value of the tag.
type: string
$ref: ../components/schemas/AdminProductsListTagsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

7
docs/api/admin/paths/products_types.yaml
View File

@@ -24,12 +24,7 @@ get:
content:
application/json:
schema:
type: object
properties:
types:
type: array
items:
$ref: ../components/schemas/ProductType.yaml
$ref: ../components/schemas/AdminProductsListTypesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

24
docs/api/admin/paths/products_{id}.yaml
View File

@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted Product.
object:
type: string
description: The type of the object that was deleted.
default: product
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
$ref: ../components/schemas/AdminProductsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/products_{id}_metadata.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/products_{id}_options.yaml
View File

@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/products_{id}_options_{option_id}.yaml
View File

@@ -41,21 +41,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
option_id:
type: string
description: The ID of the deleted Product Option
object:
type: string
description: The type of the object that was deleted.
default: option
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsDeleteOptionRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -112,10 +98,7 @@ post:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/products_{id}_variants.yaml
View File

@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -103,21 +100,7 @@ get:
content:
application/json:
schema:
type: object
properties:
variants:
type: array
items:
$ref: ../components/schemas/ProductVariant.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/AdminProductsListVariantsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

21
docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml
View File

@@ -38,21 +38,7 @@ delete:
content:
application/json:
schema:
type: object
properties:
variant_id:
type: string
description: The ID of the deleted Product Variant.
object:
type: string
description: The type of the object that was deleted.
default: variant
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsDeleteVariantRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -111,10 +97,7 @@ post:
content:
application/json:
schema:
type: object
properties:
product:
$ref: ../components/schemas/Product.yaml
$ref: ../components/schemas/AdminProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

5
docs/api/admin/paths/publishable-api-key_{id}.yaml
View File

@@ -36,10 +36,7 @@ post:
content:
application/json:
schema:
type: object
properties:
publishable_api_key:
$ref: ../components/schemas/PublishableApiKey.yaml
$ref: ../components/schemas/AdminPublishableApiKeysRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':

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