diff --git a/.changeset/flat-swans-pay.md b/.changeset/flat-swans-pay.md
new file mode 100644
index 0000000000..c0fda279c4
--- /dev/null
+++ b/.changeset/flat-swans-pay.md
@@ -0,0 +1,5 @@
+---
+"@medusajs/medusa": patch
+---
+
+fix(medusa): Only add SC relation when enabled
diff --git a/.changeset/long-windows-divide.md b/.changeset/long-windows-divide.md
new file mode 100644
index 0000000000..a2b07db502
--- /dev/null
+++ b/.changeset/long-windows-divide.md
@@ -0,0 +1,5 @@
+---
+"@medusajs/medusa": patch
+---
+
+fix(medusa): Move migration to correct folder
diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json
index 3da4c57742..f6e41e681d 100644
--- a/docs/api/admin-spec3.json
+++ b/docs/api/admin-spec3.json
@@ -211,10 +211,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- apps:
- $ref: '#/components/schemas/OAuth'
+ $ref: '#/components/schemas/AdminAppsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -250,12 +247,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- apps:
- type: array
- items:
- $ref: '#/components/schemas/OAuth'
+ $ref: '#/components/schemas/AdminAppsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -322,10 +314,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -419,10 +408,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -482,10 +468,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -545,10 +528,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -615,10 +595,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -906,21 +883,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_jobs:
- type: array
- items:
- $ref: '#/components/schemas/BatchJob'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -980,10 +943,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1041,10 +1001,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1101,21 +1058,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1181,10 +1124,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1337,21 +1277,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collections:
- type: array
- items:
- $ref: '#/components/schemas/ProductCollection'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1411,19 +1337,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1482,10 +1396,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1557,10 +1468,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1638,21 +1546,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- currencies:
- type: array
- items:
- $ref: '#/components/schemas/Currency'
- 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'
'/currencies/{code}':
post:
operationId: PostCurrenciesCurrency
@@ -1710,10 +1604,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- currency:
- $ref: '#/components/schemas/Currency'
+ $ref: '#/components/schemas/AdminCurrenciesRes'
'/customer-groups/{id}/customers/batch':
post:
operationId: PostCustomerGroupsGroupCustomersBatch
@@ -1784,10 +1675,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1869,10 +1757,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1934,10 +1819,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2120,21 +2002,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_groups:
- type: array
- items:
- $ref: '#/components/schemas/CustomerGroup'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2194,21 +2062,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2281,10 +2135,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2356,10 +2207,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2419,21 +2267,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customers:
- type: array
- items:
- $ref: '#/components/schemas/Customer'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2505,10 +2339,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/AdminCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2583,21 +2414,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customers:
- type: array
- items:
- $ref: '#/components/schemas/Customer'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2667,10 +2484,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/AdminCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2752,10 +2566,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/AdminCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2821,10 +2632,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2891,10 +2699,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2990,10 +2795,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3088,10 +2890,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3183,10 +2982,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3281,10 +3077,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3394,21 +3187,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discounts:
- type: array
- items:
- $ref: '#/components/schemas/Discount'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3480,10 +3259,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3580,24 +3356,7 @@ paths:
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'
+ $ref: '#/components/schemas/AdminDiscountConditionsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3673,10 +3432,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount_condition:
- $ref: '#/components/schemas/DiscountCondition'
+ $ref: '#/components/schemas/AdminDiscountConditionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3777,10 +3533,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3840,19 +3593,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3921,10 +3662,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4012,10 +3750,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4081,10 +3816,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4154,10 +3886,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4245,10 +3974,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4320,21 +4046,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_orders:
- type: array
- items:
- $ref: '#/components/schemas/DraftOrder'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4407,10 +4119,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4470,19 +4179,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4541,10 +4238,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4611,10 +4305,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4694,10 +4385,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4757,10 +4445,8 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: >-
+ #/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4833,10 +4519,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4904,10 +4587,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/AdminGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4977,21 +4657,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_cards:
- type: array
- items:
- $ref: '#/components/schemas/GiftCard'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5051,19 +4717,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5122,10 +4776,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/AdminGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5199,10 +4850,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/AdminGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5397,12 +5045,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- invites:
- type: array
- items:
- $ref: '#/components/schemas/Invite'
+ $ref: '#/components/schemas/AdminListInvitesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5418,8 +5061,8 @@ paths:
'/invites/{invite_id}':
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
@@ -5462,19 +5105,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5604,10 +5235,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- note:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/AdminNotesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5675,21 +5303,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- notes:
- type: array
- items:
- $ref: '#/components/schemas/Note'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5749,19 +5363,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5820,10 +5422,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- note:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/AdminNotesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5895,10 +5494,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- note:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/AdminNotesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6006,12 +5602,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- notifications:
- type: array
- items:
- $ref: '#/components/schemas/Notification'
+ $ref: '#/components/schemas/AdminNotificationsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6078,10 +5669,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- notification:
- $ref: '#/components/schemas/Notification'
+ $ref: '#/components/schemas/AdminNotificationsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6154,10 +5742,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6216,10 +5801,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6274,10 +5856,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6335,10 +5914,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6422,20 +5998,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edits:
- type: array
- $ref: '#/components/schemas/OrderEdit'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6500,10 +6063,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6579,10 +6139,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6649,19 +6206,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'/order-edits/{id}':
@@ -6710,19 +6255,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
get:
@@ -6780,10 +6313,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6854,10 +6384,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6916,10 +6443,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6988,10 +6512,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7076,10 +6597,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7146,10 +6664,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7223,10 +6738,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7300,10 +6812,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7370,10 +6879,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7436,10 +6942,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7506,10 +7009,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7569,10 +7069,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7632,10 +7129,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7715,10 +7209,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7803,10 +7294,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7891,10 +7379,89 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ '/orders/{id}/line-items/{line_item_id}/reserve':
+ 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'
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.orders.createReservation(order_id, line_item_id, {
+ location_id
+ })
+
+ .then(({ reservation }) => {
+ console.log(reservation.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations'
+ \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "location_id": "loc_1"
+ }'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Order
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7967,10 +7534,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8050,10 +7614,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8138,10 +7699,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8214,10 +7772,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8290,10 +7845,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8353,10 +7905,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8428,10 +7977,79 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ '/orders/{id}/reservations':
+ 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: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.orders.retrieveReservations(order_id)
+
+ .then(({ reservations }) => {
+ console.log(reservations[0].id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/admin/orders/{id}/reservations' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Order
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminGetReservationReservationsReq'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8698,21 +8316,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- orders:
- type: array
- items:
- $ref: '#/components/schemas/Order'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8782,10 +8386,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8860,10 +8461,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8949,10 +8547,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9031,10 +8626,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9093,19 +8685,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9165,10 +8745,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/AdminPaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9239,10 +8816,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/AdminPaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9301,10 +8875,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/AdminPaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9364,10 +8935,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment:
- $ref: '#/components/schemas/Payment'
+ $ref: '#/components/schemas/AdminPaymentRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9427,10 +8995,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment:
- $ref: '#/components/schemas/Payment'
+ $ref: '#/components/schemas/AdminPaymentRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9507,10 +9072,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- refund:
- $ref: '#/components/schemas/Refund'
+ $ref: '#/components/schemas/AdminRefundRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9595,10 +9157,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9676,21 +9235,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9776,10 +9321,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9972,21 +9514,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_lists:
- type: array
- items:
- $ref: '#/components/schemas/PriceList'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10046,19 +9574,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10117,10 +9633,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10192,10 +9705,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10265,21 +9775,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10349,21 +9845,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10589,21 +10071,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- products:
- type: array
- items:
- $ref: '#/components/schemas/Product'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10721,6 +10189,20 @@ paths:
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
@@ -10873,6 +10355,78 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
+ 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'
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/product-categories/{id}' \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "name": "Skinny Jeans"
+ }'
+ 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'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
/product-tags:
get:
operationId: GetProductTags
@@ -11003,19 +10557,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product_tags:
- $ref: '#/components/schemas/ProductTag'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11158,19 +10700,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product_types:
- $ref: '#/components/schemas/ProductType'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11243,10 +10773,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11314,10 +10841,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11571,21 +11095,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- products:
- type: array
- items:
- $ref: '#/components/schemas/Product'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11685,10 +11195,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11754,21 +11261,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variants:
- type: array
- items:
- $ref: '#/components/schemas/ProductVariant'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11838,21 +11331,7 @@ paths:
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'
+ $ref: '#/components/schemas/AdminProductsDeleteOptionRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11930,10 +11409,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11993,19 +11469,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12064,10 +11528,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12140,10 +11601,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12209,21 +11667,7 @@ paths:
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'
+ $ref: '#/components/schemas/AdminProductsDeleteVariantRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12320,10 +11764,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12376,21 +11817,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12444,12 +11871,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- types:
- type: array
- items:
- $ref: '#/components/schemas/ProductType'
+ $ref: '#/components/schemas/AdminProductsListTypesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12525,10 +11947,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12611,9 +12030,7 @@ paths:
content:
application/json:
schema:
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12695,9 +12112,7 @@ paths:
content:
application/json:
schema:
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12763,10 +12178,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12845,11 +12257,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_keys:
- type: array
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12909,19 +12317,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted PublishableApiKey.
- object:
- type: string
- description: The type of the object that was deleted.
- format: publishable_api_key
- deleted:
- type: boolean
- description: Whether the PublishableApiKeys was deleted.
- default: true
+ $ref: '#/components/schemas/AdminPublishableApiKeyDeleteRes'
'400':
$ref: '#/components/responses/400_error'
get:
@@ -12970,10 +12366,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13038,11 +12431,8 @@ paths:
content:
application/json:
schema:
- properties:
- sales_channels:
- type: array
- items:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: >-
+ #/components/schemas/AdminPublishableApiKeysListSalesChannelsRes
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13102,10 +12492,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13179,10 +12566,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13255,10 +12639,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13332,10 +12713,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13408,10 +12786,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13499,10 +12874,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13593,21 +12965,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- regions:
- type: array
- items:
- $ref: '#/components/schemas/Region'
- 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/AdminRegionsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13667,19 +13025,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Region.
- object:
- type: string
- description: The type of the object that was deleted.
- default: region
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminRegionsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13738,10 +13084,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13813,10 +13156,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13876,22 +13216,8 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- fulfillment_options:
- type: array
- items:
- properties:
- provider_id:
- type: string
- description: ID of the fulfillment provider
- options:
- type: array
- description: fulfillment provider options
- example:
- - id: manual-fulfillment
- - id: manual-fulfillment-return
- is_return: true
+ $ref: >-
+ #/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13960,10 +13286,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14030,10 +13353,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14094,6 +13414,249 @@ paths:
- cookie_auth: []
tags:
- Region
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminRegionsRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ /reservations:
+ post:
+ operationId: PostReservations
+ summary: Creates a Reservation
+ description: >-
+ Creates a Reservation which can be associated with any resource as
+ required.
+ x-authenticated: true
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.create({
+
+ })
+
+ .then(({ reservations }) => {
+ console.log(reservations.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/reservations' \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "resource_id": "{resource_id}",
+ "resource_type": "order",
+ "value": "We delivered this order"
+ }'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ get:
+ operationId: GetReservations
+ summary: List Reservations
+ description: Retrieve a list of Reservations.
+ x-authenticated: true
+ parameters:
+ - in: query
+ name: location_id
+ style: form
+ explode: false
+ description: Location ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: inventory_item_id
+ style: form
+ explode: false
+ description: Inventory Item ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: line_item_id
+ style: form
+ explode: false
+ description: Line Item ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: quantity
+ description: Filter by reservation quantity
+ schema:
+ type: object
+ properties:
+ lt:
+ type: number
+ description: filter by reservation quantity less than this number
+ gt:
+ type: number
+ description: filter by reservation quantity greater than this number
+ lte:
+ type: number
+ description: >-
+ filter by reservation quantity less than or equal to this
+ number
+ gte:
+ type: number
+ description: >-
+ filter by reservation quantity greater than or equal to this
+ number
+ - in: query
+ name: offset
+ description: How many Reservations to skip in the result.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: limit
+ description: Limit the number of Reservations returned.
+ schema:
+ type: integer
+ default: 20
+ - 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
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/admin/product-categories' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminGetReservationReservationsReq'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ '/reservations/{id}':
+ delete:
+ operationId: DeleteReservationsReservation
+ summary: Delete a Reservation
+ description: Deletes a Reservation.
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the Reservation to delete.
+ schema:
+ type: string
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.delete(reservation.id)
+
+ .then(({ id, object, deleted }) => {
+ console.log(id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request DELETE
+ 'https://medusa-url.com/admin/reservations/{id}' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
responses:
'200':
description: OK
@@ -14102,8 +13665,150 @@ paths:
schema:
type: object
properties:
- region:
- $ref: '#/components/schemas/Region'
+ id:
+ type: string
+ description: The ID of the deleted Reservation.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: reservation
+ deleted:
+ type: boolean
+ description: Whether or not the Reservation was deleted.
+ default: true
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ get:
+ operationId: GetReservationsReservation
+ summary: Get a Reservation
+ description: Retrieves a single reservation using its id
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the reservation to retrieve.
+ schema:
+ type: string
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.retrieve(reservation_id)
+
+ .then(({ reservation }) => {
+ console.log(reservation.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/admin/reservations/{id}' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ post:
+ operationId: PostReservationsReservation
+ summary: Updates a Reservation
+ description: >-
+ Updates a Reservation which can be associated with any resource as
+ required.
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the Reservation to update.
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReservationReq'
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.update(reservation.id, {
+ quantity: 3
+ })
+
+ .then(({ reservations }) => {
+ console.log(reservations.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/reservations/{id}' \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "quantity": 3,
+ }'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14171,10 +13876,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14226,12 +13928,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reasons:
- type: array
- items:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14291,19 +13988,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted return reason
- object:
- type: string
- description: The type of the object that was deleted.
- default: return_reason
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminReturnReasonsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14362,10 +14047,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14437,10 +14119,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14499,10 +14178,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminReturnsCancelRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14567,21 +14243,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- returns:
- type: array
- items:
- $ref: '#/components/schemas/Return'
- 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/AdminReturnsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14665,10 +14327,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return:
- $ref: '#/components/schemas/Return'
+ $ref: '#/components/schemas/AdminReturnsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14750,10 +14409,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14834,10 +14490,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14911,10 +14564,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14987,19 +14637,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the removed stock location from a sales channel
- object:
- type: string
- description: The type of the object that was removed.
- default: stock-location
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminSalesChannelsDeleteLocationRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15066,10 +14704,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15239,21 +14874,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channels:
- type: array
- items:
- $ref: '#/components/schemas/SalesChannel'
- 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/AdminSalesChannelsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15313,19 +14934,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted sales channel
- object:
- type: string
- description: The type of the object that was deleted.
- default: sales-channel
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminSalesChannelsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15384,10 +14993,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15459,10 +15065,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15537,10 +15140,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/AdminShippingOptionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15608,15 +15208,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: '#/components/schemas/ShippingOption'
- count:
- type: integer
- description: The total number of items available
+ $ref: '#/components/schemas/AdminShippingOptionsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15676,19 +15268,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping-option
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminShippingOptionsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15747,10 +15327,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/AdminShippingOptionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15834,10 +15411,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/AdminShippingOptionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15903,10 +15477,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15958,12 +15529,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profiles:
- type: array
- items:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16023,19 +15589,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Profile.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping_profile
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminDeleteShippingProfileRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16094,10 +15648,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16168,10 +15719,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16249,10 +15797,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: '#/components/schemas/StockLocationDTO'
+ $ref: '#/components/schemas/AdminStockLocationsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16412,21 +15957,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_locations:
- type: array
- items:
- $ref: '#/components/schemas/StockLocationDTO'
- 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/AdminStockLocationsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16496,10 +16027,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: '#/components/schemas/StockLocationDTO'
+ $ref: '#/components/schemas/AdminStockLocationsRes'
post:
operationId: PostStockLocationsStockLocation
summary: Update a Stock Location
@@ -16569,10 +16097,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: '#/components/schemas/StockLocationDTO'
+ $ref: '#/components/schemas/AdminStockLocationsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16635,10 +16160,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16700,10 +16222,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16754,10 +16273,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16822,10 +16338,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16878,12 +16391,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_providers:
- type: array
- items:
- $ref: '#/components/schemas/PaymentProvider'
+ $ref: '#/components/schemas/AdminPaymentProvidersList'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16936,12 +16444,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_providers:
- type: array
- items:
- $ref: '#/components/schemas/TaxProvider'
+ $ref: '#/components/schemas/AdminTaxProvidersList'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17001,10 +16504,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/AdminSwapsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17068,21 +16568,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swaps:
- type: array
- items:
- $ref: '#/components/schemas/Swap'
- 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/AdminSwapsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17177,10 +16663,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17274,10 +16757,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17372,10 +16852,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17469,10 +16946,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17568,10 +17042,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17667,10 +17138,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17759,10 +17227,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17888,21 +17353,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rates:
- type: array
- items:
- $ref: '#/components/schemas/TaxRate'
- 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/AdminTaxRatesListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17962,19 +17413,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: tax-rate
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminTaxRatesDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18051,10 +17490,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18144,10 +17580,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18217,17 +17650,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- uploads:
- type: array
- items:
- type: object
- properties:
- url:
- type: string
- description: The URL of the uploaded file.
- format: uri
+ $ref: '#/components/schemas/AdminUploadsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18297,17 +17720,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- uploads:
- type: array
- items:
- type: object
- properties:
- url:
- type: string
- description: The URL of the uploaded file.
- format: uri
+ $ref: '#/components/schemas/AdminUploadsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18372,19 +17785,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The file key of the upload deleted
- object:
- type: string
- description: The type of the object that was deleted.
- default: file
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminDeleteUploadsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18450,11 +17851,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- download_url:
- type: string
- description: The Download URL of the file
+ $ref: '#/components/schemas/AdminUploadsDownloadUrlRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18522,10 +17919,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18575,12 +17969,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- users:
- type: array
- items:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUsersListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18640,19 +18029,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted user.
- object:
- type: string
- description: The type of the object that was deleted.
- default: user
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminDeleteUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18711,10 +18088,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18786,10 +18160,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18923,10 +18294,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -19071,21 +18439,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variants:
- type: array
- items:
- $ref: '#/components/schemas/ProductVariant'
- 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/AdminVariantsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -23100,6 +22454,41 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ProductVariantInventoryItem:
+ title: Product Variant Inventory Item
+ description: >-
+ Product Variant Inventory Items link variants with inventory items and
+ denote the number of inventory items constituting a variant.
+ type: object
+ properties:
+ id:
+ type: string
+ description: The product variant inventory item's ID
+ example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+ inventory_item_id:
+ description: The id of the inventory item
+ type: string
+ variant_id:
+ description: The id of the variant.
+ type: string
+ required_quantity:
+ description: >-
+ The quantity of an inventory item required for one quantity of the
+ variant.
+ type: integer
+ default: 1
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
ProductVariant:
title: Product Variant
description: >-
@@ -23257,46 +22646,6 @@ components:
description: An optional key-value map with additional details
example:
car: white
- ProductVariantPricesFields:
- title: Product Variant Prices Fields
- description: Product Variants Prices Fields that are only available in some requests.
- type: object
- properties:
- original_price:
- type: number
- description: >-
- The original price of the variant without any discounted prices
- applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
Product:
title: Product
description: >-
@@ -24821,6 +24170,98 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ReservationItemDTO:
+ title: Reservation item
+ description: Represents a reservation of an inventory item at a stock location
+ type: object
+ required:
+ - id
+ - location_id
+ - inventory_item_id
+ - quantity
+ properties:
+ id:
+ description: The id of the reservation item
+ type: string
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ inventory_item_id:
+ description: The id of the inventory item the reservation relates to
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ type: object
+ description: An optional key-value map with additional details
+ example:
+ car: white
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
+ PricedVariant:
+ title: Priced Product Variant
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/ProductVariant'
+ - type: object
+ properties:
+ original_price:
+ type: number
+ description: >-
+ The original price of the variant without any discounted prices
+ applied.
+ calculated_price:
+ type: number
+ description: The calculated price of the variant. Can be a discounted price.
+ original_price_incl_tax:
+ type: number
+ description: The original price of the variant including taxes.
+ calculated_price_incl_tax:
+ type: number
+ description: The calculated price of the variant including taxes.
+ original_tax:
+ type: number
+ description: The taxes applied on the original price.
+ calculated_tax:
+ type: number
+ description: The taxes applied on the calculated price.
+ tax_rates:
+ type: array
+ description: An array of applied tax rates
+ items:
+ type: object
+ properties:
+ rate:
+ type: number
+ description: The tax rate value
+ name:
+ type: string
+ description: The name of the tax rate
+ code:
+ type: string
+ description: The code of the tax rate
+ PricedProduct:
+ title: Priced Product
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/Product'
+ - type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedVariant'
StockLocationAddressDTO:
title: Stock Location Address
description: Represents a Stock Location Address
@@ -25053,6 +24494,18 @@ components:
code:
type: string
description: The code for the generated token.
+ AdminAppsRes:
+ type: object
+ properties:
+ apps:
+ $ref: '#/components/schemas/OAuth'
+ AdminAppsListRes:
+ type: object
+ properties:
+ apps:
+ type: array
+ items:
+ $ref: '#/components/schemas/OAuth'
AdminPostAuthReq:
type: object
required:
@@ -25067,6 +24520,11 @@ components:
type: string
description: The User's password.
format: password
+ AdminAuthRes:
+ type: object
+ properties:
+ user:
+ $ref: '#/components/schemas/User'
AdminPostBatchesReq:
type: object
required:
@@ -25104,6 +24562,27 @@ components:
Set a batch job in dry_run mode to get some information on what will
be done without applying any modifications.
default: false
+ AdminBatchJobRes:
+ type: object
+ properties:
+ batch_job:
+ $ref: '#/components/schemas/BatchJob'
+ AdminBatchJobListRes:
+ type: object
+ properties:
+ batch_jobs:
+ type: array
+ items:
+ $ref: '#/components/schemas/BatchJob'
+ 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
AdminPostProductsToCollectionReq:
type: object
required:
@@ -25131,6 +24610,57 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminCollectionsListRes:
+ type: object
+ properties:
+ collections:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductCollection'
+ 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
+ AdminCollectionsDeleteRes:
+ 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
+ AdminDeleteProductsFromCollectionRes:
+ 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
+ AdminCollectionsRes:
+ type: object
+ properties:
+ collection:
+ $ref: '#/components/schemas/ProductCollection'
AdminDeleteProductsFromCollectionReq:
type: object
required:
@@ -25156,6 +24686,27 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminCurrenciesListRes:
+ type: object
+ properties:
+ currencies:
+ type: array
+ items:
+ $ref: '#/components/schemas/Currency'
+ 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
+ AdminCurrenciesRes:
+ type: object
+ properties:
+ currency:
+ $ref: '#/components/schemas/Currency'
AdminPostCurrenciesCurrencyReq:
type: object
properties:
@@ -25192,6 +24743,41 @@ components:
id:
description: ID of the customer
type: string
+ AdminCustomerGroupsRes:
+ type: object
+ properties:
+ customer_group:
+ $ref: '#/components/schemas/CustomerGroup'
+ AdminCustomerGroupsDeleteRes:
+ 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
+ AdminCustomerGroupsListRes:
+ type: object
+ properties:
+ customer_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomerGroup'
+ 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
AdminPostCustomerGroupsGroupReq:
type: object
properties:
@@ -25229,6 +24815,27 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminCustomersRes:
+ type: object
+ properties:
+ customer:
+ $ref: '#/components/schemas/Customer'
+ AdminCustomersListRes:
+ type: object
+ properties:
+ customers:
+ type: array
+ items:
+ $ref: '#/components/schemas/Customer'
+ 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
AdminPostCustomersCustomerReq:
type: object
properties:
@@ -25467,6 +25074,63 @@ components:
id:
description: The id of the item
type: string
+ AdminDiscountsRes:
+ type: object
+ properties:
+ discount:
+ $ref: '#/components/schemas/Discount'
+ AdminDiscountConditionsRes:
+ type: object
+ properties:
+ discount_condition:
+ $ref: '#/components/schemas/DiscountCondition'
+ AdminDiscountsDeleteRes:
+ 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
+ AdminDiscountConditionsDeleteRes:
+ 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'
+ AdminDiscountsListRes:
+ type: object
+ properties:
+ discounts:
+ type: array
+ items:
+ $ref: '#/components/schemas/Discount'
+ 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
AdminPostDiscountsDiscountConditionsCondition:
type: object
properties:
@@ -25735,6 +25399,46 @@ components:
The optional key-value map with additional details about the Line
Item.
type: object
+ AdminPostDraftOrdersDraftOrderRegisterPaymentRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
+ AdminDraftOrdersRes:
+ type: object
+ properties:
+ draft_order:
+ $ref: '#/components/schemas/DraftOrder'
+ AdminDraftOrdersDeleteRes:
+ 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
+ AdminDraftOrdersListRes:
+ type: object
+ properties:
+ draft_orders:
+ type: array
+ items:
+ $ref: '#/components/schemas/DraftOrder'
+ 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
AdminPostDraftOrdersDraftOrderReq:
type: object
properties:
@@ -25821,6 +25525,41 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminGiftCardsRes:
+ type: object
+ properties:
+ gift_card:
+ $ref: '#/components/schemas/GiftCard'
+ AdminGiftCardsDeleteRes:
+ 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
+ AdminGiftCardsListRes:
+ type: object
+ properties:
+ gift_cards:
+ type: array
+ items:
+ $ref: '#/components/schemas/GiftCard'
+ 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
AdminPostGiftCardsGiftCardReq:
type: object
properties:
@@ -25886,6 +25625,27 @@ components:
- admin
- member
- developer
+ AdminInviteDeleteRes:
+ 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.
+ default: invite
+ deleted:
+ type: boolean
+ description: Whether or not the Invite was deleted.
+ default: true
+ AdminListInvitesRes:
+ type: object
+ properties:
+ invites:
+ type: array
+ items:
+ $ref: '#/components/schemas/Invite'
AdminPostNotesReq:
type: object
required:
@@ -25902,6 +25662,41 @@ components:
value:
type: string
description: The content of the Note to create.
+ AdminNotesRes:
+ type: object
+ properties:
+ note:
+ $ref: '#/components/schemas/Note'
+ AdminNotesDeleteRes:
+ 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
+ AdminNotesListRes:
+ type: object
+ properties:
+ notes:
+ type: array
+ items:
+ $ref: '#/components/schemas/Note'
+ 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
AdminPostNotesNoteReq:
type: object
required:
@@ -25910,6 +25705,18 @@ components:
value:
type: string
description: The updated description of the Note.
+ AdminNotificationsListRes:
+ type: object
+ properties:
+ notifications:
+ type: array
+ items:
+ $ref: '#/components/schemas/Notification'
+ AdminNotificationsRes:
+ type: object
+ properties:
+ notification:
+ $ref: '#/components/schemas/Notification'
AdminPostNotificationsNotificationResendReq:
type: object
properties:
@@ -25944,6 +25751,55 @@ components:
internal_note:
description: An optional note to create for the order edit.
type: string
+ AdminOrderEditsRes:
+ type: object
+ properties:
+ order_edit:
+ $ref: '#/components/schemas/OrderEdit'
+ AdminOrderEditsListRes:
+ type: object
+ properties:
+ order_edits:
+ type: array
+ items:
+ $ref: '#/components/schemas/OrderEdit'
+ 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
+ AdminOrderEditDeleteRes:
+ 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.
+ default: order_edit
+ deleted:
+ type: boolean
+ description: Whether or not the Order Edit was deleted.
+ default: true
+ AdminOrderEditItemChangeDeleteRes:
+ 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.
+ default: item_change
+ deleted:
+ type: boolean
+ description: Whether or not the Order Edit Item Change was deleted.
+ default: true
AdminPostOrderEditsEditLineItemsLineItemReq:
type: object
required:
@@ -26105,6 +25961,17 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminOrdersOrderLineItemReservationReq:
+ type: object
+ required:
+ - location_id
+ properties:
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ quantity:
+ description: The quantity to reserve
+ type: number
AdminPostOrdersOrderShipmentReq:
type: object
required:
@@ -26233,6 +26100,27 @@ components:
no_notification:
description: If set to true no notification will be send related to this Claim.
type: boolean
+ AdminOrdersRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
+ AdminOrdersListRes:
+ type: object
+ properties:
+ orders:
+ type: array
+ items:
+ $ref: '#/components/schemas/Order'
+ 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
AdminPostOrdersOrderRefundsReq:
type: object
required:
@@ -26452,6 +26340,25 @@ components:
A flag to indicate if no notifications should be emitted related to
the updated order.
type: boolean
+ AdminPaymentCollectionsRes:
+ type: object
+ properties:
+ payment_collection:
+ $ref: '#/components/schemas/PaymentCollection'
+ AdminPaymentCollectionDeleteRes:
+ 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.
+ default: payment_collection
+ deleted:
+ type: boolean
+ description: Whether or not the Payment Collection was deleted.
+ default: true
AdminUpdatePaymentCollectionsReq:
type: object
properties:
@@ -26461,6 +26368,16 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminPaymentRes:
+ type: object
+ properties:
+ payment:
+ $ref: '#/components/schemas/Payment'
+ AdminRefundRes:
+ type: object
+ properties:
+ refund:
+ $ref: '#/components/schemas/Refund'
AdminPostPaymentRefundsReq:
type: object
required:
@@ -26608,6 +26525,105 @@ components:
type: array
items:
type: string
+ AdminPriceListRes:
+ type: object
+ properties:
+ price_list:
+ $ref: '#/components/schemas/PriceList'
+ AdminPriceListDeleteBatchRes:
+ 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
+ AdminPriceListDeleteProductPricesRes:
+ 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
+ AdminPriceListDeleteVariantPricesRes:
+ 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
+ AdminPriceListDeleteRes:
+ 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
+ AdminPriceListsListRes:
+ type: object
+ properties:
+ price_lists:
+ type: array
+ items:
+ $ref: '#/components/schemas/PriceList'
+ 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
+ AdminPriceListsProductsListRes:
+ type: object
+ properties:
+ products:
+ type: array
+ items:
+ $ref: '#/components/schemas/Product'
+ 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
AdminPostPriceListsPriceListPriceListReq:
type: object
properties:
@@ -26708,6 +26724,56 @@ components:
parent_category_id:
type: string
description: The ID of the parent product category
+ AdminPostProductCategoriesCategoryReq:
+ type: object
+ properties:
+ name:
+ type: string
+ description: The name to identify the Product Category by.
+ handle:
+ type: string
+ description: A handle to be used in slugs.
+ is_internal:
+ type: boolean
+ description: A flag to make product category an internal category for admins
+ is_active:
+ type: boolean
+ description: A flag to make product category visible/hidden in the store front
+ parent_category_id:
+ type: string
+ description: The ID of the parent product category
+ AdminProductTagsListRes:
+ type: object
+ properties:
+ product_tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductTag'
+ 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
+ AdminProductTypesListRes:
+ type: object
+ properties:
+ product_types:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductType'
+ 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
AdminPostProductsProductOptionsReq:
type: object
required:
@@ -26982,6 +27048,7 @@ components:
Whether Medusa should keep track of the inventory for this Product
Variant.
type: boolean
+ default: true
weight:
description: The wieght of the Product Variant.
type: number
@@ -27050,6 +27117,114 @@ components:
value:
description: The value to give for the Product Option.
type: string
+ AdminProductsDeleteOptionRes:
+ 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'
+ AdminProductsDeleteVariantRes:
+ 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: product-variant
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ product:
+ $ref: '#/components/schemas/Product'
+ AdminProductsDeleteRes:
+ 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
+ AdminProductsListRes:
+ type: object
+ properties:
+ products:
+ type: array
+ items:
+ oneOf:
+ - $ref: '#/components/schemas/Product'
+ - $ref: '#/components/schemas/PricedProduct'
+ 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
+ AdminProductsListVariantsRes:
+ type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductVariant'
+ 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
+ AdminProductsListTypesRes:
+ type: object
+ properties:
+ types:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductType'
+ AdminProductsListTagsRes:
+ 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
+ AdminProductsRes:
+ type: object
+ properties:
+ product:
+ $ref: '#/components/schemas/Product'
AdminPostProductsProductMetadataReq:
type: object
required:
@@ -27422,6 +27597,48 @@ components:
id:
type: string
description: The ID of the sales channel
+ AdminPublishableApiKeysRes:
+ type: object
+ properties:
+ publishable_api_key:
+ $ref: '#/components/schemas/PublishableApiKey'
+ AdminPublishableApiKeysListRes:
+ type: object
+ properties:
+ publishable_api_keys:
+ type: array
+ items:
+ $ref: '#/components/schemas/PublishableApiKey'
+ 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
+ AdminPublishableApiKeyDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted PublishableApiKey.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: publishable_api_key
+ deleted:
+ type: boolean
+ description: Whether the PublishableApiKeys was deleted.
+ default: true
+ AdminPublishableApiKeysListSalesChannelsRes:
+ type: object
+ properties:
+ sales_channels:
+ type: array
+ items:
+ $ref: '#/components/schemas/SalesChannel'
AdminPostPublishableApiKeysPublishableApiKeyReq:
type: object
properties:
@@ -27505,6 +27722,59 @@ components:
includes_tax:
description: '[EXPERIMENTAL] Tax included in prices of region'
type: boolean
+ AdminRegionsRes:
+ type: object
+ properties:
+ region:
+ $ref: '#/components/schemas/Region'
+ AdminRegionsListRes:
+ type: object
+ properties:
+ regions:
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
+ 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
+ AdminRegionsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Region.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: region
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminGetRegionsRegionFulfillmentOptionsRes:
+ type: object
+ properties:
+ fulfillment_options:
+ type: array
+ items:
+ type: object
+ properties:
+ provider_id:
+ type: string
+ description: ID of the fulfillment provider
+ options:
+ type: array
+ description: fulfillment provider options
+ example:
+ - id: manual-fulfillment
+ - id: manual-fulfillment-return
+ is_return: true
AdminPostRegionsRegionReq:
type: object
properties:
@@ -27560,6 +27830,41 @@ components:
type: array
items:
type: string
+ AdminPostReservationsReq:
+ type: object
+ required:
+ - reservation
+ properties:
+ reservation:
+ $ref: '#/components/schemas/ReservationItemDTO'
+ AdminGetReservationReservationsReq:
+ type: object
+ properties:
+ reservations:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReservationItemDTO'
+ 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
+ AdminPostReservationsReservationReq:
+ type: object
+ properties:
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ description: An optional set of key-value pairs with additional information.
+ type: object
AdminPostReturnReasonsReq:
type: object
required:
@@ -27583,6 +27888,32 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminReturnReasonsRes:
+ type: object
+ properties:
+ return_reason:
+ $ref: '#/components/schemas/ReturnReason'
+ AdminReturnReasonsListRes:
+ type: object
+ properties:
+ return_reasons:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReturnReason'
+ AdminReturnReasonsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted return reason
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: return_reason
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
AdminPostReturnReasonsReasonReq:
type: object
properties:
@@ -27600,6 +27931,32 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminReturnsCancelRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
+ AdminReturnsListRes:
+ type: object
+ properties:
+ returns:
+ type: array
+ items:
+ $ref: '#/components/schemas/Return'
+ 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
+ AdminReturnsRes:
+ type: object
+ properties:
+ return:
+ $ref: '#/components/schemas/Return'
AdminPostReturnsReturnReceiveReq:
type: object
required:
@@ -27676,6 +28033,55 @@ components:
id:
description: The ID of a product
type: string
+ AdminSalesChannelsRes:
+ type: object
+ properties:
+ sales_channel:
+ $ref: '#/components/schemas/SalesChannel'
+ AdminSalesChannelsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted sales channel
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: sales-channel
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminSalesChannelsDeleteLocationRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the removed stock location from a sales channel
+ object:
+ type: string
+ description: The type of the object that was removed.
+ default: stock-location
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminSalesChannelsListRes:
+ type: object
+ properties:
+ sales_channels:
+ type: array
+ items:
+ $ref: '#/components/schemas/SalesChannel'
+ 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
AdminDeleteSalesChannelsChannelStockLocationsReq:
type: object
required:
@@ -27764,6 +28170,35 @@ components:
includes_tax:
description: '[EXPERIMENTAL] Tax included in prices of shipping option'
type: boolean
+ AdminShippingOptionsListRes:
+ type: object
+ properties:
+ shipping_options:
+ type: array
+ items:
+ $ref: '#/components/schemas/ShippingOption'
+ count:
+ type: integer
+ description: The total number of items available
+ AdminShippingOptionsRes:
+ type: object
+ properties:
+ shipping_option:
+ $ref: '#/components/schemas/ShippingOption'
+ AdminShippingOptionsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Option.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: shipping-option
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
AdminPostShippingOptionsOptionReq:
type: object
required:
@@ -27814,6 +28249,32 @@ components:
name:
description: The name of the Shipping Profile
type: string
+ AdminDeleteShippingProfileRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Profile.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: shipping_profile
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminShippingProfilesRes:
+ type: object
+ properties:
+ shipping_profile:
+ $ref: '#/components/schemas/ShippingProfile'
+ AdminShippingProfilesListRes:
+ type: object
+ properties:
+ shipping_profiles:
+ type: array
+ items:
+ $ref: '#/components/schemas/ShippingProfile'
AdminPostShippingProfilesProfileReq:
type: object
properties:
@@ -27838,6 +28299,27 @@ components:
car: white
address:
$ref: '#/components/schemas/StockLocationAddressInput'
+ AdminStockLocationsRes:
+ type: object
+ properties:
+ stock_location:
+ $ref: '#/components/schemas/StockLocationDTO'
+ AdminStockLocationsListRes:
+ type: object
+ properties:
+ stock_locations:
+ type: array
+ items:
+ $ref: '#/components/schemas/StockLocationDTO'
+ 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
AdminPostStockLocationsLocationReq:
type: object
properties:
@@ -27854,6 +28336,25 @@ components:
car: white
address:
$ref: '#/components/schemas/StockLocationAddressInput'
+ AdminStoresRes:
+ type: object
+ properties:
+ store:
+ $ref: '#/components/schemas/Store'
+ AdminTaxProvidersList:
+ type: object
+ properties:
+ tax_providers:
+ type: array
+ items:
+ $ref: '#/components/schemas/TaxProvider'
+ AdminPaymentProvidersList:
+ type: object
+ properties:
+ payment_providers:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentProvider'
AdminPostStoreReq:
type: object
properties:
@@ -27889,6 +28390,27 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminSwapsListRes:
+ type: object
+ properties:
+ swaps:
+ type: array
+ items:
+ $ref: '#/components/schemas/Swap'
+ 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
+ AdminSwapsRes:
+ type: object
+ properties:
+ swap:
+ $ref: '#/components/schemas/Swap'
AdminPostTaxRatesTaxRateProductTypesReq:
type: object
required:
@@ -27953,6 +28475,41 @@ components:
description: The IDs of the types of products associated with this tax rate
items:
type: string
+ AdminTaxRatesDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Option.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: tax-rate
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminTaxRatesListRes:
+ type: object
+ properties:
+ tax_rates:
+ type: array
+ items:
+ $ref: '#/components/schemas/TaxRate'
+ 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
+ AdminTaxRatesRes:
+ type: object
+ properties:
+ tax_rate:
+ $ref: '#/components/schemas/TaxRate'
AdminDeleteTaxRatesTaxRateProductTypesReq:
type: object
required:
@@ -28033,6 +28590,38 @@ components:
file_key:
description: key of the file to obtain the download link for
type: string
+ AdminUploadsRes:
+ type: object
+ properties:
+ uploads:
+ type: array
+ items:
+ type: object
+ properties:
+ url:
+ type: string
+ description: The URL of the uploaded file.
+ format: uri
+ AdminDeleteUploadsRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The file key of the upload deleted
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: file
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminUploadsDownloadUrlRes:
+ type: object
+ properties:
+ download_url:
+ type: string
+ description: The Download URL of the file
AdminCreateUserRequest:
type: object
required:
@@ -28060,6 +28649,32 @@ components:
description: The Users password.
type: string
format: password
+ AdminUserRes:
+ type: object
+ properties:
+ user:
+ $ref: '#/components/schemas/User'
+ AdminUsersListRes:
+ type: object
+ properties:
+ users:
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
+ AdminDeleteUserRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted user.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: user
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
AdminResetPasswordTokenRequest:
type: object
required:
@@ -28108,3 +28723,19 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminVariantsListRes:
+ type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductVariant'
+ 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
diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml
index 3da4c57742..f6e41e681d 100644
--- a/docs/api/admin-spec3.yaml
+++ b/docs/api/admin-spec3.yaml
@@ -211,10 +211,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- apps:
- $ref: '#/components/schemas/OAuth'
+ $ref: '#/components/schemas/AdminAppsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -250,12 +247,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- apps:
- type: array
- items:
- $ref: '#/components/schemas/OAuth'
+ $ref: '#/components/schemas/AdminAppsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -322,10 +314,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -419,10 +408,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -482,10 +468,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -545,10 +528,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -615,10 +595,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -906,21 +883,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_jobs:
- type: array
- items:
- $ref: '#/components/schemas/BatchJob'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -980,10 +943,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- batch_job:
- $ref: '#/components/schemas/BatchJob'
+ $ref: '#/components/schemas/AdminBatchJobRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1041,10 +1001,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1101,21 +1058,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1181,10 +1124,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1337,21 +1277,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collections:
- type: array
- items:
- $ref: '#/components/schemas/ProductCollection'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1411,19 +1337,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1482,10 +1396,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1557,10 +1468,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/AdminCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1638,21 +1546,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- currencies:
- type: array
- items:
- $ref: '#/components/schemas/Currency'
- 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'
'/currencies/{code}':
post:
operationId: PostCurrenciesCurrency
@@ -1710,10 +1604,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- currency:
- $ref: '#/components/schemas/Currency'
+ $ref: '#/components/schemas/AdminCurrenciesRes'
'/customer-groups/{id}/customers/batch':
post:
operationId: PostCustomerGroupsGroupCustomersBatch
@@ -1784,10 +1675,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1869,10 +1757,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1934,10 +1819,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2120,21 +2002,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_groups:
- type: array
- items:
- $ref: '#/components/schemas/CustomerGroup'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2194,21 +2062,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2281,10 +2135,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2356,10 +2207,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer_group:
- $ref: '#/components/schemas/CustomerGroup'
+ $ref: '#/components/schemas/AdminCustomerGroupsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2419,21 +2267,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customers:
- type: array
- items:
- $ref: '#/components/schemas/Customer'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2505,10 +2339,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/AdminCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2583,21 +2414,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customers:
- type: array
- items:
- $ref: '#/components/schemas/Customer'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2667,10 +2484,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/AdminCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2752,10 +2566,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/AdminCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2821,10 +2632,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2891,10 +2699,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2990,10 +2795,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3088,10 +2890,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3183,10 +2982,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3281,10 +3077,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3394,21 +3187,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discounts:
- type: array
- items:
- $ref: '#/components/schemas/Discount'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3480,10 +3259,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3580,24 +3356,7 @@ paths:
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'
+ $ref: '#/components/schemas/AdminDiscountConditionsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3673,10 +3432,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount_condition:
- $ref: '#/components/schemas/DiscountCondition'
+ $ref: '#/components/schemas/AdminDiscountConditionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3777,10 +3533,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3840,19 +3593,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3921,10 +3662,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4012,10 +3750,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4081,10 +3816,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4154,10 +3886,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- discount:
- $ref: '#/components/schemas/Discount'
+ $ref: '#/components/schemas/AdminDiscountsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4245,10 +3974,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4320,21 +4046,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_orders:
- type: array
- items:
- $ref: '#/components/schemas/DraftOrder'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4407,10 +4119,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4470,19 +4179,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4541,10 +4238,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4611,10 +4305,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4694,10 +4385,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4757,10 +4445,8 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: >-
+ #/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4833,10 +4519,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- draft_order:
- $ref: '#/components/schemas/DraftOrder'
+ $ref: '#/components/schemas/AdminDraftOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4904,10 +4587,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/AdminGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -4977,21 +4657,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_cards:
- type: array
- items:
- $ref: '#/components/schemas/GiftCard'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5051,19 +4717,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5122,10 +4776,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/AdminGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5199,10 +4850,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/AdminGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5397,12 +5045,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- invites:
- type: array
- items:
- $ref: '#/components/schemas/Invite'
+ $ref: '#/components/schemas/AdminListInvitesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5418,8 +5061,8 @@ paths:
'/invites/{invite_id}':
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
@@ -5462,19 +5105,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5604,10 +5235,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- note:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/AdminNotesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5675,21 +5303,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- notes:
- type: array
- items:
- $ref: '#/components/schemas/Note'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5749,19 +5363,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5820,10 +5422,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- note:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/AdminNotesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -5895,10 +5494,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- note:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/AdminNotesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6006,12 +5602,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- notifications:
- type: array
- items:
- $ref: '#/components/schemas/Notification'
+ $ref: '#/components/schemas/AdminNotificationsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6078,10 +5669,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- notification:
- $ref: '#/components/schemas/Notification'
+ $ref: '#/components/schemas/AdminNotificationsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6154,10 +5742,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6216,10 +5801,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6274,10 +5856,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6335,10 +5914,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6422,20 +5998,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edits:
- type: array
- $ref: '#/components/schemas/OrderEdit'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6500,10 +6063,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6579,10 +6139,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6649,19 +6206,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'/order-edits/{id}':
@@ -6710,19 +6255,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
get:
@@ -6780,10 +6313,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6854,10 +6384,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6916,10 +6443,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/AdminOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -6988,10 +6512,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7076,10 +6597,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7146,10 +6664,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7223,10 +6738,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7300,10 +6812,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7370,10 +6879,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7436,10 +6942,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7506,10 +7009,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7569,10 +7069,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7632,10 +7129,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7715,10 +7209,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7803,10 +7294,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7891,10 +7379,89 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ '/orders/{id}/line-items/{line_item_id}/reserve':
+ 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'
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.orders.createReservation(order_id, line_item_id, {
+ location_id
+ })
+
+ .then(({ reservation }) => {
+ console.log(reservation.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations'
+ \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "location_id": "loc_1"
+ }'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Order
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -7967,10 +7534,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8050,10 +7614,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8138,10 +7699,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8214,10 +7772,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8290,10 +7845,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8353,10 +7905,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8428,10 +7977,79 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ '/orders/{id}/reservations':
+ 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: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.orders.retrieveReservations(order_id)
+
+ .then(({ reservations }) => {
+ console.log(reservations[0].id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/admin/orders/{id}/reservations' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Order
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminGetReservationReservationsReq'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8698,21 +8316,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- orders:
- type: array
- items:
- $ref: '#/components/schemas/Order'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8782,10 +8386,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8860,10 +8461,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -8949,10 +8547,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9031,10 +8626,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9093,19 +8685,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9165,10 +8745,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/AdminPaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9239,10 +8816,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/AdminPaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9301,10 +8875,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/AdminPaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9364,10 +8935,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment:
- $ref: '#/components/schemas/Payment'
+ $ref: '#/components/schemas/AdminPaymentRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9427,10 +8995,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment:
- $ref: '#/components/schemas/Payment'
+ $ref: '#/components/schemas/AdminPaymentRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9507,10 +9072,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- refund:
- $ref: '#/components/schemas/Refund'
+ $ref: '#/components/schemas/AdminRefundRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9595,10 +9157,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9676,21 +9235,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9776,10 +9321,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -9972,21 +9514,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_lists:
- type: array
- items:
- $ref: '#/components/schemas/PriceList'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10046,19 +9574,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10117,10 +9633,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10192,10 +9705,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- price_list:
- $ref: '#/components/schemas/PriceList'
+ $ref: '#/components/schemas/AdminPriceListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10265,21 +9775,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10349,21 +9845,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10589,21 +10071,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- products:
- type: array
- items:
- $ref: '#/components/schemas/Product'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -10721,6 +10189,20 @@ paths:
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
@@ -10873,6 +10355,78 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
+ 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'
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/product-categories/{id}' \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "name": "Skinny Jeans"
+ }'
+ 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'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
/product-tags:
get:
operationId: GetProductTags
@@ -11003,19 +10557,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product_tags:
- $ref: '#/components/schemas/ProductTag'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11158,19 +10700,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product_types:
- $ref: '#/components/schemas/ProductType'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11243,10 +10773,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11314,10 +10841,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11571,21 +11095,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- products:
- type: array
- items:
- $ref: '#/components/schemas/Product'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11685,10 +11195,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11754,21 +11261,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variants:
- type: array
- items:
- $ref: '#/components/schemas/ProductVariant'
- 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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11838,21 +11331,7 @@ paths:
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'
+ $ref: '#/components/schemas/AdminProductsDeleteOptionRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11930,10 +11409,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -11993,19 +11469,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12064,10 +11528,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12140,10 +11601,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12209,21 +11667,7 @@ paths:
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'
+ $ref: '#/components/schemas/AdminProductsDeleteVariantRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12320,10 +11764,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12376,21 +11817,7 @@ paths:
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'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12444,12 +11871,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- types:
- type: array
- items:
- $ref: '#/components/schemas/ProductType'
+ $ref: '#/components/schemas/AdminProductsListTypesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12525,10 +11947,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- $ref: '#/components/schemas/Product'
+ $ref: '#/components/schemas/AdminProductsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12611,9 +12030,7 @@ paths:
content:
application/json:
schema:
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12695,9 +12112,7 @@ paths:
content:
application/json:
schema:
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12763,10 +12178,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12845,11 +12257,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_keys:
- type: array
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -12909,19 +12317,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted PublishableApiKey.
- object:
- type: string
- description: The type of the object that was deleted.
- format: publishable_api_key
- deleted:
- type: boolean
- description: Whether the PublishableApiKeys was deleted.
- default: true
+ $ref: '#/components/schemas/AdminPublishableApiKeyDeleteRes'
'400':
$ref: '#/components/responses/400_error'
get:
@@ -12970,10 +12366,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13038,11 +12431,8 @@ paths:
content:
application/json:
schema:
- properties:
- sales_channels:
- type: array
- items:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: >-
+ #/components/schemas/AdminPublishableApiKeysListSalesChannelsRes
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13102,10 +12492,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13179,10 +12566,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_key:
- $ref: '#/components/schemas/PublishableApiKey'
+ $ref: '#/components/schemas/AdminPublishableApiKeysRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13255,10 +12639,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13332,10 +12713,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13408,10 +12786,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13499,10 +12874,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13593,21 +12965,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- regions:
- type: array
- items:
- $ref: '#/components/schemas/Region'
- 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/AdminRegionsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13667,19 +13025,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Region.
- object:
- type: string
- description: The type of the object that was deleted.
- default: region
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminRegionsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13738,10 +13084,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13813,10 +13156,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13876,22 +13216,8 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- fulfillment_options:
- type: array
- items:
- properties:
- provider_id:
- type: string
- description: ID of the fulfillment provider
- options:
- type: array
- description: fulfillment provider options
- example:
- - id: manual-fulfillment
- - id: manual-fulfillment-return
- is_return: true
+ $ref: >-
+ #/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -13960,10 +13286,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14030,10 +13353,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/AdminRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14094,6 +13414,249 @@ paths:
- cookie_auth: []
tags:
- Region
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminRegionsRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ /reservations:
+ post:
+ operationId: PostReservations
+ summary: Creates a Reservation
+ description: >-
+ Creates a Reservation which can be associated with any resource as
+ required.
+ x-authenticated: true
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.create({
+
+ })
+
+ .then(({ reservations }) => {
+ console.log(reservations.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/reservations' \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "resource_id": "{resource_id}",
+ "resource_type": "order",
+ "value": "We delivered this order"
+ }'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ get:
+ operationId: GetReservations
+ summary: List Reservations
+ description: Retrieve a list of Reservations.
+ x-authenticated: true
+ parameters:
+ - in: query
+ name: location_id
+ style: form
+ explode: false
+ description: Location ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: inventory_item_id
+ style: form
+ explode: false
+ description: Inventory Item ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: line_item_id
+ style: form
+ explode: false
+ description: Line Item ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: quantity
+ description: Filter by reservation quantity
+ schema:
+ type: object
+ properties:
+ lt:
+ type: number
+ description: filter by reservation quantity less than this number
+ gt:
+ type: number
+ description: filter by reservation quantity greater than this number
+ lte:
+ type: number
+ description: >-
+ filter by reservation quantity less than or equal to this
+ number
+ gte:
+ type: number
+ description: >-
+ filter by reservation quantity greater than or equal to this
+ number
+ - in: query
+ name: offset
+ description: How many Reservations to skip in the result.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: limit
+ description: Limit the number of Reservations returned.
+ schema:
+ type: integer
+ default: 20
+ - 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
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/admin/product-categories' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminGetReservationReservationsReq'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ '/reservations/{id}':
+ delete:
+ operationId: DeleteReservationsReservation
+ summary: Delete a Reservation
+ description: Deletes a Reservation.
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the Reservation to delete.
+ schema:
+ type: string
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.delete(reservation.id)
+
+ .then(({ id, object, deleted }) => {
+ console.log(id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request DELETE
+ 'https://medusa-url.com/admin/reservations/{id}' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
responses:
'200':
description: OK
@@ -14102,8 +13665,150 @@ paths:
schema:
type: object
properties:
- region:
- $ref: '#/components/schemas/Region'
+ id:
+ type: string
+ description: The ID of the deleted Reservation.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: reservation
+ deleted:
+ type: boolean
+ description: Whether or not the Reservation was deleted.
+ default: true
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ get:
+ operationId: GetReservationsReservation
+ summary: Get a Reservation
+ description: Retrieves a single reservation using its id
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the reservation to retrieve.
+ schema:
+ type: string
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.retrieve(reservation_id)
+
+ .then(({ reservation }) => {
+ console.log(reservation.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/admin/reservations/{id}' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ post:
+ operationId: PostReservationsReservation
+ summary: Updates a Reservation
+ description: >-
+ Updates a Reservation which can be associated with any resource as
+ required.
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the Reservation to update.
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReservationReq'
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.admin.reservations.update(reservation.id, {
+ quantity: 3
+ })
+
+ .then(({ reservations }) => {
+ console.log(reservations.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request POST
+ 'https://medusa-url.com/admin/reservations/{id}' \
+
+ --header 'Authorization: Bearer {api_token}' \
+
+ --header 'Content-Type: application/json' \
+
+ --data-raw '{
+ "quantity": 3,
+ }'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdminPostReservationsReq'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14171,10 +13876,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14226,12 +13928,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reasons:
- type: array
- items:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14291,19 +13988,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted return reason
- object:
- type: string
- description: The type of the object that was deleted.
- default: return_reason
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminReturnReasonsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14362,10 +14047,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14437,10 +14119,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/AdminReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14499,10 +14178,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/AdminReturnsCancelRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14567,21 +14243,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- returns:
- type: array
- items:
- $ref: '#/components/schemas/Return'
- 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/AdminReturnsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14665,10 +14327,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return:
- $ref: '#/components/schemas/Return'
+ $ref: '#/components/schemas/AdminReturnsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14750,10 +14409,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14834,10 +14490,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14911,10 +14564,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -14987,19 +14637,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the removed stock location from a sales channel
- object:
- type: string
- description: The type of the object that was removed.
- default: stock-location
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminSalesChannelsDeleteLocationRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15066,10 +14704,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15239,21 +14874,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channels:
- type: array
- items:
- $ref: '#/components/schemas/SalesChannel'
- 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/AdminSalesChannelsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15313,19 +14934,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted sales channel
- object:
- type: string
- description: The type of the object that was deleted.
- default: sales-channel
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminSalesChannelsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15384,10 +14993,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15459,10 +15065,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: '#/components/schemas/SalesChannel'
+ $ref: '#/components/schemas/AdminSalesChannelsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15537,10 +15140,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/AdminShippingOptionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15608,15 +15208,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: '#/components/schemas/ShippingOption'
- count:
- type: integer
- description: The total number of items available
+ $ref: '#/components/schemas/AdminShippingOptionsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15676,19 +15268,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping-option
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminShippingOptionsDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15747,10 +15327,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/AdminShippingOptionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15834,10 +15411,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/AdminShippingOptionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15903,10 +15477,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15958,12 +15529,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profiles:
- type: array
- items:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16023,19 +15589,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Profile.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping_profile
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminDeleteShippingProfileRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16094,10 +15648,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16168,10 +15719,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: '#/components/schemas/ShippingProfile'
+ $ref: '#/components/schemas/AdminShippingProfilesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16249,10 +15797,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: '#/components/schemas/StockLocationDTO'
+ $ref: '#/components/schemas/AdminStockLocationsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16412,21 +15957,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_locations:
- type: array
- items:
- $ref: '#/components/schemas/StockLocationDTO'
- 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/AdminStockLocationsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16496,10 +16027,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: '#/components/schemas/StockLocationDTO'
+ $ref: '#/components/schemas/AdminStockLocationsRes'
post:
operationId: PostStockLocationsStockLocation
summary: Update a Stock Location
@@ -16569,10 +16097,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: '#/components/schemas/StockLocationDTO'
+ $ref: '#/components/schemas/AdminStockLocationsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16635,10 +16160,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16700,10 +16222,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16754,10 +16273,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16822,10 +16338,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: '#/components/schemas/Store'
+ $ref: '#/components/schemas/AdminStoresRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16878,12 +16391,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_providers:
- type: array
- items:
- $ref: '#/components/schemas/PaymentProvider'
+ $ref: '#/components/schemas/AdminPaymentProvidersList'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -16936,12 +16444,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_providers:
- type: array
- items:
- $ref: '#/components/schemas/TaxProvider'
+ $ref: '#/components/schemas/AdminTaxProvidersList'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17001,10 +16504,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/AdminSwapsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17068,21 +16568,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swaps:
- type: array
- items:
- $ref: '#/components/schemas/Swap'
- 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/AdminSwapsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17177,10 +16663,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17274,10 +16757,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17372,10 +16852,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17469,10 +16946,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17568,10 +17042,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17667,10 +17138,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17759,10 +17227,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17888,21 +17353,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rates:
- type: array
- items:
- $ref: '#/components/schemas/TaxRate'
- 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/AdminTaxRatesListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -17962,19 +17413,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: tax-rate
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminTaxRatesDeleteRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18051,10 +17490,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18144,10 +17580,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: '#/components/schemas/TaxRate'
+ $ref: '#/components/schemas/AdminTaxRatesRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18217,17 +17650,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- uploads:
- type: array
- items:
- type: object
- properties:
- url:
- type: string
- description: The URL of the uploaded file.
- format: uri
+ $ref: '#/components/schemas/AdminUploadsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18297,17 +17720,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- uploads:
- type: array
- items:
- type: object
- properties:
- url:
- type: string
- description: The URL of the uploaded file.
- format: uri
+ $ref: '#/components/schemas/AdminUploadsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18372,19 +17785,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The file key of the upload deleted
- object:
- type: string
- description: The type of the object that was deleted.
- default: file
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminDeleteUploadsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18450,11 +17851,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- download_url:
- type: string
- description: The Download URL of the file
+ $ref: '#/components/schemas/AdminUploadsDownloadUrlRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18522,10 +17919,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18575,12 +17969,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- users:
- type: array
- items:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUsersListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18640,19 +18029,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted user.
- object:
- type: string
- description: The type of the object that was deleted.
- default: user
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: '#/components/schemas/AdminDeleteUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18711,10 +18088,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18786,10 +18160,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -18923,10 +18294,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/AdminUserRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -19071,21 +18439,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variants:
- type: array
- items:
- $ref: '#/components/schemas/ProductVariant'
- 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/AdminVariantsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -23100,6 +22454,41 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ProductVariantInventoryItem:
+ title: Product Variant Inventory Item
+ description: >-
+ Product Variant Inventory Items link variants with inventory items and
+ denote the number of inventory items constituting a variant.
+ type: object
+ properties:
+ id:
+ type: string
+ description: The product variant inventory item's ID
+ example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+ inventory_item_id:
+ description: The id of the inventory item
+ type: string
+ variant_id:
+ description: The id of the variant.
+ type: string
+ required_quantity:
+ description: >-
+ The quantity of an inventory item required for one quantity of the
+ variant.
+ type: integer
+ default: 1
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
ProductVariant:
title: Product Variant
description: >-
@@ -23257,46 +22646,6 @@ components:
description: An optional key-value map with additional details
example:
car: white
- ProductVariantPricesFields:
- title: Product Variant Prices Fields
- description: Product Variants Prices Fields that are only available in some requests.
- type: object
- properties:
- original_price:
- type: number
- description: >-
- The original price of the variant without any discounted prices
- applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
Product:
title: Product
description: >-
@@ -24821,6 +24170,98 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ReservationItemDTO:
+ title: Reservation item
+ description: Represents a reservation of an inventory item at a stock location
+ type: object
+ required:
+ - id
+ - location_id
+ - inventory_item_id
+ - quantity
+ properties:
+ id:
+ description: The id of the reservation item
+ type: string
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ inventory_item_id:
+ description: The id of the inventory item the reservation relates to
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ type: object
+ description: An optional key-value map with additional details
+ example:
+ car: white
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
+ PricedVariant:
+ title: Priced Product Variant
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/ProductVariant'
+ - type: object
+ properties:
+ original_price:
+ type: number
+ description: >-
+ The original price of the variant without any discounted prices
+ applied.
+ calculated_price:
+ type: number
+ description: The calculated price of the variant. Can be a discounted price.
+ original_price_incl_tax:
+ type: number
+ description: The original price of the variant including taxes.
+ calculated_price_incl_tax:
+ type: number
+ description: The calculated price of the variant including taxes.
+ original_tax:
+ type: number
+ description: The taxes applied on the original price.
+ calculated_tax:
+ type: number
+ description: The taxes applied on the calculated price.
+ tax_rates:
+ type: array
+ description: An array of applied tax rates
+ items:
+ type: object
+ properties:
+ rate:
+ type: number
+ description: The tax rate value
+ name:
+ type: string
+ description: The name of the tax rate
+ code:
+ type: string
+ description: The code of the tax rate
+ PricedProduct:
+ title: Priced Product
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/Product'
+ - type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedVariant'
StockLocationAddressDTO:
title: Stock Location Address
description: Represents a Stock Location Address
@@ -25053,6 +24494,18 @@ components:
code:
type: string
description: The code for the generated token.
+ AdminAppsRes:
+ type: object
+ properties:
+ apps:
+ $ref: '#/components/schemas/OAuth'
+ AdminAppsListRes:
+ type: object
+ properties:
+ apps:
+ type: array
+ items:
+ $ref: '#/components/schemas/OAuth'
AdminPostAuthReq:
type: object
required:
@@ -25067,6 +24520,11 @@ components:
type: string
description: The User's password.
format: password
+ AdminAuthRes:
+ type: object
+ properties:
+ user:
+ $ref: '#/components/schemas/User'
AdminPostBatchesReq:
type: object
required:
@@ -25104,6 +24562,27 @@ components:
Set a batch job in dry_run mode to get some information on what will
be done without applying any modifications.
default: false
+ AdminBatchJobRes:
+ type: object
+ properties:
+ batch_job:
+ $ref: '#/components/schemas/BatchJob'
+ AdminBatchJobListRes:
+ type: object
+ properties:
+ batch_jobs:
+ type: array
+ items:
+ $ref: '#/components/schemas/BatchJob'
+ 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
AdminPostProductsToCollectionReq:
type: object
required:
@@ -25131,6 +24610,57 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminCollectionsListRes:
+ type: object
+ properties:
+ collections:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductCollection'
+ 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
+ AdminCollectionsDeleteRes:
+ 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
+ AdminDeleteProductsFromCollectionRes:
+ 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
+ AdminCollectionsRes:
+ type: object
+ properties:
+ collection:
+ $ref: '#/components/schemas/ProductCollection'
AdminDeleteProductsFromCollectionReq:
type: object
required:
@@ -25156,6 +24686,27 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminCurrenciesListRes:
+ type: object
+ properties:
+ currencies:
+ type: array
+ items:
+ $ref: '#/components/schemas/Currency'
+ 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
+ AdminCurrenciesRes:
+ type: object
+ properties:
+ currency:
+ $ref: '#/components/schemas/Currency'
AdminPostCurrenciesCurrencyReq:
type: object
properties:
@@ -25192,6 +24743,41 @@ components:
id:
description: ID of the customer
type: string
+ AdminCustomerGroupsRes:
+ type: object
+ properties:
+ customer_group:
+ $ref: '#/components/schemas/CustomerGroup'
+ AdminCustomerGroupsDeleteRes:
+ 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
+ AdminCustomerGroupsListRes:
+ type: object
+ properties:
+ customer_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomerGroup'
+ 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
AdminPostCustomerGroupsGroupReq:
type: object
properties:
@@ -25229,6 +24815,27 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminCustomersRes:
+ type: object
+ properties:
+ customer:
+ $ref: '#/components/schemas/Customer'
+ AdminCustomersListRes:
+ type: object
+ properties:
+ customers:
+ type: array
+ items:
+ $ref: '#/components/schemas/Customer'
+ 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
AdminPostCustomersCustomerReq:
type: object
properties:
@@ -25467,6 +25074,63 @@ components:
id:
description: The id of the item
type: string
+ AdminDiscountsRes:
+ type: object
+ properties:
+ discount:
+ $ref: '#/components/schemas/Discount'
+ AdminDiscountConditionsRes:
+ type: object
+ properties:
+ discount_condition:
+ $ref: '#/components/schemas/DiscountCondition'
+ AdminDiscountsDeleteRes:
+ 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
+ AdminDiscountConditionsDeleteRes:
+ 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'
+ AdminDiscountsListRes:
+ type: object
+ properties:
+ discounts:
+ type: array
+ items:
+ $ref: '#/components/schemas/Discount'
+ 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
AdminPostDiscountsDiscountConditionsCondition:
type: object
properties:
@@ -25735,6 +25399,46 @@ components:
The optional key-value map with additional details about the Line
Item.
type: object
+ AdminPostDraftOrdersDraftOrderRegisterPaymentRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
+ AdminDraftOrdersRes:
+ type: object
+ properties:
+ draft_order:
+ $ref: '#/components/schemas/DraftOrder'
+ AdminDraftOrdersDeleteRes:
+ 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
+ AdminDraftOrdersListRes:
+ type: object
+ properties:
+ draft_orders:
+ type: array
+ items:
+ $ref: '#/components/schemas/DraftOrder'
+ 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
AdminPostDraftOrdersDraftOrderReq:
type: object
properties:
@@ -25821,6 +25525,41 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminGiftCardsRes:
+ type: object
+ properties:
+ gift_card:
+ $ref: '#/components/schemas/GiftCard'
+ AdminGiftCardsDeleteRes:
+ 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
+ AdminGiftCardsListRes:
+ type: object
+ properties:
+ gift_cards:
+ type: array
+ items:
+ $ref: '#/components/schemas/GiftCard'
+ 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
AdminPostGiftCardsGiftCardReq:
type: object
properties:
@@ -25886,6 +25625,27 @@ components:
- admin
- member
- developer
+ AdminInviteDeleteRes:
+ 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.
+ default: invite
+ deleted:
+ type: boolean
+ description: Whether or not the Invite was deleted.
+ default: true
+ AdminListInvitesRes:
+ type: object
+ properties:
+ invites:
+ type: array
+ items:
+ $ref: '#/components/schemas/Invite'
AdminPostNotesReq:
type: object
required:
@@ -25902,6 +25662,41 @@ components:
value:
type: string
description: The content of the Note to create.
+ AdminNotesRes:
+ type: object
+ properties:
+ note:
+ $ref: '#/components/schemas/Note'
+ AdminNotesDeleteRes:
+ 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
+ AdminNotesListRes:
+ type: object
+ properties:
+ notes:
+ type: array
+ items:
+ $ref: '#/components/schemas/Note'
+ 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
AdminPostNotesNoteReq:
type: object
required:
@@ -25910,6 +25705,18 @@ components:
value:
type: string
description: The updated description of the Note.
+ AdminNotificationsListRes:
+ type: object
+ properties:
+ notifications:
+ type: array
+ items:
+ $ref: '#/components/schemas/Notification'
+ AdminNotificationsRes:
+ type: object
+ properties:
+ notification:
+ $ref: '#/components/schemas/Notification'
AdminPostNotificationsNotificationResendReq:
type: object
properties:
@@ -25944,6 +25751,55 @@ components:
internal_note:
description: An optional note to create for the order edit.
type: string
+ AdminOrderEditsRes:
+ type: object
+ properties:
+ order_edit:
+ $ref: '#/components/schemas/OrderEdit'
+ AdminOrderEditsListRes:
+ type: object
+ properties:
+ order_edits:
+ type: array
+ items:
+ $ref: '#/components/schemas/OrderEdit'
+ 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
+ AdminOrderEditDeleteRes:
+ 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.
+ default: order_edit
+ deleted:
+ type: boolean
+ description: Whether or not the Order Edit was deleted.
+ default: true
+ AdminOrderEditItemChangeDeleteRes:
+ 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.
+ default: item_change
+ deleted:
+ type: boolean
+ description: Whether or not the Order Edit Item Change was deleted.
+ default: true
AdminPostOrderEditsEditLineItemsLineItemReq:
type: object
required:
@@ -26105,6 +25961,17 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminOrdersOrderLineItemReservationReq:
+ type: object
+ required:
+ - location_id
+ properties:
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ quantity:
+ description: The quantity to reserve
+ type: number
AdminPostOrdersOrderShipmentReq:
type: object
required:
@@ -26233,6 +26100,27 @@ components:
no_notification:
description: If set to true no notification will be send related to this Claim.
type: boolean
+ AdminOrdersRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
+ AdminOrdersListRes:
+ type: object
+ properties:
+ orders:
+ type: array
+ items:
+ $ref: '#/components/schemas/Order'
+ 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
AdminPostOrdersOrderRefundsReq:
type: object
required:
@@ -26452,6 +26340,25 @@ components:
A flag to indicate if no notifications should be emitted related to
the updated order.
type: boolean
+ AdminPaymentCollectionsRes:
+ type: object
+ properties:
+ payment_collection:
+ $ref: '#/components/schemas/PaymentCollection'
+ AdminPaymentCollectionDeleteRes:
+ 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.
+ default: payment_collection
+ deleted:
+ type: boolean
+ description: Whether or not the Payment Collection was deleted.
+ default: true
AdminUpdatePaymentCollectionsReq:
type: object
properties:
@@ -26461,6 +26368,16 @@ components:
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
+ AdminPaymentRes:
+ type: object
+ properties:
+ payment:
+ $ref: '#/components/schemas/Payment'
+ AdminRefundRes:
+ type: object
+ properties:
+ refund:
+ $ref: '#/components/schemas/Refund'
AdminPostPaymentRefundsReq:
type: object
required:
@@ -26608,6 +26525,105 @@ components:
type: array
items:
type: string
+ AdminPriceListRes:
+ type: object
+ properties:
+ price_list:
+ $ref: '#/components/schemas/PriceList'
+ AdminPriceListDeleteBatchRes:
+ 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
+ AdminPriceListDeleteProductPricesRes:
+ 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
+ AdminPriceListDeleteVariantPricesRes:
+ 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
+ AdminPriceListDeleteRes:
+ 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
+ AdminPriceListsListRes:
+ type: object
+ properties:
+ price_lists:
+ type: array
+ items:
+ $ref: '#/components/schemas/PriceList'
+ 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
+ AdminPriceListsProductsListRes:
+ type: object
+ properties:
+ products:
+ type: array
+ items:
+ $ref: '#/components/schemas/Product'
+ 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
AdminPostPriceListsPriceListPriceListReq:
type: object
properties:
@@ -26708,6 +26724,56 @@ components:
parent_category_id:
type: string
description: The ID of the parent product category
+ AdminPostProductCategoriesCategoryReq:
+ type: object
+ properties:
+ name:
+ type: string
+ description: The name to identify the Product Category by.
+ handle:
+ type: string
+ description: A handle to be used in slugs.
+ is_internal:
+ type: boolean
+ description: A flag to make product category an internal category for admins
+ is_active:
+ type: boolean
+ description: A flag to make product category visible/hidden in the store front
+ parent_category_id:
+ type: string
+ description: The ID of the parent product category
+ AdminProductTagsListRes:
+ type: object
+ properties:
+ product_tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductTag'
+ 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
+ AdminProductTypesListRes:
+ type: object
+ properties:
+ product_types:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductType'
+ 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
AdminPostProductsProductOptionsReq:
type: object
required:
@@ -26982,6 +27048,7 @@ components:
Whether Medusa should keep track of the inventory for this Product
Variant.
type: boolean
+ default: true
weight:
description: The wieght of the Product Variant.
type: number
@@ -27050,6 +27117,114 @@ components:
value:
description: The value to give for the Product Option.
type: string
+ AdminProductsDeleteOptionRes:
+ 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'
+ AdminProductsDeleteVariantRes:
+ 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: product-variant
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ product:
+ $ref: '#/components/schemas/Product'
+ AdminProductsDeleteRes:
+ 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
+ AdminProductsListRes:
+ type: object
+ properties:
+ products:
+ type: array
+ items:
+ oneOf:
+ - $ref: '#/components/schemas/Product'
+ - $ref: '#/components/schemas/PricedProduct'
+ 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
+ AdminProductsListVariantsRes:
+ type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductVariant'
+ 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
+ AdminProductsListTypesRes:
+ type: object
+ properties:
+ types:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductType'
+ AdminProductsListTagsRes:
+ 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
+ AdminProductsRes:
+ type: object
+ properties:
+ product:
+ $ref: '#/components/schemas/Product'
AdminPostProductsProductMetadataReq:
type: object
required:
@@ -27422,6 +27597,48 @@ components:
id:
type: string
description: The ID of the sales channel
+ AdminPublishableApiKeysRes:
+ type: object
+ properties:
+ publishable_api_key:
+ $ref: '#/components/schemas/PublishableApiKey'
+ AdminPublishableApiKeysListRes:
+ type: object
+ properties:
+ publishable_api_keys:
+ type: array
+ items:
+ $ref: '#/components/schemas/PublishableApiKey'
+ 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
+ AdminPublishableApiKeyDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted PublishableApiKey.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: publishable_api_key
+ deleted:
+ type: boolean
+ description: Whether the PublishableApiKeys was deleted.
+ default: true
+ AdminPublishableApiKeysListSalesChannelsRes:
+ type: object
+ properties:
+ sales_channels:
+ type: array
+ items:
+ $ref: '#/components/schemas/SalesChannel'
AdminPostPublishableApiKeysPublishableApiKeyReq:
type: object
properties:
@@ -27505,6 +27722,59 @@ components:
includes_tax:
description: '[EXPERIMENTAL] Tax included in prices of region'
type: boolean
+ AdminRegionsRes:
+ type: object
+ properties:
+ region:
+ $ref: '#/components/schemas/Region'
+ AdminRegionsListRes:
+ type: object
+ properties:
+ regions:
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
+ 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
+ AdminRegionsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Region.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: region
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminGetRegionsRegionFulfillmentOptionsRes:
+ type: object
+ properties:
+ fulfillment_options:
+ type: array
+ items:
+ type: object
+ properties:
+ provider_id:
+ type: string
+ description: ID of the fulfillment provider
+ options:
+ type: array
+ description: fulfillment provider options
+ example:
+ - id: manual-fulfillment
+ - id: manual-fulfillment-return
+ is_return: true
AdminPostRegionsRegionReq:
type: object
properties:
@@ -27560,6 +27830,41 @@ components:
type: array
items:
type: string
+ AdminPostReservationsReq:
+ type: object
+ required:
+ - reservation
+ properties:
+ reservation:
+ $ref: '#/components/schemas/ReservationItemDTO'
+ AdminGetReservationReservationsReq:
+ type: object
+ properties:
+ reservations:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReservationItemDTO'
+ 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
+ AdminPostReservationsReservationReq:
+ type: object
+ properties:
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ description: An optional set of key-value pairs with additional information.
+ type: object
AdminPostReturnReasonsReq:
type: object
required:
@@ -27583,6 +27888,32 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminReturnReasonsRes:
+ type: object
+ properties:
+ return_reason:
+ $ref: '#/components/schemas/ReturnReason'
+ AdminReturnReasonsListRes:
+ type: object
+ properties:
+ return_reasons:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReturnReason'
+ AdminReturnReasonsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted return reason
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: return_reason
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
AdminPostReturnReasonsReasonReq:
type: object
properties:
@@ -27600,6 +27931,32 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminReturnsCancelRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
+ AdminReturnsListRes:
+ type: object
+ properties:
+ returns:
+ type: array
+ items:
+ $ref: '#/components/schemas/Return'
+ 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
+ AdminReturnsRes:
+ type: object
+ properties:
+ return:
+ $ref: '#/components/schemas/Return'
AdminPostReturnsReturnReceiveReq:
type: object
required:
@@ -27676,6 +28033,55 @@ components:
id:
description: The ID of a product
type: string
+ AdminSalesChannelsRes:
+ type: object
+ properties:
+ sales_channel:
+ $ref: '#/components/schemas/SalesChannel'
+ AdminSalesChannelsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted sales channel
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: sales-channel
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminSalesChannelsDeleteLocationRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the removed stock location from a sales channel
+ object:
+ type: string
+ description: The type of the object that was removed.
+ default: stock-location
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminSalesChannelsListRes:
+ type: object
+ properties:
+ sales_channels:
+ type: array
+ items:
+ $ref: '#/components/schemas/SalesChannel'
+ 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
AdminDeleteSalesChannelsChannelStockLocationsReq:
type: object
required:
@@ -27764,6 +28170,35 @@ components:
includes_tax:
description: '[EXPERIMENTAL] Tax included in prices of shipping option'
type: boolean
+ AdminShippingOptionsListRes:
+ type: object
+ properties:
+ shipping_options:
+ type: array
+ items:
+ $ref: '#/components/schemas/ShippingOption'
+ count:
+ type: integer
+ description: The total number of items available
+ AdminShippingOptionsRes:
+ type: object
+ properties:
+ shipping_option:
+ $ref: '#/components/schemas/ShippingOption'
+ AdminShippingOptionsDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Option.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: shipping-option
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
AdminPostShippingOptionsOptionReq:
type: object
required:
@@ -27814,6 +28249,32 @@ components:
name:
description: The name of the Shipping Profile
type: string
+ AdminDeleteShippingProfileRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Profile.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: shipping_profile
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminShippingProfilesRes:
+ type: object
+ properties:
+ shipping_profile:
+ $ref: '#/components/schemas/ShippingProfile'
+ AdminShippingProfilesListRes:
+ type: object
+ properties:
+ shipping_profiles:
+ type: array
+ items:
+ $ref: '#/components/schemas/ShippingProfile'
AdminPostShippingProfilesProfileReq:
type: object
properties:
@@ -27838,6 +28299,27 @@ components:
car: white
address:
$ref: '#/components/schemas/StockLocationAddressInput'
+ AdminStockLocationsRes:
+ type: object
+ properties:
+ stock_location:
+ $ref: '#/components/schemas/StockLocationDTO'
+ AdminStockLocationsListRes:
+ type: object
+ properties:
+ stock_locations:
+ type: array
+ items:
+ $ref: '#/components/schemas/StockLocationDTO'
+ 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
AdminPostStockLocationsLocationReq:
type: object
properties:
@@ -27854,6 +28336,25 @@ components:
car: white
address:
$ref: '#/components/schemas/StockLocationAddressInput'
+ AdminStoresRes:
+ type: object
+ properties:
+ store:
+ $ref: '#/components/schemas/Store'
+ AdminTaxProvidersList:
+ type: object
+ properties:
+ tax_providers:
+ type: array
+ items:
+ $ref: '#/components/schemas/TaxProvider'
+ AdminPaymentProvidersList:
+ type: object
+ properties:
+ payment_providers:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentProvider'
AdminPostStoreReq:
type: object
properties:
@@ -27889,6 +28390,27 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminSwapsListRes:
+ type: object
+ properties:
+ swaps:
+ type: array
+ items:
+ $ref: '#/components/schemas/Swap'
+ 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
+ AdminSwapsRes:
+ type: object
+ properties:
+ swap:
+ $ref: '#/components/schemas/Swap'
AdminPostTaxRatesTaxRateProductTypesReq:
type: object
required:
@@ -27953,6 +28475,41 @@ components:
description: The IDs of the types of products associated with this tax rate
items:
type: string
+ AdminTaxRatesDeleteRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Option.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: tax-rate
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminTaxRatesListRes:
+ type: object
+ properties:
+ tax_rates:
+ type: array
+ items:
+ $ref: '#/components/schemas/TaxRate'
+ 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
+ AdminTaxRatesRes:
+ type: object
+ properties:
+ tax_rate:
+ $ref: '#/components/schemas/TaxRate'
AdminDeleteTaxRatesTaxRateProductTypesReq:
type: object
required:
@@ -28033,6 +28590,38 @@ components:
file_key:
description: key of the file to obtain the download link for
type: string
+ AdminUploadsRes:
+ type: object
+ properties:
+ uploads:
+ type: array
+ items:
+ type: object
+ properties:
+ url:
+ type: string
+ description: The URL of the uploaded file.
+ format: uri
+ AdminDeleteUploadsRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The file key of the upload deleted
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: file
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ AdminUploadsDownloadUrlRes:
+ type: object
+ properties:
+ download_url:
+ type: string
+ description: The Download URL of the file
AdminCreateUserRequest:
type: object
required:
@@ -28060,6 +28649,32 @@ components:
description: The Users password.
type: string
format: password
+ AdminUserRes:
+ type: object
+ properties:
+ user:
+ $ref: '#/components/schemas/User'
+ AdminUsersListRes:
+ type: object
+ properties:
+ users:
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
+ AdminDeleteUserRes:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted user.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: user
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
AdminResetPasswordTokenRequest:
type: object
required:
@@ -28108,3 +28723,19 @@ components:
metadata:
description: An optional set of key-value pairs with additional information.
type: object
+ AdminVariantsListRes:
+ type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductVariant'
+ 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
diff --git a/docs/api/admin/code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/postundefined b/docs/api/admin/code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/postundefined
new file mode 100644
index 0000000000..4c75d1a71e
--- /dev/null
+++ b/docs/api/admin/code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/postundefined
@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.orders.createReservation(order_id, line_item_id, {
+ location_id
+})
+.then(({ reservation }) => {
+ console.log(reservation.id);
+});
diff --git a/docs/api/admin/code_samples/JavaScript/orders_{id}_reservations/getundefined b/docs/api/admin/code_samples/JavaScript/orders_{id}_reservations/getundefined
new file mode 100644
index 0000000000..5e6366e2a6
--- /dev/null
+++ b/docs/api/admin/code_samples/JavaScript/orders_{id}_reservations/getundefined
@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.orders.retrieveReservations(order_id)
+.then(({ reservations }) => {
+ console.log(reservations[0].id);
+});
diff --git a/docs/api/admin/code_samples/JavaScript/reservations/postundefined b/docs/api/admin/code_samples/JavaScript/reservations/postundefined
new file mode 100644
index 0000000000..380666feb8
--- /dev/null
+++ b/docs/api/admin/code_samples/JavaScript/reservations/postundefined
@@ -0,0 +1,8 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.create({
+})
+.then(({ reservations }) => {
+ console.log(reservations.id);
+});
diff --git a/docs/api/admin/code_samples/JavaScript/reservations_{id}/deleteundefined b/docs/api/admin/code_samples/JavaScript/reservations_{id}/deleteundefined
new file mode 100644
index 0000000000..82df0d5cf3
--- /dev/null
+++ b/docs/api/admin/code_samples/JavaScript/reservations_{id}/deleteundefined
@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.delete(reservation.id)
+.then(({ id, object, deleted }) => {
+ console.log(id);
+});
diff --git a/docs/api/admin/code_samples/JavaScript/reservations_{id}/getundefined b/docs/api/admin/code_samples/JavaScript/reservations_{id}/getundefined
new file mode 100644
index 0000000000..88002aba3b
--- /dev/null
+++ b/docs/api/admin/code_samples/JavaScript/reservations_{id}/getundefined
@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.retrieve(reservation_id)
+.then(({ reservation }) => {
+ console.log(reservation.id);
+});
diff --git a/docs/api/admin/code_samples/JavaScript/reservations_{id}/postundefined b/docs/api/admin/code_samples/JavaScript/reservations_{id}/postundefined
new file mode 100644
index 0000000000..ea5604352a
--- /dev/null
+++ b/docs/api/admin/code_samples/JavaScript/reservations_{id}/postundefined
@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.update(reservation.id, {
+ quantity: 3
+})
+.then(({ reservations }) => {
+ console.log(reservations.id);
+});
diff --git a/docs/api/admin/code_samples/Shell/orders_{id}_line-items_{line_item_id}_reserve/postundefined b/docs/api/admin/code_samples/Shell/orders_{id}_line-items_{line_item_id}_reserve/postundefined
new file mode 100644
index 0000000000..4fb8ce478d
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/orders_{id}_line-items_{line_item_id}_reserve/postundefined
@@ -0,0 +1,6 @@
+curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "location_id": "loc_1"
+}'
diff --git a/docs/api/admin/code_samples/Shell/orders_{id}_reservations/getundefined b/docs/api/admin/code_samples/Shell/orders_{id}_reservations/getundefined
new file mode 100644
index 0000000000..355ebe1f6a
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/orders_{id}_reservations/getundefined
@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/admin/orders/{id}/reservations' \
+--header 'Authorization: Bearer {api_token}'
diff --git a/docs/api/admin/code_samples/Shell/product-categories_{id}/postundefined b/docs/api/admin/code_samples/Shell/product-categories_{id}/postundefined
new file mode 100644
index 0000000000..1df1e616fc
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/product-categories_{id}/postundefined
@@ -0,0 +1,6 @@
+curl --location --request POST 'https://medusa-url.com/admin/product-categories/{id}' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "name": "Skinny Jeans"
+}'
diff --git a/docs/api/admin/code_samples/Shell/reservations/getundefined b/docs/api/admin/code_samples/Shell/reservations/getundefined
new file mode 100644
index 0000000000..babbcf3733
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/reservations/getundefined
@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/admin/product-categories' \
+--header 'Authorization: Bearer {api_token}'
diff --git a/docs/api/admin/code_samples/Shell/reservations/postundefined b/docs/api/admin/code_samples/Shell/reservations/postundefined
new file mode 100644
index 0000000000..4246a90ec4
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/reservations/postundefined
@@ -0,0 +1,8 @@
+curl --location --request POST 'https://medusa-url.com/admin/reservations' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "resource_id": "{resource_id}",
+ "resource_type": "order",
+ "value": "We delivered this order"
+}'
diff --git a/docs/api/admin/code_samples/Shell/reservations_{id}/deleteundefined b/docs/api/admin/code_samples/Shell/reservations_{id}/deleteundefined
new file mode 100644
index 0000000000..f4e05512e9
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/reservations_{id}/deleteundefined
@@ -0,0 +1,2 @@
+curl --location --request DELETE 'https://medusa-url.com/admin/reservations/{id}' \
+--header 'Authorization: Bearer {api_token}'
diff --git a/docs/api/admin/code_samples/Shell/reservations_{id}/getundefined b/docs/api/admin/code_samples/Shell/reservations_{id}/getundefined
new file mode 100644
index 0000000000..9b6631d783
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/reservations_{id}/getundefined
@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/admin/reservations/{id}' \
+--header 'Authorization: Bearer {api_token}'
diff --git a/docs/api/admin/code_samples/Shell/reservations_{id}/postundefined b/docs/api/admin/code_samples/Shell/reservations_{id}/postundefined
new file mode 100644
index 0000000000..9d8e841f56
--- /dev/null
+++ b/docs/api/admin/code_samples/Shell/reservations_{id}/postundefined
@@ -0,0 +1,6 @@
+curl --location --request POST 'https://medusa-url.com/admin/reservations/{id}' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "quantity": 3,
+}'
diff --git a/docs/api/admin/components/schemas/AdminAppsListRes.yaml b/docs/api/admin/components/schemas/AdminAppsListRes.yaml
new file mode 100644
index 0000000000..a9759828fe
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminAppsListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ apps:
+ type: array
+ items:
+ $ref: ./OAuth.yaml
diff --git a/docs/api/admin/components/schemas/AdminAppsRes.yaml b/docs/api/admin/components/schemas/AdminAppsRes.yaml
new file mode 100644
index 0000000000..2212cbec78
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminAppsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ apps:
+ $ref: ./OAuth.yaml
diff --git a/docs/api/admin/components/schemas/AdminAuthRes.yaml b/docs/api/admin/components/schemas/AdminAuthRes.yaml
new file mode 100644
index 0000000000..34a02f7ad2
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminAuthRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ user:
+ $ref: ./User.yaml
diff --git a/docs/api/admin/components/schemas/AdminBatchJobListRes.yaml b/docs/api/admin/components/schemas/AdminBatchJobListRes.yaml
new file mode 100644
index 0000000000..c947b772d2
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminBatchJobListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ batch_jobs:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminBatchJobRes.yaml b/docs/api/admin/components/schemas/AdminBatchJobRes.yaml
new file mode 100644
index 0000000000..1d742c861a
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminBatchJobRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ batch_job:
+ $ref: ./BatchJob.yaml
diff --git a/docs/api/admin/components/schemas/AdminCollectionsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminCollectionsDeleteRes.yaml
new file mode 100644
index 0000000000..45db8c312b
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCollectionsDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminCollectionsListRes.yaml b/docs/api/admin/components/schemas/AdminCollectionsListRes.yaml
new file mode 100644
index 0000000000..252256786c
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCollectionsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ collections:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminCollectionsRes.yaml b/docs/api/admin/components/schemas/AdminCollectionsRes.yaml
new file mode 100644
index 0000000000..7802152206
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCollectionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ collection:
+ $ref: ./ProductCollection.yaml
diff --git a/docs/api/admin/components/schemas/AdminCurrenciesListRes.yaml b/docs/api/admin/components/schemas/AdminCurrenciesListRes.yaml
new file mode 100644
index 0000000000..7d8433a050
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCurrenciesListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ currencies:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminCurrenciesRes.yaml b/docs/api/admin/components/schemas/AdminCurrenciesRes.yaml
new file mode 100644
index 0000000000..905466e5ee
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCurrenciesRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ currency:
+ $ref: ./Currency.yaml
diff --git a/docs/api/admin/components/schemas/AdminCustomerGroupsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminCustomerGroupsDeleteRes.yaml
new file mode 100644
index 0000000000..f6ede8bd97
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCustomerGroupsDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminCustomerGroupsListRes.yaml b/docs/api/admin/components/schemas/AdminCustomerGroupsListRes.yaml
new file mode 100644
index 0000000000..9a57b834f2
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCustomerGroupsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ customer_groups:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminCustomerGroupsRes.yaml b/docs/api/admin/components/schemas/AdminCustomerGroupsRes.yaml
new file mode 100644
index 0000000000..a0f75ac4ad
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCustomerGroupsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ customer_group:
+ $ref: ./CustomerGroup.yaml
diff --git a/docs/api/admin/components/schemas/AdminCustomersListRes.yaml b/docs/api/admin/components/schemas/AdminCustomersListRes.yaml
new file mode 100644
index 0000000000..d5703c84a5
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCustomersListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ customers:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminCustomersRes.yaml b/docs/api/admin/components/schemas/AdminCustomersRes.yaml
new file mode 100644
index 0000000000..ffb6903bf2
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminCustomersRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ customer:
+ $ref: ./Customer.yaml
diff --git a/docs/api/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml b/docs/api/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml
new file mode 100644
index 0000000000..338dd63277
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml
@@ -0,0 +1,15 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminDeleteShippingProfileRes.yaml b/docs/api/admin/components/schemas/AdminDeleteShippingProfileRes.yaml
new file mode 100644
index 0000000000..c558057588
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDeleteShippingProfileRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Profile.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: shipping_profile
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminDeleteUploadsRes.yaml b/docs/api/admin/components/schemas/AdminDeleteUploadsRes.yaml
new file mode 100644
index 0000000000..1d146d2088
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDeleteUploadsRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The file key of the upload deleted
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: file
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminDeleteUserRes.yaml b/docs/api/admin/components/schemas/AdminDeleteUserRes.yaml
new file mode 100644
index 0000000000..b078d453de
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDeleteUserRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted user.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: user
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminDiscountConditionsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminDiscountConditionsDeleteRes.yaml
new file mode 100644
index 0000000000..b84ac7be83
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDiscountConditionsDeleteRes.yaml
@@ -0,0 +1,16 @@
+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: ./Discount.yaml
diff --git a/docs/api/admin/components/schemas/AdminDiscountConditionsRes.yaml b/docs/api/admin/components/schemas/AdminDiscountConditionsRes.yaml
new file mode 100644
index 0000000000..94ddc8b610
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDiscountConditionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ discount_condition:
+ $ref: ./DiscountCondition.yaml
diff --git a/docs/api/admin/components/schemas/AdminDiscountsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminDiscountsDeleteRes.yaml
new file mode 100644
index 0000000000..54add9e208
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDiscountsDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminDiscountsListRes.yaml b/docs/api/admin/components/schemas/AdminDiscountsListRes.yaml
new file mode 100644
index 0000000000..5b69366794
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDiscountsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ discounts:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminDiscountsRes.yaml b/docs/api/admin/components/schemas/AdminDiscountsRes.yaml
new file mode 100644
index 0000000000..f8d9aa73a1
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDiscountsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ discount:
+ $ref: ./Discount.yaml
diff --git a/docs/api/admin/components/schemas/AdminDraftOrdersDeleteRes.yaml b/docs/api/admin/components/schemas/AdminDraftOrdersDeleteRes.yaml
new file mode 100644
index 0000000000..219d3c80e3
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDraftOrdersDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminDraftOrdersListRes.yaml b/docs/api/admin/components/schemas/AdminDraftOrdersListRes.yaml
new file mode 100644
index 0000000000..f85c0a6b3e
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDraftOrdersListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ draft_orders:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminDraftOrdersRes.yaml b/docs/api/admin/components/schemas/AdminDraftOrdersRes.yaml
new file mode 100644
index 0000000000..e8723460e4
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminDraftOrdersRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ draft_order:
+ $ref: ./DraftOrder.yaml
diff --git a/docs/api/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml b/docs/api/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml
new file mode 100644
index 0000000000..531eb3895d
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml
@@ -0,0 +1,17 @@
+type: object
+properties:
+ fulfillment_options:
+ type: array
+ items:
+ type: object
+ properties:
+ provider_id:
+ type: string
+ description: ID of the fulfillment provider
+ options:
+ type: array
+ description: fulfillment provider options
+ example:
+ - id: manual-fulfillment
+ - id: manual-fulfillment-return
+ is_return: true
diff --git a/docs/api/admin/components/schemas/AdminGetReservationReservationsReq.yaml b/docs/api/admin/components/schemas/AdminGetReservationReservationsReq.yaml
new file mode 100644
index 0000000000..0523d76e88
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminGetReservationReservationsReq.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ reservations:
+ type: array
+ items:
+ $ref: ./ReservationItemDTO.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
diff --git a/docs/api/admin/components/schemas/AdminGiftCardsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminGiftCardsDeleteRes.yaml
new file mode 100644
index 0000000000..1076a0f9c7
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminGiftCardsDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminGiftCardsListRes.yaml b/docs/api/admin/components/schemas/AdminGiftCardsListRes.yaml
new file mode 100644
index 0000000000..d48cb2935e
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminGiftCardsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ gift_cards:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminGiftCardsRes.yaml b/docs/api/admin/components/schemas/AdminGiftCardsRes.yaml
new file mode 100644
index 0000000000..d72a7917c2
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminGiftCardsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ gift_card:
+ $ref: ./GiftCard.yaml
diff --git a/docs/api/admin/components/schemas/AdminInviteDeleteRes.yaml b/docs/api/admin/components/schemas/AdminInviteDeleteRes.yaml
new file mode 100644
index 0000000000..17dd571381
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminInviteDeleteRes.yaml
@@ -0,0 +1,13 @@
+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.
+ default: invite
+ deleted:
+ type: boolean
+ description: Whether or not the Invite was deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminListInvitesRes.yaml b/docs/api/admin/components/schemas/AdminListInvitesRes.yaml
new file mode 100644
index 0000000000..90af041322
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminListInvitesRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ invites:
+ type: array
+ items:
+ $ref: ./Invite.yaml
diff --git a/docs/api/admin/components/schemas/AdminNotesDeleteRes.yaml b/docs/api/admin/components/schemas/AdminNotesDeleteRes.yaml
new file mode 100644
index 0000000000..a0703d1f98
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminNotesDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminNotesListRes.yaml b/docs/api/admin/components/schemas/AdminNotesListRes.yaml
new file mode 100644
index 0000000000..b44cb9b77d
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminNotesListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ notes:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminNotesRes.yaml b/docs/api/admin/components/schemas/AdminNotesRes.yaml
new file mode 100644
index 0000000000..9c7d25e1b1
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminNotesRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ note:
+ $ref: ./Note.yaml
diff --git a/docs/api/admin/components/schemas/AdminNotificationsListRes.yaml b/docs/api/admin/components/schemas/AdminNotificationsListRes.yaml
new file mode 100644
index 0000000000..c5f9c490df
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminNotificationsListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ notifications:
+ type: array
+ items:
+ $ref: ./Notification.yaml
diff --git a/docs/api/admin/components/schemas/AdminNotificationsRes.yaml b/docs/api/admin/components/schemas/AdminNotificationsRes.yaml
new file mode 100644
index 0000000000..607f862759
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminNotificationsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ notification:
+ $ref: ./Notification.yaml
diff --git a/docs/api/admin/components/schemas/AdminOrderEditDeleteRes.yaml b/docs/api/admin/components/schemas/AdminOrderEditDeleteRes.yaml
new file mode 100644
index 0000000000..ea94c0111c
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminOrderEditDeleteRes.yaml
@@ -0,0 +1,13 @@
+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.
+ default: order_edit
+ deleted:
+ type: boolean
+ description: Whether or not the Order Edit was deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml b/docs/api/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml
new file mode 100644
index 0000000000..4889f74d96
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml
@@ -0,0 +1,13 @@
+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.
+ default: item_change
+ deleted:
+ type: boolean
+ description: Whether or not the Order Edit Item Change was deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminOrderEditsListRes.yaml b/docs/api/admin/components/schemas/AdminOrderEditsListRes.yaml
new file mode 100644
index 0000000000..91941a9eff
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminOrderEditsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ order_edits:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminOrderEditsRes.yaml b/docs/api/admin/components/schemas/AdminOrderEditsRes.yaml
new file mode 100644
index 0000000000..d266863926
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminOrderEditsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ order_edit:
+ $ref: ./OrderEdit.yaml
diff --git a/docs/api/admin/components/schemas/AdminOrdersListRes.yaml b/docs/api/admin/components/schemas/AdminOrdersListRes.yaml
new file mode 100644
index 0000000000..1b4106242e
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminOrdersListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ orders:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminOrdersOrderLineItemReservationReq.yaml b/docs/api/admin/components/schemas/AdminOrdersOrderLineItemReservationReq.yaml
new file mode 100644
index 0000000000..afd23c7204
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminOrdersOrderLineItemReservationReq.yaml
@@ -0,0 +1,10 @@
+type: object
+required:
+ - location_id
+properties:
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ quantity:
+ description: The quantity to reserve
+ type: number
diff --git a/docs/api/admin/components/schemas/AdminOrdersRes.yaml b/docs/api/admin/components/schemas/AdminOrdersRes.yaml
new file mode 100644
index 0000000000..43b8e917ca
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminOrdersRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ order:
+ $ref: ./Order.yaml
diff --git a/docs/api/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml b/docs/api/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml
new file mode 100644
index 0000000000..ccc45be4d7
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml
@@ -0,0 +1,13 @@
+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.
+ default: payment_collection
+ deleted:
+ type: boolean
+ description: Whether or not the Payment Collection was deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminPaymentCollectionsRes.yaml b/docs/api/admin/components/schemas/AdminPaymentCollectionsRes.yaml
new file mode 100644
index 0000000000..a7748cf4f4
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPaymentCollectionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ payment_collection:
+ $ref: ./PaymentCollection.yaml
diff --git a/docs/api/admin/components/schemas/AdminPaymentProvidersList.yaml b/docs/api/admin/components/schemas/AdminPaymentProvidersList.yaml
new file mode 100644
index 0000000000..fc6042e3fe
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPaymentProvidersList.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ payment_providers:
+ type: array
+ items:
+ $ref: ./PaymentProvider.yaml
diff --git a/docs/api/admin/components/schemas/AdminPaymentRes.yaml b/docs/api/admin/components/schemas/AdminPaymentRes.yaml
new file mode 100644
index 0000000000..f063721de0
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPaymentRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ payment:
+ $ref: ./Payment.yaml
diff --git a/docs/api/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml b/docs/api/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml
new file mode 100644
index 0000000000..43b8e917ca
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ order:
+ $ref: ./Order.yaml
diff --git a/docs/api/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml b/docs/api/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml
new file mode 100644
index 0000000000..f185943b26
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml
@@ -0,0 +1,17 @@
+type: object
+properties:
+ name:
+ type: string
+ description: The name to identify the Product Category by.
+ handle:
+ type: string
+ description: A handle to be used in slugs.
+ is_internal:
+ type: boolean
+ description: A flag to make product category an internal category for admins
+ is_active:
+ type: boolean
+ description: A flag to make product category visible/hidden in the store front
+ parent_category_id:
+ type: string
+ description: The ID of the parent product category
diff --git a/docs/api/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml b/docs/api/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml
index 209ef9bd18..d57a04ec20 100644
--- a/docs/api/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml
+++ b/docs/api/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml
@@ -34,6 +34,7 @@ properties:
Whether Medusa should keep track of the inventory for this Product
Variant.
type: boolean
+ default: true
weight:
description: The wieght of the Product Variant.
type: number
diff --git a/docs/api/admin/components/schemas/AdminPostReservationsReq.yaml b/docs/api/admin/components/schemas/AdminPostReservationsReq.yaml
new file mode 100644
index 0000000000..6428010b23
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPostReservationsReq.yaml
@@ -0,0 +1,6 @@
+type: object
+required:
+ - reservation
+properties:
+ reservation:
+ $ref: ./ReservationItemDTO.yaml
diff --git a/docs/api/admin/components/schemas/AdminPostReservationsReservationReq.yaml b/docs/api/admin/components/schemas/AdminPostReservationsReservationReq.yaml
new file mode 100644
index 0000000000..b74d42c336
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPostReservationsReservationReq.yaml
@@ -0,0 +1,11 @@
+type: object
+properties:
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ description: An optional set of key-value pairs with additional information.
+ type: object
diff --git a/docs/api/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml b/docs/api/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml
new file mode 100644
index 0000000000..a6e7cbc41a
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml
@@ -0,0 +1,15 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminPriceListDeleteProductPricesRes.yaml b/docs/api/admin/components/schemas/AdminPriceListDeleteProductPricesRes.yaml
new file mode 100644
index 0000000000..9e71cf7cf3
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPriceListDeleteProductPricesRes.yaml
@@ -0,0 +1,15 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminPriceListDeleteRes.yaml b/docs/api/admin/components/schemas/AdminPriceListDeleteRes.yaml
new file mode 100644
index 0000000000..a6727b02e1
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPriceListDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminPriceListDeleteVariantPricesRes.yaml b/docs/api/admin/components/schemas/AdminPriceListDeleteVariantPricesRes.yaml
new file mode 100644
index 0000000000..9e71cf7cf3
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPriceListDeleteVariantPricesRes.yaml
@@ -0,0 +1,15 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminPriceListRes.yaml b/docs/api/admin/components/schemas/AdminPriceListRes.yaml
new file mode 100644
index 0000000000..c6be0b0caa
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPriceListRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ price_list:
+ $ref: ./PriceList.yaml
diff --git a/docs/api/admin/components/schemas/AdminPriceListsListRes.yaml b/docs/api/admin/components/schemas/AdminPriceListsListRes.yaml
new file mode 100644
index 0000000000..4da038dd18
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPriceListsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ price_lists:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminPriceListsProductsListRes.yaml b/docs/api/admin/components/schemas/AdminPriceListsProductsListRes.yaml
new file mode 100644
index 0000000000..57a72f2ef3
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPriceListsProductsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ products:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminProductTagsListRes.yaml b/docs/api/admin/components/schemas/AdminProductTagsListRes.yaml
new file mode 100644
index 0000000000..6a5ca82bb8
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductTagsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ product_tags:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminProductTypesListRes.yaml b/docs/api/admin/components/schemas/AdminProductTypesListRes.yaml
new file mode 100644
index 0000000000..4cb021af96
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductTypesListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ product_types:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminProductsDeleteOptionRes.yaml b/docs/api/admin/components/schemas/AdminProductsDeleteOptionRes.yaml
new file mode 100644
index 0000000000..30c41d02d7
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsDeleteOptionRes.yaml
@@ -0,0 +1,15 @@
+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: ./Product.yaml
diff --git a/docs/api/admin/components/schemas/AdminProductsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminProductsDeleteRes.yaml
new file mode 100644
index 0000000000..6d537a2698
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsDeleteRes.yaml
@@ -0,0 +1,13 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminProductsDeleteVariantRes.yaml b/docs/api/admin/components/schemas/AdminProductsDeleteVariantRes.yaml
new file mode 100644
index 0000000000..8ed1c8db64
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsDeleteVariantRes.yaml
@@ -0,0 +1,15 @@
+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: product-variant
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
+ product:
+ $ref: ./Product.yaml
diff --git a/docs/api/admin/components/schemas/AdminProductsListRes.yaml b/docs/api/admin/components/schemas/AdminProductsListRes.yaml
new file mode 100644
index 0000000000..ab35016359
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsListRes.yaml
@@ -0,0 +1,17 @@
+type: object
+properties:
+ products:
+ type: array
+ items:
+ oneOf:
+ - $ref: ./Product.yaml
+ - $ref: ./PricedProduct.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
diff --git a/docs/api/admin/components/schemas/AdminProductsListTagsRes.yaml b/docs/api/admin/components/schemas/AdminProductsListTagsRes.yaml
new file mode 100644
index 0000000000..b795f110ce
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsListTagsRes.yaml
@@ -0,0 +1,15 @@
+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
diff --git a/docs/api/admin/components/schemas/AdminProductsListTypesRes.yaml b/docs/api/admin/components/schemas/AdminProductsListTypesRes.yaml
new file mode 100644
index 0000000000..617453260a
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsListTypesRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ types:
+ type: array
+ items:
+ $ref: ./ProductType.yaml
diff --git a/docs/api/admin/components/schemas/AdminProductsListVariantsRes.yaml b/docs/api/admin/components/schemas/AdminProductsListVariantsRes.yaml
new file mode 100644
index 0000000000..0dd6293790
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsListVariantsRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ variants:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/AdminProductsRes.yaml b/docs/api/admin/components/schemas/AdminProductsRes.yaml
new file mode 100644
index 0000000000..3fbf46b05b
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminProductsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ product:
+ $ref: ./Product.yaml
diff --git a/docs/api/admin/components/schemas/AdminPublishableApiKeyDeleteRes.yaml b/docs/api/admin/components/schemas/AdminPublishableApiKeyDeleteRes.yaml
new file mode 100644
index 0000000000..47a0ea7e2a
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPublishableApiKeyDeleteRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted PublishableApiKey.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: publishable_api_key
+ deleted:
+ type: boolean
+ description: Whether the PublishableApiKeys was deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminPublishableApiKeysListRes.yaml b/docs/api/admin/components/schemas/AdminPublishableApiKeysListRes.yaml
new file mode 100644
index 0000000000..085a3d7190
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPublishableApiKeysListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ publishable_api_keys:
+ type: array
+ items:
+ $ref: ./PublishableApiKey.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
diff --git a/docs/api/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml b/docs/api/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml
new file mode 100644
index 0000000000..0a9db99c8f
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ sales_channels:
+ type: array
+ items:
+ $ref: ./SalesChannel.yaml
diff --git a/docs/api/admin/components/schemas/AdminPublishableApiKeysRes.yaml b/docs/api/admin/components/schemas/AdminPublishableApiKeysRes.yaml
new file mode 100644
index 0000000000..c17f539d38
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminPublishableApiKeysRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ publishable_api_key:
+ $ref: ./PublishableApiKey.yaml
diff --git a/docs/api/admin/components/schemas/AdminRefundRes.yaml b/docs/api/admin/components/schemas/AdminRefundRes.yaml
new file mode 100644
index 0000000000..cd621f5f05
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminRefundRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ refund:
+ $ref: ./Refund.yaml
diff --git a/docs/api/admin/components/schemas/AdminRegionsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminRegionsDeleteRes.yaml
new file mode 100644
index 0000000000..a75d2e5a48
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminRegionsDeleteRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted Region.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: region
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminRegionsListRes.yaml b/docs/api/admin/components/schemas/AdminRegionsListRes.yaml
new file mode 100644
index 0000000000..efebb681c2
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminRegionsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ regions:
+ type: array
+ items:
+ $ref: ./Region.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
diff --git a/docs/api/admin/components/schemas/AdminRegionsRes.yaml b/docs/api/admin/components/schemas/AdminRegionsRes.yaml
new file mode 100644
index 0000000000..b4080ea096
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminRegionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ region:
+ $ref: ./Region.yaml
diff --git a/docs/api/admin/components/schemas/AdminReturnReasonsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminReturnReasonsDeleteRes.yaml
new file mode 100644
index 0000000000..02bf4792f0
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminReturnReasonsDeleteRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted return reason
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: return_reason
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminReturnReasonsListRes.yaml b/docs/api/admin/components/schemas/AdminReturnReasonsListRes.yaml
new file mode 100644
index 0000000000..c52e27f424
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminReturnReasonsListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ return_reasons:
+ type: array
+ items:
+ $ref: ./ReturnReason.yaml
diff --git a/docs/api/admin/components/schemas/AdminReturnReasonsRes.yaml b/docs/api/admin/components/schemas/AdminReturnReasonsRes.yaml
new file mode 100644
index 0000000000..ac6e4045bd
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminReturnReasonsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ return_reason:
+ $ref: ./ReturnReason.yaml
diff --git a/docs/api/admin/components/schemas/AdminReturnsCancelRes.yaml b/docs/api/admin/components/schemas/AdminReturnsCancelRes.yaml
new file mode 100644
index 0000000000..43b8e917ca
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminReturnsCancelRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ order:
+ $ref: ./Order.yaml
diff --git a/docs/api/admin/components/schemas/AdminReturnsListRes.yaml b/docs/api/admin/components/schemas/AdminReturnsListRes.yaml
new file mode 100644
index 0000000000..b86af7dc39
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminReturnsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ returns:
+ type: array
+ items:
+ $ref: ./Return.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
diff --git a/docs/api/admin/components/schemas/AdminReturnsRes.yaml b/docs/api/admin/components/schemas/AdminReturnsRes.yaml
new file mode 100644
index 0000000000..3291cf0e08
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminReturnsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ return:
+ $ref: ./Return.yaml
diff --git a/docs/api/admin/components/schemas/AdminSalesChannelsDeleteLocationRes.yaml b/docs/api/admin/components/schemas/AdminSalesChannelsDeleteLocationRes.yaml
new file mode 100644
index 0000000000..8cc317294e
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminSalesChannelsDeleteLocationRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the removed stock location from a sales channel
+ object:
+ type: string
+ description: The type of the object that was removed.
+ default: stock-location
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminSalesChannelsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminSalesChannelsDeleteRes.yaml
new file mode 100644
index 0000000000..15a97ff689
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminSalesChannelsDeleteRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted sales channel
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: sales-channel
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminSalesChannelsListRes.yaml b/docs/api/admin/components/schemas/AdminSalesChannelsListRes.yaml
new file mode 100644
index 0000000000..7409f4ba18
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminSalesChannelsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ sales_channels:
+ type: array
+ items:
+ $ref: ./SalesChannel.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
diff --git a/docs/api/admin/components/schemas/AdminSalesChannelsRes.yaml b/docs/api/admin/components/schemas/AdminSalesChannelsRes.yaml
new file mode 100644
index 0000000000..09c58c3022
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminSalesChannelsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ sales_channel:
+ $ref: ./SalesChannel.yaml
diff --git a/docs/api/admin/components/schemas/AdminShippingOptionsDeleteRes.yaml b/docs/api/admin/components/schemas/AdminShippingOptionsDeleteRes.yaml
new file mode 100644
index 0000000000..d8e319611b
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminShippingOptionsDeleteRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Option.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: shipping-option
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminShippingOptionsListRes.yaml b/docs/api/admin/components/schemas/AdminShippingOptionsListRes.yaml
new file mode 100644
index 0000000000..539446d9e4
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminShippingOptionsListRes.yaml
@@ -0,0 +1,9 @@
+type: object
+properties:
+ shipping_options:
+ type: array
+ items:
+ $ref: ./ShippingOption.yaml
+ count:
+ type: integer
+ description: The total number of items available
diff --git a/docs/api/admin/components/schemas/AdminShippingOptionsRes.yaml b/docs/api/admin/components/schemas/AdminShippingOptionsRes.yaml
new file mode 100644
index 0000000000..ef80497854
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminShippingOptionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ shipping_option:
+ $ref: ./ShippingOption.yaml
diff --git a/docs/api/admin/components/schemas/AdminShippingProfilesListRes.yaml b/docs/api/admin/components/schemas/AdminShippingProfilesListRes.yaml
new file mode 100644
index 0000000000..33cdf0e98f
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminShippingProfilesListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ shipping_profiles:
+ type: array
+ items:
+ $ref: ./ShippingProfile.yaml
diff --git a/docs/api/admin/components/schemas/AdminShippingProfilesRes.yaml b/docs/api/admin/components/schemas/AdminShippingProfilesRes.yaml
new file mode 100644
index 0000000000..392791dfa1
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminShippingProfilesRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ shipping_profile:
+ $ref: ./ShippingProfile.yaml
diff --git a/docs/api/admin/components/schemas/AdminStockLocationsListRes.yaml b/docs/api/admin/components/schemas/AdminStockLocationsListRes.yaml
new file mode 100644
index 0000000000..47df8c820a
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminStockLocationsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ stock_locations:
+ type: array
+ items:
+ $ref: ./StockLocationDTO.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
diff --git a/docs/api/admin/components/schemas/AdminStockLocationsRes.yaml b/docs/api/admin/components/schemas/AdminStockLocationsRes.yaml
new file mode 100644
index 0000000000..adef34b4ff
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminStockLocationsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ stock_location:
+ $ref: ./StockLocationDTO.yaml
diff --git a/docs/api/admin/components/schemas/AdminStoresRes.yaml b/docs/api/admin/components/schemas/AdminStoresRes.yaml
new file mode 100644
index 0000000000..2c92fa1211
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminStoresRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ store:
+ $ref: ./Store.yaml
diff --git a/docs/api/admin/components/schemas/AdminSwapsListRes.yaml b/docs/api/admin/components/schemas/AdminSwapsListRes.yaml
new file mode 100644
index 0000000000..94b2b1f075
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminSwapsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ swaps:
+ type: array
+ items:
+ $ref: ./Swap.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
diff --git a/docs/api/admin/components/schemas/AdminSwapsRes.yaml b/docs/api/admin/components/schemas/AdminSwapsRes.yaml
new file mode 100644
index 0000000000..3eaa21eadf
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminSwapsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ swap:
+ $ref: ./Swap.yaml
diff --git a/docs/api/admin/components/schemas/AdminTaxProvidersList.yaml b/docs/api/admin/components/schemas/AdminTaxProvidersList.yaml
new file mode 100644
index 0000000000..5f97c98d61
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminTaxProvidersList.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ tax_providers:
+ type: array
+ items:
+ $ref: ./TaxProvider.yaml
diff --git a/docs/api/admin/components/schemas/AdminTaxRatesDeleteRes.yaml b/docs/api/admin/components/schemas/AdminTaxRatesDeleteRes.yaml
new file mode 100644
index 0000000000..d3b6b06558
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminTaxRatesDeleteRes.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ description: The ID of the deleted Shipping Option.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: tax-rate
+ deleted:
+ type: boolean
+ description: Whether or not the items were deleted.
+ default: true
diff --git a/docs/api/admin/components/schemas/AdminTaxRatesListRes.yaml b/docs/api/admin/components/schemas/AdminTaxRatesListRes.yaml
new file mode 100644
index 0000000000..e782e3d2c1
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminTaxRatesListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ tax_rates:
+ type: array
+ items:
+ $ref: ./TaxRate.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
diff --git a/docs/api/admin/components/schemas/AdminTaxRatesRes.yaml b/docs/api/admin/components/schemas/AdminTaxRatesRes.yaml
new file mode 100644
index 0000000000..5d4c877a0e
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminTaxRatesRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ tax_rate:
+ $ref: ./TaxRate.yaml
diff --git a/docs/api/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml b/docs/api/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml
new file mode 100644
index 0000000000..478368e8c5
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml
@@ -0,0 +1,5 @@
+type: object
+properties:
+ download_url:
+ type: string
+ description: The Download URL of the file
diff --git a/docs/api/admin/components/schemas/AdminUploadsRes.yaml b/docs/api/admin/components/schemas/AdminUploadsRes.yaml
new file mode 100644
index 0000000000..8c248af21c
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminUploadsRes.yaml
@@ -0,0 +1,11 @@
+type: object
+properties:
+ uploads:
+ type: array
+ items:
+ type: object
+ properties:
+ url:
+ type: string
+ description: The URL of the uploaded file.
+ format: uri
diff --git a/docs/api/admin/components/schemas/AdminUserRes.yaml b/docs/api/admin/components/schemas/AdminUserRes.yaml
new file mode 100644
index 0000000000..34a02f7ad2
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminUserRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ user:
+ $ref: ./User.yaml
diff --git a/docs/api/admin/components/schemas/AdminUsersListRes.yaml b/docs/api/admin/components/schemas/AdminUsersListRes.yaml
new file mode 100644
index 0000000000..4549b76e5b
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminUsersListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ users:
+ type: array
+ items:
+ $ref: ./User.yaml
diff --git a/docs/api/admin/components/schemas/AdminVariantsListRes.yaml b/docs/api/admin/components/schemas/AdminVariantsListRes.yaml
new file mode 100644
index 0000000000..0dd6293790
--- /dev/null
+++ b/docs/api/admin/components/schemas/AdminVariantsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ variants:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/admin/components/schemas/PricedProduct.yaml b/docs/api/admin/components/schemas/PricedProduct.yaml
new file mode 100644
index 0000000000..6054bb7d16
--- /dev/null
+++ b/docs/api/admin/components/schemas/PricedProduct.yaml
@@ -0,0 +1,10 @@
+title: Priced Product
+type: object
+allOf:
+ - $ref: ./Product.yaml
+ - type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: ./PricedVariant.yaml
diff --git a/docs/api/admin/components/schemas/PricedVariant.yaml b/docs/api/admin/components/schemas/PricedVariant.yaml
new file mode 100644
index 0000000000..4b74691549
--- /dev/null
+++ b/docs/api/admin/components/schemas/PricedVariant.yaml
@@ -0,0 +1,41 @@
+title: Priced Product Variant
+type: object
+allOf:
+ - $ref: ./ProductVariant.yaml
+ - type: object
+ properties:
+ original_price:
+ type: number
+ description: >-
+ The original price of the variant without any discounted prices
+ applied.
+ calculated_price:
+ type: number
+ description: The calculated price of the variant. Can be a discounted price.
+ original_price_incl_tax:
+ type: number
+ description: The original price of the variant including taxes.
+ calculated_price_incl_tax:
+ type: number
+ description: The calculated price of the variant including taxes.
+ original_tax:
+ type: number
+ description: The taxes applied on the original price.
+ calculated_tax:
+ type: number
+ description: The taxes applied on the calculated price.
+ tax_rates:
+ type: array
+ description: An array of applied tax rates
+ items:
+ type: object
+ properties:
+ rate:
+ type: number
+ description: The tax rate value
+ name:
+ type: string
+ description: The name of the tax rate
+ code:
+ type: string
+ description: The code of the tax rate
diff --git a/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml b/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml
new file mode 100644
index 0000000000..f583f59667
--- /dev/null
+++ b/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml
@@ -0,0 +1,34 @@
+title: Product Variant Inventory Item
+description: >-
+ Product Variant Inventory Items link variants with inventory items and denote
+ the number of inventory items constituting a variant.
+type: object
+properties:
+ id:
+ type: string
+ description: The product variant inventory item's ID
+ example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+ inventory_item_id:
+ description: The id of the inventory item
+ type: string
+ variant_id:
+ description: The id of the variant.
+ type: string
+ required_quantity:
+ description: >-
+ The quantity of an inventory item required for one quantity of the
+ variant.
+ type: integer
+ default: 1
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
diff --git a/docs/api/admin/components/schemas/ProductVariantPricesFields.yaml b/docs/api/admin/components/schemas/ProductVariantPricesFields.yaml
deleted file mode 100644
index 3bece0c504..0000000000
--- a/docs/api/admin/components/schemas/ProductVariantPricesFields.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-title: Product Variant Prices Fields
-description: Product Variants Prices Fields that are only available in some requests.
-type: object
-properties:
- original_price:
- type: number
- description: The original price of the variant without any discounted prices applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
diff --git a/docs/api/admin/components/schemas/ReservationItemDTO.yaml b/docs/api/admin/components/schemas/ReservationItemDTO.yaml
new file mode 100644
index 0000000000..2a99d8583f
--- /dev/null
+++ b/docs/api/admin/components/schemas/ReservationItemDTO.yaml
@@ -0,0 +1,38 @@
+title: Reservation item
+description: Represents a reservation of an inventory item at a stock location
+type: object
+required:
+ - id
+ - location_id
+ - inventory_item_id
+ - quantity
+properties:
+ id:
+ description: The id of the reservation item
+ type: string
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ inventory_item_id:
+ description: The id of the inventory item the reservation relates to
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ type: object
+ description: An optional key-value map with additional details
+ example:
+ car: white
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
diff --git a/docs/api/admin/openapi.yaml b/docs/api/admin/openapi.yaml
index f206186be9..5492810a7e 100644
--- a/docs/api/admin/openapi.yaml
+++ b/docs/api/admin/openapi.yaml
@@ -303,6 +303,8 @@ paths:
$ref: paths/order_{id}_claims.yaml
/orders/{id}/fulfillment:
$ref: paths/orders_{id}_fulfillment.yaml
+ /orders/{id}/line-items/{line_item_id}/reserve:
+ $ref: paths/orders_{id}_line-items_{line_item_id}_reserve.yaml
/orders/{id}/shipment:
$ref: paths/orders_{id}_shipment.yaml
/orders/{id}/swaps/{swap_id}/shipments:
@@ -315,6 +317,8 @@ paths:
$ref: paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
/orders/{id}:
$ref: paths/orders_{id}.yaml
+ /orders/{id}/reservations:
+ $ref: paths/orders_{id}_reservations.yaml
/orders:
$ref: paths/orders.yaml
/orders/{id}/swaps/{swap_id}/process-payment:
@@ -403,6 +407,10 @@ paths:
$ref: paths/regions_{id}_fulfillment-providers_{provider_id}.yaml
/regions/{id}/payment-providers/{provider_id}:
$ref: paths/regions_{id}_payment-providers_{provider_id}.yaml
+ /reservations:
+ $ref: paths/reservations.yaml
+ /reservations/{id}:
+ $ref: paths/reservations_{id}.yaml
/return-reasons:
$ref: paths/return-reasons.yaml
/return-reasons/{id}:
diff --git a/docs/api/admin/paths/admin_draft-orders_{id}.yaml b/docs/api/admin/paths/admin_draft-orders_{id}.yaml
index 2840671094..f8718848dc 100644
--- a/docs/api/admin/paths/admin_draft-orders_{id}.yaml
+++ b/docs/api/admin/paths/admin_draft-orders_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/apps.yaml b/docs/api/admin/paths/apps.yaml
index a2ae650530..4d0b2d4090 100644
--- a/docs/api/admin/paths/apps.yaml
+++ b/docs/api/admin/paths/apps.yaml
@@ -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':
diff --git a/docs/api/admin/paths/apps_authorizations.yaml b/docs/api/admin/paths/apps_authorizations.yaml
index fe5c56aefd..f461bc235b 100644
--- a/docs/api/admin/paths/apps_authorizations.yaml
+++ b/docs/api/admin/paths/apps_authorizations.yaml
@@ -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':
diff --git a/docs/api/admin/paths/auth.yaml b/docs/api/admin/paths/auth.yaml
index 7df22e8372..1a74b737f7 100644
--- a/docs/api/admin/paths/auth.yaml
+++ b/docs/api/admin/paths/auth.yaml
@@ -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':
diff --git a/docs/api/admin/paths/batch-jobs.yaml b/docs/api/admin/paths/batch-jobs.yaml
index 620314d7bb..36207da518 100644
--- a/docs/api/admin/paths/batch-jobs.yaml
+++ b/docs/api/admin/paths/batch-jobs.yaml
@@ -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':
diff --git a/docs/api/admin/paths/batch-jobs_{id}.yaml b/docs/api/admin/paths/batch-jobs_{id}.yaml
index 590a2bcf81..000772b520 100644
--- a/docs/api/admin/paths/batch-jobs_{id}.yaml
+++ b/docs/api/admin/paths/batch-jobs_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml b/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml
index 1802061a1c..bff194f18b 100644
--- a/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml
+++ b/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml b/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml
index e2230ad52a..3bc12e8922 100644
--- a/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml
+++ b/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml
@@ -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':
diff --git a/docs/api/admin/paths/collections.yaml b/docs/api/admin/paths/collections.yaml
index fbd79a669c..dbd9acf2ef 100644
--- a/docs/api/admin/paths/collections.yaml
+++ b/docs/api/admin/paths/collections.yaml
@@ -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':
diff --git a/docs/api/admin/paths/collections_{id}.yaml b/docs/api/admin/paths/collections_{id}.yaml
index a98116c2bf..8247a2566f 100644
--- a/docs/api/admin/paths/collections_{id}.yaml
+++ b/docs/api/admin/paths/collections_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/collections_{id}_products_batch.yaml b/docs/api/admin/paths/collections_{id}_products_batch.yaml
index 2d696a0484..96241493e5 100644
--- a/docs/api/admin/paths/collections_{id}_products_batch.yaml
+++ b/docs/api/admin/paths/collections_{id}_products_batch.yaml
@@ -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':
diff --git a/docs/api/admin/paths/currencies.yaml b/docs/api/admin/paths/currencies.yaml
index 739390489f..5d49d8849f 100644
--- a/docs/api/admin/paths/currencies.yaml
+++ b/docs/api/admin/paths/currencies.yaml
@@ -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
diff --git a/docs/api/admin/paths/currencies_{code}.yaml b/docs/api/admin/paths/currencies_{code}.yaml
index fc68439223..b7194abda1 100644
--- a/docs/api/admin/paths/currencies_{code}.yaml
+++ b/docs/api/admin/paths/currencies_{code}.yaml
@@ -32,7 +32,4 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- currency:
- $ref: ../components/schemas/Currency.yaml
+ $ref: ../components/schemas/AdminCurrenciesRes.yaml
diff --git a/docs/api/admin/paths/customer-groups.yaml b/docs/api/admin/paths/customer-groups.yaml
index f3358f5dae..81d0a90f85 100644
--- a/docs/api/admin/paths/customer-groups.yaml
+++ b/docs/api/admin/paths/customer-groups.yaml
@@ -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':
diff --git a/docs/api/admin/paths/customer-groups_{id}.yaml b/docs/api/admin/paths/customer-groups_{id}.yaml
index be757bb093..d117c7d0db 100644
--- a/docs/api/admin/paths/customer-groups_{id}.yaml
+++ b/docs/api/admin/paths/customer-groups_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/customer-groups_{id}_customers.yaml b/docs/api/admin/paths/customer-groups_{id}_customers.yaml
index 1e0f51e3a2..54e9bb3f31 100644
--- a/docs/api/admin/paths/customer-groups_{id}_customers.yaml
+++ b/docs/api/admin/paths/customer-groups_{id}_customers.yaml
@@ -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':
diff --git a/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml b/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
index 026d2d010a..3f4849fa2e 100644
--- a/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
+++ b/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
@@ -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':
diff --git a/docs/api/admin/paths/customers.yaml b/docs/api/admin/paths/customers.yaml
index 6a2c283eb8..3ac2c02628 100644
--- a/docs/api/admin/paths/customers.yaml
+++ b/docs/api/admin/paths/customers.yaml
@@ -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':
diff --git a/docs/api/admin/paths/customers_{id}.yaml b/docs/api/admin/paths/customers_{id}.yaml
index 5295e0bd70..56e84f9c72 100644
--- a/docs/api/admin/paths/customers_{id}.yaml
+++ b/docs/api/admin/paths/customers_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts.yaml b/docs/api/admin/paths/discounts.yaml
index 48e56e3da4..036a2ec584 100644
--- a/docs/api/admin/paths/discounts.yaml
+++ b/docs/api/admin/paths/discounts.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_code_{code}.yaml b/docs/api/admin/paths/discounts_code_{code}.yaml
index 5d5997d34b..9639a63fc3 100644
--- a/docs/api/admin/paths/discounts_code_{code}.yaml
+++ b/docs/api/admin/paths/discounts_code_{code}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml b/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
index 8ff0e9eef1..b094f2528a 100644
--- a/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
+++ b/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
index 9730b4108e..aaddd8c66e 100644
--- a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
+++ b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml
index 104bd794c5..acfeac0295 100644
--- a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml
+++ b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_{id}.yaml b/docs/api/admin/paths/discounts_{id}.yaml
index bd7cf157c8..09266cfeb5 100644
--- a/docs/api/admin/paths/discounts_{id}.yaml
+++ b/docs/api/admin/paths/discounts_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml b/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
index f84d9639e1..8228ec0adf 100644
--- a/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
+++ b/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml b/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml
index d1f2a7c71a..64a02ba04d 100644
--- a/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml
+++ b/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml b/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml
index da2a06418b..b340b10849 100644
--- a/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml
+++ b/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/draft-orders.yaml b/docs/api/admin/paths/draft-orders.yaml
index 7c57cc7065..501bcfc24e 100644
--- a/docs/api/admin/paths/draft-orders.yaml
+++ b/docs/api/admin/paths/draft-orders.yaml
@@ -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':
diff --git a/docs/api/admin/paths/draft-orders_{id}.yaml b/docs/api/admin/paths/draft-orders_{id}.yaml
index c65beb2cff..91e31ccc0c 100644
--- a/docs/api/admin/paths/draft-orders_{id}.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/draft-orders_{id}_line-items.yaml b/docs/api/admin/paths/draft-orders_{id}_line-items.yaml
index 843f755985..118863d6e6 100644
--- a/docs/api/admin/paths/draft-orders_{id}_line-items.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}_line-items.yaml
@@ -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':
diff --git a/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml b/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml
index 7c10c48c6a..7b12fd27ba 100644
--- a/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/draft-orders_{id}_pay.yaml b/docs/api/admin/paths/draft-orders_{id}_pay.yaml
index 33498b2817..05b8bda2bb 100644
--- a/docs/api/admin/paths/draft-orders_{id}_pay.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}_pay.yaml
@@ -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':
diff --git a/docs/api/admin/paths/gift-cards.yaml b/docs/api/admin/paths/gift-cards.yaml
index 6a2bd0f9e4..40e74a8103 100644
--- a/docs/api/admin/paths/gift-cards.yaml
+++ b/docs/api/admin/paths/gift-cards.yaml
@@ -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':
diff --git a/docs/api/admin/paths/gift-cards_{id}.yaml b/docs/api/admin/paths/gift-cards_{id}.yaml
index 736536499e..cacd875001 100644
--- a/docs/api/admin/paths/gift-cards_{id}.yaml
+++ b/docs/api/admin/paths/gift-cards_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/invites.yaml b/docs/api/admin/paths/invites.yaml
index 6de86e8dbf..1285069b4e 100644
--- a/docs/api/admin/paths/invites.yaml
+++ b/docs/api/admin/paths/invites.yaml
@@ -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':
diff --git a/docs/api/admin/paths/invites_{invite_id}.yaml b/docs/api/admin/paths/invites_{invite_id}.yaml
index 3c05c78304..fbcb5bed13 100644
--- a/docs/api/admin/paths/invites_{invite_id}.yaml
+++ b/docs/api/admin/paths/invites_{invite_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/notes.yaml b/docs/api/admin/paths/notes.yaml
index a92fea1245..d943c91667 100644
--- a/docs/api/admin/paths/notes.yaml
+++ b/docs/api/admin/paths/notes.yaml
@@ -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':
diff --git a/docs/api/admin/paths/notes_{id}.yaml b/docs/api/admin/paths/notes_{id}.yaml
index 2a363e121e..90ef87e655 100644
--- a/docs/api/admin/paths/notes_{id}.yaml
+++ b/docs/api/admin/paths/notes_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/notifications.yaml b/docs/api/admin/paths/notifications.yaml
index d34b6f4804..1de38278d4 100644
--- a/docs/api/admin/paths/notifications.yaml
+++ b/docs/api/admin/paths/notifications.yaml
@@ -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':
diff --git a/docs/api/admin/paths/notifications_{id}_resend.yaml b/docs/api/admin/paths/notifications_{id}_resend.yaml
index 4ac15c94f6..9999095382 100644
--- a/docs/api/admin/paths/notifications_{id}_resend.yaml
+++ b/docs/api/admin/paths/notifications_{id}_resend.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order-edits.yaml b/docs/api/admin/paths/order-edits.yaml
index 7f1af81759..81f3bfa72e 100644
--- a/docs/api/admin/paths/order-edits.yaml
+++ b/docs/api/admin/paths/order-edits.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order-edits_{id}.yaml b/docs/api/admin/paths/order-edits_{id}.yaml
index b968c8f7b8..02dd01a081 100644
--- a/docs/api/admin/paths/order-edits_{id}.yaml
+++ b/docs/api/admin/paths/order-edits_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order-edits_{id}_cancel.yaml b/docs/api/admin/paths/order-edits_{id}_cancel.yaml
index e378f19a34..50300d73e5 100644
--- a/docs/api/admin/paths/order-edits_{id}_cancel.yaml
+++ b/docs/api/admin/paths/order-edits_{id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml b/docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml
index c4cbba55dd..80731c4111 100644
--- a/docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml
+++ b/docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml
@@ -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
diff --git a/docs/api/admin/paths/order-edits_{id}_confirm.yaml b/docs/api/admin/paths/order-edits_{id}_confirm.yaml
index 0f035a3369..3bee93163e 100644
--- a/docs/api/admin/paths/order-edits_{id}_confirm.yaml
+++ b/docs/api/admin/paths/order-edits_{id}_confirm.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order-edits_{id}_items.yaml b/docs/api/admin/paths/order-edits_{id}_items.yaml
index cdb50f40b3..d1c017ef9a 100644
--- a/docs/api/admin/paths/order-edits_{id}_items.yaml
+++ b/docs/api/admin/paths/order-edits_{id}_items.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml b/docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml
index 30b79062b8..abe7fd9543 100644
--- a/docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml
+++ b/docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order-edits_{id}_request.yaml b/docs/api/admin/paths/order-edits_{id}_request.yaml
index c0a23d74bf..1e8f82358b 100644
--- a/docs/api/admin/paths/order-edits_{id}_request.yaml
+++ b/docs/api/admin/paths/order-edits_{id}_request.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order_{id}_claims.yaml b/docs/api/admin/paths/order_{id}_claims.yaml
index 2d4aee6462..2fee281dcf 100644
--- a/docs/api/admin/paths/order_{id}_claims.yaml
+++ b/docs/api/admin/paths/order_{id}_claims.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml b/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml
index 0554d754b8..db86163b36 100644
--- a/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml
+++ b/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/order_{id}_swaps.yaml b/docs/api/admin/paths/order_{id}_swaps.yaml
index 3730e0c5d1..02801de7ca 100644
--- a/docs/api/admin/paths/order_{id}_swaps.yaml
+++ b/docs/api/admin/paths/order_{id}_swaps.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders.yaml b/docs/api/admin/paths/orders.yaml
index fd89f2bd8a..5b1fbd8dbf 100644
--- a/docs/api/admin/paths/orders.yaml
+++ b/docs/api/admin/paths/orders.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}.yaml b/docs/api/admin/paths/orders_{id}.yaml
index 8d172d6e7c..91da15ffb1 100644
--- a/docs/api/admin/paths/orders_{id}.yaml
+++ b/docs/api/admin/paths/orders_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_archive.yaml b/docs/api/admin/paths/orders_{id}_archive.yaml
index d2e57d0960..c3c6576368 100644
--- a/docs/api/admin/paths/orders_{id}_archive.yaml
+++ b/docs/api/admin/paths/orders_{id}_archive.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_cancel.yaml
index 2f46c1853b..a6ed10c37c 100644
--- a/docs/api/admin/paths/orders_{id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_capture.yaml b/docs/api/admin/paths/orders_{id}_capture.yaml
index 2640a03b48..c022c5c25f 100644
--- a/docs/api/admin/paths/orders_{id}_capture.yaml
+++ b/docs/api/admin/paths/orders_{id}_capture.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
index 04951b25c7..98bfa19200 100644
--- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
index 8a4e372cdc..1ad2f311bc 100644
--- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
+++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
index 957be39b25..f431edeb09 100644
--- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml
index 30814ec8da..8228d5b3b1 100644
--- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml
+++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_complete.yaml b/docs/api/admin/paths/orders_{id}_complete.yaml
index 3c51f1298a..60137f2529 100644
--- a/docs/api/admin/paths/orders_{id}_complete.yaml
+++ b/docs/api/admin/paths/orders_{id}_complete.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_fulfillment.yaml b/docs/api/admin/paths/orders_{id}_fulfillment.yaml
index 1d2fac8cf6..d9c699f6c7 100644
--- a/docs/api/admin/paths/orders_{id}_fulfillment.yaml
+++ b/docs/api/admin/paths/orders_{id}_fulfillment.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
index 1eaef848b0..45d608ef5a 100644
--- a/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_line-items_{line_item_id}_reserve.yaml b/docs/api/admin/paths/orders_{id}_line-items_{line_item_id}_reserve.yaml
new file mode 100644
index 0000000000..661d634556
--- /dev/null
+++ b/docs/api/admin/paths/orders_{id}_line-items_{line_item_id}_reserve.yaml
@@ -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
diff --git a/docs/api/admin/paths/orders_{id}_refund.yaml b/docs/api/admin/paths/orders_{id}_refund.yaml
index 9ec6262938..f76477a3c9 100644
--- a/docs/api/admin/paths/orders_{id}_refund.yaml
+++ b/docs/api/admin/paths/orders_{id}_refund.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_reservations.yaml b/docs/api/admin/paths/orders_{id}_reservations.yaml
new file mode 100644
index 0000000000..def4a369c0
--- /dev/null
+++ b/docs/api/admin/paths/orders_{id}_reservations.yaml
@@ -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
diff --git a/docs/api/admin/paths/orders_{id}_return.yaml b/docs/api/admin/paths/orders_{id}_return.yaml
index b1a6e0387d..7f7858c132 100644
--- a/docs/api/admin/paths/orders_{id}_return.yaml
+++ b/docs/api/admin/paths/orders_{id}_return.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_shipment.yaml b/docs/api/admin/paths/orders_{id}_shipment.yaml
index 342b5e38cb..7dc1319d5c 100644
--- a/docs/api/admin/paths/orders_{id}_shipment.yaml
+++ b/docs/api/admin/paths/orders_{id}_shipment.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_shipping-methods.yaml b/docs/api/admin/paths/orders_{id}_shipping-methods.yaml
index 044c460284..9c59b9a795 100644
--- a/docs/api/admin/paths/orders_{id}_shipping-methods.yaml
+++ b/docs/api/admin/paths/orders_{id}_shipping-methods.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml
index 7bdc8fdcfd..ab6ed2d5ec 100644
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
index 3c87673b34..d234c30c3b 100644
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
index b4924eb557..2aab1e34ec 100644
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
index 180c2c8172..5df1ed6d02 100644
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
@@ -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':
diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
index 46e984cd91..0c8813d210 100644
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
@@ -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':
diff --git a/docs/api/admin/paths/payment-collections_{id}.yaml b/docs/api/admin/paths/payment-collections_{id}.yaml
index 7ea1b8c985..16ac725bf5 100644
--- a/docs/api/admin/paths/payment-collections_{id}.yaml
+++ b/docs/api/admin/paths/payment-collections_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/payment-collections_{id}_authorize.yaml b/docs/api/admin/paths/payment-collections_{id}_authorize.yaml
index 023819f387..ba6ab17043 100644
--- a/docs/api/admin/paths/payment-collections_{id}_authorize.yaml
+++ b/docs/api/admin/paths/payment-collections_{id}_authorize.yaml
@@ -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':
diff --git a/docs/api/admin/paths/payments_{id}.yaml b/docs/api/admin/paths/payments_{id}.yaml
index 261c03bc84..1dc98ab031 100644
--- a/docs/api/admin/paths/payments_{id}.yaml
+++ b/docs/api/admin/paths/payments_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/payments_{id}_capture.yaml b/docs/api/admin/paths/payments_{id}_capture.yaml
index c60c0f33e9..442ec5c449 100644
--- a/docs/api/admin/paths/payments_{id}_capture.yaml
+++ b/docs/api/admin/paths/payments_{id}_capture.yaml
@@ -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':
diff --git a/docs/api/admin/paths/payments_{id}_refund.yaml b/docs/api/admin/paths/payments_{id}_refund.yaml
index 4e2b2feb56..599d843802 100644
--- a/docs/api/admin/paths/payments_{id}_refund.yaml
+++ b/docs/api/admin/paths/payments_{id}_refund.yaml
@@ -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':
diff --git a/docs/api/admin/paths/price-lists.yaml b/docs/api/admin/paths/price-lists.yaml
index a80ea6ebaa..e8ef087d4c 100644
--- a/docs/api/admin/paths/price-lists.yaml
+++ b/docs/api/admin/paths/price-lists.yaml
@@ -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':
diff --git a/docs/api/admin/paths/price-lists_{id}.yaml b/docs/api/admin/paths/price-lists_{id}.yaml
index a4262d9979..dd3edd69f6 100644
--- a/docs/api/admin/paths/price-lists_{id}.yaml
+++ b/docs/api/admin/paths/price-lists_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml b/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml
index 489dc91870..95e061eba8 100644
--- a/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml
@@ -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':
diff --git a/docs/api/admin/paths/price-lists_{id}_products.yaml b/docs/api/admin/paths/price-lists_{id}_products.yaml
index 7275b51bbe..66fc54fad0 100644
--- a/docs/api/admin/paths/price-lists_{id}_products.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_products.yaml
@@ -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':
diff --git a/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml b/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml
index 84dd0b1799..8adbf0f60c 100644
--- a/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml
@@ -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':
diff --git a/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml b/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml
index a4420e961f..5d18611063 100644
--- a/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml
@@ -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':
diff --git a/docs/api/admin/paths/product-categories.yaml b/docs/api/admin/paths/product-categories.yaml
index 34fb79228e..f009bf5fa1 100644
--- a/docs/api/admin/paths/product-categories.yaml
+++ b/docs/api/admin/paths/product-categories.yaml
@@ -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
diff --git a/docs/api/admin/paths/product-categories_{id}.yaml b/docs/api/admin/paths/product-categories_{id}.yaml
index 47550ecb39..f1f95d2ec5 100644
--- a/docs/api/admin/paths/product-categories_{id}.yaml
+++ b/docs/api/admin/paths/product-categories_{id}.yaml
@@ -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
diff --git a/docs/api/admin/paths/product-tags.yaml b/docs/api/admin/paths/product-tags.yaml
index dbf6d2eed6..a4a7e032e1 100644
--- a/docs/api/admin/paths/product-tags.yaml
+++ b/docs/api/admin/paths/product-tags.yaml
@@ -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':
diff --git a/docs/api/admin/paths/product-types.yaml b/docs/api/admin/paths/product-types.yaml
index 32c4deb44f..018daab908 100644
--- a/docs/api/admin/paths/product-types.yaml
+++ b/docs/api/admin/paths/product-types.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products.yaml b/docs/api/admin/paths/products.yaml
index f8751763ad..66b61da211 100644
--- a/docs/api/admin/paths/products.yaml
+++ b/docs/api/admin/paths/products.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_tag-usage.yaml b/docs/api/admin/paths/products_tag-usage.yaml
index 19e7537a29..c15a0b60e2 100644
--- a/docs/api/admin/paths/products_tag-usage.yaml
+++ b/docs/api/admin/paths/products_tag-usage.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_types.yaml b/docs/api/admin/paths/products_types.yaml
index 3a59bf42c9..791ae38a83 100644
--- a/docs/api/admin/paths/products_types.yaml
+++ b/docs/api/admin/paths/products_types.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_{id}.yaml b/docs/api/admin/paths/products_{id}.yaml
index 9aa12442b0..457faa50fb 100644
--- a/docs/api/admin/paths/products_{id}.yaml
+++ b/docs/api/admin/paths/products_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_{id}_metadata.yaml b/docs/api/admin/paths/products_{id}_metadata.yaml
index 3763a0bd21..fecb66a47c 100644
--- a/docs/api/admin/paths/products_{id}_metadata.yaml
+++ b/docs/api/admin/paths/products_{id}_metadata.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_{id}_options.yaml b/docs/api/admin/paths/products_{id}_options.yaml
index e3dfbe91ad..c8958932c5 100644
--- a/docs/api/admin/paths/products_{id}_options.yaml
+++ b/docs/api/admin/paths/products_{id}_options.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_{id}_options_{option_id}.yaml b/docs/api/admin/paths/products_{id}_options_{option_id}.yaml
index 8ddc2ab70f..5c6245fa4d 100644
--- a/docs/api/admin/paths/products_{id}_options_{option_id}.yaml
+++ b/docs/api/admin/paths/products_{id}_options_{option_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_{id}_variants.yaml b/docs/api/admin/paths/products_{id}_variants.yaml
index 2f9f540936..5810d23da2 100644
--- a/docs/api/admin/paths/products_{id}_variants.yaml
+++ b/docs/api/admin/paths/products_{id}_variants.yaml
@@ -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':
diff --git a/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml b/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml
index 97be489152..40c8867c26 100644
--- a/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml
+++ b/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/publishable-api-key_{id}.yaml b/docs/api/admin/paths/publishable-api-key_{id}.yaml
index a8153dbf1c..525ebf1b44 100644
--- a/docs/api/admin/paths/publishable-api-key_{id}.yaml
+++ b/docs/api/admin/paths/publishable-api-key_{id}.yaml
@@ -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':
diff --git a/docs/api/admin/paths/publishable-api-keys.yaml b/docs/api/admin/paths/publishable-api-keys.yaml
index 515c76488d..eb29fec0b6 100644
--- a/docs/api/admin/paths/publishable-api-keys.yaml
+++ b/docs/api/admin/paths/publishable-api-keys.yaml
@@ -28,10 +28,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':
@@ -97,11 +94,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- publishable_api_keys:
- type: array
- $ref: ../components/schemas/PublishableApiKey.yaml
+ $ref: ../components/schemas/AdminPublishableApiKeysListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/publishable-api-keys_{id}.yaml b/docs/api/admin/paths/publishable-api-keys_{id}.yaml
index 2866fb8cad..0175ee2eca 100644
--- a/docs/api/admin/paths/publishable-api-keys_{id}.yaml
+++ b/docs/api/admin/paths/publishable-api-keys_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted PublishableApiKey.
- object:
- type: string
- description: The type of the object that was deleted.
- format: publishable_api_key
- deleted:
- type: boolean
- description: Whether the PublishableApiKeys was deleted.
- default: true
+ $ref: ../components/schemas/AdminPublishableApiKeyDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
get:
@@ -77,10 +65,7 @@ get:
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':
diff --git a/docs/api/admin/paths/publishable-api-keys_{id}_revoke.yaml b/docs/api/admin/paths/publishable-api-keys_{id}_revoke.yaml
index 5520c369e5..974f94cc42 100644
--- a/docs/api/admin/paths/publishable-api-keys_{id}_revoke.yaml
+++ b/docs/api/admin/paths/publishable-api-keys_{id}_revoke.yaml
@@ -31,10 +31,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':
diff --git a/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels.yaml b/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels.yaml
index 8ae7c7c18a..b2fa9789ca 100644
--- a/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels.yaml
+++ b/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels.yaml
@@ -37,11 +37,8 @@ get:
content:
application/json:
schema:
- properties:
- sales_channels:
- type: array
- items:
- $ref: ../components/schemas/SalesChannel.yaml
+ $ref: >-
+ ../components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels_batch.yaml b/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels_batch.yaml
index fcd71624d7..5781079806 100644
--- a/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels_batch.yaml
+++ b/docs/api/admin/paths/publishable-api-keys_{id}_sales-channels_batch.yaml
@@ -38,9 +38,7 @@ post:
content:
application/json:
schema:
- properties:
- publishable_api_key:
- $ref: ../components/schemas/PublishableApiKey.yaml
+ $ref: ../components/schemas/AdminPublishableApiKeysRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -93,9 +91,7 @@ delete:
content:
application/json:
schema:
- properties:
- publishable_api_key:
- $ref: ../components/schemas/PublishableApiKey.yaml
+ $ref: ../components/schemas/AdminPublishableApiKeysRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions.yaml b/docs/api/admin/paths/regions.yaml
index cb9689cadb..f44ed7f081 100644
--- a/docs/api/admin/paths/regions.yaml
+++ b/docs/api/admin/paths/regions.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -108,21 +105,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- regions:
- type: array
- items:
- $ref: ../components/schemas/Region.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/AdminRegionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}.yaml b/docs/api/admin/paths/regions_{id}.yaml
index 3af3854927..92f41aea93 100644
--- a/docs/api/admin/paths/regions_{id}.yaml
+++ b/docs/api/admin/paths/regions_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Region.
- object:
- type: string
- description: The type of the object that was deleted.
- default: region
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminRegionsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}_countries.yaml b/docs/api/admin/paths/regions_{id}_countries.yaml
index 67bb512250..2a3906b302 100644
--- a/docs/api/admin/paths/regions_{id}_countries.yaml
+++ b/docs/api/admin/paths/regions_{id}_countries.yaml
@@ -35,10 +35,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml b/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml
index c68d9ce238..27b444cb9d 100644
--- a/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml
+++ b/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml
@@ -41,10 +41,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml b/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml
index 04966fcc77..b58b7838ea 100644
--- a/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml
+++ b/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml
@@ -31,22 +31,8 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- fulfillment_options:
- type: array
- items:
- properties:
- provider_id:
- type: string
- description: ID of the fulfillment provider
- options:
- type: array
- description: fulfillment provider options
- example:
- - id: manual-fulfillment
- - id: manual-fulfillment-return
- is_return: true
+ $ref: >-
+ ../components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}_fulfillment-providers.yaml b/docs/api/admin/paths/regions_{id}_fulfillment-providers.yaml
index 1683a5f2e2..38aaef2eb8 100644
--- a/docs/api/admin/paths/regions_{id}_fulfillment-providers.yaml
+++ b/docs/api/admin/paths/regions_{id}_fulfillment-providers.yaml
@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml b/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml
index cd9097439e..a91bfcaf7d 100644
--- a/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml
+++ b/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml
@@ -38,10 +38,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}_payment-providers.yaml b/docs/api/admin/paths/regions_{id}_payment-providers.yaml
index 83abf118c3..a2e20c16fa 100644
--- a/docs/api/admin/paths/regions_{id}_payment-providers.yaml
+++ b/docs/api/admin/paths/regions_{id}_payment-providers.yaml
@@ -36,10 +36,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml b/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml
index 3d2c890ef7..f83f52186d 100644
--- a/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml
+++ b/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml
@@ -38,10 +38,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/AdminRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/reservations.yaml b/docs/api/admin/paths/reservations.yaml
new file mode 100644
index 0000000000..934587039e
--- /dev/null
+++ b/docs/api/admin/paths/reservations.yaml
@@ -0,0 +1,151 @@
+post:
+ operationId: PostReservations
+ summary: Creates a Reservation
+ description: Creates a Reservation which can be associated with any resource as required.
+ x-authenticated: true
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/AdminPostReservationsReq.yaml
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source:
+ $ref: ../code_samples/JavaScript/reservations/postundefined
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/reservations/postundefined
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ 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
+get:
+ operationId: GetReservations
+ summary: List Reservations
+ description: Retrieve a list of Reservations.
+ x-authenticated: true
+ parameters:
+ - in: query
+ name: location_id
+ style: form
+ explode: false
+ description: Location ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: inventory_item_id
+ style: form
+ explode: false
+ description: Inventory Item ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: line_item_id
+ style: form
+ explode: false
+ description: Line Item ids to search for.
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: quantity
+ description: Filter by reservation quantity
+ schema:
+ type: object
+ properties:
+ lt:
+ type: number
+ description: filter by reservation quantity less than this number
+ gt:
+ type: number
+ description: filter by reservation quantity greater than this number
+ lte:
+ type: number
+ description: filter by reservation quantity less than or equal to this number
+ gte:
+ type: number
+ description: >-
+ filter by reservation quantity greater than or equal to this
+ number
+ - in: query
+ name: offset
+ description: How many Reservations to skip in the result.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: limit
+ description: Limit the number of Reservations returned.
+ schema:
+ type: integer
+ default: 20
+ - 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
+ source:
+ $ref: ../code_samples/Shell/reservations/getundefined
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ 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
diff --git a/docs/api/admin/paths/reservations_{id}.yaml b/docs/api/admin/paths/reservations_{id}.yaml
new file mode 100644
index 0000000000..abbc5b4f09
--- /dev/null
+++ b/docs/api/admin/paths/reservations_{id}.yaml
@@ -0,0 +1,152 @@
+delete:
+ operationId: DeleteReservationsReservation
+ summary: Delete a Reservation
+ description: Deletes a Reservation.
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the Reservation to delete.
+ schema:
+ type: string
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source:
+ $ref: ../code_samples/JavaScript/reservations_{id}/deleteundefined
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/reservations_{id}/deleteundefined
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the deleted Reservation.
+ object:
+ type: string
+ description: The type of the object that was deleted.
+ default: reservation
+ deleted:
+ type: boolean
+ description: Whether or not the Reservation was deleted.
+ default: true
+ '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
+get:
+ operationId: GetReservationsReservation
+ summary: Get a Reservation
+ description: Retrieves a single reservation using its id
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the reservation to retrieve.
+ schema:
+ type: string
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source:
+ $ref: ../code_samples/JavaScript/reservations_{id}/getundefined
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/reservations_{id}/getundefined
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ 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
+post:
+ operationId: PostReservationsReservation
+ summary: Updates a Reservation
+ description: Updates a Reservation which can be associated with any resource as required.
+ x-authenticated: true
+ parameters:
+ - in: path
+ name: id
+ required: true
+ description: The ID of the Reservation to update.
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/AdminPostReservationsReservationReq.yaml
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source:
+ $ref: ../code_samples/JavaScript/reservations_{id}/postundefined
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/reservations_{id}/postundefined
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Reservation
+ 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
diff --git a/docs/api/admin/paths/return-reasons.yaml b/docs/api/admin/paths/return-reasons.yaml
index 9f837be913..38a19d8144 100644
--- a/docs/api/admin/paths/return-reasons.yaml
+++ b/docs/api/admin/paths/return-reasons.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: ../components/schemas/ReturnReason.yaml
+ $ref: ../components/schemas/AdminReturnReasonsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -69,12 +66,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- return_reasons:
- type: array
- items:
- $ref: ../components/schemas/ReturnReason.yaml
+ $ref: ../components/schemas/AdminReturnReasonsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/return-reasons_{id}.yaml b/docs/api/admin/paths/return-reasons_{id}.yaml
index 7d33d59612..2071e18767 100644
--- a/docs/api/admin/paths/return-reasons_{id}.yaml
+++ b/docs/api/admin/paths/return-reasons_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted return reason
- object:
- type: string
- description: The type of the object that was deleted.
- default: return_reason
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminReturnReasonsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: ../components/schemas/ReturnReason.yaml
+ $ref: ../components/schemas/AdminReturnReasonsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: ../components/schemas/ReturnReason.yaml
+ $ref: ../components/schemas/AdminReturnReasonsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/returns.yaml b/docs/api/admin/paths/returns.yaml
index 556bf4fb98..9db369f85b 100644
--- a/docs/api/admin/paths/returns.yaml
+++ b/docs/api/admin/paths/returns.yaml
@@ -35,21 +35,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- returns:
- type: array
- items:
- $ref: ../components/schemas/Return.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/AdminReturnsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/returns_{id}_cancel.yaml b/docs/api/admin/paths/returns_{id}_cancel.yaml
index 6eb4ddc4d9..e2f6d13915 100644
--- a/docs/api/admin/paths/returns_{id}_cancel.yaml
+++ b/docs/api/admin/paths/returns_{id}_cancel.yaml
@@ -29,10 +29,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: ../components/schemas/Order.yaml
+ $ref: ../components/schemas/AdminReturnsCancelRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/returns_{id}_receive.yaml b/docs/api/admin/paths/returns_{id}_receive.yaml
index a9b568196a..f4941020f5 100644
--- a/docs/api/admin/paths/returns_{id}_receive.yaml
+++ b/docs/api/admin/paths/returns_{id}_receive.yaml
@@ -36,10 +36,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- return:
- $ref: ../components/schemas/Return.yaml
+ $ref: ../components/schemas/AdminReturnsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/sales-channels.yaml b/docs/api/admin/paths/sales-channels.yaml
index ab7bab6a69..19b2b2597a 100644
--- a/docs/api/admin/paths/sales-channels.yaml
+++ b/docs/api/admin/paths/sales-channels.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: ../components/schemas/SalesChannel.yaml
+ $ref: ../components/schemas/AdminSalesChannelsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -187,21 +184,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- sales_channels:
- type: array
- items:
- $ref: ../components/schemas/SalesChannel.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/AdminSalesChannelsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/sales-channels_{id}.yaml b/docs/api/admin/paths/sales-channels_{id}.yaml
index df2e649fdc..d0cf30ee46 100644
--- a/docs/api/admin/paths/sales-channels_{id}.yaml
+++ b/docs/api/admin/paths/sales-channels_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted sales channel
- object:
- type: string
- description: The type of the object that was deleted.
- default: sales-channel
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminSalesChannelsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: ../components/schemas/SalesChannel.yaml
+ $ref: ../components/schemas/AdminSalesChannelsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: ../components/schemas/SalesChannel.yaml
+ $ref: ../components/schemas/AdminSalesChannelsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml b/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml
index e85bfabb81..fe479a5dab 100644
--- a/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml
+++ b/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml
@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: ../components/schemas/SalesChannel.yaml
+ $ref: ../components/schemas/AdminSalesChannelsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -93,10 +90,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: ../components/schemas/SalesChannel.yaml
+ $ref: ../components/schemas/AdminSalesChannelsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml b/docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml
index 57a80b1051..54c7e9f435 100644
--- a/docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml
+++ b/docs/api/admin/paths/sales-channels_{id}_stock-locations.yaml
@@ -38,10 +38,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- sales_channel:
- $ref: ../components/schemas/SalesChannel.yaml
+ $ref: ../components/schemas/AdminSalesChannelsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -94,19 +91,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the removed stock location from a sales channel
- object:
- type: string
- description: The type of the object that was removed.
- default: stock-location
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminSalesChannelsDeleteLocationRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/shipping-options.yaml b/docs/api/admin/paths/shipping-options.yaml
index 0e3d88bb08..26e8d73ece 100644
--- a/docs/api/admin/paths/shipping-options.yaml
+++ b/docs/api/admin/paths/shipping-options.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: ../components/schemas/ShippingOption.yaml
+ $ref: ../components/schemas/AdminShippingOptionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -85,15 +82,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: ../components/schemas/ShippingOption.yaml
- count:
- type: integer
- description: The total number of items available
+ $ref: ../components/schemas/AdminShippingOptionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/shipping-options_{id}.yaml b/docs/api/admin/paths/shipping-options_{id}.yaml
index 32f77bde79..aafe06cad9 100644
--- a/docs/api/admin/paths/shipping-options_{id}.yaml
+++ b/docs/api/admin/paths/shipping-options_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping-option
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminShippingOptionsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: ../components/schemas/ShippingOption.yaml
+ $ref: ../components/schemas/AdminShippingOptionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- shipping_option:
- $ref: ../components/schemas/ShippingOption.yaml
+ $ref: ../components/schemas/AdminShippingOptionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/shipping-profiles.yaml b/docs/api/admin/paths/shipping-profiles.yaml
index a6d0019d37..d3a03a5a0a 100644
--- a/docs/api/admin/paths/shipping-profiles.yaml
+++ b/docs/api/admin/paths/shipping-profiles.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: ../components/schemas/ShippingProfile.yaml
+ $ref: ../components/schemas/AdminShippingProfilesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -69,12 +66,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profiles:
- type: array
- items:
- $ref: ../components/schemas/ShippingProfile.yaml
+ $ref: ../components/schemas/AdminShippingProfilesListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/shipping-profiles_{id}.yaml b/docs/api/admin/paths/shipping-profiles_{id}.yaml
index 7e8ced6ba8..50419aac0f 100644
--- a/docs/api/admin/paths/shipping-profiles_{id}.yaml
+++ b/docs/api/admin/paths/shipping-profiles_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Profile.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping_profile
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminDeleteShippingProfileRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: ../components/schemas/ShippingProfile.yaml
+ $ref: ../components/schemas/AdminShippingProfilesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -139,10 +124,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- shipping_profile:
- $ref: ../components/schemas/ShippingProfile.yaml
+ $ref: ../components/schemas/AdminShippingProfilesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/stock-locations.yaml b/docs/api/admin/paths/stock-locations.yaml
index 7677f046c3..5026f18c23 100644
--- a/docs/api/admin/paths/stock-locations.yaml
+++ b/docs/api/admin/paths/stock-locations.yaml
@@ -39,10 +39,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: ../components/schemas/StockLocationDTO.yaml
+ $ref: ../components/schemas/AdminStockLocationsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -188,21 +185,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- stock_locations:
- type: array
- items:
- $ref: ../components/schemas/StockLocationDTO.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/AdminStockLocationsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/stock-locations_{id}.yaml b/docs/api/admin/paths/stock-locations_{id}.yaml
index e7311484f4..f3ecb5ae36 100644
--- a/docs/api/admin/paths/stock-locations_{id}.yaml
+++ b/docs/api/admin/paths/stock-locations_{id}.yaml
@@ -40,10 +40,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: ../components/schemas/StockLocationDTO.yaml
+ $ref: ../components/schemas/AdminStockLocationsRes.yaml
post:
operationId: PostStockLocationsStockLocation
summary: Update a Stock Location
@@ -91,10 +88,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- stock_location:
- $ref: ../components/schemas/StockLocationDTO.yaml
+ $ref: ../components/schemas/AdminStockLocationsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/store.yaml b/docs/api/admin/paths/store.yaml
index 43e9b03410..92ad3d600a 100644
--- a/docs/api/admin/paths/store.yaml
+++ b/docs/api/admin/paths/store.yaml
@@ -23,10 +23,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: ../components/schemas/Store.yaml
+ $ref: ../components/schemas/AdminStoresRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -69,10 +66,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: ../components/schemas/Store.yaml
+ $ref: ../components/schemas/AdminStoresRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/store_currencies_{code}.yaml b/docs/api/admin/paths/store_currencies_{code}.yaml
index 651a4d03cb..9592667940 100644
--- a/docs/api/admin/paths/store_currencies_{code}.yaml
+++ b/docs/api/admin/paths/store_currencies_{code}.yaml
@@ -33,10 +33,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: ../components/schemas/Store.yaml
+ $ref: ../components/schemas/AdminStoresRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -84,10 +81,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- store:
- $ref: ../components/schemas/Store.yaml
+ $ref: ../components/schemas/AdminStoresRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/store_payment-providers.yaml b/docs/api/admin/paths/store_payment-providers.yaml
index 87f3db3c05..bda19f2490 100644
--- a/docs/api/admin/paths/store_payment-providers.yaml
+++ b/docs/api/admin/paths/store_payment-providers.yaml
@@ -23,12 +23,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- payment_providers:
- type: array
- items:
- $ref: ../components/schemas/PaymentProvider.yaml
+ $ref: ../components/schemas/AdminPaymentProvidersList.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/store_tax-providers.yaml b/docs/api/admin/paths/store_tax-providers.yaml
index 15968f5187..8d0780e899 100644
--- a/docs/api/admin/paths/store_tax-providers.yaml
+++ b/docs/api/admin/paths/store_tax-providers.yaml
@@ -23,12 +23,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- tax_providers:
- type: array
- items:
- $ref: ../components/schemas/TaxProvider.yaml
+ $ref: ../components/schemas/AdminTaxProvidersList.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/swaps.yaml b/docs/api/admin/paths/swaps.yaml
index e3ccdbe78b..d9e3f604a4 100644
--- a/docs/api/admin/paths/swaps.yaml
+++ b/docs/api/admin/paths/swaps.yaml
@@ -36,21 +36,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- swaps:
- type: array
- items:
- $ref: ../components/schemas/Swap.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/AdminSwapsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/swaps_{id}.yaml b/docs/api/admin/paths/swaps_{id}.yaml
index 4463605886..fcd4d58a5e 100644
--- a/docs/api/admin/paths/swaps_{id}.yaml
+++ b/docs/api/admin/paths/swaps_{id}.yaml
@@ -30,10 +30,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: ../components/schemas/Swap.yaml
+ $ref: ../components/schemas/AdminSwapsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/tax-rates.yaml b/docs/api/admin/paths/tax-rates.yaml
index 44a6f2270a..5f1966a1d9 100644
--- a/docs/api/admin/paths/tax-rates.yaml
+++ b/docs/api/admin/paths/tax-rates.yaml
@@ -47,10 +47,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -162,21 +159,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- tax_rates:
- type: array
- items:
- $ref: ../components/schemas/TaxRate.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/AdminTaxRatesListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/tax-rates_{id}.yaml b/docs/api/admin/paths/tax-rates_{id}.yaml
index 64796ba8d6..56b44211de 100644
--- a/docs/api/admin/paths/tax-rates_{id}.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: tax-rate
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminTaxRatesDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -105,10 +93,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -176,10 +161,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml
index 45c9308856..c612cb0c90 100644
--- a/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml
@@ -54,10 +54,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -127,10 +124,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml
index 7db58c1b34..d06afb4f43 100644
--- a/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml
@@ -53,10 +53,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -125,10 +122,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml
index a180a9b0d2..f8aab48ffe 100644
--- a/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml
@@ -56,10 +56,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -130,10 +127,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- tax_rate:
- $ref: ../components/schemas/TaxRate.yaml
+ $ref: ../components/schemas/AdminTaxRatesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/uploads.yaml b/docs/api/admin/paths/uploads.yaml
index 97ded7f302..d2efc7b5b3 100644
--- a/docs/api/admin/paths/uploads.yaml
+++ b/docs/api/admin/paths/uploads.yaml
@@ -34,17 +34,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- uploads:
- type: array
- items:
- type: object
- properties:
- url:
- type: string
- description: The URL of the uploaded file.
- format: uri
+ $ref: ../components/schemas/AdminUploadsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,19 +77,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The file key of the upload deleted
- object:
- type: string
- description: The type of the object that was deleted.
- default: file
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminDeleteUploadsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/uploads_download-url.yaml b/docs/api/admin/paths/uploads_download-url.yaml
index fb6abd3a9a..716ab2a434 100644
--- a/docs/api/admin/paths/uploads_download-url.yaml
+++ b/docs/api/admin/paths/uploads_download-url.yaml
@@ -28,11 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- download_url:
- type: string
- description: The Download URL of the file
+ $ref: ../components/schemas/AdminUploadsDownloadUrlRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/uploads_protected.yaml b/docs/api/admin/paths/uploads_protected.yaml
index 45bf68a6b9..d0429c3886 100644
--- a/docs/api/admin/paths/uploads_protected.yaml
+++ b/docs/api/admin/paths/uploads_protected.yaml
@@ -34,17 +34,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- uploads:
- type: array
- items:
- type: object
- properties:
- url:
- type: string
- description: The URL of the uploaded file.
- format: uri
+ $ref: ../components/schemas/AdminUploadsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/users.yaml b/docs/api/admin/paths/users.yaml
index 33f32882bb..b43a7478a4 100644
--- a/docs/api/admin/paths/users.yaml
+++ b/docs/api/admin/paths/users.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: ../components/schemas/User.yaml
+ $ref: ../components/schemas/AdminUserRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -69,12 +66,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- users:
- type: array
- items:
- $ref: ../components/schemas/User.yaml
+ $ref: ../components/schemas/AdminUsersListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/users_reset-password.yaml b/docs/api/admin/paths/users_reset-password.yaml
index bda603c314..32edb08c36 100644
--- a/docs/api/admin/paths/users_reset-password.yaml
+++ b/docs/api/admin/paths/users_reset-password.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: ../components/schemas/User.yaml
+ $ref: ../components/schemas/AdminUserRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/users_{id}.yaml b/docs/api/admin/paths/users_{id}.yaml
index 7b023f8546..3719da14ca 100644
--- a/docs/api/admin/paths/users_{id}.yaml
+++ b/docs/api/admin/paths/users_{id}.yaml
@@ -30,19 +30,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- id:
- type: string
- description: The ID of the deleted user.
- object:
- type: string
- description: The type of the object that was deleted.
- default: user
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
+ $ref: ../components/schemas/AdminDeleteUserRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -87,10 +75,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: ../components/schemas/User.yaml
+ $ref: ../components/schemas/AdminUserRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -140,10 +125,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- user:
- $ref: ../components/schemas/User.yaml
+ $ref: ../components/schemas/AdminUserRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/admin/paths/variants.yaml b/docs/api/admin/paths/variants.yaml
index c168a933e7..176e1393d2 100644
--- a/docs/api/admin/paths/variants.yaml
+++ b/docs/api/admin/paths/variants.yaml
@@ -113,21 +113,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/AdminVariantsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json
index c234b6d583..78ce2600e0 100644
--- a/docs/api/store-spec3.json
+++ b/docs/api/store-spec3.json
@@ -175,10 +175,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -274,10 +271,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -328,11 +322,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- exists:
- type: boolean
- description: Whether email exists or not.
+ $ref: '#/components/schemas/StoreGetAuthEmailRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -390,10 +380,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -450,10 +437,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -513,42 +497,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- type:
- type: string
- description: The type of the data property.
- enum:
- - order
- - cart
- - swap
- data:
- type: object
- description: >-
- The data of the result object. Its type depends on the
- type field.
- oneOf:
- - type: object
- description: >-
- Cart was successfully authorized and order was placed
- successfully.
- properties:
- order:
- $ref: '#/components/schemas/Order'
- - type: object
- description: >-
- Cart was successfully authorized but requires further
- actions.
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
- - type: object
- description: >-
- When cart is used for a swap and it has been completed
- successfully.
- properties:
- cart:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/StoreCompleteCartRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -600,10 +549,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -655,10 +601,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -714,10 +657,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -773,10 +713,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -839,10 +776,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -913,10 +847,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -980,10 +911,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1044,10 +972,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1109,10 +1034,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1172,10 +1094,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1235,10 +1154,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1299,10 +1215,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/StoreCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1404,21 +1317,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collections:
- type: array
- items:
- $ref: '#/components/schemas/ProductCollection'
- 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/StoreCollectionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1500,10 +1399,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1567,10 +1463,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1647,10 +1540,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1722,10 +1612,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1779,10 +1666,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1846,10 +1730,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1904,22 +1785,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_methods:
- type: array
- items:
- properties:
- provider_id:
- type: string
- description: >-
- The id of the Payment Provider where the payment
- method is saved.
- data:
- type: object
- description: >-
- The data needed for the Payment Provider to use the
- saved payment method.
+ $ref: '#/components/schemas/StoreCustomersListPaymentMethodsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2136,21 +2002,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- orders:
- type: array
- items:
- $ref: '#/components/schemas/Order'
- 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/StoreCustomersListOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2275,10 +2127,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2330,10 +2179,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/StoreGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2382,10 +2228,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/StoreOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2437,10 +2280,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/StoreOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2488,10 +2328,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/StoreOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2610,10 +2447,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/StoreOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2663,10 +2497,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/StoreOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2739,10 +2570,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/StoreOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2869,9 +2697,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2935,9 +2761,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_session:
- $ref: '#/components/schemas/PaymentSession'
+ $ref: '#/components/schemas/StorePaymentCollectionsSessionRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3004,10 +2828,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3097,9 +2918,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3167,9 +2986,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3231,10 +3048,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_session:
- $ref: '#/components/schemas/PaymentSession'
+ $ref: '#/components/schemas/StorePaymentCollectionsSessionRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3245,6 +3059,303 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
+ '/product-categories/{id}':
+ get:
+ operationId: GetProductCategoriesCategory
+ summary: Get a Product Category
+ description: Retrieves a Product Category.
+ x-authenticated: false
+ 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
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.productCategories.retrieve("pcat-id")
+
+ .then(({ productCategory }) => {
+ console.log(productCategory.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/store/product-categories/{id}' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/StoreGetProductCategoryRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ /product-categories:
+ get:
+ operationId: GetProductCategories
+ summary: List Product Categories
+ description: Retrieve a list of product categories.
+ x-authenticated: false
+ parameters:
+ - in: query
+ name: q
+ description: Query used for searching product category names orhandles.
+ schema:
+ type: string
+ - in: query
+ name: parent_category_id
+ description: Returns categories scoped by parent
+ schema:
+ type: string
+ - in: query
+ name: offset
+ description: How many product categories to skip in the result.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: limit
+ description: Limit the number of product categories returned.
+ schema:
+ type: integer
+ default: 100
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/store/product-categories' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ product_categories:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductCategory'
+ 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
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ /product-tags:
+ get:
+ operationId: GetProductTags
+ summary: List Product Tags
+ description: Retrieve a list of Product Tags.
+ x-authenticated: true
+ parameters:
+ - in: query
+ name: limit
+ description: The number of types to return.
+ schema:
+ type: integer
+ default: 20
+ - in: query
+ name: offset
+ description: The number of items to skip before the results.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: order
+ description: The field to sort items by.
+ schema:
+ type: string
+ - in: query
+ name: discount_condition_id
+ description: The discount condition id on which to filter the product tags.
+ schema:
+ type: string
+ - in: query
+ name: value
+ style: form
+ explode: false
+ description: The tag values to search for
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: id
+ style: form
+ explode: false
+ description: The tag IDs to search for
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: q
+ description: A query string to search values for
+ schema:
+ type: string
+ - in: query
+ name: created_at
+ description: Date comparison for when resulting product tags were created.
+ schema:
+ type: object
+ properties:
+ lt:
+ type: string
+ description: filter by dates less than this date
+ format: date
+ gt:
+ type: string
+ description: filter by dates greater than this date
+ format: date
+ lte:
+ type: string
+ description: filter by dates less than or equal to this date
+ format: date
+ gte:
+ type: string
+ description: filter by dates greater than or equal to this date
+ format: date
+ - in: query
+ name: updated_at
+ description: Date comparison for when resulting product tags were updated.
+ schema:
+ type: object
+ properties:
+ lt:
+ type: string
+ description: filter by dates less than this date
+ format: date
+ gt:
+ type: string
+ description: filter by dates greater than this date
+ format: date
+ lte:
+ type: string
+ description: filter by dates less than or equal to this date
+ format: date
+ gte:
+ type: string
+ description: filter by dates greater than or equal to this date
+ format: date
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ medusa.store.productTags.list()
+
+ .then(({ product_tags }) => {
+ console.log(product_tags.length);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/store/product-tags'
+ tags:
+ - Product Tag
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ product_tags:
+ $ref: '#/components/schemas/ProductTag'
+ 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
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
/product-types:
get:
operationId: GetProductTypes
@@ -3375,19 +3486,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product_types:
- $ref: '#/components/schemas/ProductType'
- 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/StoreProductTypesListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3463,20 +3562,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- allOf:
- - $ref: '#/components/schemas/Product'
- - type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: >-
- #/components/schemas/ProductVariantPricesFields
+ $ref: '#/components/schemas/StoreProductsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3669,31 +3755,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- products:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Product'
- - type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: >-
- #/components/schemas/ProductVariantPricesFields
- 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/StoreProductsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3757,13 +3819,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- hits:
- type: array
- description: >-
- Array of results. The format of the items depends on the
- search engine installed on the server.
+ $ref: '#/components/schemas/StorePostSearchRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3813,10 +3869,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/StoreRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3915,12 +3968,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- regions:
- type: array
- items:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/StoreRegionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3970,10 +4018,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/StoreReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4016,12 +4061,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reasons:
- type: array
- items:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/StoreReturnReasonsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4089,10 +4129,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return:
- $ref: '#/components/schemas/Return'
+ $ref: '#/components/schemas/StoreReturnsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4153,12 +4190,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/StoreShippingOptionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4208,12 +4240,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/StoreShippingOptionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4295,10 +4322,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/StoreSwapsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4348,10 +4372,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/StoreSwapsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4408,12 +4429,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variant:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: '#/components/schemas/ProductVariantPricesFields'
+ $ref: '#/components/schemas/StoreVariantsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4505,14 +4521,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: '#/components/schemas/ProductVariantPricesFields'
+ $ref: '#/components/schemas/StoreVariantsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4574,10 +4583,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -8539,6 +8545,41 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ProductVariantInventoryItem:
+ title: Product Variant Inventory Item
+ description: >-
+ Product Variant Inventory Items link variants with inventory items and
+ denote the number of inventory items constituting a variant.
+ type: object
+ properties:
+ id:
+ type: string
+ description: The product variant inventory item's ID
+ example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+ inventory_item_id:
+ description: The id of the inventory item
+ type: string
+ variant_id:
+ description: The id of the variant.
+ type: string
+ required_quantity:
+ description: >-
+ The quantity of an inventory item required for one quantity of the
+ variant.
+ type: integer
+ default: 1
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
ProductVariant:
title: Product Variant
description: >-
@@ -8696,46 +8737,6 @@ components:
description: An optional key-value map with additional details
example:
car: white
- ProductVariantPricesFields:
- title: Product Variant Prices Fields
- description: Product Variants Prices Fields that are only available in some requests.
- type: object
- properties:
- original_price:
- type: number
- description: >-
- The original price of the variant without any discounted prices
- applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
Product:
title: Product
description: >-
@@ -10260,6 +10261,98 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ReservationItemDTO:
+ title: Reservation item
+ description: Represents a reservation of an inventory item at a stock location
+ type: object
+ required:
+ - id
+ - location_id
+ - inventory_item_id
+ - quantity
+ properties:
+ id:
+ description: The id of the reservation item
+ type: string
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ inventory_item_id:
+ description: The id of the inventory item the reservation relates to
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ type: object
+ description: An optional key-value map with additional details
+ example:
+ car: white
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
+ PricedVariant:
+ title: Priced Product Variant
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/ProductVariant'
+ - type: object
+ properties:
+ original_price:
+ type: number
+ description: >-
+ The original price of the variant without any discounted prices
+ applied.
+ calculated_price:
+ type: number
+ description: The calculated price of the variant. Can be a discounted price.
+ original_price_incl_tax:
+ type: number
+ description: The original price of the variant including taxes.
+ calculated_price_incl_tax:
+ type: number
+ description: The calculated price of the variant including taxes.
+ original_tax:
+ type: number
+ description: The taxes applied on the original price.
+ calculated_tax:
+ type: number
+ description: The taxes applied on the calculated price.
+ tax_rates:
+ type: array
+ description: An array of applied tax rates
+ items:
+ type: object
+ properties:
+ rate:
+ type: number
+ description: The tax rate value
+ name:
+ type: string
+ description: The name of the tax rate
+ code:
+ type: string
+ description: The code of the tax rate
+ PricedProduct:
+ title: Priced Product
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/Product'
+ - type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedVariant'
StockLocationAddressDTO:
title: Stock Location Address
description: Represents a Stock Location Address
@@ -10476,6 +10569,17 @@ components:
type:
type: string
description: A slug indicating the type of the error.
+ StoreAuthRes:
+ type: object
+ properties:
+ customer:
+ $ref: '#/components/schemas/Customer'
+ StoreGetAuthEmailRes:
+ type: object
+ properties:
+ exists:
+ type: boolean
+ description: Whether email exists or not.
StorePostCartReq:
type: object
properties:
@@ -10516,6 +10620,43 @@ components:
example:
ip: '::1'
user_agent: Chrome
+ StoreCartsRes:
+ type: object
+ properties:
+ cart:
+ $ref: '#/components/schemas/Cart'
+ StoreCompleteCartRes:
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of the data property.
+ enum:
+ - order
+ - cart
+ - swap
+ data:
+ type: object
+ description: The data of the result object. Its type depends on the type field.
+ oneOf:
+ - type: object
+ allOf:
+ - description: >-
+ Cart was successfully authorized and order was placed
+ successfully.
+ - $ref: '#/components/schemas/Order'
+ - type: object
+ allOf:
+ - description: >-
+ Cart was successfully authorized but requires further
+ actions.
+ - $ref: '#/components/schemas/Cart'
+ - type: object
+ allOf:
+ - description: >-
+ When cart is used for a swap and it has been completed
+ successfully.
+ - $ref: '#/components/schemas/Swap'
StorePostCartsCartReq:
type: object
properties:
@@ -10579,6 +10720,27 @@ components:
example:
ip: '::1'
user_agent: Chrome
+ StoreCollectionsListRes:
+ type: object
+ properties:
+ collections:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductCollection'
+ 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
+ StoreCollectionsRes:
+ type: object
+ properties:
+ collection:
+ $ref: '#/components/schemas/ProductCollection'
StorePostCustomersCustomerAddressesReq:
type: object
required:
@@ -10621,6 +10783,45 @@ components:
phone:
description: The Customer's phone number.
type: string
+ StoreCustomersRes:
+ type: object
+ properties:
+ customer:
+ $ref: '#/components/schemas/Customer'
+ StoreCustomersListOrdersRes:
+ type: object
+ properties:
+ orders:
+ type: array
+ items:
+ $ref: '#/components/schemas/Order'
+ 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
+ StoreCustomersListPaymentMethodsRes:
+ type: object
+ properties:
+ payment_methods:
+ type: array
+ items:
+ type: object
+ properties:
+ provider_id:
+ type: string
+ description: >-
+ The id of the Payment Provider where the payment method is
+ saved.
+ data:
+ type: object
+ description: >-
+ The data needed for the Payment Provider to use the saved
+ payment method.
StorePostCustomersCustomerPasswordTokenReq:
type: object
required:
@@ -10679,12 +10880,22 @@ components:
metadata:
description: Metadata about the customer.
type: object
+ StoreGiftCardsRes:
+ type: object
+ properties:
+ gift_card:
+ $ref: '#/components/schemas/GiftCard'
StorePostOrderEditsOrderEditDecline:
type: object
properties:
declined_reason:
type: string
description: The reason for declining the OrderEdit.
+ StoreOrderEditsRes:
+ type: object
+ properties:
+ order_edit:
+ $ref: '#/components/schemas/OrderEdit'
StorePostCustomersCustomerAcceptClaimReq:
type: object
required:
@@ -10693,6 +10904,11 @@ components:
token:
description: The invite token provided by the admin.
type: string
+ StoreOrdersRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
StorePostCustomersCustomerOrderClaimReq:
type: object
required:
@@ -10713,6 +10929,16 @@ components:
type: array
items:
type: string
+ StorePaymentCollectionsRes:
+ type: object
+ properties:
+ payment_collection:
+ $ref: '#/components/schemas/PaymentCollection'
+ StorePaymentCollectionsSessionRes:
+ type: object
+ properties:
+ payment_session:
+ $ref: '#/components/schemas/PaymentSession'
StorePostPaymentCollectionsBatchSessionsReq:
type: object
required:
@@ -10746,6 +10972,80 @@ components:
provider_id:
type: string
description: The ID of the Payment Provider.
+ StoreGetProductCategoryRes:
+ type: object
+ properties:
+ product_category:
+ $ref: '#/components/schemas/ProductCategory'
+ StoreProductTypesListRes:
+ type: object
+ properties:
+ product_types:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductType'
+ 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
+ StoreProductsRes:
+ type: object
+ properties:
+ product:
+ $ref: '#/components/schemas/PricedProduct'
+ StorePostSearchRes:
+ type: object
+ properties:
+ hits:
+ type: array
+ description: >-
+ Array of results. The format of the items depends on the search
+ engine installed on the server.
+ StoreProductsListRes:
+ type: object
+ properties:
+ products:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedProduct'
+ 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
+ StoreRegionsListRes:
+ type: object
+ properties:
+ regions:
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
+ StoreRegionsRes:
+ type: object
+ properties:
+ region:
+ $ref: '#/components/schemas/Region'
+ StoreReturnReasonsListRes:
+ type: object
+ properties:
+ return_reasons:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReturnReason'
+ StoreReturnReasonsRes:
+ type: object
+ properties:
+ return_reason:
+ $ref: '#/components/schemas/ReturnReason'
StorePostReturnsReq:
type: object
required:
@@ -10789,6 +11089,18 @@ components:
description: >-
The ID of the Shipping Option to create the Shipping Method
from.
+ StoreReturnsRes:
+ type: object
+ properties:
+ return:
+ $ref: '#/components/schemas/Return'
+ StoreShippingOptionsListRes:
+ type: object
+ properties:
+ shipping_options:
+ type: array
+ items:
+ $ref: '#/components/schemas/ShippingOption'
StorePostSwapsReq:
type: object
required:
@@ -10836,3 +11148,20 @@ components:
quantity:
description: The quantity to send of the variant.
type: integer
+ StoreSwapsRes:
+ type: object
+ properties:
+ swap:
+ $ref: '#/components/schemas/Swap'
+ StoreVariantsRes:
+ type: object
+ properties:
+ variant:
+ $ref: '#/components/schemas/PricedVariant'
+ StoreVariantsListRes:
+ type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedVariant'
diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml
index c234b6d583..78ce2600e0 100644
--- a/docs/api/store-spec3.yaml
+++ b/docs/api/store-spec3.yaml
@@ -175,10 +175,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -274,10 +271,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreAuthRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -328,11 +322,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- exists:
- type: boolean
- description: Whether email exists or not.
+ $ref: '#/components/schemas/StoreGetAuthEmailRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -390,10 +380,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -450,10 +437,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -513,42 +497,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- type:
- type: string
- description: The type of the data property.
- enum:
- - order
- - cart
- - swap
- data:
- type: object
- description: >-
- The data of the result object. Its type depends on the
- type field.
- oneOf:
- - type: object
- description: >-
- Cart was successfully authorized and order was placed
- successfully.
- properties:
- order:
- $ref: '#/components/schemas/Order'
- - type: object
- description: >-
- Cart was successfully authorized but requires further
- actions.
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
- - type: object
- description: >-
- When cart is used for a swap and it has been completed
- successfully.
- properties:
- cart:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/StoreCompleteCartRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -600,10 +549,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -655,10 +601,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -714,10 +657,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -773,10 +713,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -839,10 +776,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -913,10 +847,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -980,10 +911,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1044,10 +972,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1109,10 +1034,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1172,10 +1094,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1235,10 +1154,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1299,10 +1215,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: '#/components/schemas/ProductCollection'
+ $ref: '#/components/schemas/StoreCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1404,21 +1317,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- collections:
- type: array
- items:
- $ref: '#/components/schemas/ProductCollection'
- 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/StoreCollectionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1500,10 +1399,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1567,10 +1463,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -1647,10 +1540,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1722,10 +1612,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1779,10 +1666,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1846,10 +1730,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -1904,22 +1785,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_methods:
- type: array
- items:
- properties:
- provider_id:
- type: string
- description: >-
- The id of the Payment Provider where the payment
- method is saved.
- data:
- type: object
- description: >-
- The data needed for the Payment Provider to use the
- saved payment method.
+ $ref: '#/components/schemas/StoreCustomersListPaymentMethodsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2136,21 +2002,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- orders:
- type: array
- items:
- $ref: '#/components/schemas/Order'
- 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/StoreCustomersListOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2275,10 +2127,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: '#/components/schemas/Customer'
+ $ref: '#/components/schemas/StoreCustomersRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2330,10 +2179,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: '#/components/schemas/GiftCard'
+ $ref: '#/components/schemas/StoreGiftCardsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2382,10 +2228,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/StoreOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2437,10 +2280,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/StoreOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2488,10 +2328,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: '#/components/schemas/OrderEdit'
+ $ref: '#/components/schemas/StoreOrderEditsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2610,10 +2447,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/StoreOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2663,10 +2497,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/StoreOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2739,10 +2570,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: '#/components/schemas/Order'
+ $ref: '#/components/schemas/StoreOrdersRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -2869,9 +2697,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -2935,9 +2761,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_session:
- $ref: '#/components/schemas/PaymentSession'
+ $ref: '#/components/schemas/StorePaymentCollectionsSessionRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3004,10 +2828,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3097,9 +2918,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3167,9 +2986,7 @@ paths:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: '#/components/schemas/PaymentCollection'
+ $ref: '#/components/schemas/StorePaymentCollectionsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3231,10 +3048,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- payment_session:
- $ref: '#/components/schemas/PaymentSession'
+ $ref: '#/components/schemas/StorePaymentCollectionsSessionRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3245,6 +3059,303 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
+ '/product-categories/{id}':
+ get:
+ operationId: GetProductCategoriesCategory
+ summary: Get a Product Category
+ description: Retrieves a Product Category.
+ x-authenticated: false
+ 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
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ // must be previously logged in or use api token
+
+ medusa.productCategories.retrieve("pcat-id")
+
+ .then(({ productCategory }) => {
+ console.log(productCategory.id);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/store/product-categories/{id}' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/StoreGetProductCategoryRes'
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ /product-categories:
+ get:
+ operationId: GetProductCategories
+ summary: List Product Categories
+ description: Retrieve a list of product categories.
+ x-authenticated: false
+ parameters:
+ - in: query
+ name: q
+ description: Query used for searching product category names orhandles.
+ schema:
+ type: string
+ - in: query
+ name: parent_category_id
+ description: Returns categories scoped by parent
+ schema:
+ type: string
+ - in: query
+ name: offset
+ description: How many product categories to skip in the result.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: limit
+ description: Limit the number of product categories returned.
+ schema:
+ type: integer
+ default: 100
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/store/product-categories' \
+
+ --header 'Authorization: Bearer {api_token}'
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ product_categories:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductCategory'
+ 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
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ /product-tags:
+ get:
+ operationId: GetProductTags
+ summary: List Product Tags
+ description: Retrieve a list of Product Tags.
+ x-authenticated: true
+ parameters:
+ - in: query
+ name: limit
+ description: The number of types to return.
+ schema:
+ type: integer
+ default: 20
+ - in: query
+ name: offset
+ description: The number of items to skip before the results.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: order
+ description: The field to sort items by.
+ schema:
+ type: string
+ - in: query
+ name: discount_condition_id
+ description: The discount condition id on which to filter the product tags.
+ schema:
+ type: string
+ - in: query
+ name: value
+ style: form
+ explode: false
+ description: The tag values to search for
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: id
+ style: form
+ explode: false
+ description: The tag IDs to search for
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: q
+ description: A query string to search values for
+ schema:
+ type: string
+ - in: query
+ name: created_at
+ description: Date comparison for when resulting product tags were created.
+ schema:
+ type: object
+ properties:
+ lt:
+ type: string
+ description: filter by dates less than this date
+ format: date
+ gt:
+ type: string
+ description: filter by dates greater than this date
+ format: date
+ lte:
+ type: string
+ description: filter by dates less than or equal to this date
+ format: date
+ gte:
+ type: string
+ description: filter by dates greater than or equal to this date
+ format: date
+ - in: query
+ name: updated_at
+ description: Date comparison for when resulting product tags were updated.
+ schema:
+ type: object
+ properties:
+ lt:
+ type: string
+ description: filter by dates less than this date
+ format: date
+ gt:
+ type: string
+ description: filter by dates greater than this date
+ format: date
+ lte:
+ type: string
+ description: filter by dates less than or equal to this date
+ format: date
+ gte:
+ type: string
+ description: filter by dates greater than or equal to this date
+ format: date
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source: >
+ import Medusa from "@medusajs/medusa-js"
+
+ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
+ 3 })
+
+ medusa.store.productTags.list()
+
+ .then(({ product_tags }) => {
+ console.log(product_tags.length);
+ });
+ - lang: Shell
+ label: cURL
+ source: >
+ curl --location --request GET
+ 'https://medusa-url.com/store/product-tags'
+ tags:
+ - Product Tag
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ product_tags:
+ $ref: '#/components/schemas/ProductTag'
+ 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
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
/product-types:
get:
operationId: GetProductTypes
@@ -3375,19 +3486,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product_types:
- $ref: '#/components/schemas/ProductType'
- 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/StoreProductTypesListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -3463,20 +3562,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- product:
- allOf:
- - $ref: '#/components/schemas/Product'
- - type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: >-
- #/components/schemas/ProductVariantPricesFields
+ $ref: '#/components/schemas/StoreProductsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3669,31 +3755,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- products:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Product'
- - type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: >-
- #/components/schemas/ProductVariantPricesFields
- 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/StoreProductsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3757,13 +3819,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- hits:
- type: array
- description: >-
- Array of results. The format of the items depends on the
- search engine installed on the server.
+ $ref: '#/components/schemas/StorePostSearchRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3813,10 +3869,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/StoreRegionsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3915,12 +3968,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- regions:
- type: array
- items:
- $ref: '#/components/schemas/Region'
+ $ref: '#/components/schemas/StoreRegionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -3970,10 +4018,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/StoreReturnReasonsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4016,12 +4061,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return_reasons:
- type: array
- items:
- $ref: '#/components/schemas/ReturnReason'
+ $ref: '#/components/schemas/StoreReturnReasonsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4089,10 +4129,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- return:
- $ref: '#/components/schemas/Return'
+ $ref: '#/components/schemas/StoreReturnsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4153,12 +4190,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/StoreShippingOptionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4208,12 +4240,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: '#/components/schemas/ShippingOption'
+ $ref: '#/components/schemas/StoreShippingOptionsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4295,10 +4322,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/StoreSwapsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4348,10 +4372,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: '#/components/schemas/Swap'
+ $ref: '#/components/schemas/StoreSwapsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4408,12 +4429,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variant:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: '#/components/schemas/ProductVariantPricesFields'
+ $ref: '#/components/schemas/StoreVariantsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4505,14 +4521,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - $ref: '#/components/schemas/ProductVariantPricesFields'
+ $ref: '#/components/schemas/StoreVariantsListRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -4574,10 +4583,7 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: '#/components/schemas/Cart'
+ $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
'404':
@@ -8539,6 +8545,41 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ProductVariantInventoryItem:
+ title: Product Variant Inventory Item
+ description: >-
+ Product Variant Inventory Items link variants with inventory items and
+ denote the number of inventory items constituting a variant.
+ type: object
+ properties:
+ id:
+ type: string
+ description: The product variant inventory item's ID
+ example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+ inventory_item_id:
+ description: The id of the inventory item
+ type: string
+ variant_id:
+ description: The id of the variant.
+ type: string
+ required_quantity:
+ description: >-
+ The quantity of an inventory item required for one quantity of the
+ variant.
+ type: integer
+ default: 1
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
ProductVariant:
title: Product Variant
description: >-
@@ -8696,46 +8737,6 @@ components:
description: An optional key-value map with additional details
example:
car: white
- ProductVariantPricesFields:
- title: Product Variant Prices Fields
- description: Product Variants Prices Fields that are only available in some requests.
- type: object
- properties:
- original_price:
- type: number
- description: >-
- The original price of the variant without any discounted prices
- applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
Product:
title: Product
description: >-
@@ -10260,6 +10261,98 @@ components:
description: An optional key-value map with additional details
example:
car: white
+ ReservationItemDTO:
+ title: Reservation item
+ description: Represents a reservation of an inventory item at a stock location
+ type: object
+ required:
+ - id
+ - location_id
+ - inventory_item_id
+ - quantity
+ properties:
+ id:
+ description: The id of the reservation item
+ type: string
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ inventory_item_id:
+ description: The id of the inventory item the reservation relates to
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ type: object
+ description: An optional key-value map with additional details
+ example:
+ car: white
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
+ PricedVariant:
+ title: Priced Product Variant
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/ProductVariant'
+ - type: object
+ properties:
+ original_price:
+ type: number
+ description: >-
+ The original price of the variant without any discounted prices
+ applied.
+ calculated_price:
+ type: number
+ description: The calculated price of the variant. Can be a discounted price.
+ original_price_incl_tax:
+ type: number
+ description: The original price of the variant including taxes.
+ calculated_price_incl_tax:
+ type: number
+ description: The calculated price of the variant including taxes.
+ original_tax:
+ type: number
+ description: The taxes applied on the original price.
+ calculated_tax:
+ type: number
+ description: The taxes applied on the calculated price.
+ tax_rates:
+ type: array
+ description: An array of applied tax rates
+ items:
+ type: object
+ properties:
+ rate:
+ type: number
+ description: The tax rate value
+ name:
+ type: string
+ description: The name of the tax rate
+ code:
+ type: string
+ description: The code of the tax rate
+ PricedProduct:
+ title: Priced Product
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/Product'
+ - type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedVariant'
StockLocationAddressDTO:
title: Stock Location Address
description: Represents a Stock Location Address
@@ -10476,6 +10569,17 @@ components:
type:
type: string
description: A slug indicating the type of the error.
+ StoreAuthRes:
+ type: object
+ properties:
+ customer:
+ $ref: '#/components/schemas/Customer'
+ StoreGetAuthEmailRes:
+ type: object
+ properties:
+ exists:
+ type: boolean
+ description: Whether email exists or not.
StorePostCartReq:
type: object
properties:
@@ -10516,6 +10620,43 @@ components:
example:
ip: '::1'
user_agent: Chrome
+ StoreCartsRes:
+ type: object
+ properties:
+ cart:
+ $ref: '#/components/schemas/Cart'
+ StoreCompleteCartRes:
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of the data property.
+ enum:
+ - order
+ - cart
+ - swap
+ data:
+ type: object
+ description: The data of the result object. Its type depends on the type field.
+ oneOf:
+ - type: object
+ allOf:
+ - description: >-
+ Cart was successfully authorized and order was placed
+ successfully.
+ - $ref: '#/components/schemas/Order'
+ - type: object
+ allOf:
+ - description: >-
+ Cart was successfully authorized but requires further
+ actions.
+ - $ref: '#/components/schemas/Cart'
+ - type: object
+ allOf:
+ - description: >-
+ When cart is used for a swap and it has been completed
+ successfully.
+ - $ref: '#/components/schemas/Swap'
StorePostCartsCartReq:
type: object
properties:
@@ -10579,6 +10720,27 @@ components:
example:
ip: '::1'
user_agent: Chrome
+ StoreCollectionsListRes:
+ type: object
+ properties:
+ collections:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductCollection'
+ 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
+ StoreCollectionsRes:
+ type: object
+ properties:
+ collection:
+ $ref: '#/components/schemas/ProductCollection'
StorePostCustomersCustomerAddressesReq:
type: object
required:
@@ -10621,6 +10783,45 @@ components:
phone:
description: The Customer's phone number.
type: string
+ StoreCustomersRes:
+ type: object
+ properties:
+ customer:
+ $ref: '#/components/schemas/Customer'
+ StoreCustomersListOrdersRes:
+ type: object
+ properties:
+ orders:
+ type: array
+ items:
+ $ref: '#/components/schemas/Order'
+ 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
+ StoreCustomersListPaymentMethodsRes:
+ type: object
+ properties:
+ payment_methods:
+ type: array
+ items:
+ type: object
+ properties:
+ provider_id:
+ type: string
+ description: >-
+ The id of the Payment Provider where the payment method is
+ saved.
+ data:
+ type: object
+ description: >-
+ The data needed for the Payment Provider to use the saved
+ payment method.
StorePostCustomersCustomerPasswordTokenReq:
type: object
required:
@@ -10679,12 +10880,22 @@ components:
metadata:
description: Metadata about the customer.
type: object
+ StoreGiftCardsRes:
+ type: object
+ properties:
+ gift_card:
+ $ref: '#/components/schemas/GiftCard'
StorePostOrderEditsOrderEditDecline:
type: object
properties:
declined_reason:
type: string
description: The reason for declining the OrderEdit.
+ StoreOrderEditsRes:
+ type: object
+ properties:
+ order_edit:
+ $ref: '#/components/schemas/OrderEdit'
StorePostCustomersCustomerAcceptClaimReq:
type: object
required:
@@ -10693,6 +10904,11 @@ components:
token:
description: The invite token provided by the admin.
type: string
+ StoreOrdersRes:
+ type: object
+ properties:
+ order:
+ $ref: '#/components/schemas/Order'
StorePostCustomersCustomerOrderClaimReq:
type: object
required:
@@ -10713,6 +10929,16 @@ components:
type: array
items:
type: string
+ StorePaymentCollectionsRes:
+ type: object
+ properties:
+ payment_collection:
+ $ref: '#/components/schemas/PaymentCollection'
+ StorePaymentCollectionsSessionRes:
+ type: object
+ properties:
+ payment_session:
+ $ref: '#/components/schemas/PaymentSession'
StorePostPaymentCollectionsBatchSessionsReq:
type: object
required:
@@ -10746,6 +10972,80 @@ components:
provider_id:
type: string
description: The ID of the Payment Provider.
+ StoreGetProductCategoryRes:
+ type: object
+ properties:
+ product_category:
+ $ref: '#/components/schemas/ProductCategory'
+ StoreProductTypesListRes:
+ type: object
+ properties:
+ product_types:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProductType'
+ 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
+ StoreProductsRes:
+ type: object
+ properties:
+ product:
+ $ref: '#/components/schemas/PricedProduct'
+ StorePostSearchRes:
+ type: object
+ properties:
+ hits:
+ type: array
+ description: >-
+ Array of results. The format of the items depends on the search
+ engine installed on the server.
+ StoreProductsListRes:
+ type: object
+ properties:
+ products:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedProduct'
+ 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
+ StoreRegionsListRes:
+ type: object
+ properties:
+ regions:
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
+ StoreRegionsRes:
+ type: object
+ properties:
+ region:
+ $ref: '#/components/schemas/Region'
+ StoreReturnReasonsListRes:
+ type: object
+ properties:
+ return_reasons:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReturnReason'
+ StoreReturnReasonsRes:
+ type: object
+ properties:
+ return_reason:
+ $ref: '#/components/schemas/ReturnReason'
StorePostReturnsReq:
type: object
required:
@@ -10789,6 +11089,18 @@ components:
description: >-
The ID of the Shipping Option to create the Shipping Method
from.
+ StoreReturnsRes:
+ type: object
+ properties:
+ return:
+ $ref: '#/components/schemas/Return'
+ StoreShippingOptionsListRes:
+ type: object
+ properties:
+ shipping_options:
+ type: array
+ items:
+ $ref: '#/components/schemas/ShippingOption'
StorePostSwapsReq:
type: object
required:
@@ -10836,3 +11148,20 @@ components:
quantity:
description: The quantity to send of the variant.
type: integer
+ StoreSwapsRes:
+ type: object
+ properties:
+ swap:
+ $ref: '#/components/schemas/Swap'
+ StoreVariantsRes:
+ type: object
+ properties:
+ variant:
+ $ref: '#/components/schemas/PricedVariant'
+ StoreVariantsListRes:
+ type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: '#/components/schemas/PricedVariant'
diff --git a/docs/api/store/code_samples/JavaScript/product-categories_{id}/getundefined b/docs/api/store/code_samples/JavaScript/product-categories_{id}/getundefined
new file mode 100644
index 0000000000..0e5671230d
--- /dev/null
+++ b/docs/api/store/code_samples/JavaScript/product-categories_{id}/getundefined
@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.productCategories.retrieve("pcat-id")
+.then(({ productCategory }) => {
+ console.log(productCategory.id);
+});
diff --git a/docs/api/store/code_samples/JavaScript/product-tags/getundefined b/docs/api/store/code_samples/JavaScript/product-tags/getundefined
new file mode 100644
index 0000000000..7d0a963010
--- /dev/null
+++ b/docs/api/store/code_samples/JavaScript/product-tags/getundefined
@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.store.productTags.list()
+.then(({ product_tags }) => {
+ console.log(product_tags.length);
+});
diff --git a/docs/api/store/code_samples/Shell/product-categories/getundefined b/docs/api/store/code_samples/Shell/product-categories/getundefined
new file mode 100644
index 0000000000..73332a22f3
--- /dev/null
+++ b/docs/api/store/code_samples/Shell/product-categories/getundefined
@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/store/product-categories' \
+--header 'Authorization: Bearer {api_token}'
diff --git a/docs/api/store/code_samples/Shell/product-categories_{id}/getundefined b/docs/api/store/code_samples/Shell/product-categories_{id}/getundefined
new file mode 100644
index 0000000000..2df11a1fa6
--- /dev/null
+++ b/docs/api/store/code_samples/Shell/product-categories_{id}/getundefined
@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/store/product-categories/{id}' \
+--header 'Authorization: Bearer {api_token}'
diff --git a/docs/api/store/code_samples/Shell/product-tags/getundefined b/docs/api/store/code_samples/Shell/product-tags/getundefined
new file mode 100644
index 0000000000..7013d00968
--- /dev/null
+++ b/docs/api/store/code_samples/Shell/product-tags/getundefined
@@ -0,0 +1 @@
+curl --location --request GET 'https://medusa-url.com/store/product-tags'
diff --git a/docs/api/store/components/schemas/PricedProduct.yaml b/docs/api/store/components/schemas/PricedProduct.yaml
new file mode 100644
index 0000000000..6054bb7d16
--- /dev/null
+++ b/docs/api/store/components/schemas/PricedProduct.yaml
@@ -0,0 +1,10 @@
+title: Priced Product
+type: object
+allOf:
+ - $ref: ./Product.yaml
+ - type: object
+ properties:
+ variants:
+ type: array
+ items:
+ $ref: ./PricedVariant.yaml
diff --git a/docs/api/store/components/schemas/PricedVariant.yaml b/docs/api/store/components/schemas/PricedVariant.yaml
new file mode 100644
index 0000000000..4b74691549
--- /dev/null
+++ b/docs/api/store/components/schemas/PricedVariant.yaml
@@ -0,0 +1,41 @@
+title: Priced Product Variant
+type: object
+allOf:
+ - $ref: ./ProductVariant.yaml
+ - type: object
+ properties:
+ original_price:
+ type: number
+ description: >-
+ The original price of the variant without any discounted prices
+ applied.
+ calculated_price:
+ type: number
+ description: The calculated price of the variant. Can be a discounted price.
+ original_price_incl_tax:
+ type: number
+ description: The original price of the variant including taxes.
+ calculated_price_incl_tax:
+ type: number
+ description: The calculated price of the variant including taxes.
+ original_tax:
+ type: number
+ description: The taxes applied on the original price.
+ calculated_tax:
+ type: number
+ description: The taxes applied on the calculated price.
+ tax_rates:
+ type: array
+ description: An array of applied tax rates
+ items:
+ type: object
+ properties:
+ rate:
+ type: number
+ description: The tax rate value
+ name:
+ type: string
+ description: The name of the tax rate
+ code:
+ type: string
+ description: The code of the tax rate
diff --git a/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml b/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml
new file mode 100644
index 0000000000..f583f59667
--- /dev/null
+++ b/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml
@@ -0,0 +1,34 @@
+title: Product Variant Inventory Item
+description: >-
+ Product Variant Inventory Items link variants with inventory items and denote
+ the number of inventory items constituting a variant.
+type: object
+properties:
+ id:
+ type: string
+ description: The product variant inventory item's ID
+ example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+ inventory_item_id:
+ description: The id of the inventory item
+ type: string
+ variant_id:
+ description: The id of the variant.
+ type: string
+ required_quantity:
+ description: >-
+ The quantity of an inventory item required for one quantity of the
+ variant.
+ type: integer
+ default: 1
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
diff --git a/docs/api/store/components/schemas/ProductVariantPricesFields.yaml b/docs/api/store/components/schemas/ProductVariantPricesFields.yaml
deleted file mode 100644
index 3bece0c504..0000000000
--- a/docs/api/store/components/schemas/ProductVariantPricesFields.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-title: Product Variant Prices Fields
-description: Product Variants Prices Fields that are only available in some requests.
-type: object
-properties:
- original_price:
- type: number
- description: The original price of the variant without any discounted prices applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
diff --git a/docs/api/store/components/schemas/ReservationItemDTO.yaml b/docs/api/store/components/schemas/ReservationItemDTO.yaml
new file mode 100644
index 0000000000..2a99d8583f
--- /dev/null
+++ b/docs/api/store/components/schemas/ReservationItemDTO.yaml
@@ -0,0 +1,38 @@
+title: Reservation item
+description: Represents a reservation of an inventory item at a stock location
+type: object
+required:
+ - id
+ - location_id
+ - inventory_item_id
+ - quantity
+properties:
+ id:
+ description: The id of the reservation item
+ type: string
+ location_id:
+ description: The id of the location of the reservation
+ type: string
+ inventory_item_id:
+ description: The id of the inventory item the reservation relates to
+ type: string
+ quantity:
+ description: The id of the reservation item
+ type: number
+ metadata:
+ type: object
+ description: An optional key-value map with additional details
+ example:
+ car: white
+ created_at:
+ type: string
+ description: The date with timezone at which the resource was created.
+ format: date-time
+ updated_at:
+ type: string
+ description: The date with timezone at which the resource was updated.
+ format: date-time
+ deleted_at:
+ type: string
+ description: The date with timezone at which the resource was deleted.
+ format: date-time
diff --git a/docs/api/store/components/schemas/StoreAuthRes.yaml b/docs/api/store/components/schemas/StoreAuthRes.yaml
new file mode 100644
index 0000000000..ffb6903bf2
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreAuthRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ customer:
+ $ref: ./Customer.yaml
diff --git a/docs/api/store/components/schemas/StoreCartsRes.yaml b/docs/api/store/components/schemas/StoreCartsRes.yaml
new file mode 100644
index 0000000000..f8895507ed
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreCartsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ cart:
+ $ref: ./Cart.yaml
diff --git a/docs/api/store/components/schemas/StoreCollectionsListRes.yaml b/docs/api/store/components/schemas/StoreCollectionsListRes.yaml
new file mode 100644
index 0000000000..252256786c
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreCollectionsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ collections:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/store/components/schemas/StoreCollectionsRes.yaml b/docs/api/store/components/schemas/StoreCollectionsRes.yaml
new file mode 100644
index 0000000000..7802152206
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreCollectionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ collection:
+ $ref: ./ProductCollection.yaml
diff --git a/docs/api/store/components/schemas/StoreCompleteCartRes.yaml b/docs/api/store/components/schemas/StoreCompleteCartRes.yaml
new file mode 100644
index 0000000000..eb30651ad6
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreCompleteCartRes.yaml
@@ -0,0 +1,29 @@
+type: object
+properties:
+ type:
+ type: string
+ description: The type of the data property.
+ enum:
+ - order
+ - cart
+ - swap
+ data:
+ type: object
+ description: The data of the result object. Its type depends on the type field.
+ oneOf:
+ - type: object
+ allOf:
+ - description: >-
+ Cart was successfully authorized and order was placed
+ successfully.
+ - $ref: ./Order.yaml
+ - type: object
+ allOf:
+ - description: Cart was successfully authorized but requires further actions.
+ - $ref: ./Cart.yaml
+ - type: object
+ allOf:
+ - description: >-
+ When cart is used for a swap and it has been completed
+ successfully.
+ - $ref: ./Swap.yaml
diff --git a/docs/api/store/components/schemas/StoreCustomersListOrdersRes.yaml b/docs/api/store/components/schemas/StoreCustomersListOrdersRes.yaml
new file mode 100644
index 0000000000..1b4106242e
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreCustomersListOrdersRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ orders:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml b/docs/api/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml
new file mode 100644
index 0000000000..4fb8d8304a
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ payment_methods:
+ type: array
+ items:
+ type: object
+ properties:
+ provider_id:
+ type: string
+ description: The id of the Payment Provider where the payment method is saved.
+ data:
+ type: object
+ description: >-
+ The data needed for the Payment Provider to use the saved payment
+ method.
diff --git a/docs/api/store/components/schemas/StoreCustomersRes.yaml b/docs/api/store/components/schemas/StoreCustomersRes.yaml
new file mode 100644
index 0000000000..ffb6903bf2
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreCustomersRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ customer:
+ $ref: ./Customer.yaml
diff --git a/docs/api/store/components/schemas/StoreGetAuthEmailRes.yaml b/docs/api/store/components/schemas/StoreGetAuthEmailRes.yaml
new file mode 100644
index 0000000000..bcc2e3fce2
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreGetAuthEmailRes.yaml
@@ -0,0 +1,5 @@
+type: object
+properties:
+ exists:
+ type: boolean
+ description: Whether email exists or not.
diff --git a/docs/api/store/components/schemas/StoreGetProductCategoryRes.yaml b/docs/api/store/components/schemas/StoreGetProductCategoryRes.yaml
new file mode 100644
index 0000000000..d343bc439f
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreGetProductCategoryRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ product_category:
+ $ref: ./ProductCategory.yaml
diff --git a/docs/api/store/components/schemas/StoreGiftCardsRes.yaml b/docs/api/store/components/schemas/StoreGiftCardsRes.yaml
new file mode 100644
index 0000000000..d72a7917c2
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreGiftCardsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ gift_card:
+ $ref: ./GiftCard.yaml
diff --git a/docs/api/store/components/schemas/StoreOrderEditsRes.yaml b/docs/api/store/components/schemas/StoreOrderEditsRes.yaml
new file mode 100644
index 0000000000..d266863926
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreOrderEditsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ order_edit:
+ $ref: ./OrderEdit.yaml
diff --git a/docs/api/store/components/schemas/StoreOrdersRes.yaml b/docs/api/store/components/schemas/StoreOrdersRes.yaml
new file mode 100644
index 0000000000..43b8e917ca
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreOrdersRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ order:
+ $ref: ./Order.yaml
diff --git a/docs/api/store/components/schemas/StorePaymentCollectionsRes.yaml b/docs/api/store/components/schemas/StorePaymentCollectionsRes.yaml
new file mode 100644
index 0000000000..a7748cf4f4
--- /dev/null
+++ b/docs/api/store/components/schemas/StorePaymentCollectionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ payment_collection:
+ $ref: ./PaymentCollection.yaml
diff --git a/docs/api/store/components/schemas/StorePaymentCollectionsSessionRes.yaml b/docs/api/store/components/schemas/StorePaymentCollectionsSessionRes.yaml
new file mode 100644
index 0000000000..4a421583a8
--- /dev/null
+++ b/docs/api/store/components/schemas/StorePaymentCollectionsSessionRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ payment_session:
+ $ref: ./PaymentSession.yaml
diff --git a/docs/api/store/components/schemas/StorePostSearchRes.yaml b/docs/api/store/components/schemas/StorePostSearchRes.yaml
new file mode 100644
index 0000000000..43237f6eb7
--- /dev/null
+++ b/docs/api/store/components/schemas/StorePostSearchRes.yaml
@@ -0,0 +1,7 @@
+type: object
+properties:
+ hits:
+ type: array
+ description: >-
+ Array of results. The format of the items depends on the search engine
+ installed on the server.
diff --git a/docs/api/store/components/schemas/StoreProductTypesListRes.yaml b/docs/api/store/components/schemas/StoreProductTypesListRes.yaml
new file mode 100644
index 0000000000..4cb021af96
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreProductTypesListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ product_types:
+ type: array
+ items:
+ $ref: ./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
diff --git a/docs/api/store/components/schemas/StoreProductsListRes.yaml b/docs/api/store/components/schemas/StoreProductsListRes.yaml
new file mode 100644
index 0000000000..976580d53a
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreProductsListRes.yaml
@@ -0,0 +1,15 @@
+type: object
+properties:
+ products:
+ type: array
+ items:
+ $ref: ./PricedProduct.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
diff --git a/docs/api/store/components/schemas/StoreProductsRes.yaml b/docs/api/store/components/schemas/StoreProductsRes.yaml
new file mode 100644
index 0000000000..8a64340be6
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreProductsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ product:
+ $ref: ./PricedProduct.yaml
diff --git a/docs/api/store/components/schemas/StoreRegionsListRes.yaml b/docs/api/store/components/schemas/StoreRegionsListRes.yaml
new file mode 100644
index 0000000000..dc541b0eb1
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreRegionsListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ regions:
+ type: array
+ items:
+ $ref: ./Region.yaml
diff --git a/docs/api/store/components/schemas/StoreRegionsRes.yaml b/docs/api/store/components/schemas/StoreRegionsRes.yaml
new file mode 100644
index 0000000000..b4080ea096
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreRegionsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ region:
+ $ref: ./Region.yaml
diff --git a/docs/api/store/components/schemas/StoreReturnReasonsListRes.yaml b/docs/api/store/components/schemas/StoreReturnReasonsListRes.yaml
new file mode 100644
index 0000000000..c52e27f424
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreReturnReasonsListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ return_reasons:
+ type: array
+ items:
+ $ref: ./ReturnReason.yaml
diff --git a/docs/api/store/components/schemas/StoreReturnReasonsRes.yaml b/docs/api/store/components/schemas/StoreReturnReasonsRes.yaml
new file mode 100644
index 0000000000..ac6e4045bd
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreReturnReasonsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ return_reason:
+ $ref: ./ReturnReason.yaml
diff --git a/docs/api/store/components/schemas/StoreReturnsRes.yaml b/docs/api/store/components/schemas/StoreReturnsRes.yaml
new file mode 100644
index 0000000000..3291cf0e08
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreReturnsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ return:
+ $ref: ./Return.yaml
diff --git a/docs/api/store/components/schemas/StoreShippingOptionsListRes.yaml b/docs/api/store/components/schemas/StoreShippingOptionsListRes.yaml
new file mode 100644
index 0000000000..f7fe30ecaf
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreShippingOptionsListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ shipping_options:
+ type: array
+ items:
+ $ref: ./ShippingOption.yaml
diff --git a/docs/api/store/components/schemas/StoreSwapsRes.yaml b/docs/api/store/components/schemas/StoreSwapsRes.yaml
new file mode 100644
index 0000000000..3eaa21eadf
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreSwapsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ swap:
+ $ref: ./Swap.yaml
diff --git a/docs/api/store/components/schemas/StoreVariantsListRes.yaml b/docs/api/store/components/schemas/StoreVariantsListRes.yaml
new file mode 100644
index 0000000000..4f6be3d191
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreVariantsListRes.yaml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ variants:
+ type: array
+ items:
+ $ref: ./PricedVariant.yaml
diff --git a/docs/api/store/components/schemas/StoreVariantsRes.yaml b/docs/api/store/components/schemas/StoreVariantsRes.yaml
new file mode 100644
index 0000000000..7fed2ab768
--- /dev/null
+++ b/docs/api/store/components/schemas/StoreVariantsRes.yaml
@@ -0,0 +1,4 @@
+type: object
+properties:
+ variant:
+ $ref: ./PricedVariant.yaml
diff --git a/docs/api/store/openapi.yaml b/docs/api/store/openapi.yaml
index 4b57d62e00..4a0067f12f 100644
--- a/docs/api/store/openapi.yaml
+++ b/docs/api/store/openapi.yaml
@@ -209,6 +209,12 @@ paths:
$ref: paths/payment-collections_{id}_sessions.yaml
/payment-collections/{id}/sessions/{session_id}:
$ref: paths/payment-collections_{id}_sessions_{session_id}.yaml
+ /product-categories/{id}:
+ $ref: paths/product-categories_{id}.yaml
+ /product-categories:
+ $ref: paths/product-categories.yaml
+ /product-tags:
+ $ref: paths/product-tags.yaml
/product-types:
$ref: paths/product-types.yaml
/products/{id}:
diff --git a/docs/api/store/paths/auth.yaml b/docs/api/store/paths/auth.yaml
index 4fca42845f..fec81cbe6b 100644
--- a/docs/api/store/paths/auth.yaml
+++ b/docs/api/store/paths/auth.yaml
@@ -22,10 +22,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreAuthRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -106,10 +103,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreAuthRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/auth_{email}.yaml b/docs/api/store/paths/auth_{email}.yaml
index ad5684422d..46f2c1f27c 100644
--- a/docs/api/store/paths/auth_{email}.yaml
+++ b/docs/api/store/paths/auth_{email}.yaml
@@ -27,11 +27,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- exists:
- type: boolean
- description: Whether email exists or not.
+ $ref: ../components/schemas/StoreGetAuthEmailRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts.yaml b/docs/api/store/paths/carts.yaml
index da3f3d7945..604faace10 100644
--- a/docs/api/store/paths/carts.yaml
+++ b/docs/api/store/paths/carts.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}.yaml b/docs/api/store/paths/carts_{id}.yaml
index b051075749..2c303abefe 100644
--- a/docs/api/store/paths/carts_{id}.yaml
+++ b/docs/api/store/paths/carts_{id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
@@ -73,10 +70,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_complete.yaml b/docs/api/store/paths/carts_{id}_complete.yaml
index 606ec78757..164f736f13 100644
--- a/docs/api/store/paths/carts_{id}_complete.yaml
+++ b/docs/api/store/paths/carts_{id}_complete.yaml
@@ -36,42 +36,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- type:
- type: string
- description: The type of the data property.
- enum:
- - order
- - cart
- - swap
- data:
- type: object
- description: >-
- The data of the result object. Its type depends on the type
- field.
- oneOf:
- - type: object
- description: >-
- Cart was successfully authorized and order was placed
- successfully.
- properties:
- order:
- $ref: ../components/schemas/Order.yaml
- - type: object
- description: >-
- Cart was successfully authorized but requires further
- actions.
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
- - type: object
- description: >-
- When cart is used for a swap and it has been completed
- successfully.
- properties:
- cart:
- $ref: ../components/schemas/Swap.yaml
+ $ref: ../components/schemas/StoreCompleteCartRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_discounts_{code}.yaml b/docs/api/store/paths/carts_{id}_discounts_{code}.yaml
index c67f1e73e9..9d2e0edc7c 100644
--- a/docs/api/store/paths/carts_{id}_discounts_{code}.yaml
+++ b/docs/api/store/paths/carts_{id}_discounts_{code}.yaml
@@ -32,10 +32,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_line-items.yaml b/docs/api/store/paths/carts_{id}_line-items.yaml
index f8fd4e999c..5927ca5004 100644
--- a/docs/api/store/paths/carts_{id}_line-items.yaml
+++ b/docs/api/store/paths/carts_{id}_line-items.yaml
@@ -26,10 +26,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml b/docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml
index f93ec459e5..f956aa931d 100644
--- a/docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml
+++ b/docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml
@@ -33,10 +33,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
@@ -82,10 +79,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_payment-session.yaml b/docs/api/store/paths/carts_{id}_payment-session.yaml
index 0e1f181270..7a7f0903f5 100644
--- a/docs/api/store/paths/carts_{id}_payment-session.yaml
+++ b/docs/api/store/paths/carts_{id}_payment-session.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_payment-sessions.yaml b/docs/api/store/paths/carts_{id}_payment-sessions.yaml
index c8ab8f1845..7421bf65d3 100644
--- a/docs/api/store/paths/carts_{id}_payment-sessions.yaml
+++ b/docs/api/store/paths/carts_{id}_payment-sessions.yaml
@@ -28,10 +28,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml b/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml
index b0d6b0d8b1..40549de1a9 100644
--- a/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml
+++ b/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml
@@ -36,10 +36,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
@@ -86,10 +83,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml b/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
index dbd9dfc2d4..7c3a88b622 100644
--- a/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
+++ b/docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
@@ -38,10 +38,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_shipping-methods.yaml b/docs/api/store/paths/carts_{id}_shipping-methods.yaml
index 23ae878a7b..d9d73d0b1f 100644
--- a/docs/api/store/paths/carts_{id}_shipping-methods.yaml
+++ b/docs/api/store/paths/carts_{id}_shipping-methods.yaml
@@ -26,10 +26,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/carts_{id}_taxes.yaml b/docs/api/store/paths/carts_{id}_taxes.yaml
index 26ac7abf68..3b2fca7d62 100644
--- a/docs/api/store/paths/carts_{id}_taxes.yaml
+++ b/docs/api/store/paths/carts_{id}_taxes.yaml
@@ -24,10 +24,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- cart:
- $ref: ../components/schemas/Cart.yaml
+ $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/collections.yaml b/docs/api/store/paths/collections.yaml
index 33b779fcbc..7a5decca88 100644
--- a/docs/api/store/paths/collections.yaml
+++ b/docs/api/store/paths/collections.yaml
@@ -78,21 +78,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/StoreCollectionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/collections_{id}.yaml b/docs/api/store/paths/collections_{id}.yaml
index 160582a68a..0e6a630320 100644
--- a/docs/api/store/paths/collections_{id}.yaml
+++ b/docs/api/store/paths/collections_{id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- collection:
- $ref: ../components/schemas/ProductCollection.yaml
+ $ref: ../components/schemas/StoreCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/customers.yaml b/docs/api/store/paths/customers.yaml
index f7b1f5a5e6..9cfa46ca1e 100644
--- a/docs/api/store/paths/customers.yaml
+++ b/docs/api/store/paths/customers.yaml
@@ -24,10 +24,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/customers_me.yaml b/docs/api/store/paths/customers_me.yaml
index 3f0885e0f9..dadcea98c1 100644
--- a/docs/api/store/paths/customers_me.yaml
+++ b/docs/api/store/paths/customers_me.yaml
@@ -24,10 +24,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -69,10 +66,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/customers_me_addresses.yaml b/docs/api/store/paths/customers_me_addresses.yaml
index 2c1b636fff..3dad4c8077 100644
--- a/docs/api/store/paths/customers_me_addresses.yaml
+++ b/docs/api/store/paths/customers_me_addresses.yaml
@@ -27,10 +27,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/customers_me_addresses_{address_id}.yaml b/docs/api/store/paths/customers_me_addresses_{address_id}.yaml
index ae74204d04..40b17f73c7 100644
--- a/docs/api/store/paths/customers_me_addresses_{address_id}.yaml
+++ b/docs/api/store/paths/customers_me_addresses_{address_id}.yaml
@@ -31,10 +31,7 @@ delete:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -86,10 +83,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/customers_me_orders.yaml b/docs/api/store/paths/customers_me_orders.yaml
index b697a9eec7..108b908784 100644
--- a/docs/api/store/paths/customers_me_orders.yaml
+++ b/docs/api/store/paths/customers_me_orders.yaml
@@ -187,21 +187,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/StoreCustomersListOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/customers_me_payment-methods.yaml b/docs/api/store/paths/customers_me_payment-methods.yaml
index f038460c11..3b642ba318 100644
--- a/docs/api/store/paths/customers_me_payment-methods.yaml
+++ b/docs/api/store/paths/customers_me_payment-methods.yaml
@@ -25,22 +25,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- payment_methods:
- type: array
- items:
- properties:
- provider_id:
- type: string
- description: >-
- The id of the Payment Provider where the payment method
- is saved.
- data:
- type: object
- description: >-
- The data needed for the Payment Provider to use the
- saved payment method.
+ $ref: ../components/schemas/StoreCustomersListPaymentMethodsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/customers_password-reset.yaml b/docs/api/store/paths/customers_password-reset.yaml
index 0576f92444..c20e06e414 100644
--- a/docs/api/store/paths/customers_password-reset.yaml
+++ b/docs/api/store/paths/customers_password-reset.yaml
@@ -26,10 +26,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- customer:
- $ref: ../components/schemas/Customer.yaml
+ $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/gift-cards_{code}.yaml b/docs/api/store/paths/gift-cards_{code}.yaml
index 1efecec1d2..9c7dfe5d26 100644
--- a/docs/api/store/paths/gift-cards_{code}.yaml
+++ b/docs/api/store/paths/gift-cards_{code}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- gift_card:
- $ref: ../components/schemas/GiftCard.yaml
+ $ref: ../components/schemas/StoreGiftCardsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/order-edits_{id}.yaml b/docs/api/store/paths/order-edits_{id}.yaml
index 65e0def3cb..edf25d0e6b 100644
--- a/docs/api/store/paths/order-edits_{id}.yaml
+++ b/docs/api/store/paths/order-edits_{id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: ../components/schemas/OrderEdit.yaml
+ $ref: ../components/schemas/StoreOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/order-edits_{id}_complete.yaml b/docs/api/store/paths/order-edits_{id}_complete.yaml
index 0e7a856660..3ff5331fa1 100644
--- a/docs/api/store/paths/order-edits_{id}_complete.yaml
+++ b/docs/api/store/paths/order-edits_{id}_complete.yaml
@@ -26,10 +26,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: ../components/schemas/OrderEdit.yaml
+ $ref: ../components/schemas/StoreOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/order-edits_{id}_decline.yaml b/docs/api/store/paths/order-edits_{id}_decline.yaml
index 7337245d44..53cfeceb02 100644
--- a/docs/api/store/paths/order-edits_{id}_decline.yaml
+++ b/docs/api/store/paths/order-edits_{id}_decline.yaml
@@ -31,10 +31,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- order_edit:
- $ref: ../components/schemas/OrderEdit.yaml
+ $ref: ../components/schemas/StoreOrderEditsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/orders.yaml b/docs/api/store/paths/orders.yaml
index 687a2fe232..7ebd4b871d 100644
--- a/docs/api/store/paths/orders.yaml
+++ b/docs/api/store/paths/orders.yaml
@@ -46,10 +46,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: ../components/schemas/Order.yaml
+ $ref: ../components/schemas/StoreOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/orders_cart_{cart_id}.yaml b/docs/api/store/paths/orders_cart_{cart_id}.yaml
index 6e69f5568e..6ef812f754 100644
--- a/docs/api/store/paths/orders_cart_{cart_id}.yaml
+++ b/docs/api/store/paths/orders_cart_{cart_id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: ../components/schemas/Order.yaml
+ $ref: ../components/schemas/StoreOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/orders_{id}.yaml b/docs/api/store/paths/orders_{id}.yaml
index df6152833e..f2317c0d64 100644
--- a/docs/api/store/paths/orders_{id}.yaml
+++ b/docs/api/store/paths/orders_{id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- order:
- $ref: ../components/schemas/Order.yaml
+ $ref: ../components/schemas/StoreOrdersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/payment-collections_{id}.yaml b/docs/api/store/paths/payment-collections_{id}.yaml
index 5c5f16ef19..7085b9d3ff 100644
--- a/docs/api/store/paths/payment-collections_{id}.yaml
+++ b/docs/api/store/paths/payment-collections_{id}.yaml
@@ -40,10 +40,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- payment_collection:
- $ref: ../components/schemas/PaymentCollection.yaml
+ $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/payment-collections_{id}_sessions.yaml b/docs/api/store/paths/payment-collections_{id}_sessions.yaml
index 234fa1de62..20af179e08 100644
--- a/docs/api/store/paths/payment-collections_{id}_sessions.yaml
+++ b/docs/api/store/paths/payment-collections_{id}_sessions.yaml
@@ -36,9 +36,7 @@ post:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: ../components/schemas/PaymentCollection.yaml
+ $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml b/docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml
index fe566bbdb3..d562ea0661 100644
--- a/docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml
+++ b/docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml
@@ -38,9 +38,7 @@ post:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: ../components/schemas/PaymentCollection.yaml
+ $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml b/docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml
index 30c3913901..38d93b3324 100644
--- a/docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml
+++ b/docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml
@@ -38,9 +38,7 @@ post:
content:
application/json:
schema:
- properties:
- payment_collection:
- $ref: ../components/schemas/PaymentCollection.yaml
+ $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml b/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml
index a7d20ff59b..79157301e0 100644
--- a/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml
+++ b/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml
@@ -37,10 +37,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- payment_session:
- $ref: ../components/schemas/PaymentSession.yaml
+ $ref: ../components/schemas/StorePaymentCollectionsSessionRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml b/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml
index ce39905e02..0edd575da8 100644
--- a/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml
+++ b/docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml
@@ -38,9 +38,7 @@ post:
content:
application/json:
schema:
- properties:
- payment_session:
- $ref: ../components/schemas/PaymentSession.yaml
+ $ref: ../components/schemas/StorePaymentCollectionsSessionRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/product-categories.yaml b/docs/api/store/paths/product-categories.yaml
new file mode 100644
index 0000000000..5f00b425d9
--- /dev/null
+++ b/docs/api/store/paths/product-categories.yaml
@@ -0,0 +1,71 @@
+get:
+ operationId: GetProductCategories
+ summary: List Product Categories
+ description: Retrieve a list of product categories.
+ x-authenticated: false
+ parameters:
+ - in: query
+ name: q
+ description: Query used for searching product category names orhandles.
+ schema:
+ type: string
+ - in: query
+ name: parent_category_id
+ description: Returns categories scoped by parent
+ schema:
+ type: string
+ - in: query
+ name: offset
+ description: How many product categories to skip in the result.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: limit
+ description: Limit the number of product categories returned.
+ schema:
+ type: integer
+ default: 100
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/product-categories/getundefined
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ product_categories:
+ type: array
+ items:
+ $ref: ../components/schemas/ProductCategory.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
+ '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
diff --git a/docs/api/store/paths/product-categories_{id}.yaml b/docs/api/store/paths/product-categories_{id}.yaml
new file mode 100644
index 0000000000..9b9ba9082a
--- /dev/null
+++ b/docs/api/store/paths/product-categories_{id}.yaml
@@ -0,0 +1,59 @@
+get:
+ operationId: GetProductCategoriesCategory
+ summary: Get a Product Category
+ description: Retrieves a Product Category.
+ x-authenticated: false
+ 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
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source:
+ $ref: ../code_samples/JavaScript/product-categories_{id}/getundefined
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/product-categories_{id}/getundefined
+ security:
+ - api_token: []
+ - cookie_auth: []
+ tags:
+ - Product Category
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/StoreGetProductCategoryRes.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
diff --git a/docs/api/store/paths/product-tags.yaml b/docs/api/store/paths/product-tags.yaml
new file mode 100644
index 0000000000..6134c2a185
--- /dev/null
+++ b/docs/api/store/paths/product-tags.yaml
@@ -0,0 +1,137 @@
+get:
+ operationId: GetProductTags
+ summary: List Product Tags
+ description: Retrieve a list of Product Tags.
+ x-authenticated: true
+ parameters:
+ - in: query
+ name: limit
+ description: The number of types to return.
+ schema:
+ type: integer
+ default: 20
+ - in: query
+ name: offset
+ description: The number of items to skip before the results.
+ schema:
+ type: integer
+ default: 0
+ - in: query
+ name: order
+ description: The field to sort items by.
+ schema:
+ type: string
+ - in: query
+ name: discount_condition_id
+ description: The discount condition id on which to filter the product tags.
+ schema:
+ type: string
+ - in: query
+ name: value
+ style: form
+ explode: false
+ description: The tag values to search for
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: id
+ style: form
+ explode: false
+ description: The tag IDs to search for
+ schema:
+ type: array
+ items:
+ type: string
+ - in: query
+ name: q
+ description: A query string to search values for
+ schema:
+ type: string
+ - in: query
+ name: created_at
+ description: Date comparison for when resulting product tags were created.
+ schema:
+ type: object
+ properties:
+ lt:
+ type: string
+ description: filter by dates less than this date
+ format: date
+ gt:
+ type: string
+ description: filter by dates greater than this date
+ format: date
+ lte:
+ type: string
+ description: filter by dates less than or equal to this date
+ format: date
+ gte:
+ type: string
+ description: filter by dates greater than or equal to this date
+ format: date
+ - in: query
+ name: updated_at
+ description: Date comparison for when resulting product tags were updated.
+ schema:
+ type: object
+ properties:
+ lt:
+ type: string
+ description: filter by dates less than this date
+ format: date
+ gt:
+ type: string
+ description: filter by dates greater than this date
+ format: date
+ lte:
+ type: string
+ description: filter by dates less than or equal to this date
+ format: date
+ gte:
+ type: string
+ description: filter by dates greater than or equal to this date
+ format: date
+ x-codeSamples:
+ - lang: JavaScript
+ label: JS Client
+ source:
+ $ref: ../code_samples/JavaScript/product-tags/getundefined
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/product-tags/getundefined
+ tags:
+ - Product Tag
+ responses:
+ '200':
+ description: OK
+ 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
+ '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
diff --git a/docs/api/store/paths/product-types.yaml b/docs/api/store/paths/product-types.yaml
index 32c4deb44f..b5e34ef9ee 100644
--- a/docs/api/store/paths/product-types.yaml
+++ b/docs/api/store/paths/product-types.yaml
@@ -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/StoreProductTypesListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
diff --git a/docs/api/store/paths/products.yaml b/docs/api/store/paths/products.yaml
index 55507c8597..78a6955b68 100644
--- a/docs/api/store/paths/products.yaml
+++ b/docs/api/store/paths/products.yaml
@@ -169,31 +169,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- products:
- type: array
- items:
- allOf:
- - $ref: ../components/schemas/Product.yaml
- - type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: ../components/schemas/ProductVariant.yaml
- - $ref: >-
- ../components/schemas/ProductVariantPricesFields.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/StoreProductsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/products_search.yaml b/docs/api/store/paths/products_search.yaml
index 4c3b865030..07c6919b8c 100644
--- a/docs/api/store/paths/products_search.yaml
+++ b/docs/api/store/paths/products_search.yaml
@@ -36,13 +36,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- hits:
- type: array
- description: >-
- Array of results. The format of the items depends on the
- search engine installed on the server.
+ $ref: ../components/schemas/StorePostSearchRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/products_{id}.yaml b/docs/api/store/paths/products_{id}.yaml
index 6acbf07a6b..30458c8dd5 100644
--- a/docs/api/store/paths/products_{id}.yaml
+++ b/docs/api/store/paths/products_{id}.yaml
@@ -50,20 +50,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- product:
- allOf:
- - $ref: ../components/schemas/Product.yaml
- - type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: ../components/schemas/ProductVariant.yaml
- - $ref: >-
- ../components/schemas/ProductVariantPricesFields.yaml
+ $ref: ../components/schemas/StoreProductsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/regions.yaml b/docs/api/store/paths/regions.yaml
index 4d90acf272..422623b8b6 100644
--- a/docs/api/store/paths/regions.yaml
+++ b/docs/api/store/paths/regions.yaml
@@ -76,12 +76,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- regions:
- type: array
- items:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/StoreRegionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/regions_{id}.yaml b/docs/api/store/paths/regions_{id}.yaml
index 4e1a316f1c..c8158b5b4b 100644
--- a/docs/api/store/paths/regions_{id}.yaml
+++ b/docs/api/store/paths/regions_{id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- region:
- $ref: ../components/schemas/Region.yaml
+ $ref: ../components/schemas/StoreRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/return-reasons.yaml b/docs/api/store/paths/return-reasons.yaml
index 2df1323ec5..2d3cecc1ad 100644
--- a/docs/api/store/paths/return-reasons.yaml
+++ b/docs/api/store/paths/return-reasons.yaml
@@ -19,12 +19,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- return_reasons:
- type: array
- items:
- $ref: ../components/schemas/ReturnReason.yaml
+ $ref: ../components/schemas/StoreReturnReasonsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/return-reasons_{id}.yaml b/docs/api/store/paths/return-reasons_{id}.yaml
index 59140ce303..cf90f2858d 100644
--- a/docs/api/store/paths/return-reasons_{id}.yaml
+++ b/docs/api/store/paths/return-reasons_{id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- return_reason:
- $ref: ../components/schemas/ReturnReason.yaml
+ $ref: ../components/schemas/StoreReturnReasonsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/returns.yaml b/docs/api/store/paths/returns.yaml
index c852066b3c..f1297642dd 100644
--- a/docs/api/store/paths/returns.yaml
+++ b/docs/api/store/paths/returns.yaml
@@ -24,10 +24,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- return:
- $ref: ../components/schemas/Return.yaml
+ $ref: ../components/schemas/StoreReturnsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/shipping-options.yaml b/docs/api/store/paths/shipping-options.yaml
index 379694f682..7fdea9e6ff 100644
--- a/docs/api/store/paths/shipping-options.yaml
+++ b/docs/api/store/paths/shipping-options.yaml
@@ -37,12 +37,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: ../components/schemas/ShippingOption.yaml
+ $ref: ../components/schemas/StoreShippingOptionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/shipping-options_{cart_id}.yaml b/docs/api/store/paths/shipping-options_{cart_id}.yaml
index 1cf6620012..1e8797574d 100644
--- a/docs/api/store/paths/shipping-options_{cart_id}.yaml
+++ b/docs/api/store/paths/shipping-options_{cart_id}.yaml
@@ -26,12 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- shipping_options:
- type: array
- items:
- $ref: ../components/schemas/ShippingOption.yaml
+ $ref: ../components/schemas/StoreShippingOptionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/swaps.yaml b/docs/api/store/paths/swaps.yaml
index 084a9d6669..8548c772a6 100644
--- a/docs/api/store/paths/swaps.yaml
+++ b/docs/api/store/paths/swaps.yaml
@@ -26,10 +26,7 @@ post:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: ../components/schemas/Swap.yaml
+ $ref: ../components/schemas/StoreSwapsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/swaps_{cart_id}.yaml b/docs/api/store/paths/swaps_{cart_id}.yaml
index 2be992ccfd..332153ec09 100644
--- a/docs/api/store/paths/swaps_{cart_id}.yaml
+++ b/docs/api/store/paths/swaps_{cart_id}.yaml
@@ -26,10 +26,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- swap:
- $ref: ../components/schemas/Swap.yaml
+ $ref: ../components/schemas/StoreSwapsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/variants.yaml b/docs/api/store/paths/variants.yaml
index 298d92ce80..3369c1722b 100644
--- a/docs/api/store/paths/variants.yaml
+++ b/docs/api/store/paths/variants.yaml
@@ -75,14 +75,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- variants:
- type: array
- items:
- allOf:
- - $ref: ../components/schemas/ProductVariant.yaml
- - $ref: ../components/schemas/ProductVariantPricesFields.yaml
+ $ref: ../components/schemas/StoreVariantsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/api/store/paths/variants_{variant_id}.yaml b/docs/api/store/paths/variants_{variant_id}.yaml
index 4bbb842ac2..c551b6ce0d 100644
--- a/docs/api/store/paths/variants_{variant_id}.yaml
+++ b/docs/api/store/paths/variants_{variant_id}.yaml
@@ -42,12 +42,7 @@ get:
content:
application/json:
schema:
- type: object
- properties:
- variant:
- allOf:
- - $ref: ../components/schemas/ProductVariant.yaml
- - $ref: ../components/schemas/ProductVariantPricesFields.yaml
+ $ref: ../components/schemas/StoreVariantsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
diff --git a/docs/content/advanced/backend/upgrade-guides/admin/_category_.json b/docs/content/advanced/backend/upgrade-guides/admin/_category_.json
new file mode 100644
index 0000000000..62f8fbd27e
--- /dev/null
+++ b/docs/content/advanced/backend/upgrade-guides/admin/_category_.json
@@ -0,0 +1,9 @@
+{
+ "position": 3,
+ "collapsed": true,
+ "link": null,
+ "label": "Medusa Admin",
+ "customProps": {
+ "sort": "desc"
+ }
+}
\ No newline at end of file
diff --git a/docs/content/advanced/backend/upgrade-guides/admin/admin-vite.md b/docs/content/advanced/backend/upgrade-guides/admin/admin-vite.md
index 07b20e27f0..ccd133ec5a 100644
--- a/docs/content/advanced/backend/upgrade-guides/admin/admin-vite.md
+++ b/docs/content/advanced/backend/upgrade-guides/admin/admin-vite.md
@@ -1,5 +1,6 @@
---
description: 'Actions Required for Vite Update'
+sidebar_label: 'Medusa Admin: Vite'
---
# Updating Medusa Admin from Gatsby to Vite
diff --git a/docs/content/advanced/backend/upgrade-guides/index.mdx b/docs/content/advanced/backend/upgrade-guides/index.mdx
index 338ef22178..8f74590bc2 100644
--- a/docs/content/advanced/backend/upgrade-guides/index.mdx
+++ b/docs/content/advanced/backend/upgrade-guides/index.mdx
@@ -4,7 +4,7 @@ hide_table_of_contents: true
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
-import filterListItems from '@site/src/utils/filterListItems';
+import filterListItems, { flattenList } from '@site/src/utils/filterListItems';
# Upgrade Guides
@@ -12,8 +12,12 @@ Find in this page the upgrade guides that require necessary steps when upgrading
## Server
-
+
+
+## Medusa React
+
+
## Admin
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/content/advanced/backend/upgrade-guides/1-3-0.md b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-0.md
similarity index 99%
rename from docs/content/advanced/backend/upgrade-guides/1-3-0.md
rename to docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-0.md
index 62768e48e8..36cbe8ca33 100644
--- a/docs/content/advanced/backend/upgrade-guides/1-3-0.md
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-0.md
@@ -1,4 +1,5 @@
---
+sidebar_position: 7
description: 'Actions Required for v.1.3.0'
---
diff --git a/docs/content/advanced/backend/upgrade-guides/1-3-6.md b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-6.md
similarity index 83%
rename from docs/content/advanced/backend/upgrade-guides/1-3-6.md
rename to docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-6.md
index 7f021aef8a..7091e1e1f9 100644
--- a/docs/content/advanced/backend/upgrade-guides/1-3-6.md
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-6.md
@@ -1,4 +1,5 @@
---
+sidebar_position: 6
description: 'Actions Required for v.1.3.0'
---
@@ -8,7 +9,7 @@ Following the addition of feature flags in version v1.3.3 and the addition of th
:::note
-In version 1.3.6, Sales Channels are available but guraded by [feature flags](../feature-flags/toggle.md). If you don’t have Sales Channels enabled, you don’t need to follow the steps detailed in this migration script.
+In version 1.3.6, Sales Channels are available but guraded by [feature flags](../../feature-flags/toggle.md). If you don’t have Sales Channels enabled, you don’t need to follow the steps detailed in this migration script.
:::
@@ -30,7 +31,7 @@ These environment variables are used in the data migration scripts in this upgra
## Sales Channels
-Sales Channels were introduced in v1.3.5 guarded by a [feature flag](../feature-flags/toggle.md). By enabling Sales Channels, developers and users can associate products and other entities with a specific Sales Channel.
+Sales Channels were introduced in v1.3.5 guarded by a [feature flag](../../feature-flags/toggle.md). By enabling Sales Channels, developers and users can associate products and other entities with a specific Sales Channel.
However, if you upgraded Medusa to v1.3.5 and enabled Sales Channels, you must add every product to at least one Sales Channel manually. Otherwise, products can’t be added to carts in different Sales Channels.
diff --git a/docs/content/advanced/backend/upgrade-guides/1-3-8.md b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-8.md
similarity index 98%
rename from docs/content/advanced/backend/upgrade-guides/1-3-8.md
rename to docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-8.md
index 15fd523957..93d5cc925e 100644
--- a/docs/content/advanced/backend/upgrade-guides/1-3-8.md
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-3-8.md
@@ -1,4 +1,5 @@
---
+sidebar_position: 5
description: 'Actions Required for v.1.3.0'
---
diff --git a/docs/content/advanced/backend/upgrade-guides/1-6-1.md b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-6-1.md
similarity index 96%
rename from docs/content/advanced/backend/upgrade-guides/1-6-1.md
rename to docs/content/advanced/backend/upgrade-guides/medusa-core/1-6-1.md
index 8c6d2a7365..a1a877fe78 100644
--- a/docs/content/advanced/backend/upgrade-guides/1-6-1.md
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-6-1.md
@@ -1,4 +1,5 @@
---
+sidebar_position: 4
description: 'Actions Required for v.1.6.1'
---
diff --git a/docs/content/advanced/backend/upgrade-guides/1-7-0.md b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-0.md
similarity index 81%
rename from docs/content/advanced/backend/upgrade-guides/1-7-0.md
rename to docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-0.md
index d6ef8caa9d..91a1751003 100644
--- a/docs/content/advanced/backend/upgrade-guides/1-7-0.md
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-0.md
@@ -1,14 +1,15 @@
---
+sidebar_position: 3
description: 'Actions Required for v.1.7.0'
---
# v1.7.0
-Version `1.7.0` of Medusa introduces a breaking change in the [CustomerService](../../../references/services/classes/CustomerService.md).
+Version `1.7.0` of Medusa introduces a breaking change in the [CustomerService](../../../../references/services/classes/CustomerService.md).
## Overview
-In this new version, the method [`retrieveByEmail` in the Customer Service](../../../references/services/classes/CustomerService.md#retrievebyemail) has been deprecated in favor of other methods. Read the actions required below to learn which methods to use instead.
+In this new version, the method [`retrieveByEmail` in the Customer Service](../../../../references/services/classes/CustomerService.md#retrievebyemail) has been deprecated in favor of other methods. Read the actions required below to learn which methods to use instead.
In addition, after introducing the Claim Order feature, this version of Medusa introduces changes in the database that allows two customers having the same email based on the value of the `has_account` field. This change requires running migrations after the update.
diff --git a/docs/content/advanced/backend/upgrade-guides/1-7-1.md b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-1.md
similarity index 96%
rename from docs/content/advanced/backend/upgrade-guides/1-7-1.md
rename to docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-1.md
index 3ac0f87a97..cd122587d1 100644
--- a/docs/content/advanced/backend/upgrade-guides/1-7-1.md
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-1.md
@@ -1,4 +1,5 @@
---
+sidebar_position: 2
description: 'Actions Required for v.1.7.1'
---
@@ -65,7 +66,7 @@ const myJob = async (container, options) => {
export default myJob
```
-You can learn more in the [How to Create a Scheduled Job](../scheduled-jobs/create.md) documentation.
+You can learn more in the [How to Create a Scheduled Job](../../scheduled-jobs/create.md) documentation.
### Change to Payment Provider
diff --git a/docs/content/advanced/backend/upgrade-guides/1-7-3.md b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-3.md
similarity index 85%
rename from docs/content/advanced/backend/upgrade-guides/1-7-3.md
rename to docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-3.md
index 634c0de460..7f3144eea4 100644
--- a/docs/content/advanced/backend/upgrade-guides/1-7-3.md
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/1-7-3.md
@@ -1,4 +1,5 @@
---
+sidebar_position: 1
description: 'Actions Required for v.1.7.3'
---
@@ -8,7 +9,7 @@ Version 1.7.3 of Medusa changes the feature flag value for Sales Channels and Pu
## Overview
-Sales Channels and Publishable API Keys were introduced in previous versions of Medusa, but guarded by [feature flags](../feature-flags/toggle.md) This meant that developers had to manually enable them to use them.
+Sales Channels and Publishable API Keys were introduced in previous versions of Medusa, but guarded by [feature flags](../../feature-flags/toggle.md) This meant that developers had to manually enable them to use them.
Version 1.7.3 of Medusa keeps the feature flags for these two features, but they’re now enabled by default. This requires running the necessary migrations to ensure your server works as expected.
@@ -50,4 +51,4 @@ node ./node_modules/@medusajs/medusa/dist/scripts/sales-channels-migration.js
## Disabling Feature Flags
-Although this version enables Sales Channels and Publishable API Keys by default, you can still turn them off using feature flags. Learn more in [this documentation](../feature-flags/toggle.md#disable-feature-flags)
+Although this version enables Sales Channels and Publishable API Keys by default, you can still turn them off using feature flags. Learn more in [this documentation](../../feature-flags/toggle.md#disable-feature-flags)
diff --git a/docs/content/advanced/backend/upgrade-guides/medusa-core/_category_.json b/docs/content/advanced/backend/upgrade-guides/medusa-core/_category_.json
new file mode 100644
index 0000000000..e2430d912e
--- /dev/null
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-core/_category_.json
@@ -0,0 +1,9 @@
+{
+ "position": 1,
+ "collapsed": false,
+ "link": null,
+ "label": "Server",
+ "customProps": {
+ "sort": "desc"
+ }
+}
\ No newline at end of file
diff --git a/docs/content/advanced/backend/upgrade-guides/medusa-react/4-0-2.md b/docs/content/advanced/backend/upgrade-guides/medusa-react/4-0-2.md
new file mode 100644
index 0000000000..22d7089c61
--- /dev/null
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-react/4-0-2.md
@@ -0,0 +1,54 @@
+---
+description: 'Actions Required for v4.0.2'
+---
+
+# Medusa React: v4.0.2
+
+Version 4.0.2 of Medusa React introduces a new update in its dependencies which can lead to breaking changes.
+
+## Overview
+
+Medusa React previously required installing React Query v3 as a peer dependency. This version changes the peer dependency requirement to [Tanstack Query](https://tanstack.com/query/latest/docs/react/overview) - the updated version of React Query.
+
+This requires additional actions related to installing the new dependency and changing imports.
+
+---
+
+## Actions Required
+
+### Update Medusa Dependencies
+
+To update to the latest version of Medusa React, run the following command in your custom storefront or admin to update both Medusa React and the core package:
+
+```bash npm2yarn
+npm install medusa-react@latest @medusajs/medusa@latest
+```
+
+### Uninstall React Query v3
+
+As React Query v3 is not required as a peer dependency anymore, uninstall it from your custom storefront or admin:
+
+```bash npm2yarn
+npm uninstall react-query
+```
+
+### Install Tanstack Query
+
+Run the following command to install Tanstack Query:
+
+```bash npm2yarn
+npm install @tanstack/react-query
+```
+
+### Update Imports
+
+Across your custom storefront or admin project, change all imports from `react-query` to `@tanstack/react-query`.
+
+For example, update the import for `QueryClient` where you use it with Medusa Provider:
+
+```ts
+import { QueryClient } from "@tanstack/react-query"
+
+// this remains the same
+const queryClient = new QueryClient()
+```
diff --git a/docs/content/advanced/backend/upgrade-guides/medusa-react/_category_.json b/docs/content/advanced/backend/upgrade-guides/medusa-react/_category_.json
new file mode 100644
index 0000000000..5ef0b7dd9a
--- /dev/null
+++ b/docs/content/advanced/backend/upgrade-guides/medusa-react/_category_.json
@@ -0,0 +1,9 @@
+{
+ "position": 2,
+ "collapsed": true,
+ "link": null,
+ "label": "Medusa React",
+ "customProps": {
+ "sort": "desc"
+ }
+}
\ No newline at end of file
diff --git a/docs/content/advanced/storefront/implement-claim-order.mdx b/docs/content/advanced/storefront/implement-claim-order.mdx
index ea62a6dd7c..0d964128d5 100644
--- a/docs/content/advanced/storefront/implement-claim-order.mdx
+++ b/docs/content/advanced/storefront/implement-claim-order.mdx
@@ -7,7 +7,7 @@ In this document, you’ll learn how to implement the claim order flow in a stor
:::note
-This flow was added starting from Medusa v1.7. You can learn more about upgrading in the [upgrade guide](../backend/upgrade-guides/1-7-0.md).
+This flow was added starting from Medusa v1.7. You can learn more about upgrading in the [upgrade guide](../backend/upgrade-guides/medusa-core/1-7-0.md).
:::
diff --git a/docs/content/medusa-react/overview.md b/docs/content/medusa-react/overview.md
index cc73ac52e9..b4863eb5a1 100644
--- a/docs/content/medusa-react/overview.md
+++ b/docs/content/medusa-react/overview.md
@@ -13,13 +13,20 @@ Alternatively, you can use Medusa’s [JS Client](../js-client/overview.md) or t
In the directory holding your React-based storefront or admin dashboard, run the following command to install Medusa React:
```bash npm2yarn
-npm install medusa-react react-query @medusajs/medusa
+npm install medusa-react @tanstack/react-query @medusajs/medusa
```
In addition to the `medusa-react` library, you need the following libraries:
-1. `react-query`: `medusa-react` is built on top of [React Query v3](https://react-query-v3.tanstack.com/). You’ll learn later in this reference how you can use Mutations and Queries with Medusa React.
-2. `@medusajs/medusa`: The core Medusa package. This is used to import types used by Medusa React and while developing with it.
+1\. `@tanstack/react-query`: `medusa-react` is built on top of [Tanstack Query](https://tanstack.com/query/latest/docs/react/overview). You’ll learn later in this reference how you can use Mutations and Queries with Medusa React.
+
+:::note
+
+Versions of Medusa React prior to v4.0.2 used React Query v3 instead of Tanstack Query. Check out [this upgrade guide] to learn how you can update your storefront.
+
+:::
+
+2\. `@medusajs/medusa`: The core Medusa package. This is used to import types used by Medusa React and while developing with it.
:::info
@@ -36,14 +43,14 @@ To use the hooks exposed by Medusa React, you need to include the `MedusaProvi
The `MedusaProvider` requires two props:
1. `baseUrl`: The URL to your Medusa server
-2. `queryClientProviderProps`: An object used to set the `react-query` client. The object requires a `client` property, which should be an instance of [QueryClient](https://react-query-v3.tanstack.com/reference/QueryClient).
+2. `queryClientProviderProps`: An object used to set the Tanstack Query client. The object requires a `client` property, which should be an instance of [QueryClient](https://tanstack.com/query/v4/docs/react/reference/QueryClient).
For example:
```tsx title=src/App.ts
import { MedusaProvider } from "medusa-react"
import Storefront from "./Storefront"
-import { QueryClient } from "react-query"
+import { QueryClient } from "@tanstack/react-query"
import React from "react"
const queryClient = new QueryClient()
@@ -68,7 +75,7 @@ The `Storefront` component and its child components can now use hooks exposed by
### Queries
-To fetch data from the Medusa server (in other words, perform `GET` requests), you can use [Queries](https://react-query-v3.tanstack.com/guides/queries). Query hooks simply wrap around react-query's `useQuery` hook to fetch data from your medusa server.
+To fetch data from the Medusa server (in other words, perform `GET` requests), you can use [Queries](https://tanstack.com/query/v4/docs/react/guides/queries). Query hooks simply wrap around Tanstack Query's `useQuery` hook to fetch data from your medusa server.
For example, to fetch products from your Medusa server:
@@ -99,7 +106,7 @@ const Products = () => {
export default Products
```
-In the example above, you import the `useProducts` hook from `medusa-react`. This hook, and every other query hook exposed by `medusa-react`, returns everything that `useQuery` [returns in react-query](https://react-query-v3.tanstack.com/reference/useQuery), except for the `data` field.
+In the example above, you import the `useProducts` hook from `medusa-react`. This hook, and every other query hook exposed by `medusa-react`, returns everything that `useQuery` [returns in Tanstack Query](https://tanstack.com/query/v4/docs/react/reference/useQuery), except for the `data` field.
Instead of the `data` field, the response data is flattened and is part of the hooks’ returned fields. In the example above, the List Products endpoint returns a `products` array. So, `useProducts` returns a `products` array along with other fields returned by `useQuery`.
@@ -111,11 +118,11 @@ const { products } = useProducts({
})
```
-You can learn more about using queries in [React Query’s documentation](https://react-query-v3.tanstack.com/guides/queries).
+You can learn more about using queries in [Tanstack Query’s documentation](https://tanstack.com/query/v4/docs/react/guides/queries).
### Mutations
-To create, update, or delete data on the Medusa server (in other words, perform `POST`, `PUT`, and `DELETE` requests), you can use [Mutations](https://react-query-v3.tanstack.com/guides/mutations). Mutation hooks wrap around react-query's `useMutation` to mutate data on your medusa server.
+To create, update, or delete data on the Medusa server (in other words, perform `POST`, `PUT`, and `DELETE` requests), you can use [Mutations](https://tanstack.com/query/v4/docs/react/guides/mutations). Mutation hooks wrap around Tanstack Query's `useMutation` to mutate data on your medusa server.
For example, to create a cart:
@@ -148,13 +155,13 @@ const Cart = () => {
export default Cart
```
-In the example above, you import the `useCreateCart` hook from `medusa-react`. This hook, and every other mutation hook exposed by `medusa-react`, returns everything that [useMutation](https://react-query-v3.tanstack.com/reference/useMutation) returns. You can also pass the same options you would pass to `useMutation` to mutation hooks exposed by `medusa-react`.
+In the example above, you import the `useCreateCart` hook from `medusa-react`. This hook, and every other mutation hook exposed by `medusa-react`, returns everything that [useMutation](https://tanstack.com/query/v4/docs/react/reference/useMutation) returns. You can also pass the same options you would pass to `useMutation` to mutation hooks exposed by `medusa-react`.
To create a cart, you call the `createCart.mutate` method. In the underlying logic, this method sends a `POST` request to the Medusa server to create a cart.
If the request accepts any parameters, they can be passed as parameters to the `mutate` request. For example:
-```tsx
+```ts
createCart.mutate({
region_id,
})
@@ -170,7 +177,7 @@ The example above does not store in the browser the ID of the cart created, so t
Instead of using `mutate`, you can use `mutateAsync` to receive a Promise that resolves on success or throws on error.
-Learn more about how you can use mutations in [React Query’s documentation](https://react-query-v3.tanstack.com/guides/mutations).
+Learn more about how you can use mutations in [Tanstack Query’s documentation](https://tanstack.com/query/v4/docs/react/guides/mutations).
---
@@ -349,7 +356,7 @@ For example:
```tsx title=src/App.ts
import { CartProvider, MedusaProvider } from "medusa-react"
import Storefront from "./Storefront"
-import { QueryClient } from "react-query"
+import { QueryClient } from "@tanstack/react-query"
import React from "react"
const queryClient = new QueryClient()
@@ -439,7 +446,7 @@ For example:
```tsx title=src/App.ts
import { SessionProvider, MedusaProvider } from "medusa-react"
import Storefront from "./Storefront"
-import { QueryClient } from "react-query"
+import { QueryClient } from "@tanstack/react-query"
import React from "react"
const queryClient = new QueryClient()
diff --git a/docs/content/usage/configurations.md b/docs/content/usage/configurations.md
index 884a71a16c..ff0ba2a998 100644
--- a/docs/content/usage/configurations.md
+++ b/docs/content/usage/configurations.md
@@ -24,7 +24,7 @@ By default, Medusa loads environment variables from the system’s environment v
:::info
-This change in how environment variables are loaded was introduced in version 1.3.0. You can learn more in the [upgrade guide for version 1.3.0](../advanced/backend/upgrade-guides/1-3-0.md).
+This change in how environment variables are loaded was introduced in version 1.3.0. You can learn more in the [upgrade guide for version 1.3.0](../advanced/backend/upgrade-guides/medusa-core/1-3-0.md).
:::
diff --git a/docs/styles/docs/HeadingColons.yml b/docs/styles/docs/HeadingColons.yml
index a0596c4a60..d8ebe4305b 100644
--- a/docs/styles/docs/HeadingColons.yml
+++ b/docs/styles/docs/HeadingColons.yml
@@ -2,7 +2,7 @@ extends: existence
message: "Capitalize '%s'."
link: https://medusajs.notion.site/Style-Guide-Docs-fad86dd1c5f84b48b145e959f36628e0#a5043fc5f8bc4b0b84f3ba494f817e42
nonword: true
-level: error
+level: warning
scope: heading
tokens:
- ':\s[a-z]'
diff --git a/packages/medusa-react/README.md b/packages/medusa-react/README.md
index 12d79e079f..62e88b9c86 100644
--- a/packages/medusa-react/README.md
+++ b/packages/medusa-react/README.md
@@ -2,305 +2,4 @@
A React library providing a set of components, utilities, and hooks for interacting seamlessly with a Medusa backend and building custom React storefronts.
-## Installation
-
-The library uses [react-query](https://react-query.tanstack.com/overview) as a solution for server-side state management and lists the library as a peer dependency.
-
-In order to install the package, run the following
-
-```bash
-npm install medusa-react react-query @medusajs/medusa
-# or
-yarn add medusa-react react-query @medusajs/medusa
-```
-
-## Quick Start
-
-In order to use the hooks exposed by medusa-react, you will need to include the `MedusaProvider` somewhere up in your component tree. The `MedusaProvider` takes a `baseUrl` prop which should point to your Medusa server. Under the hood, `medusa-react` uses the `medusa-js` client library (built on top of axios) to interact with your server.
-
-In addition, because medusa-react is built on top of react-query, you can pass an object representing react-query's [QueryClientProvider](https://react-query.tanstack.com/reference/QueryClientProvider#_top) props, which will be passed along by `MedusaProvider`.
-
-```jsx
-// App.tsx
-
-import * as React from "react"
-import { QueryClient } from "@tanstack/react-query"
-import { MedusaProvider } from "medusa-react"
-import MyStorefront from "./my-storefront"
-
-// Your react-query's query client config
-const queryClient = new QueryClient({
- defaultOptions: {
- queries: {
- refetchOnWindowFocus: false,
- staleTime: 30000,
- retry: 1,
- },
- },
-})
-
-const App = () => {
- return (
-
-
-
- )
-}
-
-export default App
-```
-
-The hooks exposed by `medusa-react` fall into two main categories: queries and mutations.
-
-### Queries
-
-[Queries](https://react-query.tanstack.com/guides/queries#_top) simply wrap around react-query's `useQuery` hook to fetch some data from your medusa server
-
-```jsx
-// ./my-storefront.tsx
-import * as React from "react"
-import { useProducts } from "medusa-react"
-
-const MyStorefront = () => {
- const { products, isLoading } = useProducts()
-
- return isLoading ? (
-
- ) : (
- products.map((product) => )
- )
-}
-```
-
-In general, the queries will return everything react-query returns from [`useQuery`](https://react-query.tanstack.com/reference/useQuery#_top) except the `data` field, which will be flattened out. In addition, you can also access the HTTP response object returned from the `medusa-js` client including things like `status`, `headers`, etc.
-
-So, in other words, we can express what the above query returns as the following:
-
-```typescript
-import { UseQueryResult } from "@tanstack/react-query"
-
-// This is what a Medusa server returns when you hit the GET /store/products endpoint
-type ProductsResponse = {
- products: Product[]
- limit: number
- offset: number
-}
-
-// UseProductsQuery refers to what's returned by the useProducts hook
-type UseProductsQuery = ProductsResponse &
- Omit & {
- response: {
- status: number
- statusText: string
- headers: Record & {
- "set-cookie"?: string[]
- }
- config: any
- request?: any
- }
- }
-
-// More generally ...
-
-type QueryReturnType = APIResponse &
- Omit & {
- response: {
- status: number
- statusText: string
- headers: Record & {
- "set-cookie"?: string[]
- }
- config: any
- request?: any
- }
- }
-```
-
-### Mutations
-
-[Mutations](https://react-query.tanstack.com/guides/mutations#_top) wrap around react-query's `useMutation` to mutate data and perform server-side effects on your medusa server. If you are not entirely familiar with this idea of "mutations", creating a cart would be a mutation because it creates a cart in your server (and database). Mutations also have to be invoked imperatively, meaning that calling for the mutation to take action, you will have to call a `mutate()` function returned from mutation hooks.
-
-```jsx
-import * as React from "react"
-import { useCreateCart } from "medusa-react"
-
-const CreateCartButton = () => {
- const createCart = useCreateCart()
- const handleClick = () => {
- createCart.mutate({}) // create an empty cart
- }
-
- return (
-
- )
-}
-```
-
-The mutation hooks will return exactly what react-query's [`useMutation`](https://react-query.tanstack.com/reference/useMutation#_top) returns. In addition, the options you pass in to the hooks will be passed along to `useMutation`.
-
-### Utilities
-
-A set of utility functions are also exposed from the library to make your life easier when dealing with displaying money amounts
-
-#### `formatVariantPrice()`
-
-- `formatVariantPrice(params: FormatVariantPriceParams): string`
-
-```typescript
-type FormatVariantPriceParams = {
- variant: ProductVariantInfo
- region: RegionInfo
- includeTaxes?: boolean
- minimumFractionDigits?: number
- maximumFractionDigits?: number
- locale?: string
-}
-
-type ProductVariantInfo = Pick
-
-type RegionInfo = {
- currency_code: string
- tax_code: string
- tax_rate: number
-}
-```
-
-Given a variant and region, will return a string representing the localized amount (i.e: `$19.50`)
-
-The behavior of minimumFractionDigits and maximumFractionDigits is the same as the one explained by MDN [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat). In fact, in order to convert the decimal amount, we use the browser's `Intl.NumberFormat` method.
-
-#### `computeVariantPrice()`
-
-- `computeVariantPrice(params: ComputeVariantPriceParams): number`
-
-```typescript
-type ComputeVariantPriceParams = {
- variant: ProductVariantInfo
- region: RegionInfo
- includeTaxes?: boolean
-}
-```
-
-Determines a variant's price based on the region provided. Returns a decimal number representing the amount.
-
-#### `formatAmount()`
-
-- `formatAmount(params: FormatAmountParams): string`
-
-```typescript
-type FormatAmountParams = {
- amount: number
- region: RegionInfo
- includeTaxes?: boolean
- minimumFractionDigits?: number
- maximumFractionDigits?: number
- locale?: string
-}
-```
-
-Returns a localized string based on the input params representing the amount (i.e: "$10.99").
-
-#### `computeAmount()`
-
-- `computeAmount(params: ComputeAmountParams): number`
-
-```typescript
-type ComputeAmountParams = {
- amount: number
- region: RegionInfo
- includeTaxes?: boolean
-}
-```
-
-Takes an integer amount, a region, and includeTaxes boolean. Returns a decimal amount including (or excluding) taxes.
-
-### Context Providers (Experimental)
-
-In order to make building custom storefronts easier, we also expose a `SessionCartProvider` and a `CartProvider` . At first, the two sound very similar to each other, however, the main distinction between the two is that the `SessionCartProvider` never interacts with your medusa server.
-
-The main goal behind the provider is to manage the state related to your users' cart experience. In other words, the provider keeps track of the items users add to their cart and help you interact with those items through a set of helpful methods like `addItem`, `updateQuantity`, `removeItem` , etc.
-
-On the other hand the `CartProvider` makes use of some of the hooks already exposed by `medusa-react` to help you create a cart (on the medusa backend), start the checkout flow, authorize payment sessions, etc. It also manages one single global piece of state which represents a cart, exactly like the one created on your medusa backend.
-
-You can think of a `sessionCart` as a purely client-side lightweight cart, in other words, just a javascript object living in your browser, whereas `cart` is the entity which you have stored in your database.
-
-### SessionCart
-
-The first step to using the `SessionCartProvider` is by inserting it somewhere up in your component tree.
-
-```jsx
-// App.tsx
-
-import * as React from "react"
-import { QueryClient } from "@tanstack/react-query"
-import { MedusaProvider, SessionCartProvider } from "medusa-react"
-import MyStorefront from "./my-storefront"
-
-// Your react-query's query client config
-const queryClient = new QueryClient({
- defaultOptions: {
- queries: {
- refetchOnWindowFocus: false,
- staleTime: 30000,
- retry: 1,
- },
- },
-})
-
-const App = () => {
- return (
-
-
-
-
-
- )
-}
-
-export default App
-```
-
-### Cart
-
-```jsx
-// App.tsx
-
-import * as React from "react"
-import { QueryClient } from "@tanstack/react-query"
-import { MedusaProvider, CartProvider } from "medusa-react"
-import MyStorefront from "./my-storefront"
-
-// Your react-query's query client config
-const queryClient = new QueryClient({
- defaultOptions: {
- queries: {
- refetchOnWindowFocus: false,
- staleTime: 30000,
- retry: 1,
- },
- },
-})
-
-const App = () => {
- return (
-
-
-
-
-
- )
-}
-
-export default App
-```
+Learn how to install and use it in [this documentation](https://docs.medusajs.com/medusa-react/overview).
diff --git a/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js b/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js
index 996cd1684d..0145ffa4a4 100644
--- a/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js
+++ b/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js
@@ -30,20 +30,24 @@ describe("GET /admin/orders", () => {
expect(OrderServiceMock.retrieveWithTotals).toHaveBeenCalledWith(
IdMap.getId("test-order"),
{
- select: defaultAdminOrdersFields.filter((field) => {
- return ![
- "shipping_total",
- "discount_total",
- "tax_total",
- "refunded_total",
- "total",
- "subtotal",
- "refundable_amount",
- "gift_card_total",
- "gift_card_tax_total",
- ].includes(field)
- }),
- relations: [...defaultAdminOrdersRelations],
+ // TODO [MEDUSA_FF_SALES_CHANNELS]: Remove when sales channel flag is removed entirely
+ select: [...defaultAdminOrdersFields, "sales_channel_id"].filter(
+ (field) => {
+ return ![
+ "shipping_total",
+ "discount_total",
+ "tax_total",
+ "refunded_total",
+ "total",
+ "subtotal",
+ "refundable_amount",
+ "gift_card_total",
+ "gift_card_tax_total",
+ ].includes(field)
+ }
+ ),
+ // TODO [MEDUSA_FF_SALES_CHANNELS]: Remove when sales channel flag is removed entirely
+ relations: [...defaultAdminOrdersRelations, "sales_channel"],
}
)
})
diff --git a/packages/medusa/src/api/routes/admin/orders/index.ts b/packages/medusa/src/api/routes/admin/orders/index.ts
index bd85cb273a..7ba42e6629 100644
--- a/packages/medusa/src/api/routes/admin/orders/index.ts
+++ b/packages/medusa/src/api/routes/admin/orders/index.ts
@@ -1,11 +1,8 @@
import { Router } from "express"
import "reflect-metadata"
import { Order } from "../../../.."
-import {
- DeleteResponse,
- FindParams,
- PaginatedResponse,
-} from "../../../../types/common"
+import SalesChannelFeatureFlag from "../../../../loaders/feature-flags/sales-channels"
+import { FindParams, PaginatedResponse } from "../../../../types/common"
import { FlagRouter } from "../../../../utils/flag-router"
import middlewares, {
transformBody,
@@ -22,6 +19,12 @@ export default (app, featureFlagRouter: FlagRouter) => {
app.use("/orders", route)
const relations = [...defaultAdminOrdersRelations]
+ const defaultFields = [...defaultAdminOrdersFields]
+
+ if (featureFlagRouter.isFeatureEnabled(SalesChannelFeatureFlag.key)) {
+ relations.push("sales_channel")
+ defaultFields.push("sales_channel_id")
+ }
/**
* List orders
@@ -43,7 +46,7 @@ export default (app, featureFlagRouter: FlagRouter) => {
"/:id",
transformQuery(FindParams, {
defaultRelations: relations,
- defaultFields: defaultAdminOrdersFields.filter((field) => {
+ defaultFields: defaultFields.filter((field) => {
return ![
"shipping_total",
"discount_total",
@@ -333,7 +336,6 @@ export const defaultAdminOrdersRelations = [
"swaps.additional_items",
"swaps.fulfillments",
"swaps.fulfillments.tracking_links",
- "sales_channel",
]
export const defaultAdminOrdersFields = [
@@ -345,7 +347,6 @@ export const defaultAdminOrdersFields = [
"cart_id",
"draft_order_id",
"customer_id",
- "sales_channel_id",
"email",
"region_id",
"currency_code",
@@ -379,7 +380,6 @@ export const filterableAdminOrdersFields = [
"customer_id",
"email",
"region_id",
- "sales_channel_id",
"currency_code",
"tax_rate",
"canceled_at",
diff --git a/1673550502785-unique_pay_sess_cart_id.ts b/packages/medusa/src/migrations/1673550502785-unique_pay_sess_cart_id.ts
similarity index 100%
rename from 1673550502785-unique_pay_sess_cart_id.ts
rename to packages/medusa/src/migrations/1673550502785-unique_pay_sess_cart_id.ts
diff --git a/www/docs/announcement.json b/www/docs/announcement.json
index 9e26dfeeb6..dbca515b43 100644
--- a/www/docs/announcement.json
+++ b/www/docs/announcement.json
@@ -1 +1 @@
-{}
\ No newline at end of file
+{"id":"https://github.com/medusajs/medusa/releases/tag/v1.7.4","content":"v1.7.4 is out","isCloseable":true}
\ No newline at end of file
diff --git a/www/docs/docusaurus.config.js b/www/docs/docusaurus.config.js
index 8dcfda82ad..2b0873de38 100644
--- a/www/docs/docusaurus.config.js
+++ b/www/docs/docusaurus.config.js
@@ -2,6 +2,7 @@ const path = require("path")
const fs = require("fs")
const docsPath = path.join(__dirname, "../../docs/content")
const apisPath = path.join(__dirname, "../../docs/api")
+const reverseSidebar = require('./src/utils/reverseSidebar')
const algoliaAppId = process.env.ALGOLIA_APP_ID || "temp"
const algoliaApiKey = process.env.ALGOLIA_API_KEY || "temp"
@@ -33,7 +34,7 @@ const config = {
apiKey: process.env.SEGMENT_API_KEY || "temp"
}
],
- require.resolve("docusaurus-plugin-image-zoom")
+ require.resolve("docusaurus-plugin-image-zoom"),
],
themeConfig: {
image: 'img/docs-banner.jpg',
@@ -210,6 +211,10 @@ const config = {
],
showLastUpdateTime: true,
breadcrumbs: false,
+ async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
+ const sidebarItems = await defaultSidebarItemsGenerator(args);
+ return reverseSidebar(sidebarItems);
+ },
},
theme: {
customCss: require.resolve("./src/css/custom.css")
diff --git a/www/docs/netlify.toml b/www/docs/netlify.toml
index 03b920b820..407bb4e164 100644
--- a/www/docs/netlify.toml
+++ b/www/docs/netlify.toml
@@ -84,4 +84,32 @@
[[redirects]]
from = "/guides/checkouts"
- to = "/advanced/storefront/how-to-implement-checkout-flow"
\ No newline at end of file
+ to = "/advanced/storefront/how-to-implement-checkout-flow"
+
+[[redirects]]
+ from="/advanced/backend/upgrade-guides/1-7-3"
+ to="advanced/backend/upgrade-guides/medusa-core/1-7-3"
+
+[[redirects]]
+ from="/advanced/backend/upgrade-guides/1-7-1"
+ to="advanced/backend/upgrade-guides/medusa-core/1-7-1"
+
+[[redirects]]
+ from="/advanced/backend/upgrade-guides/1-7-0"
+ to="advanced/backend/upgrade-guides/medusa-core/1-7-0"
+
+[[redirects]]
+ from="/advanced/backend/upgrade-guides/1-6-1"
+ to="advanced/backend/upgrade-guides/medusa-core/1-6-1"
+
+[[redirects]]
+ from="/advanced/backend/upgrade-guides/1-3-8"
+ to="advanced/backend/upgrade-guides/medusa-core/1-3-8"
+
+[[redirects]]
+ from="/advanced/backend/upgrade-guides/1-3-6"
+ to="advanced/backend/upgrade-guides/medusa-core/1-3-6"
+
+[[redirects]]
+ from="/advanced/backend/upgrade-guides/1-3-0"
+ to="advanced/backend/upgrade-guides/medusa-core/1-3-0"
\ No newline at end of file
diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js
index 9909b099a4..1ea583f512 100644
--- a/www/docs/sidebars.js
+++ b/www/docs/sidebars.js
@@ -183,45 +183,35 @@ module.exports = {
},
items: [
{
- type: "doc",
- id: "advanced/backend/upgrade-guides/1-7-3",
- label: "v1.7.3"
+ type: "category",
+ label: "Server",
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'advanced/backend/upgrade-guides/medusa-core'
+ }
+ ]
},
{
- type: "doc",
- id: "advanced/backend/upgrade-guides/1-7-1",
- label: "v1.7.1"
+ type: "category",
+ label: "Medusa React",
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'advanced/backend/upgrade-guides/medusa-react'
+ }
+ ]
},
{
- type: "doc",
- id: "advanced/backend/upgrade-guides/1-7-0",
- label: "v1.7.0"
- },
- {
- type: "doc",
- id: "advanced/backend/upgrade-guides/1-6-1",
- label: "v1.6.1"
- },
- {
- type: "doc",
- id: "advanced/backend/upgrade-guides/1-3-8",
- label: "v1.3.8"
- },
- {
- type: "doc",
- id: "advanced/backend/upgrade-guides/1-3-6",
- label: "v1.3.6"
- },
- {
- type: "doc",
- id: "advanced/backend/upgrade-guides/1-3-0",
- label: "v1.3.0"
- },
- {
- type: "doc",
- id: "advanced/backend/upgrade-guides/admin/admin-vite",
- label: "Medusa Admin: Vite"
- },
+ type: "category",
+ label: "Medusa Admin",
+ items: [
+ {
+ type: 'autogenerated',
+ dirName: 'advanced/backend/upgrade-guides/admin'
+ }
+ ]
+ }
]
},
{
diff --git a/www/docs/src/utils/filterListItems.ts b/www/docs/src/utils/filterListItems.ts
index 21c1e74e4f..e0c70cae3c 100644
--- a/www/docs/src/utils/filterListItems.ts
+++ b/www/docs/src/utils/filterListItems.ts
@@ -1,9 +1,28 @@
-export default function filterListItems (items: any[], pathPattern: string | RegExp) {
+import { PropSidebarItem, PropSidebarItemLink } from '@docusaurus/plugin-content-docs'
+
+export default function filterListItems (items: PropSidebarItemLink[], pathPattern: string | RegExp): PropSidebarItemLink[] {
+ console.log(items)
if (!items.length) {
return items
}
let pattern = new RegExp(pathPattern)
- return items.filter((item) => pattern.test(item.href))
+ return items.filter((item: PropSidebarItemLink) => pattern.test(item.href))
+}
+
+/**
+ * Flatting a sidebar list moving items from category
+ * to links
+ */
+export function flattenList (items: PropSidebarItem[]): PropSidebarItem[] {
+ const newItems = items.map((item: PropSidebarItem) => {
+ if (item.type !== 'category') {
+ return item
+ }
+
+ return item.items
+ })
+
+ return newItems.flat()
}
\ No newline at end of file
diff --git a/www/docs/src/utils/reverseSidebar.js b/www/docs/src/utils/reverseSidebar.js
new file mode 100644
index 0000000000..599b587fcf
--- /dev/null
+++ b/www/docs/src/utils/reverseSidebar.js
@@ -0,0 +1,10 @@
+module.exports = function reverseSidebarItems(items) {
+ // Reverse items in categories
+ const result = items.map((item) => {
+ if (item.type === 'category' && item.customProps?.sort === 'desc') {
+ return {...item, items: reverseSidebarItems(item.items)};
+ }
+ return item;
+ });
+ return result;
+}
\ No newline at end of file