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

chore(docs): Updated API Reference (v2) (#9174)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-18 11:30:02 +00:00
committed by GitHub
parent a227d73e4f
commit 1c4d3f32cb
404 changed files with 2018 additions and 2141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The preview of an order.
x-schemaName: AdminOrderPreviewResponse
required:
- order

2
www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: An order's details.
x-schemaName: AdminOrderResponse
required:
- order

2
www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The order return details.
x-schemaName: AdminOrderReturnResponse
required:
- order

103
www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml
View File

@@ -12,29 +12,13 @@ properties:
title: id
description: The payment's ID.
amount:
oneOf:
- type: string
title: amount
description: The payment's amount.
- type: number
title: amount
description: The payment's amount.
- type: string
title: amount
description: The payment's amount.
- $ref: ./IBigNumber.yaml
type: number
title: amount
description: The payment's amount.
authorized_amount:
oneOf:
- type: string
title: authorized_amount
description: The payment's authorized amount.
- type: number
title: authorized_amount
description: The payment's authorized amount.
- type: string
title: authorized_amount
description: The payment's authorized amount.
- $ref: ./IBigNumber.yaml
type: number
title: authorized_amount
description: The amount authorized of the payment.
currency_code:
type: string
title: currency_code
@@ -42,86 +26,65 @@ properties:
provider_id:
type: string
title: provider_id
description: The payment's provider id.
description: The ID of the payment provider used to process this payment.
cart_id:
type: string
title: cart_id
description: The payment's cart id.
description: The ID of the associated cart.
order_id:
type: string
title: order_id
description: The payment's order id.
description: The ID of the associated order.
order_edit_id:
type: string
title: order_edit_id
description: The payment's order edit id.
description: The ID of the associated order edit.
customer_id:
type: string
title: customer_id
description: The payment's customer id.
description: ID of the associated customer.
data:
type: object
description: The payment's data.
description: The payment's data, useful for processing by the payment provider.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment
created_at:
type: string
format: date-time
title: created_at
description: The payment's created at.
description: The date the payment was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The payment's updated at.
description: The date the payment was updated.
captured_at:
oneOf:
- type: string
title: captured_at
description: The payment's captured at.
- type: string
title: captured_at
description: The payment's captured at.
format: date-time
type: string
format: date-time
title: captured_at
description: The date the payment was captured.
canceled_at:
oneOf:
- type: string
title: canceled_at
description: The payment's canceled at.
- type: string
title: canceled_at
description: The payment's canceled at.
format: date-time
type: string
format: date-time
title: canceled_at
description: The date the payment was canceled.
captured_amount:
oneOf:
- type: string
title: captured_amount
description: The payment's captured amount.
- type: number
title: captured_amount
description: The payment's captured amount.
- type: string
title: captured_amount
description: The payment's captured amount.
- $ref: ./IBigNumber.yaml
type: number
title: captured_amount
description: The captured amount of the payment.
refunded_amount:
oneOf:
- type: string
title: refunded_amount
description: The payment's refunded amount.
- type: number
title: refunded_amount
description: The payment's refunded amount.
- type: string
title: refunded_amount
description: The payment's refunded amount.
- $ref: ./IBigNumber.yaml
type: number
title: captured_amount
description: The refunded amount of the payment.
captures:
type: array
description: The payment's captures.
description: The details of payment captures.
items:
$ref: ./BaseCapture.yaml
refunds:
type: array
description: The payment's refunds.
description: The details of payment refunds.
items:
$ref: ./BaseRefund.yaml
payment_collection:

82
www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: The payment collection's payment collections.
description: The payment collection's details.
x-schemaName: AdminPaymentCollection
required:
- id
@@ -20,77 +20,41 @@ properties:
region_id:
type: string
title: region_id
description: The payment collection's region id.
description: The ID of the region this payment collection is associated with.
amount:
oneOf:
- type: string
title: amount
description: The payment collection's amount.
- type: number
title: amount
description: The payment collection's amount.
- type: string
title: amount
description: The payment collection's amount.
- $ref: ./IBigNumber.yaml
type: number
title: amount
description: The total amount to be paid.
authorized_amount:
oneOf:
- type: string
title: authorized_amount
description: The payment collection's authorized amount.
- type: number
title: authorized_amount
description: The payment collection's authorized amount.
- type: string
title: authorized_amount
description: The payment collection's authorized amount.
- $ref: ./IBigNumber.yaml
type: number
title: authorized_amount
description: The total authorized amount of the collection's payments.
captured_amount:
oneOf:
- type: string
title: captured_amount
description: The payment collection's captured amount.
- type: number
title: captured_amount
description: The payment collection's captured amount.
- type: string
title: captured_amount
description: The payment collection's captured amount.
- $ref: ./IBigNumber.yaml
type: number
title: captured_amount
description: The total captured amount of the collection's payments.
refunded_amount:
oneOf:
- type: string
title: refunded_amount
description: The payment collection's refunded amount.
- type: number
title: refunded_amount
description: The payment collection's refunded amount.
- type: string
title: refunded_amount
description: The payment collection's refunded amount.
- $ref: ./IBigNumber.yaml
type: number
title: refunded_amount
description: The total refunded amount of the collection's payments.
completed_at:
oneOf:
- type: string
title: completed_at
description: The payment collection's completed at.
- type: string
title: completed_at
description: The payment collection's completed at.
format: date-time
type: string
format: date-time
title: completed_at
description: The date the payment collection was completed.
created_at:
type: string
format: date-time
title: created_at
description: The payment collection's created at.
description: The date the payment collection was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The payment collection's updated at.
description: The date the payment collection was updated.
metadata:
type: object
description: The payment collection's metadata.
description: The payment collection's metadata, can hold custom key-value pairs.
status:
type: string
description: The payment collection's status.
@@ -102,7 +66,9 @@ properties:
- partially_authorized
payment_providers:
type: array
description: The payment collection's payment providers.
description: >-
The payment provider used to process the collection's payments and
sessions.
items:
$ref: ./BasePaymentProvider.yaml
payment_sessions:

2
www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The payment collection's details.
x-schemaName: AdminPaymentCollectionResponse
required:
- payment_collection

14
www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml
View File

@@ -1,3 +1,15 @@
type: object
description: The payment provider's payment providers.
description: The payment provider's details.
x-schemaName: AdminPaymentProvider
required:
- is_enabled
- id
properties:
id:
type: string
title: id
description: The payment provider's ID.
is_enabled:
type: boolean
title: is_enabled
description: Whether the payment provider is enabled.

2
www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The payment's details.
x-schemaName: AdminPaymentResponse
required:
- payment

4
www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelClaimReqSchema.yaml
View File

@@ -1,8 +1,8 @@
type: object
description: SUMMARY
description: The details of canceling a claim.
x-schemaName: AdminPostCancelClaimReqSchema
properties:
no_notification:
type: boolean
title: no_notification
description: The claim's no notification.
description: Whether to send the customer a notification about the claim's cancelation.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml
View File

@@ -1,8 +1,10 @@
type: object
description: SUMMARY
description: The details of canceling an exchange.
x-schemaName: AdminPostCancelExchangeReqSchema
properties:
no_notification:
type: boolean
title: no_notification
description: The exchange's no notification.
description: >-
Whether to send a notification to the customer about the exchange's
cancelation.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml
View File

@@ -1,8 +1,10 @@
type: object
description: SUMMARY
description: The details of canceling a return.
x-schemaName: AdminPostCancelReturnReqSchema
properties:
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
description: >-
Whether to send the customer a notification about the return's
cancelation.

14
www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml
View File

@@ -1,13 +1,13 @@
type: object
description: SUMMARY
description: The details of the order items to add to the claim.
x-schemaName: AdminPostClaimItemsReqSchema
properties:
items:
type: array
description: The claim's items.
description: The item's details.
items:
type: object
description: The item's items.
description: An item's details.
required:
- id
- quantity
@@ -15,14 +15,14 @@ properties:
id:
type: string
title: id
description: The item's ID.
description: The ID of the order's item.
quantity:
type: number
title: quantity
description: The item's quantity.
description: The quantity of the order's item to add to the claim.
reason:
type: string
description: The item's reason.
description: The reason the item is claimed.
enum:
- missing_item
- wrong_item
@@ -35,4 +35,4 @@ properties:
internal_note:
type: string
title: internal_note
description: The item's internal note.
description: A note that's only viewed by admin users.

14
www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml
View File

@@ -1,13 +1,13 @@
type: object
description: SUMMARY
description: The details of the outbound items to add to the claim.
x-schemaName: AdminPostClaimsAddItemsReqSchema
properties:
items:
type: array
description: The claim's items.
description: The outbound item's details.
items:
type: object
description: The item's items.
description: An item's details.
required:
- variant_id
- quantity
@@ -15,11 +15,11 @@ properties:
variant_id:
type: string
title: variant_id
description: The item's variant id.
description: The ID of the associated product variant.
quantity:
type: number
title: quantity
description: The item's quantity.
description: The quantity to send to the customer.
unit_price:
type: number
title: unit_price
@@ -27,7 +27,7 @@ properties:
internal_note:
type: string
title: internal_note
description: The item's internal note.
description: A note viewed only by admin users.
metadata:
type: object
description: The item's metadata.
description: The item's metadata, can hold custom key-value pairs.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml
View File

@@ -1,16 +1,16 @@
type: object
description: SUMMARY
description: The details to update in the item.
x-schemaName: AdminPostClaimsItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The claim's quantity.
description: The item's quantity.
reason_id:
type: string
title: reason_id
description: The claim's reason id.
description: The ID of the return reason associated with the item.
internal_note:
type: string
title: internal_note
description: The claim's internal note.
description: A note that's only viewed by admin users.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml
View File

@@ -1,15 +1,15 @@
type: object
description: SUMMARY
description: The details to update in the shipping method.
x-schemaName: AdminPostClaimsShippingActionReqSchema
properties:
custom_amount:
type: number
title: custom_amount
description: The claim's custom amount.
description: The shipping method's custom amount.
internal_note:
type: string
title: internal_note
description: The claim's internal note.
description: A note only viewed by admin users.
metadata:
type: object
description: The claim's metadata.
description: The claim's metadata, can hold custom key-value pairs.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The details of the shipping method used to ship outbound items.
x-schemaName: AdminPostClaimsShippingReqSchema
required:
- shipping_option_id
@@ -7,19 +7,19 @@ properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The claim's shipping option id.
description: The ID of the associated shipping option.
custom_amount:
type: number
title: custom_amount
description: The claim's custom amount.
description: Set a custom price for the shipping method.
description:
type: string
title: description
description: The claim's description.
description: The shipping method's description.
internal_note:
type: string
title: internal_note
description: The claim's internal note.
description: A note only viewed by admin users.
metadata:
type: object
description: The claim's metadata.
description: The claim's metadata, can hold custom key-value pairs.

14
www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml
View File

@@ -1,13 +1,13 @@
type: object
description: SUMMARY
description: The details of outbound items.
x-schemaName: AdminPostExchangesAddItemsReqSchema
properties:
items:
type: array
description: The exchange's items.
description: The details of outbound items.
items:
type: object
description: The item's items.
description: An item's details.
required:
- variant_id
- quantity
@@ -15,7 +15,7 @@ properties:
variant_id:
type: string
title: variant_id
description: The item's variant id.
description: The ID of the associated product variant.
quantity:
type: number
title: quantity
@@ -27,11 +27,11 @@ properties:
internal_note:
type: string
title: internal_note
description: The item's internal note.
description: A note viewed only by admin users.
allow_backorder:
type: boolean
title: allow_backorder
description: The item's allow backorder.
description: Whether the item can be added even if it's not in stock.
metadata:
type: object
description: The item's metadata.
description: The item's metadata, can hold custom key-value pairs.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml
View File

@@ -1,12 +1,12 @@
type: object
description: SUMMARY
description: The details to update in an outbound item.
x-schemaName: AdminPostExchangesItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The exchange's quantity.
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: The exchange's internal note.
description: A note only viewed by admin users.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml
View File

@@ -1,19 +1,19 @@
type: object
description: SUMMARY
description: The details to update in an inbound (returned) item.
x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The exchange's quantity.
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: The exchange's internal note.
description: A note viewed only by admin users.
reason_id:
type: string
title: reason_id
description: The exchange's reason id.
description: The ID of the associated return reason.
metadata:
type: object
description: The exchange's metadata.
description: The exchange's metadata, can hold custom key-value pairs.

14
www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml
View File

@@ -1,13 +1,13 @@
type: object
description: SUMMARY
description: The details of the inbound (return) items.
x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema
properties:
items:
type: array
description: The exchange's items.
description: The details of the inbound (return) items.
items:
type: object
description: The item's items.
description: An item's details.
required:
- id
- quantity
@@ -15,7 +15,7 @@ properties:
id:
type: string
title: id
description: The item's ID.
description: The ID of the order's item.
quantity:
type: number
title: quantity
@@ -27,11 +27,11 @@ properties:
internal_note:
type: string
title: internal_note
description: The item's internal note.
description: A note viewed only by admin users.
reason_id:
type: string
title: reason_id
description: The item's reason id.
description: The ID of the return reason to associate with the item.
metadata:
type: object
description: The item's metadata.
description: The item's metadata, can hold custom key-value pairs.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml
View File

@@ -1,15 +1,15 @@
type: object
description: SUMMARY
description: The details of the shipping method to update.
x-schemaName: AdminPostExchangesShippingActionReqSchema
properties:
custom_amount:
type: number
title: custom_amount
description: The exchange's custom amount.
description: The shipping method's custom amount.
internal_note:
type: string
title: internal_note
description: The exchange's internal note.
description: A note viewed by admin users only.
metadata:
type: object
description: The exchange's metadata.
description: The exchange's metadata, can hold custom key-value pairs.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The outbound shipping method's details.
x-schemaName: AdminPostExchangesShippingReqSchema
required:
- shipping_option_id
@@ -7,19 +7,19 @@ properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The exchange's shipping option id.
description: The ID of the associated shipping option.
custom_amount:
type: number
title: custom_amount
description: The exchange's custom amount.
description: Set a custom amount for the shipping method.
description:
type: string
title: description
description: The exchange's description.
description: The shipping method's description.
internal_note:
type: string
title: internal_note
description: The exchange's internal note.
description: A note viewed by admin users only.
metadata:
type: object
description: The exchange's metadata.
description: The exchange's metadata, can hold custom key-value pairs.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The claim's details.
x-schemaName: AdminPostOrderClaimsReqSchema
required:
- type
@@ -14,7 +14,7 @@ properties:
order_id:
type: string
title: order_id
description: The claim's order id.
description: The ID of the order the claim is created for.
description:
type: string
title: description
@@ -22,11 +22,11 @@ properties:
internal_note:
type: string
title: internal_note
description: The claim's internal note.
description: A note viewed only by admin users.
reason_id:
type: string
title: reason_id
description: The claim's reason id.
description: The ID of the associated return reason.
metadata:
type: object
description: The claim's metadata.
description: The claim's metadata, can hold custom key-value pairs.

16
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml
View File

@@ -1,13 +1,13 @@
type: object
description: SUMMARY
description: The details of items to be edited.
x-schemaName: AdminPostOrderEditsAddItemsReqSchema
properties:
items:
type: array
description: The order edit's items.
description: The details of items to be edited.
items:
type: object
description: The item's items.
description: An item's details.
required:
- variant_id
- quantity
@@ -15,7 +15,7 @@ properties:
variant_id:
type: string
title: variant_id
description: The item's variant id.
description: The ID of the associated product variant.
quantity:
type: number
title: quantity
@@ -27,11 +27,13 @@ properties:
internal_note:
type: string
title: internal_note
description: The item's internal note.
description: A note viewed only by admin users.
allow_backorder:
type: boolean
title: allow_backorder
description: The item's allow backorder.
description: >-
Whether the item can be added even if there's no available
invenotory quantity of the variant.
metadata:
type: object
description: The item's metadata.
description: The item's metadata, can hold custom key-value pairs.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml
View File

@@ -1,12 +1,12 @@
type: object
description: SUMMARY
description: The details to update in the item.
x-schemaName: AdminPostOrderEditsItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The order edit's quantity.
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: The order edit's internal note.
description: A note viewed only by admin users.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The order edit's details.
x-schemaName: AdminPostOrderEditsReqSchema
required:
- order_id
@@ -7,7 +7,7 @@ properties:
order_id:
type: string
title: order_id
description: The order edit's order id.
description: The ID of the order this edit is for.
description:
type: string
title: description
@@ -15,7 +15,7 @@ properties:
internal_note:
type: string
title: internal_note
description: The order edit's internal note.
description: A note viewed only by admin users.
metadata:
type: object
description: The order edit's metadata.
description: The order edit's metadata, can hold custom key-value pairs.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml
View File

@@ -1,15 +1,15 @@
type: object
description: SUMMARY
description: The shipping method's details.
x-schemaName: AdminPostOrderEditsShippingActionReqSchema
properties:
custom_amount:
type: number
title: custom_amount
description: The order edit's custom amount.
description: Set a custom price for the shipping method.
internal_note:
type: string
title: internal_note
description: The order edit's internal note.
description: A note viewed only by admin users.
metadata:
type: object
description: The order edit's metadata.
description: The order edit's metadata, can hold custom key-value pairs.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The shipping method's details.
x-schemaName: AdminPostOrderEditsShippingReqSchema
required:
- shipping_option_id
@@ -7,19 +7,19 @@ properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The order edit's shipping option id.
description: The ID of the associated shipping option.
custom_amount:
type: number
title: custom_amount
description: The order edit's custom amount.
description: Set a custom price for the shipping method.
description:
type: string
title: description
description: The order edit's description.
description: The shipping method's description.
internal_note:
type: string
title: internal_note
description: The order edit's internal note.
description: A note viewed only by admin users.
metadata:
type: object
description: The order edit's metadata.
description: The shipping method's metadata, can hold custom key-value pairs.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The order item's details to update.
x-schemaName: AdminPostOrderEditsUpdateItemQuantityReqSchema
required:
- quantity
@@ -7,8 +7,8 @@ properties:
quantity:
type: number
title: quantity
description: The order edit's quantity.
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: The order edit's internal note.
description: A note viewed only by admin users.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The exchange's details.
x-schemaName: AdminPostOrderExchangesReqSchema
required:
- order_id
@@ -7,7 +7,7 @@ properties:
order_id:
type: string
title: order_id
description: The exchange's order id.
description: The ID of the order this exchange is created for.
description:
type: string
title: description
@@ -15,7 +15,7 @@ properties:
internal_note:
type: string
title: internal_note
description: The exchange's internal note.
description: A note viewed only by admin users.
metadata:
type: object
description: The exchange's metadata.
description: The exchange's metadata, can hold custom key-value pairs.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml
View File

@@ -1,15 +1,15 @@
type: object
description: SUMMARY
description: The return receival details.
x-schemaName: AdminPostReceiveReturnsReqSchema
properties:
internal_note:
type: string
title: internal_note
description: The return's internal note.
description: A note viewed only by admin users.
description:
type: string
title: description
description: The return's description.
metadata:
type: object
description: The return's metadata.
description: The return's metadata, can hold custom key-value pairs.

4
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml
View File

@@ -1,8 +1,8 @@
type: object
description: SUMMARY
description: The confirmation's details.
x-schemaName: AdminPostReturnsConfirmRequestReqSchema
properties:
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
description: Whether to send the customer a notification about the confirmation.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml
View File

@@ -1,12 +1,12 @@
type: object
description: SUMMARY
description: The details to update of the damaged item.
x-schemaName: AdminPostReturnsDismissItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The return's quantity.
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: The return's internal note.
description: A note viewed only by admin users.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml
View File

@@ -1,12 +1,12 @@
type: object
description: SUMMARY
description: The details of the received item.
x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The return's quantity.
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: The return's internal note.
description: A note viewed only by admin users.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml
View File

@@ -1,13 +1,13 @@
type: object
description: SUMMARY
description: The items details.
x-schemaName: AdminPostReturnsReceiveItemsReqSchema
properties:
items:
type: array
description: The return's items.
description: The items details.
items:
type: object
description: The item's items.
description: An item's details.
required:
- id
- quantity
@@ -15,7 +15,7 @@ properties:
id:
type: string
title: id
description: The item's ID.
description: The ID of the item in the order.
quantity:
type: number
title: quantity
@@ -27,4 +27,4 @@ properties:
internal_note:
type: string
title: internal_note
description: The item's internal note.
description: A note viewed only by admin users.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The return's details.
x-schemaName: AdminPostReturnsReqSchema
required:
- order_id
@@ -7,11 +7,11 @@ properties:
order_id:
type: string
title: order_id
description: The return's order id.
description: The ID of the order the return belongs to.
location_id:
type: string
title: location_id
description: The return's location id.
description: The ID of the location the items are returned to.
description:
type: string
title: description
@@ -19,11 +19,11 @@ properties:
internal_note:
type: string
title: internal_note
description: The return's internal note.
description: A note viewed only by admin users.
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
description: Whether to send the customer a notification about the created return.
metadata:
type: object
description: The return's metadata.
description: The return's metadata, can hold custom key-value pairs.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml
View File

@@ -1,19 +1,19 @@
type: object
description: SUMMARY
description: The details to update in the item.
x-schemaName: AdminPostReturnsRequestItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The claim's quantity.
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: The claim's internal note.
description: A note viewed only by admin users.
reason_id:
type: string
title: reason_id
description: The claim's reason id.
description: The ID of the associated return reason.
metadata:
type: object
description: The claim's metadata.
description: The claim's metadata, can hold custom key-value pairs.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml
View File

@@ -1,13 +1,13 @@
type: object
description: SUMMARY
description: The items' details.
x-schemaName: AdminPostReturnsRequestItemsReqSchema
properties:
items:
type: array
description: The claim's items.
description: The items' details.
items:
type: object
description: The item's items.
description: An item's details.
required:
- id
- quantity
@@ -27,11 +27,11 @@ properties:
internal_note:
type: string
title: internal_note
description: The item's internal note.
description: A note viewed only by admin users.
reason_id:
type: string
title: reason_id
description: The item's reason id.
description: The ID of the associated return reason.
metadata:
type: object
description: The item's metadata.
description: The item's metadata, can hold custom key-value pairs.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml
View File

@@ -1,15 +1,17 @@
type: object
description: SUMMARY
description: The return's details.
x-schemaName: AdminPostReturnsReturnReqSchema
properties:
location_id:
type: string
title: location_id
description: The return's location id.
description: The ID of the location to return items to.
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
description: >-
Whether the customer should receive notifications about updates to the
return.
metadata:
type: object
description: The return's metadata.
description: The return's metadata, can hold custom key-value pairs.

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml
View File

@@ -1,15 +1,15 @@
type: object
description: SUMMARY
description: The shipping method's details.
x-schemaName: AdminPostReturnsShippingActionReqSchema
properties:
custom_amount:
type: number
title: custom_amount
description: The return's custom amount.
description: Set a custom price for the shipping method.
internal_note:
type: string
title: internal_note
description: The return's internal note.
description: A note viewed only by admin users.
metadata:
type: object
description: The return's metadata.
description: The return's metadata, can hold custom key-value pairs.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The shipping method's details.
x-schemaName: AdminPostReturnsShippingReqSchema
required:
- shipping_option_id
@@ -7,19 +7,19 @@ properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The exchange's shipping option id.
description: The ID of the associated shipping option.
custom_amount:
type: number
title: custom_amount
description: The exchange's custom amount.
description: Set the price of the shipping method.
description:
type: string
title: description
description: The exchange's description.
description: The shipping method's description.
internal_note:
type: string
title: internal_note
description: The exchange's internal note.
description: A note viewed only by admin users.
metadata:
type: object
description: The exchange's metadata.
description: The exchange's metadata, can hold custom key-value pairs.

19
www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: The price's prices.
description: The price's details.
x-schemaName: AdminPrice
required:
- id
@@ -26,6 +26,7 @@ properties:
type: string
title: currency_code
description: The price's currency code.
example: usd
amount:
type: number
title: amount
@@ -36,27 +37,31 @@ properties:
min_quantity:
type: number
title: min_quantity
description: The price's min quantity.
description: >-
The minimum quantity that must be available in the cart for the price to
be applied.
max_quantity:
type: number
title: max_quantity
description: The price's max quantity.
description: >-
The maximum quantity allowed to be available in the cart for the price to
be applied.
price_set_id:
type: string
title: price_set_id
description: The price's price set id.
description: The ID of the associated price set.
created_at:
type: string
format: date-time
title: created_at
description: The price's created at.
description: The date the price was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The price's updated at.
description: The date the price was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The price's deleted at.
description: The date the price was deleted.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml
View File

@@ -33,11 +33,11 @@ properties:
starts_at:
type: string
title: starts_at
description: The price list's starts at.
description: The date the price list starts.
ends_at:
type: string
title: ends_at
description: The price list's ends at.
description: The date the price list ends.
status:
type: string
description: The price list's status.
@@ -59,14 +59,14 @@ properties:
type: string
format: date-time
title: created_at
description: The price list's created at.
description: The date the price list was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The price list's updated at.
description: The date the price list was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The price list's deleted at.
description: The date the price list was deleted.

17
www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The details of the created, updated, and deleted prices in a price list.
x-schemaName: AdminPriceListBatchResponse
required:
- created
@@ -8,17 +8,17 @@ required:
properties:
created:
type: array
description: The price list's created.
description: The created prices.
items:
$ref: ./AdminPrice.yaml
updated:
type: array
description: The price list's updated.
description: The updated prices.
items:
$ref: ./AdminPrice.yaml
deleted:
type: object
description: SUMMARY
description: The details of the deleted prices.
required:
- ids
- object
@@ -26,16 +26,17 @@ properties:
properties:
ids:
type: array
description: The deleted's ids.
description: The IDs of the deleted prices.
items:
type: string
title: ids
description: The id's ids.
description: A price's ID.
object:
type: string
title: object
description: SUMMARY
description: The name of the deleted object.
default: price
deleted:
type: boolean
title: deleted
description: SUMMARY
description: Whether the prices were deleted.

4
www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The details of the deleted price list.
x-schemaName: AdminPriceListDeleteResponse
required:
- id
@@ -18,4 +18,4 @@ properties:
deleted:
type: boolean
title: deleted
description: Whether the Price List was deleted.
description: Whether the price list was deleted.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The paginated list of price lists.
x-schemaName: AdminPriceListListResponse
required:
- limit
@@ -10,17 +10,17 @@ properties:
limit:
type: number
title: limit
description: The price list's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The price list's offset.
description: The number of items skipped before retrieving the returned items.
count:
type: number
title: count
description: The price list's count.
description: The total number of items.
price_lists:
type: array
description: The price list's price lists.
description: The list of price lists.
items:
$ref: ./AdminPriceList.yaml

21
www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: The price's prices.
description: The details of a price list's price.
x-schemaName: AdminPriceListPrice
required:
- variant_id
@@ -19,7 +19,7 @@ properties:
variant_id:
type: string
title: variant_id
description: The price's variant id.
description: The ID of the product variant this price list is for.
rules:
type: object
description: The price's rules.
@@ -35,6 +35,7 @@ properties:
type: string
title: currency_code
description: The price's currency code.
example: usd
amount:
type: number
title: amount
@@ -45,27 +46,31 @@ properties:
min_quantity:
type: number
title: min_quantity
description: The price's min quantity.
description: >-
The minimum quantity that must be available in the cart for the price to
be applied.
max_quantity:
type: number
title: max_quantity
description: The price's max quantity.
description: >-
The maximum quantity allowed to be available in the cart for the price to
be applied.
price_set_id:
type: string
title: price_set_id
description: The price's price set id.
description: The ID of the price set this price belongs to.
created_at:
type: string
format: date-time
title: created_at
description: The price's created at.
description: The date the price was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The price's updated at.
description: The date the price was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The price's deleted at.
description: The date the price was deleted.

2
www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The price list's details.
x-schemaName: AdminPriceListResponse
required:
- price_list

10
www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml
View File

@@ -18,26 +18,28 @@ properties:
type: string
title: attribute
description: The price preference's attribute.
example: region_id
value:
type: string
title: value
description: The price preference's value.
example: reg_123
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The price preference's is tax inclusive.
description: Whether prices matching this preference include taxes.
created_at:
type: string
format: date-time
title: created_at
description: The price preference's created at.
description: The date the price preference was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The price preference's updated at.
description: The date the price preference was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The price preference's deleted at.
description: The date the price preference was deleted.

4
www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The details of the deleted price preference.
x-schemaName: AdminPricePreferenceDeleteResponse
required:
- id
@@ -18,4 +18,4 @@ properties:
deleted:
type: boolean
title: deleted
description: Whether the Price Preference was deleted.
description: Whether the price preference was deleted.

10
www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The paginated list of price preferences.
x-schemaName: AdminPricePreferenceListResponse
required:
- limit
@@ -10,17 +10,17 @@ properties:
limit:
type: number
title: limit
description: The price preference's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The price preference's offset.
description: The number of items skipped before retrieving the returned items.
count:
type: number
title: count
description: The price preference's count.
description: The total count of items.
price_preferences:
type: array
description: The price preference's price preferences.
description: The list of price preferences.
items:
$ref: ./AdminPricePreference.yaml

2
www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The price preference's details.
x-schemaName: AdminPricePreferenceResponse
required:
- price_preference

62
www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: The product's parent.
description: The product's details.
x-schemaName: AdminProduct
required:
- type
@@ -33,37 +33,37 @@ properties:
$ref: ./AdminCollection.yaml
categories:
type: array
description: The parent's categories.
description: The product's categories.
items:
$ref: ./AdminProductCategory.yaml
sales_channels:
type: array
description: The parent's sales channels.
description: The sales channels that the product is available in.
items:
$ref: ./AdminSalesChannel.yaml
variants:
type: array
description: The parent's variants.
description: The product's variants.
items:
$ref: ./AdminProductVariant.yaml
type:
$ref: ./AdminProductType.yaml
tags:
type: array
description: The parent's tags.
description: The product's tags.
items:
$ref: ./AdminProductTag.yaml
length:
type: number
title: length
description: The parent's length.
description: The product's length.
title:
type: string
title: title
description: The parent's title.
description: The product's title.
status:
type: string
description: The parent's status.
description: The product's status.
enum:
- draft
- proposed
@@ -71,97 +71,97 @@ properties:
- rejected
options:
type: array
description: The parent's options.
description: The product's options.
items:
$ref: ./BaseProductOption.yaml
description:
type: string
title: description
description: The parent's description.
description: The product's description.
id:
type: string
title: id
description: The parent's ID.
description: The product's ID.
metadata:
type: object
description: The parent's metadata.
description: The product's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The parent's created at.
description: The date the product was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The parent's updated at.
description: The date the product was updated.
handle:
type: string
title: handle
description: The parent's handle.
description: The product's unique handle.
subtitle:
type: string
title: subtitle
description: The parent's subtitle.
description: The product's subtitle.
is_giftcard:
type: boolean
title: is_giftcard
description: The parent's is giftcard.
description: Whether the product is a gift card.
thumbnail:
type: string
title: thumbnail
description: The parent's thumbnail.
description: The product's thumbnail.
width:
type: number
title: width
description: The parent's width.
description: The product's width.
weight:
type: number
title: weight
description: The parent's weight.
description: The product's weight.
height:
type: number
title: height
description: The parent's height.
description: The product's height.
origin_country:
type: string
title: origin_country
description: The parent's origin country.
description: The product's origin country.
hs_code:
type: string
title: hs_code
description: The parent's hs code.
description: The product's HS code.
mid_code:
type: string
title: mid_code
description: The parent's mid code.
description: The product's MID code.
material:
type: string
title: material
description: The parent's material.
description: The product's material.
collection_id:
type: string
title: collection_id
description: The parent's collection id.
description: The ID of the collection that the product belongs to.
type_id:
type: string
title: type_id
description: The parent's type id.
description: The ID of the product's type.
images:
type: array
description: The parent's images.
description: The product's images.
items:
$ref: ./BaseProductImage.yaml
discountable:
type: boolean
title: discountable
description: The parent's discountable.
description: Whether discounts can be applied on the product.
external_id:
type: string
title: external_id
description: The parent's external id.
description: The ID of a product in an external system, such as an ERP or CMS.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The parent's deleted at.
description: The date the product was deleted.

26
www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: The category's categories.
description: The product category's details.
x-schemaName: AdminProductCategory
required:
- category_children
@@ -18,7 +18,7 @@ required:
properties:
category_children:
type: array
description: The category's category children.
description: The category's children.
items:
type: object
parent_category:
@@ -42,39 +42,43 @@ properties:
description: The category's ID.
metadata:
type: object
description: The category's metadata.
description: The category's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The category's created at.
description: The date the category was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The category's updated at.
description: The date the category was updated.
handle:
type: string
title: handle
description: The category's handle.
description: The category's unique handle.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The category's deleted at.
description: The date the category was deleted.
is_active:
type: boolean
title: is_active
description: The category's is active.
description: >-
Whether the category is active. If disabled, the category isn't shown in
the storefront.
is_internal:
type: boolean
title: is_internal
description: The category's is internal.
description: >-
Whether the category is internal. If enabled, the category is only seen by
admin users.
rank:
type: number
title: rank
description: The category's rank.
description: The category's rank among sibling categories.
parent_category_id:
type: string
title: parent_category_id
description: The category's parent category id.
description: The ID of the category's parent.

4
www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The details of deleting the category.
x-schemaName: AdminProductCategoryDeleteResponse
required:
- id
@@ -18,4 +18,4 @@ properties:
deleted:
type: boolean
title: deleted
description: Whether the Product Category was deleted.
description: Whether the product category was deleted.

10
www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The paginated list of product categories.
x-schemaName: AdminProductCategoryListResponse
required:
- limit
@@ -10,17 +10,17 @@ properties:
limit:
type: number
title: limit
description: The product category's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The product category's offset.
description: The number of items skipped before retrieving the returned items.
count:
type: number
title: count
description: The product category's count.
description: The total number of items.
product_categories:
type: array
description: The product category's product categories.
description: The list of product categories.
items:
$ref: ./AdminProductCategory.yaml

2
www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The product category's details.
x-schemaName: AdminProductCategoryResponse
required:
- product_category

4
www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml
View File

@@ -1,5 +1,5 @@
type: object
description: SUMMARY
description: The details of the product deletion.
x-schemaName: AdminProductDeleteResponse
required:
- id
@@ -18,4 +18,4 @@ properties:
deleted:
type: boolean
title: deleted
description: Whether the Product was deleted.
description: Whether the product was deleted.