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:
github-actions[bot]
committed by
GitHub
GitHub
parent
4bd0917aed
commit
b23ddcdde8
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/claims/{id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/exchanges' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,7 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges' \
|
||||
-H 'x-medusa-access-token: {api_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"order_id": "{value}",
|
||||
"metadata": {}
|
||||
}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/cancel' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,6 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' \
|
||||
-H 'x-medusa-access-token: {api_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"shipping_option_id": "{value}"
|
||||
}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,6 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' \
|
||||
-H 'x-medusa-access-token: {api_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"shipping_option_id": "{value}"
|
||||
}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X DELETE '{backend_url}/admin/exchanges/{id}/request' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/exchanges/{id}/request' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/product-variants' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/refund-reasons' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,7 @@
|
||||
curl -X POST '{backend_url}/admin/refund-reasons' \
|
||||
-H 'x-medusa-access-token: {api_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"label": "{value}",
|
||||
"description": "{value}"
|
||||
}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X DELETE '{backend_url}/admin/refund-reasons/{id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/refund-reasons/{id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
@@ -0,0 +1,6 @@
|
||||
curl -X POST '{backend_url}/admin/refund-reasons/{id}' \
|
||||
-H 'x-medusa-access-token: {api_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"description": "{value}"
|
||||
}'
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminApiKeyResponse
|
||||
required:
|
||||
- api_key
|
||||
properties:
|
||||
api_key:
|
||||
$ref: ./ApiKeyResponse.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCampaignResponse
|
||||
required:
|
||||
- campaign
|
||||
properties:
|
||||
campaign:
|
||||
$ref: ./CampaignResponse.yaml
|
||||
@@ -0,0 +1,250 @@
|
||||
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: ./BaseClaimItem.yaml
|
||||
additional_items:
|
||||
type: array
|
||||
description: The claim's additional items.
|
||||
items: {}
|
||||
return:
|
||||
$ref: ./Return.yaml
|
||||
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: ./BaseOrderAddress.yaml
|
||||
billing_address:
|
||||
$ref: ./BaseOrderAddress.yaml
|
||||
shipping_methods:
|
||||
type: array
|
||||
description: The claim's shipping methods.
|
||||
items:
|
||||
$ref: ./BaseOrderShippingMethod.yaml
|
||||
payment_collections:
|
||||
type: array
|
||||
description: The claim's payment collections.
|
||||
items:
|
||||
$ref: ./BasePaymentCollection.yaml
|
||||
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: ./BaseOrderFulfillment.yaml
|
||||
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: ./BaseOrderTransaction.yaml
|
||||
summary:
|
||||
$ref: ./BaseOrderSummary.yaml
|
||||
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,24 @@
|
||||
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,26 @@
|
||||
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: ./AdminClaim.yaml
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminClaimOrderResponse
|
||||
required:
|
||||
- order
|
||||
- claim
|
||||
properties:
|
||||
order:
|
||||
$ref: ./Order.yaml
|
||||
claim:
|
||||
$ref: ./AdminClaim.yaml
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminClaimPreviewResponse
|
||||
required:
|
||||
- order_preview
|
||||
- claim
|
||||
properties:
|
||||
order_preview:
|
||||
$ref: ./Order.yaml
|
||||
claim:
|
||||
$ref: ./AdminClaim.yaml
|
||||
@@ -0,0 +1,14 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminClaimRequestResponse
|
||||
required:
|
||||
- return
|
||||
- order_preview
|
||||
- claim
|
||||
properties:
|
||||
return:
|
||||
$ref: ./AdminReturn.yaml
|
||||
order_preview:
|
||||
$ref: ./Order.yaml
|
||||
claim:
|
||||
$ref: ./AdminClaim.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminClaimResponse
|
||||
required:
|
||||
- claim
|
||||
properties:
|
||||
claim:
|
||||
$ref: ./AdminClaim.yaml
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminClaimReturnPreviewResponse
|
||||
required:
|
||||
- order_preview
|
||||
- return
|
||||
properties:
|
||||
order_preview:
|
||||
$ref: ./Order.yaml
|
||||
return:
|
||||
$ref: ./AdminReturn.yaml
|
||||
@@ -0,0 +1,24 @@
|
||||
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,26 @@
|
||||
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: ./AdminCollection.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCollectionResponse
|
||||
required:
|
||||
- collection
|
||||
properties:
|
||||
collection:
|
||||
$ref: ./AdminCollection.yaml
|
||||
@@ -1,10 +0,0 @@
|
||||
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,35 +0,0 @@
|
||||
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,72 +0,0 @@
|
||||
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.
|
||||
@@ -79,15 +79,13 @@ properties:
|
||||
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,3 @@
|
||||
type: object
|
||||
description: The supported currency's currency.
|
||||
x-schemaName: AdminCurrency
|
||||
@@ -0,0 +1,26 @@
|
||||
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: ./AdminCurrency.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCurrencyResponse
|
||||
required:
|
||||
- currency
|
||||
properties:
|
||||
currency:
|
||||
$ref: ./AdminCurrency.yaml
|
||||
@@ -0,0 +1,96 @@
|
||||
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,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCustomerAddressResponse
|
||||
required:
|
||||
- address
|
||||
properties:
|
||||
address:
|
||||
$ref: ./AdminCustomerAddress.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCustomerGroupResponse
|
||||
required:
|
||||
- customer_group
|
||||
properties:
|
||||
customer_group:
|
||||
$ref: ./AdminCustomerGroup.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCustomerResponse
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ./AdminCustomer.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminDraftOrderResponse
|
||||
required:
|
||||
- draft_order
|
||||
properties:
|
||||
draft_order:
|
||||
$ref: ./AdminOrder.yaml
|
||||
@@ -0,0 +1,251 @@
|
||||
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: ./AdminReturnItem.yaml
|
||||
additional_items:
|
||||
type: array
|
||||
description: The exchange's additional items.
|
||||
items:
|
||||
$ref: ./BaseExchangeItem.yaml
|
||||
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: ./AdminReturn.yaml
|
||||
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: ./BaseOrderAddress.yaml
|
||||
billing_address:
|
||||
$ref: ./BaseOrderAddress.yaml
|
||||
shipping_methods:
|
||||
type: array
|
||||
description: The exchange's shipping methods.
|
||||
items:
|
||||
$ref: ./BaseOrderShippingMethod.yaml
|
||||
payment_collections:
|
||||
type: array
|
||||
description: The exchange's payment collections.
|
||||
items:
|
||||
$ref: ./BasePaymentCollection.yaml
|
||||
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: ./BaseOrderFulfillment.yaml
|
||||
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: ./BaseOrderTransaction.yaml
|
||||
summary:
|
||||
$ref: ./BaseOrderSummary.yaml
|
||||
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,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminExchangeOrderResponse
|
||||
required:
|
||||
- order
|
||||
- exchange
|
||||
properties:
|
||||
order:
|
||||
$ref: ./Order.yaml
|
||||
exchange:
|
||||
$ref: ./AdminExchange.yaml
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminExchangePreviewResponse
|
||||
required:
|
||||
- order_preview
|
||||
- exchange
|
||||
properties:
|
||||
order_preview:
|
||||
$ref: ./Order.yaml
|
||||
exchange:
|
||||
$ref: ./AdminExchange.yaml
|
||||
@@ -0,0 +1,14 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminExchangeRequestResponse
|
||||
required:
|
||||
- return
|
||||
- order_preview
|
||||
- exchange
|
||||
properties:
|
||||
return:
|
||||
$ref: ./AdminReturn.yaml
|
||||
order_preview:
|
||||
$ref: ./Order.yaml
|
||||
exchange:
|
||||
$ref: ./AdminExchange.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminExchangeResponse
|
||||
required:
|
||||
- exchange
|
||||
properties:
|
||||
exchange:
|
||||
$ref: ./AdminExchange.yaml
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminExchangeReturnResponse
|
||||
required:
|
||||
- order_preview
|
||||
- return
|
||||
properties:
|
||||
order_preview:
|
||||
$ref: ./Order.yaml
|
||||
return:
|
||||
$ref: ./AdminReturn.yaml
|
||||
@@ -0,0 +1,15 @@
|
||||
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,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminFileListResponse
|
||||
required:
|
||||
- files
|
||||
properties:
|
||||
files:
|
||||
type: array
|
||||
description: The upload's files.
|
||||
items:
|
||||
$ref: ./AdminFile.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminFileResponse
|
||||
required:
|
||||
- file
|
||||
properties:
|
||||
file:
|
||||
$ref: ./AdminFile.yaml
|
||||
@@ -0,0 +1,89 @@
|
||||
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: ./AdminFulfillmentProvider.yaml
|
||||
delivery_address:
|
||||
$ref: ./AdminFulfillmentAddress.yaml
|
||||
items:
|
||||
type: array
|
||||
description: The fulfillment's items.
|
||||
items:
|
||||
$ref: ./AdminFulfillmentItem.yaml
|
||||
labels:
|
||||
type: array
|
||||
description: The fulfillment's labels.
|
||||
items:
|
||||
$ref: ./AdminFulfillmentLabel.yaml
|
||||
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,87 @@
|
||||
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,63 @@
|
||||
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,48 @@
|
||||
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,3 +1,3 @@
|
||||
type: object
|
||||
description: The shipping option's provider.
|
||||
description: The fulfillment provider's fulfillment providers.
|
||||
x-schemaName: AdminFulfillmentProvider
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
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: ./AdminFulfillmentProvider.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminFulfillmentResponse
|
||||
required:
|
||||
- fulfillment
|
||||
properties:
|
||||
fulfillment:
|
||||
$ref: ./AdminFulfillment.yaml
|
||||
@@ -5,6 +5,7 @@ required:
|
||||
- id
|
||||
- name
|
||||
- type
|
||||
- location
|
||||
- service_zones
|
||||
- created_at
|
||||
- updated_at
|
||||
@@ -22,6 +23,8 @@ properties:
|
||||
type: string
|
||||
title: type
|
||||
description: The fulfillment set's type.
|
||||
location:
|
||||
$ref: ./AdminStockLocation.yaml
|
||||
service_zones:
|
||||
type: array
|
||||
description: The fulfillment set's service zones.
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
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,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminInventoryItemResponse
|
||||
required:
|
||||
- inventory_item
|
||||
properties:
|
||||
inventory_item:
|
||||
$ref: ./AdminInventoryItem.yaml
|
||||
@@ -0,0 +1,44 @@
|
||||
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,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminInviteResponse
|
||||
required:
|
||||
- invite
|
||||
properties:
|
||||
invite:
|
||||
$ref: ./AdminInvite.yaml
|
||||
@@ -0,0 +1,63 @@
|
||||
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,26 @@
|
||||
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: ./AdminNotification.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminNotificationResponse
|
||||
required:
|
||||
- notification
|
||||
properties:
|
||||
notification:
|
||||
$ref: ./AdminNotification.yaml
|
||||
@@ -0,0 +1,232 @@
|
||||
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: ./AdminPaymentCollection.yaml
|
||||
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: ./BaseOrderAddress.yaml
|
||||
billing_address:
|
||||
$ref: ./BaseOrderAddress.yaml
|
||||
items:
|
||||
type: array
|
||||
description: The order's items.
|
||||
items:
|
||||
$ref: ./BaseOrderLineItem.yaml
|
||||
shipping_methods:
|
||||
type: array
|
||||
description: The order's shipping methods.
|
||||
items:
|
||||
$ref: ./BaseOrderShippingMethod.yaml
|
||||
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: ./BaseOrderFulfillment.yaml
|
||||
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: ./BaseOrderTransaction.yaml
|
||||
summary:
|
||||
$ref: ./BaseOrderSummary.yaml
|
||||
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,37 +0,0 @@
|
||||
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,55 +0,0 @@
|
||||
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,642 @@
|
||||
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: ./BaseOrderChange.yaml
|
||||
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: ./BaseProductVariant.yaml
|
||||
variant_id:
|
||||
type: string
|
||||
title: variant_id
|
||||
description: The item's variant id.
|
||||
product:
|
||||
$ref: ./BaseProduct.yaml
|
||||
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: ./BaseOrderLineItemTaxLine.yaml
|
||||
adjustments:
|
||||
type: array
|
||||
description: The item's adjustments.
|
||||
items:
|
||||
$ref: ./BaseOrderLineItemAdjustment.yaml
|
||||
detail:
|
||||
$ref: ./BaseOrderItemDetail.yaml
|
||||
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: ./BaseOrderShippingMethodTaxLine.yaml
|
||||
adjustments:
|
||||
type: array
|
||||
description: The shipping method's adjustments.
|
||||
items:
|
||||
$ref: ./BaseOrderShippingMethodAdjustment.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
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: ./BaseOrderAddress.yaml
|
||||
billing_address:
|
||||
$ref: ./BaseOrderAddress.yaml
|
||||
payment_collections:
|
||||
type: array
|
||||
description: The order preview's payment collections.
|
||||
items:
|
||||
$ref: ./AdminPaymentCollection.yaml
|
||||
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: ./BaseOrderFulfillment.yaml
|
||||
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: ./BaseOrderTransaction.yaml
|
||||
summary:
|
||||
$ref: ./BaseOrderSummary.yaml
|
||||
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,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderPreviewResponse
|
||||
required:
|
||||
- order
|
||||
properties:
|
||||
order:
|
||||
$ref: ./AdminOrderPreview.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderResponse
|
||||
required:
|
||||
- order
|
||||
properties:
|
||||
order:
|
||||
$ref: ./AdminOrder.yaml
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderReturnResponse
|
||||
required:
|
||||
- order
|
||||
- return
|
||||
properties:
|
||||
order:
|
||||
$ref: ./Order.yaml
|
||||
return:
|
||||
$ref: ./AdminReturn.yaml
|
||||
@@ -0,0 +1,130 @@
|
||||
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: ./IBigNumber.yaml
|
||||
authorized_amount:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: authorized_amount
|
||||
description: The payment's authorized amount.
|
||||
- type: number
|
||||
title: authorized_amount
|
||||
description: The payment's authorized amount.
|
||||
- type: string
|
||||
title: authorized_amount
|
||||
description: The payment's authorized amount.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
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: ./IBigNumber.yaml
|
||||
refunded_amount:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: refunded_amount
|
||||
description: The payment's refunded amount.
|
||||
- type: number
|
||||
title: refunded_amount
|
||||
description: The payment's refunded amount.
|
||||
- type: string
|
||||
title: refunded_amount
|
||||
description: The payment's refunded amount.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
captures:
|
||||
type: array
|
||||
description: The payment's captures.
|
||||
items:
|
||||
$ref: ./BaseCapture.yaml
|
||||
refunds:
|
||||
type: array
|
||||
description: The payment's refunds.
|
||||
items:
|
||||
$ref: ./BaseRefund.yaml
|
||||
payment_collection:
|
||||
$ref: ./BasePaymentCollection.yaml
|
||||
payment_session:
|
||||
$ref: ./BasePaymentSession.yaml
|
||||
@@ -0,0 +1,116 @@
|
||||
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: ./IBigNumber.yaml
|
||||
authorized_amount:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: authorized_amount
|
||||
description: The payment collection's authorized amount.
|
||||
- type: number
|
||||
title: authorized_amount
|
||||
description: The payment collection's authorized amount.
|
||||
- type: string
|
||||
title: authorized_amount
|
||||
description: The payment collection's authorized amount.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
captured_amount:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: captured_amount
|
||||
description: The payment collection's captured amount.
|
||||
- type: number
|
||||
title: captured_amount
|
||||
description: The payment collection's captured amount.
|
||||
- type: string
|
||||
title: captured_amount
|
||||
description: The payment collection's captured amount.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
refunded_amount:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: refunded_amount
|
||||
description: The payment collection's refunded amount.
|
||||
- type: number
|
||||
title: refunded_amount
|
||||
description: The payment collection's refunded amount.
|
||||
- type: string
|
||||
title: refunded_amount
|
||||
description: The payment collection's refunded amount.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
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: ./BasePaymentProvider.yaml
|
||||
payment_sessions:
|
||||
type: array
|
||||
description: The payment collection's payment sessions.
|
||||
items:
|
||||
$ref: ./BasePaymentSession.yaml
|
||||
payments:
|
||||
type: array
|
||||
description: The payment collection's payments.
|
||||
items:
|
||||
$ref: ./BasePayment.yaml
|
||||
@@ -0,0 +1,3 @@
|
||||
type: object
|
||||
description: The payment provider's payment providers.
|
||||
x-schemaName: AdminPaymentProvider
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPaymentResponse
|
||||
required:
|
||||
- payment
|
||||
properties:
|
||||
payment:
|
||||
$ref: ./AdminPayment.yaml
|
||||
@@ -1,8 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderCancelFulfillment
|
||||
x-schemaName: AdminPostCancelExchangeReqSchema
|
||||
properties:
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: The order's no notification.
|
||||
description: The exchange's no notification.
|
||||
@@ -1,18 +1,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,37 @@
|
||||
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.
|
||||
@@ -0,0 +1,19 @@
|
||||
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.
|
||||
@@ -0,0 +1,37 @@
|
||||
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,15 @@
|
||||
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,25 @@
|
||||
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,12 @@
|
||||
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.
|
||||
@@ -4,6 +4,7 @@ x-schemaName: AdminPostOrderClaimsReqSchema
|
||||
required:
|
||||
- type
|
||||
- order_id
|
||||
- reason_id
|
||||
- metadata
|
||||
properties:
|
||||
type:
|
||||
@@ -23,6 +24,10 @@ properties:
|
||||
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,22 @@
|
||||
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.
|
||||
@@ -7,19 +7,19 @@ properties:
|
||||
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,70 @@
|
||||
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: ./AdminPriceListPrice.yaml
|
||||
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,41 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPriceListBatchResponse
|
||||
required:
|
||||
- created
|
||||
- updated
|
||||
- deleted
|
||||
properties:
|
||||
created:
|
||||
type: array
|
||||
description: The price list's created.
|
||||
items:
|
||||
$ref: ./AdminPrice.yaml
|
||||
updated:
|
||||
type: array
|
||||
description: The price list's updated.
|
||||
items:
|
||||
$ref: ./AdminPrice.yaml
|
||||
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,24 @@
|
||||
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,26 @@
|
||||
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: ./AdminPriceList.yaml
|
||||
@@ -0,0 +1,71 @@
|
||||
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.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user