chore(docs): Updated API Reference (v2) (#8609)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
4bd0917aed
commit
b23ddcdde8
1211 files changed
+92070
-5062
No files matched your search
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminApiKeyResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminApiKeyResponse
|
||||
* required:
|
||||
* - api_key
|
||||
* properties:
|
||||
* api_key:
|
||||
* $ref: "#/components/schemas/ApiKeyResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminCampaignResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCampaignResponse
|
||||
* required:
|
||||
* - campaign
|
||||
* properties:
|
||||
* campaign:
|
||||
* $ref: "#/components/schemas/CampaignResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,255 @@
|
||||
/**
|
||||
* @schema AdminClaim
|
||||
* type: object
|
||||
* description: The claim's details.
|
||||
* x-schemaName: AdminClaim
|
||||
* required:
|
||||
* - order_id
|
||||
* - claim_items
|
||||
* - additional_items
|
||||
* - currency_code
|
||||
* - id
|
||||
* - region_id
|
||||
* - customer_id
|
||||
* - sales_channel_id
|
||||
* - email
|
||||
* - shipping_methods
|
||||
* - payment_status
|
||||
* - fulfillment_status
|
||||
* - summary
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_item_total
|
||||
* - original_item_subtotal
|
||||
* - original_item_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - gift_card_total
|
||||
* - gift_card_tax_total
|
||||
* - shipping_total
|
||||
* - shipping_subtotal
|
||||
* - shipping_tax_total
|
||||
* - original_shipping_total
|
||||
* - original_shipping_subtotal
|
||||
* - original_shipping_tax_total
|
||||
* properties:
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The claim's order id.
|
||||
* claim_items:
|
||||
* type: array
|
||||
* description: The claim's claim items.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseClaimItem"
|
||||
* additional_items:
|
||||
* type: array
|
||||
* description: The claim's additional items.
|
||||
* items: {}
|
||||
* return:
|
||||
* $ref: "#/components/schemas/Return"
|
||||
* return_id:
|
||||
* type: string
|
||||
* title: return_id
|
||||
* description: The claim's return id.
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: The claim's no notification.
|
||||
* refund_amount:
|
||||
* type: number
|
||||
* title: refund_amount
|
||||
* description: The claim's refund amount.
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The claim's currency code.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The claim's ID.
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The claim's region id.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The claim's customer id.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The claim's sales channel id.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The claim's email.
|
||||
* format: email
|
||||
* display_id:
|
||||
* type: string
|
||||
* title: display_id
|
||||
* description: The claim's display id.
|
||||
* shipping_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* billing_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* shipping_methods:
|
||||
* type: array
|
||||
* description: The claim's shipping methods.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderShippingMethod"
|
||||
* payment_collections:
|
||||
* type: array
|
||||
* description: The claim's payment collections.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePaymentCollection"
|
||||
* payment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* fulfillments:
|
||||
* type: array
|
||||
* description: The claim's fulfillments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderFulfillment"
|
||||
* fulfillment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* transactions:
|
||||
* type: array
|
||||
* description: The claim's transactions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
* summary:
|
||||
* $ref: "#/components/schemas/BaseOrderSummary"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The claim's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The claim's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The claim's updated at.
|
||||
* original_item_total:
|
||||
* type: number
|
||||
* title: original_item_total
|
||||
* description: The claim's original item total.
|
||||
* original_item_subtotal:
|
||||
* type: number
|
||||
* title: original_item_subtotal
|
||||
* description: The claim's original item subtotal.
|
||||
* original_item_tax_total:
|
||||
* type: number
|
||||
* title: original_item_tax_total
|
||||
* description: The claim's original item tax total.
|
||||
* item_total:
|
||||
* type: number
|
||||
* title: item_total
|
||||
* description: The claim's item total.
|
||||
* item_subtotal:
|
||||
* type: number
|
||||
* title: item_subtotal
|
||||
* description: The claim's item subtotal.
|
||||
* item_tax_total:
|
||||
* type: number
|
||||
* title: item_tax_total
|
||||
* description: The claim's item tax total.
|
||||
* original_total:
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The claim's original total.
|
||||
* original_subtotal:
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The claim's original subtotal.
|
||||
* original_tax_total:
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The claim's original tax total.
|
||||
* total:
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The claim's total.
|
||||
* subtotal:
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The claim's subtotal.
|
||||
* tax_total:
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The claim's tax total.
|
||||
* discount_total:
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The claim's discount total.
|
||||
* discount_tax_total:
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The claim's discount tax total.
|
||||
* gift_card_total:
|
||||
* type: number
|
||||
* title: gift_card_total
|
||||
* description: The claim's gift card total.
|
||||
* gift_card_tax_total:
|
||||
* type: number
|
||||
* title: gift_card_tax_total
|
||||
* description: The claim's gift card tax total.
|
||||
* shipping_total:
|
||||
* type: number
|
||||
* title: shipping_total
|
||||
* description: The claim's shipping total.
|
||||
* shipping_subtotal:
|
||||
* type: number
|
||||
* title: shipping_subtotal
|
||||
* description: The claim's shipping subtotal.
|
||||
* shipping_tax_total:
|
||||
* type: number
|
||||
* title: shipping_tax_total
|
||||
* description: The claim's shipping tax total.
|
||||
* original_shipping_total:
|
||||
* type: number
|
||||
* title: original_shipping_total
|
||||
* description: The claim's original shipping total.
|
||||
* original_shipping_subtotal:
|
||||
* type: number
|
||||
* title: original_shipping_subtotal
|
||||
* description: The claim's original shipping subtotal.
|
||||
* original_shipping_tax_total:
|
||||
* type: number
|
||||
* title: original_shipping_tax_total
|
||||
* description: The claim's original shipping tax total.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* @schema AdminClaimDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminClaimDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The claim's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The claim's object.
|
||||
* default: claim
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The claim's deleted.
|
||||
* parent:
|
||||
* type: object
|
||||
* description: The claim's parent.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminClaimListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminClaimListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - claims
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The claim's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The claim's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The claim's count.
|
||||
* claims:
|
||||
* type: array
|
||||
* description: The claim's claims.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminClaimOrderResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminClaimOrderResponse
|
||||
* required:
|
||||
* - order
|
||||
* - claim
|
||||
* properties:
|
||||
* order:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminClaimPreviewResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminClaimPreviewResponse
|
||||
* required:
|
||||
* - order_preview
|
||||
* - claim
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
/**
|
||||
* @schema AdminClaimRequestResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminClaimRequestResponse
|
||||
* required:
|
||||
* - return
|
||||
* - order_preview
|
||||
* - claim
|
||||
* properties:
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminClaimResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminClaimResponse
|
||||
* required:
|
||||
* - claim
|
||||
* properties:
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminClaimReturnPreviewResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminClaimReturnPreviewResponse
|
||||
* required:
|
||||
* - order_preview
|
||||
* - return
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* @schema AdminCollectionDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCollectionDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The collection's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The collection's object.
|
||||
* default: collection
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The collection's deleted.
|
||||
* parent:
|
||||
* type: object
|
||||
* description: The collection's parent.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminCollectionListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCollectionListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - collections
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The collection's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The collection's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The collection's count.
|
||||
* collections:
|
||||
* type: array
|
||||
* description: The collection's collections.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminCollection"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminCollectionResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCollectionResponse
|
||||
* required:
|
||||
* - collection
|
||||
* properties:
|
||||
* collection:
|
||||
* $ref: "#/components/schemas/AdminCollection"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/**
|
||||
* @schema AdminCompleteOrder
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCompleteOrder
|
||||
* required:
|
||||
* - order_id
|
||||
* properties:
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The order's order id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
/**
|
||||
* @schema AdminCreateCustomer
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateCustomer
|
||||
* required:
|
||||
* - email
|
||||
* - company_name
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - phone
|
||||
* - metadata
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The customer's email.
|
||||
* format: email
|
||||
* company_name:
|
||||
* type: string
|
||||
* title: company_name
|
||||
* description: The customer's company name.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The customer's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The customer's last name.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The customer's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,77 +0,0 @@
|
||||
/**
|
||||
* @schema AdminCreateCustomerAddress
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateCustomerAddress
|
||||
* required:
|
||||
* - address_name
|
||||
* - company
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - address_1
|
||||
* - address_2
|
||||
* - city
|
||||
* - country_code
|
||||
* - province
|
||||
* - postal_code
|
||||
* - phone
|
||||
* - metadata
|
||||
* properties:
|
||||
* address_name:
|
||||
* type: string
|
||||
* title: address_name
|
||||
* description: The customer's address name.
|
||||
* is_default_shipping:
|
||||
* type: boolean
|
||||
* title: is_default_shipping
|
||||
* description: The customer's is default shipping.
|
||||
* is_default_billing:
|
||||
* type: boolean
|
||||
* title: is_default_billing
|
||||
* description: The customer's is default billing.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The customer's company.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The customer's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The customer's last name.
|
||||
* address_1:
|
||||
* type: string
|
||||
* title: address_1
|
||||
* description: The customer's address 1.
|
||||
* address_2:
|
||||
* type: string
|
||||
* title: address_2
|
||||
* description: The customer's address 2.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The customer's city.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The customer's country code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The customer's province.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The customer's postal code.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The customer's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -81,15 +81,13 @@
|
||||
* items:
|
||||
* type: object
|
||||
* description: The tag's tags.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The tag's ID.
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The tag's value.
|
||||
* options:
|
||||
* type: array
|
||||
* description: The create's options.
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* @schema AdminCurrency
|
||||
* type: object
|
||||
* description: The supported currency's currency.
|
||||
* x-schemaName: AdminCurrency
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminCurrencyListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCurrencyListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - currencies
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The currency's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The currency's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The currency's count.
|
||||
* currencies:
|
||||
* type: array
|
||||
* description: The currency's currencies.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminCurrency"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminCurrencyResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCurrencyResponse
|
||||
* required:
|
||||
* - currency
|
||||
* properties:
|
||||
* currency:
|
||||
* $ref: "#/components/schemas/AdminCurrency"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
/**
|
||||
* @schema AdminCustomerAddress
|
||||
* type: object
|
||||
* description: The customer's address.
|
||||
* x-schemaName: AdminCustomerAddress
|
||||
* required:
|
||||
* - id
|
||||
* - address_name
|
||||
* - is_default_shipping
|
||||
* - is_default_billing
|
||||
* - customer_id
|
||||
* - company
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - address_1
|
||||
* - address_2
|
||||
* - city
|
||||
* - country_code
|
||||
* - province
|
||||
* - postal_code
|
||||
* - phone
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The address's ID.
|
||||
* address_name:
|
||||
* type: string
|
||||
* title: address_name
|
||||
* description: The address's address name.
|
||||
* is_default_shipping:
|
||||
* type: boolean
|
||||
* title: is_default_shipping
|
||||
* description: The address's is default shipping.
|
||||
* is_default_billing:
|
||||
* type: boolean
|
||||
* title: is_default_billing
|
||||
* description: The address's is default billing.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The address's customer id.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The address's company.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The address's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The address's last name.
|
||||
* address_1:
|
||||
* type: string
|
||||
* title: address_1
|
||||
* description: The address's address 1.
|
||||
* address_2:
|
||||
* type: string
|
||||
* title: address_2
|
||||
* description: The address's address 2.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The address's city.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The address's country code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The address's province.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The address's postal code.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The address's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The address's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The address's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The address's updated at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminCustomerAddressResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCustomerAddressResponse
|
||||
* required:
|
||||
* - address
|
||||
* properties:
|
||||
* address:
|
||||
* $ref: "#/components/schemas/AdminCustomerAddress"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminCustomerGroupResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCustomerGroupResponse
|
||||
* required:
|
||||
* - customer_group
|
||||
* properties:
|
||||
* customer_group:
|
||||
* $ref: "#/components/schemas/AdminCustomerGroup"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminCustomerResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCustomerResponse
|
||||
* required:
|
||||
* - customer
|
||||
* properties:
|
||||
* customer:
|
||||
* $ref: "#/components/schemas/AdminCustomer"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminDraftOrderResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminDraftOrderResponse
|
||||
* required:
|
||||
* - draft_order
|
||||
* properties:
|
||||
* draft_order:
|
||||
* $ref: "#/components/schemas/AdminOrder"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,256 @@
|
||||
/**
|
||||
* @schema AdminExchange
|
||||
* type: object
|
||||
* description: The exchange's details.
|
||||
* x-schemaName: AdminExchange
|
||||
* required:
|
||||
* - order_id
|
||||
* - return_items
|
||||
* - additional_items
|
||||
* - currency_code
|
||||
* - id
|
||||
* - region_id
|
||||
* - customer_id
|
||||
* - sales_channel_id
|
||||
* - email
|
||||
* - shipping_methods
|
||||
* - payment_status
|
||||
* - fulfillment_status
|
||||
* - summary
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_item_total
|
||||
* - original_item_subtotal
|
||||
* - original_item_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - gift_card_total
|
||||
* - gift_card_tax_total
|
||||
* - shipping_total
|
||||
* - shipping_subtotal
|
||||
* - shipping_tax_total
|
||||
* - original_shipping_total
|
||||
* - original_shipping_subtotal
|
||||
* - original_shipping_tax_total
|
||||
* properties:
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The exchange's order id.
|
||||
* return_items:
|
||||
* type: array
|
||||
* description: The exchange's return items.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminReturnItem"
|
||||
* additional_items:
|
||||
* type: array
|
||||
* description: The exchange's additional items.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseExchangeItem"
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: The exchange's no notification.
|
||||
* difference_due:
|
||||
* type: number
|
||||
* title: difference_due
|
||||
* description: The exchange's difference due.
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
* return_id:
|
||||
* type: string
|
||||
* title: return_id
|
||||
* description: The exchange's return id.
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The exchange's currency code.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The exchange's ID.
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The exchange's region id.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The exchange's customer id.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The exchange's sales channel id.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The exchange's email.
|
||||
* format: email
|
||||
* display_id:
|
||||
* type: string
|
||||
* title: display_id
|
||||
* description: The exchange's display id.
|
||||
* shipping_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* billing_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* shipping_methods:
|
||||
* type: array
|
||||
* description: The exchange's shipping methods.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderShippingMethod"
|
||||
* payment_collections:
|
||||
* type: array
|
||||
* description: The exchange's payment collections.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePaymentCollection"
|
||||
* payment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* fulfillments:
|
||||
* type: array
|
||||
* description: The exchange's fulfillments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderFulfillment"
|
||||
* fulfillment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* transactions:
|
||||
* type: array
|
||||
* description: The exchange's transactions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
* summary:
|
||||
* $ref: "#/components/schemas/BaseOrderSummary"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The exchange's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The exchange's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The exchange's updated at.
|
||||
* original_item_total:
|
||||
* type: number
|
||||
* title: original_item_total
|
||||
* description: The exchange's original item total.
|
||||
* original_item_subtotal:
|
||||
* type: number
|
||||
* title: original_item_subtotal
|
||||
* description: The exchange's original item subtotal.
|
||||
* original_item_tax_total:
|
||||
* type: number
|
||||
* title: original_item_tax_total
|
||||
* description: The exchange's original item tax total.
|
||||
* item_total:
|
||||
* type: number
|
||||
* title: item_total
|
||||
* description: The exchange's item total.
|
||||
* item_subtotal:
|
||||
* type: number
|
||||
* title: item_subtotal
|
||||
* description: The exchange's item subtotal.
|
||||
* item_tax_total:
|
||||
* type: number
|
||||
* title: item_tax_total
|
||||
* description: The exchange's item tax total.
|
||||
* original_total:
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The exchange's original total.
|
||||
* original_subtotal:
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The exchange's original subtotal.
|
||||
* original_tax_total:
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The exchange's original tax total.
|
||||
* total:
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The exchange's total.
|
||||
* subtotal:
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The exchange's subtotal.
|
||||
* tax_total:
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The exchange's tax total.
|
||||
* discount_total:
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The exchange's discount total.
|
||||
* discount_tax_total:
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The exchange's discount tax total.
|
||||
* gift_card_total:
|
||||
* type: number
|
||||
* title: gift_card_total
|
||||
* description: The exchange's gift card total.
|
||||
* gift_card_tax_total:
|
||||
* type: number
|
||||
* title: gift_card_tax_total
|
||||
* description: The exchange's gift card tax total.
|
||||
* shipping_total:
|
||||
* type: number
|
||||
* title: shipping_total
|
||||
* description: The exchange's shipping total.
|
||||
* shipping_subtotal:
|
||||
* type: number
|
||||
* title: shipping_subtotal
|
||||
* description: The exchange's shipping subtotal.
|
||||
* shipping_tax_total:
|
||||
* type: number
|
||||
* title: shipping_tax_total
|
||||
* description: The exchange's shipping tax total.
|
||||
* original_shipping_total:
|
||||
* type: number
|
||||
* title: original_shipping_total
|
||||
* description: The exchange's original shipping total.
|
||||
* original_shipping_subtotal:
|
||||
* type: number
|
||||
* title: original_shipping_subtotal
|
||||
* description: The exchange's original shipping subtotal.
|
||||
* original_shipping_tax_total:
|
||||
* type: number
|
||||
* title: original_shipping_tax_total
|
||||
* description: The exchange's original shipping tax total.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminExchangeOrderResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExchangeOrderResponse
|
||||
* required:
|
||||
* - order
|
||||
* - exchange
|
||||
* properties:
|
||||
* order:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminExchangePreviewResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExchangePreviewResponse
|
||||
* required:
|
||||
* - order_preview
|
||||
* - exchange
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
/**
|
||||
* @schema AdminExchangeRequestResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExchangeRequestResponse
|
||||
* required:
|
||||
* - return
|
||||
* - order_preview
|
||||
* - exchange
|
||||
* properties:
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminExchangeResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExchangeResponse
|
||||
* required:
|
||||
* - exchange
|
||||
* properties:
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminExchangeReturnResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExchangeReturnResponse
|
||||
* required:
|
||||
* - order_preview
|
||||
* - return
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
/**
|
||||
* @schema AdminFile
|
||||
* type: object
|
||||
* description: The upload's file.
|
||||
* x-schemaName: AdminFile
|
||||
* required:
|
||||
* - id
|
||||
* - url
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The file's ID.
|
||||
* url:
|
||||
* type: string
|
||||
* title: url
|
||||
* description: The file's url.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminFileListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminFileListResponse
|
||||
* required:
|
||||
* - files
|
||||
* properties:
|
||||
* files:
|
||||
* type: array
|
||||
* description: The upload's files.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminFile"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminFileResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminFileResponse
|
||||
* required:
|
||||
* - file
|
||||
* properties:
|
||||
* file:
|
||||
* $ref: "#/components/schemas/AdminFile"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
/**
|
||||
* @schema AdminFulfillment
|
||||
* type: object
|
||||
* description: The fulfillment's details.
|
||||
* x-schemaName: AdminFulfillment
|
||||
* required:
|
||||
* - id
|
||||
* - location_id
|
||||
* - provider_id
|
||||
* - shipping_option_id
|
||||
* - provider
|
||||
* - delivery_address
|
||||
* - items
|
||||
* - labels
|
||||
* - packed_at
|
||||
* - shipped_at
|
||||
* - delivered_at
|
||||
* - canceled_at
|
||||
* - data
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The fulfillment's ID.
|
||||
* location_id:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The fulfillment's location id.
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
* description: The fulfillment's provider id.
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The fulfillment's shipping option id.
|
||||
* provider:
|
||||
* $ref: "#/components/schemas/AdminFulfillmentProvider"
|
||||
* delivery_address:
|
||||
* $ref: "#/components/schemas/AdminFulfillmentAddress"
|
||||
* items:
|
||||
* type: array
|
||||
* description: The fulfillment's items.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminFulfillmentItem"
|
||||
* labels:
|
||||
* type: array
|
||||
* description: The fulfillment's labels.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminFulfillmentLabel"
|
||||
* packed_at:
|
||||
* type: string
|
||||
* title: packed_at
|
||||
* description: The fulfillment's packed at.
|
||||
* shipped_at:
|
||||
* type: string
|
||||
* title: shipped_at
|
||||
* description: The fulfillment's shipped at.
|
||||
* delivered_at:
|
||||
* type: string
|
||||
* title: delivered_at
|
||||
* description: The fulfillment's delivered at.
|
||||
* canceled_at:
|
||||
* type: string
|
||||
* title: canceled_at
|
||||
* description: The fulfillment's canceled at.
|
||||
* data:
|
||||
* type: object
|
||||
* description: The fulfillment's data.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The fulfillment's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The fulfillment's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The fulfillment's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The fulfillment's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentAddress
|
||||
* type: object
|
||||
* description: The fulfillment's delivery address.
|
||||
* x-schemaName: AdminFulfillmentAddress
|
||||
* required:
|
||||
* - id
|
||||
* - fulfillment_id
|
||||
* - company
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - address_1
|
||||
* - address_2
|
||||
* - city
|
||||
* - country_code
|
||||
* - province
|
||||
* - postal_code
|
||||
* - phone
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The delivery address's ID.
|
||||
* fulfillment_id:
|
||||
* type: string
|
||||
* title: fulfillment_id
|
||||
* description: The delivery address's fulfillment id.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The delivery address's company.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The delivery address's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The delivery address's last name.
|
||||
* address_1:
|
||||
* type: string
|
||||
* title: address_1
|
||||
* description: The delivery address's address 1.
|
||||
* address_2:
|
||||
* type: string
|
||||
* title: address_2
|
||||
* description: The delivery address's address 2.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The delivery address's city.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The delivery address's country code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The delivery address's province.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The delivery address's postal code.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The delivery address's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The delivery address's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The delivery address's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The delivery address's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The delivery address's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentItem
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* x-schemaName: AdminFulfillmentItem
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - quantity
|
||||
* - sku
|
||||
* - barcode
|
||||
* - line_item_id
|
||||
* - inventory_item_id
|
||||
* - fulfillment_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The item's title.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The item's sku.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The item's barcode.
|
||||
* line_item_id:
|
||||
* type: string
|
||||
* title: line_item_id
|
||||
* description: The item's line item id.
|
||||
* inventory_item_id:
|
||||
* type: string
|
||||
* title: inventory_item_id
|
||||
* description: The item's inventory item id.
|
||||
* fulfillment_id:
|
||||
* type: string
|
||||
* title: fulfillment_id
|
||||
* description: The item's fulfillment id.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The item's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The item's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The item's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentLabel
|
||||
* type: object
|
||||
* description: The label's labels.
|
||||
* x-schemaName: AdminFulfillmentLabel
|
||||
* required:
|
||||
* - id
|
||||
* - tracking_number
|
||||
* - tracking_url
|
||||
* - label_url
|
||||
* - fulfillment_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The label's ID.
|
||||
* tracking_number:
|
||||
* type: string
|
||||
* title: tracking_number
|
||||
* description: The label's tracking number.
|
||||
* tracking_url:
|
||||
* type: string
|
||||
* title: tracking_url
|
||||
* description: The label's tracking url.
|
||||
* label_url:
|
||||
* type: string
|
||||
* title: label_url
|
||||
* description: The label's label url.
|
||||
* fulfillment_id:
|
||||
* type: string
|
||||
* title: fulfillment_id
|
||||
* description: The label's fulfillment id.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The label's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The label's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The label's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentProvider
|
||||
* type: object
|
||||
* description: The shipping option's provider.
|
||||
* description: The fulfillment provider's fulfillment providers.
|
||||
* x-schemaName: AdminFulfillmentProvider
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentProviderListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminFulfillmentProviderListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - fulfillment_providers
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The fulfillment provider's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The fulfillment provider's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The fulfillment provider's count.
|
||||
* fulfillment_providers:
|
||||
* type: array
|
||||
* description: The fulfillment provider's fulfillment providers.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminFulfillmentProvider"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminFulfillmentResponse
|
||||
* required:
|
||||
* - fulfillment
|
||||
* properties:
|
||||
* fulfillment:
|
||||
* $ref: "#/components/schemas/AdminFulfillment"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
* - id
|
||||
* - name
|
||||
* - type
|
||||
* - location
|
||||
* - service_zones
|
||||
* - created_at
|
||||
* - updated_at
|
||||
@@ -24,6 +25,8 @@
|
||||
* type: string
|
||||
* title: type
|
||||
* description: The fulfillment set's type.
|
||||
* location:
|
||||
* $ref: "#/components/schemas/AdminStockLocation"
|
||||
* service_zones:
|
||||
* type: array
|
||||
* description: The fulfillment set's service zones.
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
/**
|
||||
* @schema AdminInventoryItem
|
||||
* type: object
|
||||
* description: The inventory item's details.
|
||||
* x-schemaName: AdminInventoryItem
|
||||
* required:
|
||||
* - id
|
||||
* - requires_shipping
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The inventory item's ID.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The inventory item's sku.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The inventory item's origin country.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The inventory item's hs code.
|
||||
* requires_shipping:
|
||||
* type: boolean
|
||||
* title: requires_shipping
|
||||
* description: The inventory item's requires shipping.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The inventory item's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The inventory item's material.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The inventory item's weight.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The inventory item's length.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The inventory item's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The inventory item's width.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The inventory item's title.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The inventory item's description.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The inventory item's thumbnail.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The inventory item's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminInventoryItemResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminInventoryItemResponse
|
||||
* required:
|
||||
* - inventory_item
|
||||
* properties:
|
||||
* inventory_item:
|
||||
* $ref: "#/components/schemas/AdminInventoryItem"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
/**
|
||||
* @schema AdminInvite
|
||||
* type: object
|
||||
* description: The invite's details.
|
||||
* x-schemaName: AdminInvite
|
||||
* required:
|
||||
* - id
|
||||
* - email
|
||||
* - accepted
|
||||
* - token
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The invite's ID.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The invite's email.
|
||||
* format: email
|
||||
* accepted:
|
||||
* type: boolean
|
||||
* title: accepted
|
||||
* description: The invite's accepted.
|
||||
* token:
|
||||
* type: string
|
||||
* title: token
|
||||
* description: The invite's token.
|
||||
* expires_at:
|
||||
* type: string
|
||||
* title: expires_at
|
||||
* description: The invite's expires at.
|
||||
* format: date-time
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The invite's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The invite's created at.
|
||||
* format: date-time
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The invite's updated at.
|
||||
* format: date-time
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminInviteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminInviteResponse
|
||||
* required:
|
||||
* - invite
|
||||
* properties:
|
||||
* invite:
|
||||
* $ref: "#/components/schemas/AdminInvite"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
/**
|
||||
* @schema AdminNotification
|
||||
* type: object
|
||||
* description: The notification's details.
|
||||
* x-schemaName: AdminNotification
|
||||
* required:
|
||||
* - id
|
||||
* - to
|
||||
* - channel
|
||||
* - template
|
||||
* - provider_id
|
||||
* - created_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The notification's ID.
|
||||
* to:
|
||||
* type: string
|
||||
* title: to
|
||||
* description: The notification's to.
|
||||
* channel:
|
||||
* type: string
|
||||
* title: channel
|
||||
* description: The notification's channel.
|
||||
* template:
|
||||
* type: string
|
||||
* title: template
|
||||
* description: The notification's template.
|
||||
* data:
|
||||
* type: object
|
||||
* description: The notification's data.
|
||||
* trigger_type:
|
||||
* type: string
|
||||
* title: trigger_type
|
||||
* description: The notification's trigger type.
|
||||
* resource_id:
|
||||
* type: string
|
||||
* title: resource_id
|
||||
* description: The notification's resource id.
|
||||
* resource_type:
|
||||
* type: string
|
||||
* title: resource_type
|
||||
* description: The notification's resource type.
|
||||
* receiver_id:
|
||||
* type: string
|
||||
* title: receiver_id
|
||||
* description: The notification's receiver id.
|
||||
* original_notification_id:
|
||||
* type: string
|
||||
* title: original_notification_id
|
||||
* description: The notification's original notification id.
|
||||
* external_id:
|
||||
* type: string
|
||||
* title: external_id
|
||||
* description: The notification's external id.
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
* description: The notification's provider id.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The notification's created at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminNotificationListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminNotificationListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - notifications
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The notification's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The notification's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The notification's count.
|
||||
* notifications:
|
||||
* type: array
|
||||
* description: The notification's notifications.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminNotification"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminNotificationResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminNotificationResponse
|
||||
* required:
|
||||
* - notification
|
||||
* properties:
|
||||
* notification:
|
||||
* $ref: "#/components/schemas/AdminNotification"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,237 @@
|
||||
/**
|
||||
* @schema AdminOrder
|
||||
* type: object
|
||||
* description: The order's details.
|
||||
* x-schemaName: AdminOrder
|
||||
* required:
|
||||
* - payment_collections
|
||||
* - id
|
||||
* - version
|
||||
* - region_id
|
||||
* - customer_id
|
||||
* - sales_channel_id
|
||||
* - email
|
||||
* - currency_code
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - payment_status
|
||||
* - fulfillment_status
|
||||
* - summary
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_item_total
|
||||
* - original_item_subtotal
|
||||
* - original_item_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - gift_card_total
|
||||
* - gift_card_tax_total
|
||||
* - shipping_total
|
||||
* - shipping_subtotal
|
||||
* - shipping_tax_total
|
||||
* - original_shipping_total
|
||||
* - original_shipping_subtotal
|
||||
* - original_shipping_tax_total
|
||||
* properties:
|
||||
* payment_collections:
|
||||
* type: array
|
||||
* description: The order's payment collections.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPaymentCollection"
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The order's ID.
|
||||
* version:
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The order's version.
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The order's region id.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The order's customer id.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The order's sales channel id.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The order's email.
|
||||
* format: email
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The order's currency code.
|
||||
* display_id:
|
||||
* type: string
|
||||
* title: display_id
|
||||
* description: The order's display id.
|
||||
* shipping_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* billing_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* items:
|
||||
* type: array
|
||||
* description: The order's items.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderLineItem"
|
||||
* shipping_methods:
|
||||
* type: array
|
||||
* description: The order's shipping methods.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderShippingMethod"
|
||||
* payment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* fulfillments:
|
||||
* type: array
|
||||
* description: The order's fulfillments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderFulfillment"
|
||||
* fulfillment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* transactions:
|
||||
* type: array
|
||||
* description: The order's transactions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
* summary:
|
||||
* $ref: "#/components/schemas/BaseOrderSummary"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The order's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The order's updated at.
|
||||
* original_item_total:
|
||||
* type: number
|
||||
* title: original_item_total
|
||||
* description: The order's original item total.
|
||||
* original_item_subtotal:
|
||||
* type: number
|
||||
* title: original_item_subtotal
|
||||
* description: The order's original item subtotal.
|
||||
* original_item_tax_total:
|
||||
* type: number
|
||||
* title: original_item_tax_total
|
||||
* description: The order's original item tax total.
|
||||
* item_total:
|
||||
* type: number
|
||||
* title: item_total
|
||||
* description: The order's item total.
|
||||
* item_subtotal:
|
||||
* type: number
|
||||
* title: item_subtotal
|
||||
* description: The order's item subtotal.
|
||||
* item_tax_total:
|
||||
* type: number
|
||||
* title: item_tax_total
|
||||
* description: The order's item tax total.
|
||||
* original_total:
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The order's original total.
|
||||
* original_subtotal:
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The order's original subtotal.
|
||||
* original_tax_total:
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The order's original tax total.
|
||||
* total:
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The order's total.
|
||||
* subtotal:
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The order's subtotal.
|
||||
* tax_total:
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The order's tax total.
|
||||
* discount_total:
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The order's discount total.
|
||||
* discount_tax_total:
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The order's discount tax total.
|
||||
* gift_card_total:
|
||||
* type: number
|
||||
* title: gift_card_total
|
||||
* description: The order's gift card total.
|
||||
* gift_card_tax_total:
|
||||
* type: number
|
||||
* title: gift_card_tax_total
|
||||
* description: The order's gift card tax total.
|
||||
* shipping_total:
|
||||
* type: number
|
||||
* title: shipping_total
|
||||
* description: The order's shipping total.
|
||||
* shipping_subtotal:
|
||||
* type: number
|
||||
* title: shipping_subtotal
|
||||
* description: The order's shipping subtotal.
|
||||
* shipping_tax_total:
|
||||
* type: number
|
||||
* title: shipping_tax_total
|
||||
* description: The order's shipping tax total.
|
||||
* original_shipping_total:
|
||||
* type: number
|
||||
* title: original_shipping_total
|
||||
* description: The order's original shipping total.
|
||||
* original_shipping_subtotal:
|
||||
* type: number
|
||||
* title: original_shipping_subtotal
|
||||
* description: The order's original shipping subtotal.
|
||||
* original_shipping_tax_total:
|
||||
* type: number
|
||||
* title: original_shipping_tax_total
|
||||
* description: The order's original shipping tax total.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
/**
|
||||
* @schema AdminOrderCancelFulfillment
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminOrderCancelFulfillment
|
||||
* properties:
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: The order's no notification.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
/**
|
||||
* @schema AdminOrderCreateFulfillment
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminOrderCreateFulfillment
|
||||
* required:
|
||||
* - items
|
||||
* - location_id
|
||||
* - metadata
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
* description: The order's items.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* required:
|
||||
* - id
|
||||
* - quantity
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* location_id:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The order's location id.
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: The order's no notification.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,60 +0,0 @@
|
||||
/**
|
||||
* @schema AdminOrderCreateShipment
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminOrderCreateShipment
|
||||
* required:
|
||||
* - items
|
||||
* - metadata
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
* description: The order's items.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* required:
|
||||
* - id
|
||||
* - quantity
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* labels:
|
||||
* type: array
|
||||
* description: The order's labels.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The label's labels.
|
||||
* required:
|
||||
* - tracking_number
|
||||
* - tracking_url
|
||||
* - label_url
|
||||
* properties:
|
||||
* tracking_number:
|
||||
* type: string
|
||||
* title: tracking_number
|
||||
* description: The label's tracking number.
|
||||
* tracking_url:
|
||||
* type: string
|
||||
* title: tracking_url
|
||||
* description: The label's tracking url.
|
||||
* label_url:
|
||||
* type: string
|
||||
* title: label_url
|
||||
* description: The label's label url.
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: The order's no notification.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,647 @@
|
||||
/**
|
||||
* @schema AdminOrderPreview
|
||||
* type: object
|
||||
* description: The return's order preview.
|
||||
* x-schemaName: AdminOrderPreview
|
||||
* required:
|
||||
* - return_requested_total
|
||||
* - order_change
|
||||
* - currency_code
|
||||
* - id
|
||||
* - version
|
||||
* - region_id
|
||||
* - customer_id
|
||||
* - sales_channel_id
|
||||
* - email
|
||||
* - payment_collections
|
||||
* - payment_status
|
||||
* - fulfillment_status
|
||||
* - summary
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_item_total
|
||||
* - original_item_subtotal
|
||||
* - original_item_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - gift_card_total
|
||||
* - gift_card_tax_total
|
||||
* - shipping_total
|
||||
* - shipping_subtotal
|
||||
* - shipping_tax_total
|
||||
* - original_shipping_total
|
||||
* - original_shipping_subtotal
|
||||
* - original_shipping_tax_total
|
||||
* properties:
|
||||
* return_requested_total:
|
||||
* type: number
|
||||
* title: return_requested_total
|
||||
* description: The order preview's return requested total.
|
||||
* order_change:
|
||||
* $ref: "#/components/schemas/BaseOrderChange"
|
||||
* items:
|
||||
* type: array
|
||||
* description: The order preview's items.
|
||||
* items:
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: The item's items.
|
||||
* x-schemaName: BaseOrderLineItem
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - subtitle
|
||||
* - thumbnail
|
||||
* - variant_id
|
||||
* - product_id
|
||||
* - product_title
|
||||
* - product_description
|
||||
* - product_subtitle
|
||||
* - product_type
|
||||
* - product_collection
|
||||
* - product_handle
|
||||
* - variant_sku
|
||||
* - variant_barcode
|
||||
* - variant_title
|
||||
* - variant_option_values
|
||||
* - requires_shipping
|
||||
* - is_discountable
|
||||
* - is_tax_inclusive
|
||||
* - unit_price
|
||||
* - quantity
|
||||
* - detail
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - metadata
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - refundable_total
|
||||
* - refundable_total_per_unit
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The item's title.
|
||||
* subtitle:
|
||||
* type: string
|
||||
* title: subtitle
|
||||
* description: The item's subtitle.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The item's thumbnail.
|
||||
* variant:
|
||||
* $ref: "#/components/schemas/BaseProductVariant"
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The item's variant id.
|
||||
* product:
|
||||
* $ref: "#/components/schemas/BaseProduct"
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The item's product id.
|
||||
* product_title:
|
||||
* type: string
|
||||
* title: product_title
|
||||
* description: The item's product title.
|
||||
* product_description:
|
||||
* type: string
|
||||
* title: product_description
|
||||
* description: The item's product description.
|
||||
* product_subtitle:
|
||||
* type: string
|
||||
* title: product_subtitle
|
||||
* description: The item's product subtitle.
|
||||
* product_type:
|
||||
* type: string
|
||||
* title: product_type
|
||||
* description: The item's product type.
|
||||
* product_collection:
|
||||
* type: string
|
||||
* title: product_collection
|
||||
* description: The item's product collection.
|
||||
* product_handle:
|
||||
* type: string
|
||||
* title: product_handle
|
||||
* description: The item's product handle.
|
||||
* variant_sku:
|
||||
* type: string
|
||||
* title: variant_sku
|
||||
* description: The item's variant sku.
|
||||
* variant_barcode:
|
||||
* type: string
|
||||
* title: variant_barcode
|
||||
* description: The item's variant barcode.
|
||||
* variant_title:
|
||||
* type: string
|
||||
* title: variant_title
|
||||
* description: The item's variant title.
|
||||
* variant_option_values:
|
||||
* type: object
|
||||
* description: The item's variant option values.
|
||||
* requires_shipping:
|
||||
* type: boolean
|
||||
* title: requires_shipping
|
||||
* description: The item's requires shipping.
|
||||
* is_discountable:
|
||||
* type: boolean
|
||||
* title: is_discountable
|
||||
* description: The item's is discountable.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: The item's is tax inclusive.
|
||||
* compare_at_unit_price:
|
||||
* type: number
|
||||
* title: compare_at_unit_price
|
||||
* description: The item's compare at unit price.
|
||||
* unit_price:
|
||||
* type: number
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* tax_lines:
|
||||
* type: array
|
||||
* description: The item's tax lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderLineItemTaxLine"
|
||||
* adjustments:
|
||||
* type: array
|
||||
* description: The item's adjustments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderLineItemAdjustment"
|
||||
* detail:
|
||||
* $ref: "#/components/schemas/BaseOrderItemDetail"
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The item's created at.
|
||||
* format: date-time
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The item's updated at.
|
||||
* format: date-time
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata.
|
||||
* original_total:
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The item's original total.
|
||||
* original_subtotal:
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The item's original subtotal.
|
||||
* original_tax_total:
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The item's original tax total.
|
||||
* item_total:
|
||||
* type: number
|
||||
* title: item_total
|
||||
* description: The item's item total.
|
||||
* item_subtotal:
|
||||
* type: number
|
||||
* title: item_subtotal
|
||||
* description: The item's item subtotal.
|
||||
* item_tax_total:
|
||||
* type: number
|
||||
* title: item_tax_total
|
||||
* description: The item's item tax total.
|
||||
* total:
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The item's total.
|
||||
* subtotal:
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The item's subtotal.
|
||||
* tax_total:
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The item's tax total.
|
||||
* discount_total:
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The item's discount total.
|
||||
* discount_tax_total:
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The item's discount tax total.
|
||||
* refundable_total:
|
||||
* type: number
|
||||
* title: refundable_total
|
||||
* description: The item's refundable total.
|
||||
* refundable_total_per_unit:
|
||||
* type: number
|
||||
* title: refundable_total_per_unit
|
||||
* description: The item's refundable total per unit.
|
||||
* - type: object
|
||||
* description: The item's items.
|
||||
* properties:
|
||||
* actions:
|
||||
* type: array
|
||||
* description: The item's actions.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The action's actions.
|
||||
* x-schemaName: BaseOrderChangeAction
|
||||
* shipping_methods:
|
||||
* type: array
|
||||
* description: The order preview's shipping methods.
|
||||
* items:
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: The shipping method's shipping methods.
|
||||
* x-schemaName: BaseOrderShippingMethod
|
||||
* required:
|
||||
* - id
|
||||
* - order_id
|
||||
* - name
|
||||
* - amount
|
||||
* - is_tax_inclusive
|
||||
* - shipping_option_id
|
||||
* - data
|
||||
* - metadata
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The shipping method's ID.
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The shipping method's order id.
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The shipping method's name.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The shipping method's description.
|
||||
* amount:
|
||||
* type: number
|
||||
* title: amount
|
||||
* description: The shipping method's amount.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: The shipping method's is tax inclusive.
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The shipping method's shipping option id.
|
||||
* data:
|
||||
* type: object
|
||||
* description: The shipping method's data.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping method's metadata.
|
||||
* tax_lines:
|
||||
* type: array
|
||||
* description: The shipping method's tax lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderShippingMethodTaxLine"
|
||||
* adjustments:
|
||||
* type: array
|
||||
* description: The shipping method's adjustments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderShippingMethodAdjustment"
|
||||
* original_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_total
|
||||
* description: The shipping method's original total.
|
||||
* - type: number
|
||||
* title: original_total
|
||||
* description: The shipping method's original total.
|
||||
* - type: string
|
||||
* title: original_total
|
||||
* description: The shipping method's original total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* original_subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's original subtotal.
|
||||
* - type: number
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's original subtotal.
|
||||
* - type: string
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's original subtotal.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* original_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_tax_total
|
||||
* description: The shipping method's original tax total.
|
||||
* - type: number
|
||||
* title: original_tax_total
|
||||
* description: The shipping method's original tax total.
|
||||
* - type: string
|
||||
* title: original_tax_total
|
||||
* description: The shipping method's original tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: total
|
||||
* description: The shipping method's total.
|
||||
* - type: number
|
||||
* title: total
|
||||
* description: The shipping method's total.
|
||||
* - type: string
|
||||
* title: total
|
||||
* description: The shipping method's total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: subtotal
|
||||
* description: The shipping method's subtotal.
|
||||
* - type: number
|
||||
* title: subtotal
|
||||
* description: The shipping method's subtotal.
|
||||
* - type: string
|
||||
* title: subtotal
|
||||
* description: The shipping method's subtotal.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: tax_total
|
||||
* description: The shipping method's tax total.
|
||||
* - type: number
|
||||
* title: tax_total
|
||||
* description: The shipping method's tax total.
|
||||
* - type: string
|
||||
* title: tax_total
|
||||
* description: The shipping method's tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* discount_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_total
|
||||
* description: The shipping method's discount total.
|
||||
* - type: number
|
||||
* title: discount_total
|
||||
* description: The shipping method's discount total.
|
||||
* - type: string
|
||||
* title: discount_total
|
||||
* description: The shipping method's discount total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* discount_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_tax_total
|
||||
* description: The shipping method's discount tax total.
|
||||
* - type: number
|
||||
* title: discount_tax_total
|
||||
* description: The shipping method's discount tax total.
|
||||
* - type: string
|
||||
* title: discount_tax_total
|
||||
* description: The shipping method's discount tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The shipping method's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The shipping method's updated at.
|
||||
* - type: object
|
||||
* description: The shipping method's shipping methods.
|
||||
* properties:
|
||||
* actions:
|
||||
* type: array
|
||||
* description: The shipping method's actions.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The action's actions.
|
||||
* x-schemaName: BaseOrderChangeAction
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The order preview's currency code.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The order preview's ID.
|
||||
* version:
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The order preview's version.
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The order preview's region id.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The order preview's customer id.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The order preview's sales channel id.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The order preview's email.
|
||||
* format: email
|
||||
* display_id:
|
||||
* type: string
|
||||
* title: display_id
|
||||
* description: The order preview's display id.
|
||||
* shipping_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* billing_address:
|
||||
* $ref: "#/components/schemas/BaseOrderAddress"
|
||||
* payment_collections:
|
||||
* type: array
|
||||
* description: The order preview's payment collections.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPaymentCollection"
|
||||
* payment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* fulfillments:
|
||||
* type: array
|
||||
* description: The order preview's fulfillments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderFulfillment"
|
||||
* fulfillment_status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* transactions:
|
||||
* type: array
|
||||
* description: The order preview's transactions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
* summary:
|
||||
* $ref: "#/components/schemas/BaseOrderSummary"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order preview's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The order preview's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The order preview's updated at.
|
||||
* original_item_total:
|
||||
* type: number
|
||||
* title: original_item_total
|
||||
* description: The order preview's original item total.
|
||||
* original_item_subtotal:
|
||||
* type: number
|
||||
* title: original_item_subtotal
|
||||
* description: The order preview's original item subtotal.
|
||||
* original_item_tax_total:
|
||||
* type: number
|
||||
* title: original_item_tax_total
|
||||
* description: The order preview's original item tax total.
|
||||
* item_total:
|
||||
* type: number
|
||||
* title: item_total
|
||||
* description: The order preview's item total.
|
||||
* item_subtotal:
|
||||
* type: number
|
||||
* title: item_subtotal
|
||||
* description: The order preview's item subtotal.
|
||||
* item_tax_total:
|
||||
* type: number
|
||||
* title: item_tax_total
|
||||
* description: The order preview's item tax total.
|
||||
* original_total:
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The order preview's original total.
|
||||
* original_subtotal:
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The order preview's original subtotal.
|
||||
* original_tax_total:
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The order preview's original tax total.
|
||||
* total:
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The order preview's total.
|
||||
* subtotal:
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The order preview's subtotal.
|
||||
* tax_total:
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The order preview's tax total.
|
||||
* discount_total:
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The order preview's discount total.
|
||||
* discount_tax_total:
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The order preview's discount tax total.
|
||||
* gift_card_total:
|
||||
* type: number
|
||||
* title: gift_card_total
|
||||
* description: The order preview's gift card total.
|
||||
* gift_card_tax_total:
|
||||
* type: number
|
||||
* title: gift_card_tax_total
|
||||
* description: The order preview's gift card tax total.
|
||||
* shipping_total:
|
||||
* type: number
|
||||
* title: shipping_total
|
||||
* description: The order preview's shipping total.
|
||||
* shipping_subtotal:
|
||||
* type: number
|
||||
* title: shipping_subtotal
|
||||
* description: The order preview's shipping subtotal.
|
||||
* shipping_tax_total:
|
||||
* type: number
|
||||
* title: shipping_tax_total
|
||||
* description: The order preview's shipping tax total.
|
||||
* original_shipping_total:
|
||||
* type: number
|
||||
* title: original_shipping_total
|
||||
* description: The order preview's original shipping total.
|
||||
* original_shipping_subtotal:
|
||||
* type: number
|
||||
* title: original_shipping_subtotal
|
||||
* description: The order preview's original shipping subtotal.
|
||||
* original_shipping_tax_total:
|
||||
* type: number
|
||||
* title: original_shipping_tax_total
|
||||
* description: The order preview's original shipping tax total.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminOrderPreviewResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminOrderPreviewResponse
|
||||
* required:
|
||||
* - order
|
||||
* properties:
|
||||
* order:
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminOrderResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminOrderResponse
|
||||
* required:
|
||||
* - order
|
||||
* properties:
|
||||
* order:
|
||||
* $ref: "#/components/schemas/AdminOrder"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminOrderReturnResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminOrderReturnResponse
|
||||
* required:
|
||||
* - order
|
||||
* - return
|
||||
* properties:
|
||||
* order:
|
||||
* $ref: "#/components/schemas/Order"
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,135 @@
|
||||
/**
|
||||
* @schema AdminPayment
|
||||
* type: object
|
||||
* description: The payment's details.
|
||||
* x-schemaName: AdminPayment
|
||||
* required:
|
||||
* - id
|
||||
* - amount
|
||||
* - currency_code
|
||||
* - provider_id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The payment's currency code.
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
* description: The payment's provider id.
|
||||
* cart_id:
|
||||
* type: string
|
||||
* title: cart_id
|
||||
* description: The payment's cart id.
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The payment's order id.
|
||||
* order_edit_id:
|
||||
* type: string
|
||||
* title: order_edit_id
|
||||
* description: The payment's order edit id.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The payment's customer id.
|
||||
* data:
|
||||
* type: object
|
||||
* description: The payment's data.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The payment's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The payment's updated at.
|
||||
* 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
|
||||
* 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
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* captures:
|
||||
* type: array
|
||||
* description: The payment's captures.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseCapture"
|
||||
* refunds:
|
||||
* type: array
|
||||
* description: The payment's refunds.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseRefund"
|
||||
* payment_collection:
|
||||
* $ref: "#/components/schemas/BasePaymentCollection"
|
||||
* payment_session:
|
||||
* $ref: "#/components/schemas/BasePaymentSession"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
/**
|
||||
* @schema AdminPaymentCollection
|
||||
* type: object
|
||||
* description: The payment collection's payment collections.
|
||||
* x-schemaName: AdminPaymentCollection
|
||||
* required:
|
||||
* - id
|
||||
* - currency_code
|
||||
* - region_id
|
||||
* - amount
|
||||
* - status
|
||||
* - payment_providers
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The payment collection's ID.
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The payment collection's currency code.
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The payment collection's region id.
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* 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: "#/components/schemas/IBigNumber"
|
||||
* 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
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The payment collection's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The payment collection's updated at.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The payment collection's metadata.
|
||||
* status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* payment_providers:
|
||||
* type: array
|
||||
* description: The payment collection's payment providers.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePaymentProvider"
|
||||
* payment_sessions:
|
||||
* type: array
|
||||
* description: The payment collection's payment sessions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePaymentSession"
|
||||
* payments:
|
||||
* type: array
|
||||
* description: The payment collection's payments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePayment"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPaymentProvider
|
||||
* type: object
|
||||
* description: The payment provider's payment providers.
|
||||
* x-schemaName: AdminPaymentProvider
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminPaymentResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPaymentResponse
|
||||
* required:
|
||||
* - payment
|
||||
* properties:
|
||||
* payment:
|
||||
* $ref: "#/components/schemas/AdminPayment"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminPostCancelExchangeReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostCancelExchangeReqSchema
|
||||
* properties:
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: The exchange's no notification.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -3,18 +3,17 @@
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostClaimsItemsActionReqSchema
|
||||
* required:
|
||||
* - reason_id
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The claim's quantity.
|
||||
* reason:
|
||||
* reason_id:
|
||||
* type: string
|
||||
* enum:
|
||||
* - missing_item
|
||||
* - wrong_item
|
||||
* - production_failure
|
||||
* - other
|
||||
* title: reason_id
|
||||
* description: The claim's reason id.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
/**
|
||||
* @schema AdminPostExchangesAddItemsReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostExchangesAddItemsReqSchema
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
* description: The exchange's items.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* required:
|
||||
* - variant_id
|
||||
* - quantity
|
||||
* properties:
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The item's variant id.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* unit_price:
|
||||
* type: number
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The item's internal note.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The item's allow backorder.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* @schema AdminPostExchangesRequestItemsReturnActionReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The exchange's quantity.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The exchange's internal note.
|
||||
* reason_id:
|
||||
* type: string
|
||||
* title: reason_id
|
||||
* description: The exchange's reason id.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The exchange's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
/**
|
||||
* @schema AdminPostExchangesReturnRequestItemsReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
* description: The exchange's items.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* required:
|
||||
* - id
|
||||
* - quantity
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The item's description.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The item's internal note.
|
||||
* reason_id:
|
||||
* type: string
|
||||
* title: reason_id
|
||||
* description: The item's reason id.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
/**
|
||||
* @schema AdminPostExchangesShippingActionReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostExchangesShippingActionReqSchema
|
||||
* properties:
|
||||
* custom_price:
|
||||
* type: number
|
||||
* title: custom_price
|
||||
* description: The exchange's custom price.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The exchange's internal note.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The exchange's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* @schema AdminPostExchangesShippingReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostExchangesShippingReqSchema
|
||||
* required:
|
||||
* - shipping_option_id
|
||||
* properties:
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The exchange's shipping option id.
|
||||
* custom_price:
|
||||
* type: number
|
||||
* title: custom_price
|
||||
* description: The exchange's custom price.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The exchange's description.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The exchange's internal note.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The exchange's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* @schema AdminPostExhangesItemsActionReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostExhangesItemsActionReqSchema
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The exchange's quantity.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The exchange's internal note.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
* required:
|
||||
* - type
|
||||
* - order_id
|
||||
* - reason_id
|
||||
* - metadata
|
||||
* properties:
|
||||
* type:
|
||||
@@ -25,6 +26,10 @@
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The claim's internal note.
|
||||
* reason_id:
|
||||
* type: string
|
||||
* title: reason_id
|
||||
* description: The claim's reason id.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The claim's metadata.
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
/**
|
||||
* @schema AdminPostOrderExchangesReqSchema
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPostOrderExchangesReqSchema
|
||||
* required:
|
||||
* - order_id
|
||||
* - metadata
|
||||
* properties:
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The exchange's order id.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The exchange's description.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The exchange's internal note.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The exchange's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -9,22 +9,22 @@
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The claim's shipping option id.
|
||||
* description: The exchange's shipping option id.
|
||||
* custom_price:
|
||||
* type: number
|
||||
* title: custom_price
|
||||
* description: The claim's custom price.
|
||||
* description: The exchange's custom price.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The claim's description.
|
||||
* description: The exchange's description.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: The claim's internal note.
|
||||
* description: The exchange's internal note.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The claim's metadata.
|
||||
* description: The exchange's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
/**
|
||||
* @schema AdminPriceList
|
||||
* type: object
|
||||
* description: The price list's details.
|
||||
* x-schemaName: AdminPriceList
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - description
|
||||
* - rules
|
||||
* - starts_at
|
||||
* - ends_at
|
||||
* - status
|
||||
* - type
|
||||
* - prices
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The price list's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The price list's title.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The price list's description.
|
||||
* rules:
|
||||
* type: object
|
||||
* description: The price list's rules.
|
||||
* starts_at:
|
||||
* type: string
|
||||
* title: starts_at
|
||||
* description: The price list's starts at.
|
||||
* ends_at:
|
||||
* type: string
|
||||
* title: ends_at
|
||||
* description: The price list's ends at.
|
||||
* status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - draft
|
||||
* - active
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - sale
|
||||
* - override
|
||||
* prices:
|
||||
* type: array
|
||||
* description: The price list's prices.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPriceListPrice"
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The price list's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The price list's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The price list's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
/**
|
||||
* @schema AdminPriceListBatchResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPriceListBatchResponse
|
||||
* required:
|
||||
* - created
|
||||
* - updated
|
||||
* - deleted
|
||||
* properties:
|
||||
* created:
|
||||
* type: array
|
||||
* description: The price list's created.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPrice"
|
||||
* updated:
|
||||
* type: array
|
||||
* description: The price list's updated.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPrice"
|
||||
* deleted:
|
||||
* type: object
|
||||
* description: The price list's deleted.
|
||||
* required:
|
||||
* - ids
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* ids:
|
||||
* type: array
|
||||
* description: The deleted's ids.
|
||||
* items:
|
||||
* type: string
|
||||
* title: ids
|
||||
* description: The id's ids.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The deleted's object.
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The deleted's details.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* @schema AdminPriceListDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPriceListDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The price list's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The price list's object.
|
||||
* default: price_list
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The price list's deleted.
|
||||
* parent:
|
||||
* type: object
|
||||
* description: The price list's parent.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminPriceListListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPriceListListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - price_lists
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The price list's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The price list's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The price list's count.
|
||||
* price_lists:
|
||||
* type: array
|
||||
* description: The price list's price lists.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPriceList"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
/**
|
||||
* @schema AdminPriceListPrice
|
||||
* type: object
|
||||
* description: The price's prices.
|
||||
* x-schemaName: AdminPriceListPrice
|
||||
* required:
|
||||
* - variant_id
|
||||
* - rules
|
||||
* - id
|
||||
* - title
|
||||
* - currency_code
|
||||
* - amount
|
||||
* - raw_amount
|
||||
* - min_quantity
|
||||
* - max_quantity
|
||||
* - price_set_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The price's variant id.
|
||||
* rules:
|
||||
* type: object
|
||||
* description: The price's rules.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The price's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The price's title.
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The price's currency code.
|
||||
* amount:
|
||||
* type: number
|
||||
* title: amount
|
||||
* description: The price's amount.
|
||||
* raw_amount:
|
||||
* type: object
|
||||
* description: The price's raw amount.
|
||||
* min_quantity:
|
||||
* type: number
|
||||
* title: min_quantity
|
||||
* description: The price's min quantity.
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The price's max quantity.
|
||||
* price_set_id:
|
||||
* type: string
|
||||
* title: price_set_id
|
||||
* description: The price's price set id.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The price's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The price's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The price's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminPriceListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPriceListResponse
|
||||
* required:
|
||||
* - price_list
|
||||
* properties:
|
||||
* price_list:
|
||||
* $ref: "#/components/schemas/AdminPriceList"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
/**
|
||||
* @schema AdminPricePreference
|
||||
* type: object
|
||||
* description: The price preference's details.
|
||||
* x-schemaName: AdminPricePreference
|
||||
* required:
|
||||
* - id
|
||||
* - attribute
|
||||
* - value
|
||||
* - is_tax_inclusive
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The price preference's ID.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The price preference's attribute.
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The price preference's value.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: The price preference's is tax inclusive.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The price preference's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The price preference's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The price preference's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* @schema AdminPricePreferenceDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPricePreferenceDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The price preference's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The price preference's object.
|
||||
* default: price_preference
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The price preference's deleted.
|
||||
* parent:
|
||||
* type: object
|
||||
* description: The price preference's parent.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminPricePreferenceListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPricePreferenceListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - price_preferences
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The price preference's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The price preference's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The price preference's count.
|
||||
* price_preferences:
|
||||
* type: array
|
||||
* description: The price preference's price preferences.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPricePreference"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminPricePreferenceResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPricePreferenceResponse
|
||||
* required:
|
||||
* - price_preference
|
||||
* properties:
|
||||
* price_preference:
|
||||
* $ref: "#/components/schemas/AdminPricePreference"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -11,25 +11,25 @@
|
||||
* - options
|
||||
* - description
|
||||
* - id
|
||||
* - handle
|
||||
* - hs_code
|
||||
* - weight
|
||||
* - height
|
||||
* - width
|
||||
* - origin_country
|
||||
* - mid_code
|
||||
* - material
|
||||
* - thumbnail
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* - handle
|
||||
* - subtitle
|
||||
* - is_giftcard
|
||||
* - thumbnail
|
||||
* - width
|
||||
* - weight
|
||||
* - height
|
||||
* - origin_country
|
||||
* - hs_code
|
||||
* - mid_code
|
||||
* - material
|
||||
* - collection_id
|
||||
* - type_id
|
||||
* - images
|
||||
* - discountable
|
||||
* - external_id
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* collection:
|
||||
* $ref: "#/components/schemas/AdminCollection"
|
||||
@@ -86,42 +86,6 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The parent's metadata.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The parent's handle.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The parent's hs code.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The parent's weight.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The parent's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The parent's width.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The parent's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The parent's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The parent's material.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The parent's thumbnail.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
@@ -132,11 +96,10 @@
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The parent's updated at.
|
||||
* deleted_at:
|
||||
* handle:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The parent's deleted at.
|
||||
* title: handle
|
||||
* description: The parent's handle.
|
||||
* subtitle:
|
||||
* type: string
|
||||
* title: subtitle
|
||||
@@ -145,6 +108,38 @@
|
||||
* type: boolean
|
||||
* title: is_giftcard
|
||||
* description: The parent's is giftcard.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The parent's thumbnail.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The parent's width.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The parent's weight.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The parent's height.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The parent's origin country.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The parent's hs code.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The parent's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The parent's material.
|
||||
* collection_id:
|
||||
* type: string
|
||||
* title: collection_id
|
||||
@@ -166,6 +161,11 @@
|
||||
* type: string
|
||||
* title: external_id
|
||||
* description: The parent's external id.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The parent's deleted at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -9,14 +9,14 @@
|
||||
* - name
|
||||
* - description
|
||||
* - id
|
||||
* - handle
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - handle
|
||||
* - deleted_at
|
||||
* - parent_category_id
|
||||
* - is_internal
|
||||
* - is_active
|
||||
* - is_internal
|
||||
* - rank
|
||||
* - parent_category_id
|
||||
* properties:
|
||||
* category_children:
|
||||
* type: array
|
||||
@@ -42,10 +42,6 @@
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The category's ID.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The category's handle.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
@@ -56,27 +52,31 @@
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The category's updated at.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The category's handle.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The category's deleted at.
|
||||
* parent_category_id:
|
||||
* type: string
|
||||
* title: parent_category_id
|
||||
* description: The category's parent category id.
|
||||
* is_internal:
|
||||
* type: boolean
|
||||
* title: is_internal
|
||||
* description: The category's is internal.
|
||||
* is_active:
|
||||
* type: boolean
|
||||
* title: is_active
|
||||
* description: The category's is active.
|
||||
* is_internal:
|
||||
* type: boolean
|
||||
* title: is_internal
|
||||
* description: The category's is internal.
|
||||
* rank:
|
||||
* type: number
|
||||
* title: rank
|
||||
* description: The category's rank.
|
||||
* parent_category_id:
|
||||
* type: string
|
||||
* title: parent_category_id
|
||||
* description: The category's parent category id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* @schema AdminProductCategoryDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductCategoryDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The product category's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The product category's object.
|
||||
* default: product_category
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The product category's deleted.
|
||||
* parent:
|
||||
* type: object
|
||||
* description: The product category's parent.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* @schema AdminProductTagDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductTagDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The product tag's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The product tag's object.
|
||||
* default: product_tag
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The product tag's deleted.
|
||||
* parent:
|
||||
* type: object
|
||||
* description: The product tag's parent.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminProductTagListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductTagListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - product_tags
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The product tag's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The product tag's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The product tag's count.
|
||||
* product_tags:
|
||||
* type: array
|
||||
* description: The product tag's product tags.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminProductTag"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminProductTagResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductTagResponse
|
||||
* required:
|
||||
* - product_tag
|
||||
* properties:
|
||||
* product_tag:
|
||||
* $ref: "#/components/schemas/AdminProductTag"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* @schema AdminProductTypeDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductTypeDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The product type's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The product type's object.
|
||||
* default: product_type
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The product type's deleted.
|
||||
* parent:
|
||||
* type: object
|
||||
* description: The product type's parent.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminProductTypeListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductTypeListResponse
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* - product_types
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The product type's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The product type's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The product type's count.
|
||||
* product_types:
|
||||
* type: array
|
||||
* description: The product type's product types.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminProductTypeResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductTypeResponse
|
||||
* required:
|
||||
* - product_type
|
||||
* properties:
|
||||
* product_type:
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @schema AdminProductVariant
|
||||
* type: object
|
||||
* description: The updated's details.
|
||||
* description: The product's parent.
|
||||
* x-schemaName: AdminProductVariant
|
||||
* required:
|
||||
* - prices
|
||||
@@ -28,80 +28,80 @@
|
||||
* properties:
|
||||
* prices:
|
||||
* type: array
|
||||
* description: The updated's prices.
|
||||
* description: The parent's prices.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPrice"
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The updated's ID.
|
||||
* description: The parent's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The updated's title.
|
||||
* description: The parent's title.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The updated's sku.
|
||||
* description: The parent's sku.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The updated's barcode.
|
||||
* description: The parent's barcode.
|
||||
* ean:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The updated's ean.
|
||||
* description: The parent's ean.
|
||||
* upc:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The updated's upc.
|
||||
* description: The parent's upc.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The updated's allow backorder.
|
||||
* description: The parent's allow backorder.
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The updated's manage inventory.
|
||||
* description: The parent's manage inventory.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The updated's hs code.
|
||||
* description: The parent's hs code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The updated's origin country.
|
||||
* description: The parent's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The updated's mid code.
|
||||
* description: The parent's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The updated's material.
|
||||
* description: The parent's material.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The updated's weight.
|
||||
* description: The parent's weight.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The updated's length.
|
||||
* description: The parent's length.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The updated's height.
|
||||
* description: The parent's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The updated's width.
|
||||
* description: The parent's width.
|
||||
* variant_rank:
|
||||
* type: number
|
||||
* title: variant_rank
|
||||
* description: The updated's variant rank.
|
||||
* description: The parent's variant rank.
|
||||
* options:
|
||||
* type: array
|
||||
* description: The updated's options.
|
||||
* description: The parent's options.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseProductOptionValue"
|
||||
* product:
|
||||
@@ -109,27 +109,27 @@
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The updated's product id.
|
||||
* description: The parent's product id.
|
||||
* calculated_price:
|
||||
* $ref: "#/components/schemas/BaseCalculatedPriceSet"
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The updated's created at.
|
||||
* description: The parent's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The updated's updated at.
|
||||
* description: The parent's updated at.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The updated's deleted at.
|
||||
* description: The parent's deleted at.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The updated's metadata.
|
||||
* description: The parent's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
/**
|
||||
* @schema AdminProductVariantInventoryBatchResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductVariantInventoryBatchResponse
|
||||
* required:
|
||||
* - created
|
||||
* - updated
|
||||
* - deleted
|
||||
* properties:
|
||||
* created:
|
||||
* oneOf:
|
||||
* - $ref: "#/components/schemas/AdminProductVariantInventoryLink"
|
||||
* - type: array
|
||||
* description: The product's created.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The created's details.
|
||||
* x-schemaName: AdminProductVariantInventoryLink
|
||||
* required:
|
||||
* - productService
|
||||
* - inventoryService
|
||||
* properties:
|
||||
* productService:
|
||||
* type: object
|
||||
* description: The created's productservice.
|
||||
* required:
|
||||
* - variant_id
|
||||
* properties:
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The productservice's variant id.
|
||||
* inventoryService:
|
||||
* type: object
|
||||
* description: The created's inventoryservice.
|
||||
* required:
|
||||
* - inventory_item_id
|
||||
* properties:
|
||||
* inventory_item_id:
|
||||
* type: string
|
||||
* title: inventory_item_id
|
||||
* description: The inventoryservice's inventory item id.
|
||||
* updated:
|
||||
* oneOf:
|
||||
* - $ref: "#/components/schemas/AdminProductVariantInventoryLink"
|
||||
* - type: array
|
||||
* description: The product's updated.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The updated's details.
|
||||
* x-schemaName: AdminProductVariantInventoryLink
|
||||
* required:
|
||||
* - productService
|
||||
* - inventoryService
|
||||
* properties:
|
||||
* productService:
|
||||
* type: object
|
||||
* description: The updated's productservice.
|
||||
* required:
|
||||
* - variant_id
|
||||
* properties:
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The productservice's variant id.
|
||||
* inventoryService:
|
||||
* type: object
|
||||
* description: The updated's inventoryservice.
|
||||
* required:
|
||||
* - inventory_item_id
|
||||
* properties:
|
||||
* inventory_item_id:
|
||||
* type: string
|
||||
* title: inventory_item_id
|
||||
* description: The inventoryservice's inventory item id.
|
||||
* deleted:
|
||||
* oneOf:
|
||||
* - $ref: "#/components/schemas/AdminProductVariantInventoryLink"
|
||||
* - type: array
|
||||
* description: The product's deleted.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The deleted's details.
|
||||
* x-schemaName: AdminProductVariantInventoryLink
|
||||
* required:
|
||||
* - productService
|
||||
* - inventoryService
|
||||
* properties:
|
||||
* productService:
|
||||
* type: object
|
||||
* description: The deleted's productservice.
|
||||
* required:
|
||||
* - variant_id
|
||||
* properties:
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The productservice's variant id.
|
||||
* inventoryService:
|
||||
* type: object
|
||||
* description: The deleted's inventoryservice.
|
||||
* required:
|
||||
* - inventory_item_id
|
||||
* properties:
|
||||
* inventory_item_id:
|
||||
* type: string
|
||||
* title: inventory_item_id
|
||||
* description: The inventoryservice's inventory item id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* @schema AdminProductVariantInventoryLink
|
||||
* type: object
|
||||
* description: The product's ID.
|
||||
* x-schemaName: AdminProductVariantInventoryLink
|
||||
* required:
|
||||
* - productService
|
||||
* - inventoryService
|
||||
* properties:
|
||||
* productService:
|
||||
* type: object
|
||||
* description: The id's productservice.
|
||||
* required:
|
||||
* - variant_id
|
||||
* properties:
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The productservice's variant id.
|
||||
* inventoryService:
|
||||
* type: object
|
||||
* description: The id's inventoryservice.
|
||||
* required:
|
||||
* - inventory_item_id
|
||||
* properties:
|
||||
* inventory_item_id:
|
||||
* type: string
|
||||
* title: inventory_item_id
|
||||
* description: The inventoryservice's inventory item id.
|
||||
*
|
||||
*/
|
||||
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
/**
|
||||
* @schema AdminProductVariantInventoryLinkDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductVariantInventoryLinkDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* - parent
|
||||
* properties:
|
||||
* id:
|
||||
* $ref: "#/components/schemas/AdminProductVariantInventoryLink"
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The product's object.
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The product's deleted.
|
||||
* parent:
|
||||
* $ref: "#/components/schemas/AdminProductVariant"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -64,218 +64,20 @@
|
||||
* type: array
|
||||
* description: The variant's $and.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* properties:
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The $and's q.
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The $and's ID.
|
||||
* - type: array
|
||||
* description: The $and's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* sku:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: sku
|
||||
* description: The $and's sku.
|
||||
* - type: array
|
||||
* description: The $and's sku.
|
||||
* items:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The sku's details.
|
||||
* product_id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: product_id
|
||||
* description: The $and's product id.
|
||||
* - type: array
|
||||
* description: The $and's product id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The product id's details.
|
||||
* options:
|
||||
* type: object
|
||||
* description: The $and's options.
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The $and's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The $and's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The $and's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The $and's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $and's details.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $and's $or.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $and's details.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $and's $or.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* type: array
|
||||
* description: The $and's details.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The variant's $or.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* properties:
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The $or's q.
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The $or's ID.
|
||||
* - type: array
|
||||
* description: The $or's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* sku:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: sku
|
||||
* description: The $or's sku.
|
||||
* - type: array
|
||||
* description: The $or's sku.
|
||||
* items:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The sku's details.
|
||||
* product_id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: product_id
|
||||
* description: The $or's product id.
|
||||
* - type: array
|
||||
* description: The $or's product id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The product id's details.
|
||||
* options:
|
||||
* type: object
|
||||
* description: The $or's options.
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The $or's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The $or's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The $or's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The $or's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $or's $and.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $or's details.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $or's $and.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $and's details.
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $or's details.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* x-schemaName: BaseProductVariantParams
|
||||
* - type: object
|
||||
* description: The $or's details.
|
||||
* type: array
|
||||
* description: The $or's details.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
/**
|
||||
* @schema AdminPromotion
|
||||
* type: object
|
||||
* description: The promotion's details.
|
||||
* x-schemaName: AdminPromotion
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The promotion's ID.
|
||||
* code:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The promotion's code.
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* is_automatic:
|
||||
* type: boolean
|
||||
* title: is_automatic
|
||||
* description: The promotion's is automatic.
|
||||
* application_method:
|
||||
* $ref: "#/components/schemas/BaseApplicationMethod"
|
||||
* rules:
|
||||
* type: array
|
||||
* description: The promotion's rules.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePromotionRule"
|
||||
* campaign_id:
|
||||
* type: string
|
||||
* title: campaign_id
|
||||
* description: The promotion's campaign id.
|
||||
* campaign:
|
||||
* $ref: "#/components/schemas/CampaignResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminPromotionResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPromotionResponse
|
||||
* required:
|
||||
* - promotion
|
||||
* properties:
|
||||
* promotion:
|
||||
* $ref: "#/components/schemas/AdminPromotion"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
/**
|
||||
* @schema AdminPromotionRule
|
||||
* type: object
|
||||
* description: The updated's details.
|
||||
* x-schemaName: AdminPromotionRule
|
||||
* required:
|
||||
* - id
|
||||
* - values
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The updated's ID.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The updated's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The updated's attribute.
|
||||
* operator:
|
||||
* type: string
|
||||
* enum:
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* - lte
|
||||
* - gte
|
||||
* values:
|
||||
* type: array
|
||||
* description: The updated's values.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePromotionRuleValue"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
/**
|
||||
* @schema AdminRefundReason
|
||||
* type: object
|
||||
* description: The refund reason's details.
|
||||
* x-schemaName: AdminRefundReason
|
||||
* required:
|
||||
* - id
|
||||
* - label
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The refund reason's ID.
|
||||
* label:
|
||||
* type: string
|
||||
* title: label
|
||||
* description: The refund reason's label.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The refund reason's description.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The refund reason's metadata.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The refund reason's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The refund reason's updated at.
|
||||
*
|
||||
*/
|
||||
|
||||
Loaded 100 of 1211 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user