chore(docs): Updated API Reference (v2) (#9666)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
595 files changed
+33459
-13318
No files matched your search
+2
@@ -0,0 +1,2 @@
|
|||||||
|
curl '{backend_url}/admin/orders/{id}/line-items' \
|
||||||
|
-H 'Authorization: Bearer {access_token}'
|
||||||
@@ -2,5 +2,11 @@ curl -X POST '{backend_url}/admin/products' \
|
|||||||
-H 'Authorization: Bearer {access_token}' \
|
-H 'Authorization: Bearer {access_token}' \
|
||||||
-H 'Content-Type: application/json' \
|
-H 'Content-Type: application/json' \
|
||||||
--data-raw '{
|
--data-raw '{
|
||||||
"title": "{value}"
|
"title": "{value}",
|
||||||
|
"options": [
|
||||||
|
{
|
||||||
|
"title": "Default option",
|
||||||
|
"values": ["Default option value"]
|
||||||
|
}
|
||||||
|
]
|
||||||
}'
|
}'
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
curl -X POST '{backend_url}/admin/tax-regions/{id}' \
|
||||||
|
-H 'Authorization: Bearer {access_token}'
|
||||||
@@ -3,9 +3,9 @@ description: The filfillment's details.
|
|||||||
x-schemaName: AdminCreateFulfillment
|
x-schemaName: AdminCreateFulfillment
|
||||||
required:
|
required:
|
||||||
- data
|
- data
|
||||||
- order_id
|
|
||||||
- metadata
|
|
||||||
- items
|
- items
|
||||||
|
- metadata
|
||||||
|
- order_id
|
||||||
- location_id
|
- location_id
|
||||||
- provider_id
|
- provider_id
|
||||||
- delivery_address
|
- delivery_address
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ description: The product's details.
|
|||||||
x-schemaName: AdminCreateProduct
|
x-schemaName: AdminCreateProduct
|
||||||
required:
|
required:
|
||||||
- title
|
- title
|
||||||
|
- options
|
||||||
properties:
|
properties:
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
+80
-12
@@ -2,19 +2,87 @@ type: object
|
|||||||
description: The shipping option's details.
|
description: The shipping option's details.
|
||||||
x-schemaName: AdminCreateShippingOption
|
x-schemaName: AdminCreateShippingOption
|
||||||
required:
|
required:
|
||||||
- label
|
- name
|
||||||
- description
|
- service_zone_id
|
||||||
- code
|
- shipping_profile_id
|
||||||
|
- price_type
|
||||||
|
- provider_id
|
||||||
|
- type
|
||||||
|
- prices
|
||||||
properties:
|
properties:
|
||||||
label:
|
name:
|
||||||
type: string
|
type: string
|
||||||
title: label
|
title: name
|
||||||
description: The type's label.
|
description: The shipping option's name.
|
||||||
description:
|
service_zone_id:
|
||||||
type: string
|
type: string
|
||||||
title: description
|
title: service_zone_id
|
||||||
description: The type's description.
|
description: The ID of the associated service zone.
|
||||||
code:
|
shipping_profile_id:
|
||||||
type: string
|
type: string
|
||||||
title: code
|
title: shipping_profile_id
|
||||||
description: The type's code.
|
description: The ID of the associated shipping profile.
|
||||||
|
data:
|
||||||
|
type: object
|
||||||
|
description: >-
|
||||||
|
The shipping option's data, useful for the fulfillment provider handling
|
||||||
|
its processing.
|
||||||
|
externalDocs:
|
||||||
|
url: >-
|
||||||
|
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||||
|
price_type:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
The shipping option's price type. If `flat`, the shipping option has a
|
||||||
|
fixed price set in `prices`. Otherwise, the shipping option's price is
|
||||||
|
calculated by the fulfillment provider.
|
||||||
|
enum:
|
||||||
|
- flat
|
||||||
|
- calculated
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
title: provider_id
|
||||||
|
description: The ID of the fulfillment provider handling this shipping option.
|
||||||
|
type:
|
||||||
|
$ref: ./AdminCreateShippingOptionType.yaml
|
||||||
|
prices:
|
||||||
|
type: array
|
||||||
|
description: The shipping option's prices.
|
||||||
|
items:
|
||||||
|
oneOf:
|
||||||
|
- type: object
|
||||||
|
description: The price's details.
|
||||||
|
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
|
||||||
|
required:
|
||||||
|
- currency_code
|
||||||
|
- amount
|
||||||
|
properties:
|
||||||
|
currency_code:
|
||||||
|
type: string
|
||||||
|
title: currency_code
|
||||||
|
description: The price's currency code.
|
||||||
|
example: usd
|
||||||
|
amount:
|
||||||
|
type: number
|
||||||
|
title: amount
|
||||||
|
description: The price's amount.
|
||||||
|
- type: object
|
||||||
|
description: The price's details.
|
||||||
|
x-schemaName: AdminCreateShippingOptionPriceWithRegion
|
||||||
|
required:
|
||||||
|
- region_id
|
||||||
|
- amount
|
||||||
|
properties:
|
||||||
|
region_id:
|
||||||
|
type: string
|
||||||
|
title: region_id
|
||||||
|
description: The ID of the region this price is used in.
|
||||||
|
amount:
|
||||||
|
type: number
|
||||||
|
title: amount
|
||||||
|
description: The price's amount.
|
||||||
|
rules:
|
||||||
|
type: array
|
||||||
|
description: The shipping option's rules.
|
||||||
|
items:
|
||||||
|
$ref: ./AdminCreateShippingOptionRule.yaml
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
type: object
|
||||||
|
description: The shipping option type's details.
|
||||||
|
x-schemaName: AdminCreateShippingOptionType
|
||||||
|
required:
|
||||||
|
- label
|
||||||
|
- description
|
||||||
|
- code
|
||||||
|
properties:
|
||||||
|
label:
|
||||||
|
type: string
|
||||||
|
title: label
|
||||||
|
description: The type's label.
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
title: description
|
||||||
|
description: The type's description.
|
||||||
|
code:
|
||||||
|
type: string
|
||||||
|
title: code
|
||||||
|
description: The type's code.
|
||||||
@@ -95,7 +95,7 @@ properties:
|
|||||||
title: deleted_at
|
title: deleted_at
|
||||||
description: The date the exchange was deleted.
|
description: The date the exchange was deleted.
|
||||||
order:
|
order:
|
||||||
$ref: ./AdminOrder.yaml
|
$ref: ./BaseOrder.yaml
|
||||||
allow_backorder:
|
allow_backorder:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: allow_backorder
|
title: allow_backorder
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ required:
|
|||||||
- exchange
|
- exchange
|
||||||
properties:
|
properties:
|
||||||
order:
|
order:
|
||||||
description: The details of the associated order.
|
|
||||||
$ref: ./Order.yaml
|
$ref: ./Order.yaml
|
||||||
exchange:
|
exchange:
|
||||||
$ref: ./AdminExchange.yaml
|
$ref: ./AdminExchange.yaml
|
||||||
@@ -7,16 +7,16 @@ required:
|
|||||||
- shipping_methods
|
- shipping_methods
|
||||||
- currency_code
|
- currency_code
|
||||||
- id
|
- id
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- email
|
|
||||||
- version
|
- version
|
||||||
- region_id
|
- region_id
|
||||||
- customer_id
|
- customer_id
|
||||||
- sales_channel_id
|
- sales_channel_id
|
||||||
|
- email
|
||||||
- payment_status
|
- payment_status
|
||||||
- fulfillment_status
|
- fulfillment_status
|
||||||
- summary
|
- summary
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
- original_item_total
|
- original_item_total
|
||||||
- original_item_subtotal
|
- original_item_subtotal
|
||||||
- original_item_tax_total
|
- original_item_tax_total
|
||||||
|
|||||||
@@ -8,12 +8,12 @@ required:
|
|||||||
- exchange
|
- exchange
|
||||||
- actions
|
- actions
|
||||||
- status
|
- status
|
||||||
- order_id
|
|
||||||
- metadata
|
|
||||||
- id
|
- id
|
||||||
|
- version
|
||||||
|
- metadata
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
- version
|
- order_id
|
||||||
- canceled_at
|
- canceled_at
|
||||||
- return_id
|
- return_id
|
||||||
- exchange_id
|
- exchange_id
|
||||||
@@ -62,11 +62,7 @@ properties:
|
|||||||
title: claim_id
|
title: claim_id
|
||||||
description: The ID of the associated claim.
|
description: The ID of the associated claim.
|
||||||
order:
|
order:
|
||||||
type: string
|
$ref: ./AdminOrder.yaml
|
||||||
title: order
|
|
||||||
description: The order change's order.
|
|
||||||
externalDocs:
|
|
||||||
url: '#pagination'
|
|
||||||
return_order:
|
return_order:
|
||||||
$ref: ./AdminReturn.yaml
|
$ref: ./AdminReturn.yaml
|
||||||
exchange:
|
exchange:
|
||||||
|
|||||||
@@ -4,11 +4,11 @@ x-schemaName: AdminOrderChangeAction
|
|||||||
required:
|
required:
|
||||||
- order_change
|
- order_change
|
||||||
- order
|
- order
|
||||||
- order_id
|
|
||||||
- internal_note
|
|
||||||
- id
|
- id
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
|
- order_id
|
||||||
|
- internal_note
|
||||||
- return_id
|
- return_id
|
||||||
- exchange_id
|
- exchange_id
|
||||||
- claim_id
|
- claim_id
|
||||||
@@ -45,11 +45,7 @@ properties:
|
|||||||
title: exchange_id
|
title: exchange_id
|
||||||
description: The ID of the associated exchange.
|
description: The ID of the associated exchange.
|
||||||
order:
|
order:
|
||||||
type: string
|
$ref: ./AdminOrder.yaml
|
||||||
title: order
|
|
||||||
description: The order change's order.
|
|
||||||
externalDocs:
|
|
||||||
url: '#pagination'
|
|
||||||
reference:
|
reference:
|
||||||
type: string
|
type: string
|
||||||
title: reference
|
title: reference
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
type: object
|
||||||
|
description: The order item's details.
|
||||||
|
x-schemaName: AdminOrderItem
|
||||||
|
required:
|
||||||
|
- order_id
|
||||||
|
- item_id
|
||||||
|
- version
|
||||||
|
- history
|
||||||
|
- item
|
||||||
|
properties:
|
||||||
|
order_id:
|
||||||
|
type: string
|
||||||
|
title: order_id
|
||||||
|
description: The ID of the order this item belongs to.
|
||||||
|
item_id:
|
||||||
|
type: string
|
||||||
|
title: item_id
|
||||||
|
description: The ID of the associated line item.
|
||||||
|
version:
|
||||||
|
type: number
|
||||||
|
title: version
|
||||||
|
description: The order item's version.
|
||||||
|
history:
|
||||||
|
type: object
|
||||||
|
description: The order item's history.
|
||||||
|
required:
|
||||||
|
- version
|
||||||
|
properties:
|
||||||
|
version:
|
||||||
|
type: object
|
||||||
|
description: The version changes of the item.
|
||||||
|
required:
|
||||||
|
- from
|
||||||
|
- to
|
||||||
|
properties:
|
||||||
|
from:
|
||||||
|
type: number
|
||||||
|
title: from
|
||||||
|
description: The original version.
|
||||||
|
to:
|
||||||
|
type: number
|
||||||
|
title: to
|
||||||
|
description: The new version.
|
||||||
|
item:
|
||||||
|
$ref: ./AdminOrderLineItem.yaml
|
||||||
@@ -3,10 +3,8 @@ description: The item's details.
|
|||||||
x-schemaName: AdminOrderLineItem
|
x-schemaName: AdminOrderLineItem
|
||||||
required:
|
required:
|
||||||
- title
|
- title
|
||||||
- metadata
|
|
||||||
- id
|
- id
|
||||||
- subtitle
|
- metadata
|
||||||
- thumbnail
|
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
- item_total
|
- item_total
|
||||||
@@ -20,6 +18,8 @@ required:
|
|||||||
- tax_total
|
- tax_total
|
||||||
- discount_total
|
- discount_total
|
||||||
- discount_tax_total
|
- discount_tax_total
|
||||||
|
- subtitle
|
||||||
|
- thumbnail
|
||||||
- variant_id
|
- variant_id
|
||||||
- product_id
|
- product_id
|
||||||
- product_title
|
- product_title
|
||||||
|
|||||||
@@ -8,17 +8,17 @@ required:
|
|||||||
- order_change
|
- order_change
|
||||||
- currency_code
|
- currency_code
|
||||||
- id
|
- id
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- email
|
|
||||||
- version
|
- version
|
||||||
- region_id
|
- region_id
|
||||||
- customer_id
|
- customer_id
|
||||||
- sales_channel_id
|
- sales_channel_id
|
||||||
|
- email
|
||||||
- payment_collections
|
- payment_collections
|
||||||
- payment_status
|
- payment_status
|
||||||
- fulfillment_status
|
- fulfillment_status
|
||||||
- summary
|
- summary
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
- original_item_total
|
- original_item_total
|
||||||
- original_item_subtotal
|
- original_item_subtotal
|
||||||
- original_item_tax_total
|
- original_item_tax_total
|
||||||
|
|||||||
+4
@@ -37,3 +37,7 @@ properties:
|
|||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The item's metadata, can hold custom key-value pairs.
|
description: The item's metadata, can hold custom key-value pairs.
|
||||||
|
compare_at_unit_price:
|
||||||
|
type: number
|
||||||
|
title: compare_at_unit_price
|
||||||
|
description: The original price of the item before a promotion or sale.
|
||||||
+4
@@ -14,3 +14,7 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: unit_price
|
title: unit_price
|
||||||
description: The item's unit price.
|
description: The item's unit price.
|
||||||
|
compare_at_unit_price:
|
||||||
|
type: number
|
||||||
|
title: compare_at_unit_price
|
||||||
|
description: The original price of the item before a promotion or sale.
|
||||||
+4
@@ -16,3 +16,7 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: unit_price
|
title: unit_price
|
||||||
description: The item's unit price.
|
description: The item's unit price.
|
||||||
|
compare_at_unit_price:
|
||||||
|
type: number
|
||||||
|
title: compare_at_unit_price
|
||||||
|
description: The original price of the item before a promotion or sale.
|
||||||
@@ -11,10 +11,12 @@ required:
|
|||||||
- status
|
- status
|
||||||
- description
|
- description
|
||||||
- id
|
- id
|
||||||
- handle
|
- created_at
|
||||||
|
- updated_at
|
||||||
- subtitle
|
- subtitle
|
||||||
- is_giftcard
|
|
||||||
- thumbnail
|
- thumbnail
|
||||||
|
- handle
|
||||||
|
- is_giftcard
|
||||||
- width
|
- width
|
||||||
- weight
|
- weight
|
||||||
- height
|
- height
|
||||||
@@ -26,8 +28,6 @@ required:
|
|||||||
- type_id
|
- type_id
|
||||||
- discountable
|
- discountable
|
||||||
- external_id
|
- external_id
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- deleted_at
|
- deleted_at
|
||||||
properties:
|
properties:
|
||||||
collection:
|
collection:
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
type: object
|
||||||
|
description: The details to update in a tax region.
|
||||||
|
x-schemaName: AdminUpdateTaxRegion
|
||||||
|
properties:
|
||||||
|
province_code:
|
||||||
|
type: string
|
||||||
|
title: province_code
|
||||||
|
description: The tax region's province code.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The tax region's metadata, can hold custom key-value pairs.
|
||||||
@@ -56,60 +56,6 @@ properties:
|
|||||||
calculated_price:
|
calculated_price:
|
||||||
type: object
|
type: object
|
||||||
description: The calculated price's details.
|
description: The calculated price's details.
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The calculated price's ID.
|
|
||||||
price_list_id:
|
|
||||||
type: string
|
|
||||||
title: price_list_id
|
|
||||||
description: The ID of the price list that the price belongs to.
|
|
||||||
price_list_type:
|
|
||||||
type: string
|
|
||||||
title: price_list_type
|
|
||||||
description: The price list's type. For example, `sale`.
|
|
||||||
min_quantity:
|
|
||||||
type: number
|
|
||||||
title: min_quantity
|
|
||||||
description: The minimum quantity required in the cart for this price to apply.
|
|
||||||
max_quantity:
|
|
||||||
type: number
|
|
||||||
title: max_quantity
|
|
||||||
description: The maximum quantity required in the cart for this price to apply.
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- price_list_id
|
|
||||||
- price_list_type
|
|
||||||
- min_quantity
|
|
||||||
- max_quantity
|
|
||||||
original_price:
|
original_price:
|
||||||
type: object
|
type: object
|
||||||
description: The original price's details.
|
description: The original price's details.
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The original price's ID.
|
|
||||||
price_list_id:
|
|
||||||
type: string
|
|
||||||
title: price_list_id
|
|
||||||
description: The ID of the price list that the price belongs to.
|
|
||||||
price_list_type:
|
|
||||||
type: string
|
|
||||||
title: price_list_type
|
|
||||||
description: The price list's type. For example, `sale`.
|
|
||||||
min_quantity:
|
|
||||||
type: number
|
|
||||||
title: min_quantity
|
|
||||||
description: The minimum quantity required in the cart for this price to apply.
|
|
||||||
max_quantity:
|
|
||||||
type: number
|
|
||||||
title: max_quantity
|
|
||||||
description: The maximum quantity required in the cart for this price to apply.
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- price_list_id
|
|
||||||
- price_list_type
|
|
||||||
- min_quantity
|
|
||||||
- max_quantity
|
|
||||||
@@ -1,3 +1,47 @@
|
|||||||
type: object
|
type: object
|
||||||
description: The collection's details.
|
description: The product collection's details.
|
||||||
x-schemaName: BaseCollection
|
x-schemaName: BaseCollection
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- title
|
||||||
|
- handle
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
- deleted_at
|
||||||
|
- metadata
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The collection's ID.
|
||||||
|
title:
|
||||||
|
type: string
|
||||||
|
title: title
|
||||||
|
description: The collection's title.
|
||||||
|
handle:
|
||||||
|
type: string
|
||||||
|
title: handle
|
||||||
|
description: The collection's handle.
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: created_at
|
||||||
|
description: The collection's creation date.
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: updated_at
|
||||||
|
description: The collection's update date.
|
||||||
|
deleted_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: deleted_at
|
||||||
|
description: The collection's deletion date.
|
||||||
|
products:
|
||||||
|
type: array
|
||||||
|
description: The collection's products.
|
||||||
|
items:
|
||||||
|
$ref: ./AdminProduct.yaml
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The collection's metadata, used to store custom key-value pairs.
|
||||||
@@ -2,7 +2,6 @@ type: object
|
|||||||
description: The order's details.
|
description: The order's details.
|
||||||
x-schemaName: BaseOrder
|
x-schemaName: BaseOrder
|
||||||
required:
|
required:
|
||||||
- payment_collections
|
|
||||||
- id
|
- id
|
||||||
- version
|
- version
|
||||||
- region_id
|
- region_id
|
||||||
@@ -15,7 +14,6 @@ required:
|
|||||||
- payment_status
|
- payment_status
|
||||||
- fulfillment_status
|
- fulfillment_status
|
||||||
- summary
|
- summary
|
||||||
- metadata
|
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
- original_item_total
|
- original_item_total
|
||||||
@@ -45,20 +43,16 @@ properties:
|
|||||||
type: array
|
type: array
|
||||||
description: The order's payment collections.
|
description: The order's payment collections.
|
||||||
items:
|
items:
|
||||||
$ref: ./AdminPaymentCollection.yaml
|
$ref: ./BasePaymentCollection.yaml
|
||||||
fulfillments:
|
fulfillments:
|
||||||
type: array
|
type: array
|
||||||
description: The order's fulfillments.
|
description: The order's fulfillments.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderFulfillment.yaml
|
$ref: ./BaseOrderFulfillment.yaml
|
||||||
sales_channel:
|
|
||||||
$ref: ./AdminSalesChannel.yaml
|
|
||||||
customer:
|
|
||||||
$ref: ./AdminCustomer.yaml
|
|
||||||
shipping_address:
|
shipping_address:
|
||||||
$ref: ./AdminOrderAddress.yaml
|
$ref: ./BaseOrderAddress.yaml
|
||||||
billing_address:
|
billing_address:
|
||||||
$ref: ./AdminOrderAddress.yaml
|
$ref: ./BaseOrderAddress.yaml
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
type: object
|
type: object
|
||||||
description: An order address
|
description: An order address.
|
||||||
x-schemaName: BaseOrderAddress
|
x-schemaName: BaseOrderAddress
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
@@ -48,8 +48,6 @@ properties:
|
|||||||
title: country_code
|
title: country_code
|
||||||
description: The address's country code.
|
description: The address's country code.
|
||||||
example: us
|
example: us
|
||||||
country:
|
|
||||||
$ref: ./AdminRegionCountry.yaml
|
|
||||||
province:
|
province:
|
||||||
type: string
|
type: string
|
||||||
title: province
|
title: province
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
type: object
|
type: object
|
||||||
description: The fulfillment's fulfillments.
|
description: The fulfillment's details.
|
||||||
x-schemaName: BaseOrderFulfillment
|
x-schemaName: BaseOrderFulfillment
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
@@ -8,6 +8,7 @@ required:
|
|||||||
- shipped_at
|
- shipped_at
|
||||||
- delivered_at
|
- delivered_at
|
||||||
- canceled_at
|
- canceled_at
|
||||||
|
- requires_shipping
|
||||||
- data
|
- data
|
||||||
- provider_id
|
- provider_id
|
||||||
- shipping_option_id
|
- shipping_option_id
|
||||||
@@ -72,3 +73,7 @@ properties:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The date the fulfillment was updated.
|
description: The date the fulfillment was updated.
|
||||||
|
requires_shipping:
|
||||||
|
type: boolean
|
||||||
|
title: requires_shipping
|
||||||
|
description: Whether the fulfillment requires shipping.
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
type: object
|
type: object
|
||||||
description: The payment provider's payment providers.
|
description: The payment provider's details.
|
||||||
x-schemaName: BasePaymentProvider
|
x-schemaName: BasePaymentProvider
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
|
|||||||
@@ -1,3 +1,84 @@
|
|||||||
type: object
|
type: object
|
||||||
description: The category's categories.
|
description: The product category's details.
|
||||||
x-schemaName: BaseProductCategory
|
x-schemaName: BaseProductCategory
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- name
|
||||||
|
- description
|
||||||
|
- handle
|
||||||
|
- is_active
|
||||||
|
- is_internal
|
||||||
|
- rank
|
||||||
|
- parent_category_id
|
||||||
|
- parent_category
|
||||||
|
- category_children
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
- deleted_at
|
||||||
|
properties:
|
||||||
|
category_children:
|
||||||
|
type: array
|
||||||
|
description: The category's children.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
parent_category:
|
||||||
|
type: object
|
||||||
|
products:
|
||||||
|
type: array
|
||||||
|
description: The category's products.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
title: name
|
||||||
|
description: The category's name.
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
title: description
|
||||||
|
description: The category's description.
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The category's ID.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The category's metadata, can hold custom key-value pairs.
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: created_at
|
||||||
|
description: The date the category was created.
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: updated_at
|
||||||
|
description: The date the category was updated.
|
||||||
|
handle:
|
||||||
|
type: string
|
||||||
|
title: handle
|
||||||
|
description: The category's unique handle.
|
||||||
|
deleted_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: deleted_at
|
||||||
|
description: The date the category was deleted.
|
||||||
|
is_active:
|
||||||
|
type: boolean
|
||||||
|
title: is_active
|
||||||
|
description: >-
|
||||||
|
Whether the category is active. If disabled, the category isn't shown in
|
||||||
|
the storefront.
|
||||||
|
is_internal:
|
||||||
|
type: boolean
|
||||||
|
title: is_internal
|
||||||
|
description: >-
|
||||||
|
Whether the category is internal. If enabled, the category is only seen by
|
||||||
|
admin users.
|
||||||
|
rank:
|
||||||
|
type: number
|
||||||
|
title: rank
|
||||||
|
description: The category's rank among sibling categories.
|
||||||
|
parent_category_id:
|
||||||
|
type: string
|
||||||
|
title: parent_category_id
|
||||||
|
description: The ID of the category's parent.
|
||||||
@@ -1,44 +1,44 @@
|
|||||||
type: object
|
type: object
|
||||||
description: The product option's details.
|
description: The product option's details.
|
||||||
x-schemaName: BaseProductOption
|
x-schemaName: BaseProductOption
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- title
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The option's ID.
|
description: The product option's ID.
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
title: title
|
title: title
|
||||||
description: The option's title.
|
description: The product option's title.
|
||||||
product:
|
product:
|
||||||
type: object
|
type: object
|
||||||
product_id:
|
product_id:
|
||||||
type: string
|
type: string
|
||||||
title: product_id
|
title: product_id
|
||||||
description: The option's product id.
|
description: The ID of the product this option belongs to.
|
||||||
values:
|
values:
|
||||||
type: array
|
type: array
|
||||||
description: The option's values.
|
description: The product option's values.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseProductOptionValue.yaml
|
$ref: ./BaseProductOptionValue.yaml
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The option's metadata.
|
description: The product option's metadata, can hold custom key-value pairs.
|
||||||
created_at:
|
created_at:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
title: created_at
|
title: created_at
|
||||||
description: The option's created at.
|
description: The date the product option was created.
|
||||||
updated_at:
|
updated_at:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The option's updated at.
|
description: The date the product option was updated.
|
||||||
deleted_at:
|
deleted_at:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
title: deleted_at
|
title: deleted_at
|
||||||
description: The option's deleted at.
|
description: The date the product option was deleted.
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- title
|
|
||||||
@@ -1,3 +1,35 @@
|
|||||||
type: object
|
type: object
|
||||||
description: The tag's tags.
|
description: The product tag's details.
|
||||||
x-schemaName: BaseProductTag
|
x-schemaName: BaseProductTag
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- value
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The tag's ID.
|
||||||
|
value:
|
||||||
|
type: string
|
||||||
|
title: value
|
||||||
|
description: The tag's value.
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: created_at
|
||||||
|
description: The date the tag was created.
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: updated_at
|
||||||
|
description: The date the tag was updated.
|
||||||
|
deleted_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: deleted_at
|
||||||
|
description: The date the tag was deleted.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The tag's metadata, can hold custom key-value pairs.
|
||||||
@@ -31,28 +31,6 @@ required:
|
|||||||
- original_shipping_total
|
- original_shipping_total
|
||||||
- original_shipping_subtotal
|
- original_shipping_subtotal
|
||||||
- original_shipping_tax_total
|
- original_shipping_tax_total
|
||||||
- raw_original_item_total
|
|
||||||
- raw_original_item_subtotal
|
|
||||||
- raw_original_item_tax_total
|
|
||||||
- raw_item_total
|
|
||||||
- raw_item_subtotal
|
|
||||||
- raw_item_tax_total
|
|
||||||
- raw_original_total
|
|
||||||
- raw_original_subtotal
|
|
||||||
- raw_original_tax_total
|
|
||||||
- raw_total
|
|
||||||
- raw_subtotal
|
|
||||||
- raw_tax_total
|
|
||||||
- raw_discount_total
|
|
||||||
- raw_discount_tax_total
|
|
||||||
- raw_gift_card_total
|
|
||||||
- raw_gift_card_tax_total
|
|
||||||
- raw_shipping_total
|
|
||||||
- raw_shipping_subtotal
|
|
||||||
- raw_shipping_tax_total
|
|
||||||
- raw_original_shipping_total
|
|
||||||
- raw_original_shipping_subtotal
|
|
||||||
- raw_original_shipping_tax_total
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -228,69 +206,3 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes of the order's shipping excluding promotions.
|
description: The total taxes of the order's shipping excluding promotions.
|
||||||
raw_original_item_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original item total.
|
|
||||||
raw_original_item_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original item subtotal.
|
|
||||||
raw_original_item_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original item tax total.
|
|
||||||
raw_item_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw item total.
|
|
||||||
raw_item_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The order's raw item subtotal.
|
|
||||||
raw_item_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw item tax total.
|
|
||||||
raw_original_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original total.
|
|
||||||
raw_original_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original subtotal.
|
|
||||||
raw_original_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original tax total.
|
|
||||||
raw_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw total.
|
|
||||||
raw_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The order's raw subtotal.
|
|
||||||
raw_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw tax total.
|
|
||||||
raw_discount_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw discount total.
|
|
||||||
raw_discount_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw discount tax total.
|
|
||||||
raw_gift_card_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw gift card total.
|
|
||||||
raw_gift_card_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw gift card tax total.
|
|
||||||
raw_shipping_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw shipping total.
|
|
||||||
raw_shipping_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The order's raw shipping subtotal.
|
|
||||||
raw_shipping_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw shipping tax total.
|
|
||||||
raw_original_shipping_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original shipping total.
|
|
||||||
raw_original_shipping_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original shipping subtotal.
|
|
||||||
raw_original_shipping_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The order's raw original shipping tax total.
|
|
||||||
@@ -2,44 +2,14 @@ type: object
|
|||||||
description: The order change's claim.
|
description: The order change's claim.
|
||||||
x-schemaName: OrderClaim
|
x-schemaName: OrderClaim
|
||||||
required:
|
required:
|
||||||
|
- id
|
||||||
|
- type
|
||||||
- order_id
|
- order_id
|
||||||
|
- order_version
|
||||||
|
- display_id
|
||||||
- claim_items
|
- claim_items
|
||||||
- additional_items
|
- additional_items
|
||||||
- currency_code
|
|
||||||
- id
|
|
||||||
- region_id
|
|
||||||
- customer_id
|
|
||||||
- sales_channel_id
|
|
||||||
- email
|
|
||||||
- shipping_methods
|
|
||||||
- payment_status
|
|
||||||
- fulfillment_status
|
|
||||||
- summary
|
|
||||||
- metadata
|
- 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:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -70,79 +40,29 @@ properties:
|
|||||||
title: no_notification
|
title: no_notification
|
||||||
description: Whether the customer should be notified about changes in the claim.
|
description: Whether the customer should be notified about changes in the claim.
|
||||||
refund_amount:
|
refund_amount:
|
||||||
type: number
|
oneOf:
|
||||||
|
- type: string
|
||||||
title: refund_amount
|
title: refund_amount
|
||||||
|
description: The claim's refund amount.
|
||||||
|
- type: number
|
||||||
|
title: refund_amount
|
||||||
|
description: The claim's refund amount.
|
||||||
|
- type: string
|
||||||
|
title: refund_amount
|
||||||
|
description: The claim's refund amount.
|
||||||
|
- type: number
|
||||||
|
title: refund_amount
|
||||||
|
description: The claim's refund amount.
|
||||||
description: The amount to be refunded.
|
description: The amount to be refunded.
|
||||||
currency_code:
|
|
||||||
type: string
|
|
||||||
title: currency_code
|
|
||||||
description: The claim's currency code.
|
|
||||||
region_id:
|
|
||||||
type: string
|
|
||||||
title: region_id
|
|
||||||
description: The ID of the region associated with the claim.
|
|
||||||
customer_id:
|
|
||||||
type: string
|
|
||||||
title: customer_id
|
|
||||||
description: The ID of the customer associated with the claim's order.
|
|
||||||
sales_channel_id:
|
|
||||||
type: string
|
|
||||||
title: sales_channel_id
|
|
||||||
description: The ID of the sales channel the claim's order is created in.
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
title: email
|
|
||||||
description: The email associated with the claim's order.
|
|
||||||
format: email
|
|
||||||
display_id:
|
display_id:
|
||||||
type: number
|
type: number
|
||||||
title: display_id
|
title: display_id
|
||||||
description: The claim's display ID.
|
description: The claim's display ID.
|
||||||
shipping_address:
|
|
||||||
$ref: ./BaseOrderAddress.yaml
|
|
||||||
billing_address:
|
|
||||||
$ref: ./BaseOrderAddress.yaml
|
|
||||||
shipping_methods:
|
shipping_methods:
|
||||||
type: array
|
type: array
|
||||||
description: The claim's shipping methods.
|
description: The claim's shipping methods.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderShippingMethod.yaml
|
$ref: ./OrderShippingMethod.yaml
|
||||||
payment_collections:
|
|
||||||
type: array
|
|
||||||
description: The claim's payment collections.
|
|
||||||
items:
|
|
||||||
$ref: ./BasePaymentCollection.yaml
|
|
||||||
payment_status:
|
|
||||||
type: string
|
|
||||||
description: The claim's payment status.
|
|
||||||
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
|
|
||||||
description: The claim's fulfillment status.
|
|
||||||
enum:
|
|
||||||
- canceled
|
|
||||||
- not_fulfilled
|
|
||||||
- partially_fulfilled
|
|
||||||
- fulfilled
|
|
||||||
- partially_shipped
|
|
||||||
- shipped
|
|
||||||
- partially_delivered
|
|
||||||
- delivered
|
|
||||||
transactions:
|
transactions:
|
||||||
type: array
|
type: array
|
||||||
description: The claim's transactions.
|
description: The claim's transactions.
|
||||||
@@ -151,9 +71,7 @@ properties:
|
|||||||
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
|
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
|
||||||
description: Learn more about transactions of orders and associated models.
|
description: Learn more about transactions of orders and associated models.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderTransaction.yaml
|
$ref: ./OrderTransaction.yaml
|
||||||
summary:
|
|
||||||
$ref: ./BaseOrderSummary.yaml
|
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The claim's metadata, used to store custom key-value pairs.
|
description: The claim's metadata, used to store custom key-value pairs.
|
||||||
@@ -167,91 +85,43 @@ properties:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The claim's update date.
|
description: The claim's update date.
|
||||||
original_item_total:
|
type:
|
||||||
|
type: string
|
||||||
|
description: The claim's type.
|
||||||
|
enum:
|
||||||
|
- replace
|
||||||
|
- refund
|
||||||
|
order:
|
||||||
|
$ref: ./Order.yaml
|
||||||
|
order_version:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: order_version
|
||||||
description: The total of the original items in the associated order.
|
description: The claim's order version.
|
||||||
original_item_subtotal:
|
raw_refund_amount:
|
||||||
type: number
|
oneOf:
|
||||||
title: original_item_subtotal
|
- type: string
|
||||||
description: The subtotal of the original items in the associated order.
|
title: raw_refund_amount
|
||||||
original_item_tax_total:
|
description: The claim's raw refund amount.
|
||||||
type: number
|
- type: number
|
||||||
title: original_item_tax_total
|
title: raw_refund_amount
|
||||||
description: The tax total of the original items in the associated order.
|
description: The claim's raw refund amount.
|
||||||
item_total:
|
- type: string
|
||||||
type: number
|
title: raw_refund_amount
|
||||||
title: item_total
|
description: The claim's raw refund amount.
|
||||||
description: The total of the claim's items.
|
- type: number
|
||||||
item_subtotal:
|
title: raw_refund_amount
|
||||||
type: number
|
description: The claim's raw refund amount.
|
||||||
title: item_subtotal
|
created_by:
|
||||||
description: The subtotal of the claim's items.
|
type: string
|
||||||
item_tax_total:
|
title: created_by
|
||||||
type: number
|
description: The ID of the user that created the claim.
|
||||||
title: item_tax_total
|
deleted_at:
|
||||||
description: The tax total of the claim's items.
|
type: string
|
||||||
original_total:
|
format: date-time
|
||||||
type: number
|
title: deleted_at
|
||||||
title: original_total
|
description: The date the claim was deleted.
|
||||||
description: The associated order's original total.
|
canceled_at:
|
||||||
original_subtotal:
|
type: string
|
||||||
type: number
|
title: canceled_at
|
||||||
title: original_subtotal
|
description: The date the claim was canceled.
|
||||||
description: The associated order's original subtotal.
|
format: date-time
|
||||||
original_tax_total:
|
|
||||||
type: number
|
|
||||||
title: original_tax_total
|
|
||||||
description: The associated order's original tax total.
|
|
||||||
total:
|
|
||||||
type: number
|
|
||||||
title: total
|
|
||||||
description: The associated order'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 associated order's original shipping total.
|
|
||||||
original_shipping_subtotal:
|
|
||||||
type: number
|
|
||||||
title: original_shipping_subtotal
|
|
||||||
description: The associated order's original shipping subtotal.
|
|
||||||
original_shipping_tax_total:
|
|
||||||
type: number
|
|
||||||
title: original_shipping_tax_total
|
|
||||||
description: The associated order's original shipping tax total.
|
|
||||||
@@ -2,54 +2,17 @@ type: object
|
|||||||
description: The order change's exchange.
|
description: The order change's exchange.
|
||||||
x-schemaName: OrderExchange
|
x-schemaName: OrderExchange
|
||||||
required:
|
required:
|
||||||
- order_id
|
|
||||||
- return_items
|
|
||||||
- additional_items
|
|
||||||
- currency_code
|
|
||||||
- id
|
- id
|
||||||
- region_id
|
- order_id
|
||||||
- customer_id
|
- order_version
|
||||||
- sales_channel_id
|
- display_id
|
||||||
- email
|
- additional_items
|
||||||
- shipping_methods
|
|
||||||
- payment_status
|
|
||||||
- fulfillment_status
|
|
||||||
- summary
|
|
||||||
- metadata
|
- 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:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
title: order_id
|
title: order_id
|
||||||
description: The ID of the order the exchange is created for.
|
description: The ID of the order the exchange is created for.
|
||||||
return_items:
|
|
||||||
type: array
|
|
||||||
description: The items returned (inbound) by the exchange.
|
|
||||||
items:
|
|
||||||
$ref: ./AdminReturnItem.yaml
|
|
||||||
additional_items:
|
additional_items:
|
||||||
type: array
|
type: array
|
||||||
description: The new items (outbound) sent by the exchange.
|
description: The new items (outbound) sent by the exchange.
|
||||||
@@ -67,88 +30,24 @@ properties:
|
|||||||
be refunded. If positive, additional payment is required from the
|
be refunded. If positive, additional payment is required from the
|
||||||
customer.
|
customer.
|
||||||
return:
|
return:
|
||||||
description: the return associated with the exchange.
|
$ref: ./Return.yaml
|
||||||
$ref: ./AdminReturn.yaml
|
|
||||||
return_id:
|
return_id:
|
||||||
type: string
|
type: string
|
||||||
title: return_id
|
title: return_id
|
||||||
description: The ID of the associated exchange.
|
description: The ID of the associated exchange.
|
||||||
currency_code:
|
|
||||||
type: string
|
|
||||||
title: currency_code
|
|
||||||
description: The exchange's currency code.
|
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The exchange's ID.
|
description: The exchange's ID.
|
||||||
region_id:
|
|
||||||
type: string
|
|
||||||
title: region_id
|
|
||||||
description: The ID of the associated order's region.
|
|
||||||
customer_id:
|
|
||||||
type: string
|
|
||||||
title: customer_id
|
|
||||||
description: The ID of the customer that placed the order.
|
|
||||||
sales_channel_id:
|
|
||||||
type: string
|
|
||||||
title: sales_channel_id
|
|
||||||
description: The ID of the sales channel the associated order belongs to.
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
title: email
|
|
||||||
description: The email used when placing the order.
|
|
||||||
format: email
|
|
||||||
display_id:
|
display_id:
|
||||||
type: number
|
type: number
|
||||||
title: display_id
|
title: display_id
|
||||||
description: The exchange's display ID.
|
description: The exchange's display ID.
|
||||||
shipping_address:
|
|
||||||
description: The shipping address to send new items to.
|
|
||||||
$ref: ./BaseOrderAddress.yaml
|
|
||||||
billing_address:
|
|
||||||
description: The customer's billing address.
|
|
||||||
$ref: ./BaseOrderAddress.yaml
|
|
||||||
shipping_methods:
|
shipping_methods:
|
||||||
type: array
|
type: array
|
||||||
description: The shipping methods used to send the new (outbound) items.
|
description: The shipping methods used to send the new (outbound) items.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderShippingMethod.yaml
|
$ref: ./OrderShippingMethod.yaml
|
||||||
payment_collections:
|
|
||||||
type: array
|
|
||||||
description: The exchange's payment collections.
|
|
||||||
items:
|
|
||||||
$ref: ./BasePaymentCollection.yaml
|
|
||||||
payment_status:
|
|
||||||
type: string
|
|
||||||
description: The exchange's payment status.
|
|
||||||
enum:
|
|
||||||
- canceled
|
|
||||||
- not_paid
|
|
||||||
- awaiting
|
|
||||||
- authorized
|
|
||||||
- partially_authorized
|
|
||||||
- captured
|
|
||||||
- partially_captured
|
|
||||||
- partially_refunded
|
|
||||||
- refunded
|
|
||||||
- requires_action
|
|
||||||
fulfillments:
|
|
||||||
type: array
|
|
||||||
description: The exchange's fulfillments of new (outbound) items.
|
|
||||||
items:
|
|
||||||
$ref: ./BaseOrderFulfillment.yaml
|
|
||||||
fulfillment_status:
|
|
||||||
type: string
|
|
||||||
description: The exchange's fulfillment status.
|
|
||||||
enum:
|
|
||||||
- canceled
|
|
||||||
- not_fulfilled
|
|
||||||
- partially_fulfilled
|
|
||||||
- fulfilled
|
|
||||||
- partially_shipped
|
|
||||||
- shipped
|
|
||||||
- partially_delivered
|
|
||||||
- delivered
|
|
||||||
transactions:
|
transactions:
|
||||||
type: array
|
type: array
|
||||||
description: The exchange's transactions.
|
description: The exchange's transactions.
|
||||||
@@ -156,10 +55,7 @@ properties:
|
|||||||
url: >-
|
url: >-
|
||||||
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
|
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderTransaction.yaml
|
$ref: ./OrderTransaction.yaml
|
||||||
summary:
|
|
||||||
description: The totals summary of the exchange.
|
|
||||||
$ref: ./BaseOrderSummary.yaml
|
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The exchange's metadata, can hold custom key-value pairs.
|
description: The exchange's metadata, can hold custom key-value pairs.
|
||||||
@@ -173,91 +69,43 @@ properties:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The date that the exchange was updated.
|
description: The date that the exchange was updated.
|
||||||
original_item_total:
|
order:
|
||||||
|
$ref: ./Order.yaml
|
||||||
|
order_version:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: order_version
|
||||||
description: The total of the original items in the order.
|
description: The version of the order when the exchange is applied.
|
||||||
original_item_subtotal:
|
raw_difference_due:
|
||||||
type: number
|
oneOf:
|
||||||
title: original_item_subtotal
|
- type: string
|
||||||
description: The subtotal of the original items in the order.
|
title: raw_difference_due
|
||||||
original_item_tax_total:
|
description: The exchange's raw difference due.
|
||||||
type: number
|
- type: number
|
||||||
title: original_item_tax_total
|
title: raw_difference_due
|
||||||
description: The total tax of the original items in the order.
|
description: The exchange's raw difference due.
|
||||||
item_total:
|
- type: string
|
||||||
type: number
|
title: raw_difference_due
|
||||||
title: item_total
|
description: The exchange's raw difference due.
|
||||||
description: The total of the exchange's new items.
|
- type: number
|
||||||
item_subtotal:
|
title: raw_difference_due
|
||||||
type: number
|
description: The exchange's raw difference due.
|
||||||
title: item_subtotal
|
allow_backorder:
|
||||||
description: The subtotal of the exchange's new items.
|
type: boolean
|
||||||
item_tax_total:
|
title: allow_backorder
|
||||||
type: number
|
description: >-
|
||||||
title: item_tax_total
|
Whether variants that are out of stock can be added to the exchange as
|
||||||
description: The tax total of the exchange's new items.
|
outbound items.
|
||||||
original_total:
|
created_by:
|
||||||
type: number
|
type: string
|
||||||
title: original_total
|
title: created_by
|
||||||
description: The total of the order.
|
description: The ID of the user that created the exchange.
|
||||||
original_subtotal:
|
deleted_at:
|
||||||
type: number
|
type: string
|
||||||
title: original_subtotal
|
format: date-time
|
||||||
description: The subtotal of the order.
|
title: deleted_at
|
||||||
original_tax_total:
|
description: The date the exchange was deleted.
|
||||||
type: number
|
canceled_at:
|
||||||
title: original_tax_total
|
type: string
|
||||||
description: The tax total of the order.
|
title: canceled_at
|
||||||
total:
|
description: The date the exchange was canceled.
|
||||||
type: number
|
format: date-time
|
||||||
title: total
|
|
||||||
description: The total of the exchange.
|
|
||||||
subtotal:
|
|
||||||
type: number
|
|
||||||
title: subtotal
|
|
||||||
description: The subtotal of the exchange.
|
|
||||||
tax_total:
|
|
||||||
type: number
|
|
||||||
title: tax_total
|
|
||||||
description: The tax total of the exchange.
|
|
||||||
discount_total:
|
|
||||||
type: number
|
|
||||||
title: discount_total
|
|
||||||
description: The discount total of the exchange.
|
|
||||||
discount_tax_total:
|
|
||||||
type: number
|
|
||||||
title: discount_tax_total
|
|
||||||
description: The total taxes on discount of the exchange.
|
|
||||||
gift_card_total:
|
|
||||||
type: number
|
|
||||||
title: gift_card_total
|
|
||||||
description: The gift cards total of the exchange.
|
|
||||||
gift_card_tax_total:
|
|
||||||
type: number
|
|
||||||
title: gift_card_tax_total
|
|
||||||
description: The total taxes on the gift card of the exchange.
|
|
||||||
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 order's shipping total.
|
|
||||||
original_shipping_subtotal:
|
|
||||||
type: number
|
|
||||||
title: original_shipping_subtotal
|
|
||||||
description: The order's shipping subtotal.
|
|
||||||
original_shipping_tax_total:
|
|
||||||
type: number
|
|
||||||
title: original_shipping_tax_total
|
|
||||||
description: The order's shipping tax total.
|
|
||||||
@@ -6,21 +6,13 @@ required:
|
|||||||
- item_id
|
- item_id
|
||||||
- item
|
- item
|
||||||
- quantity
|
- quantity
|
||||||
- raw_quantity
|
|
||||||
- fulfilled_quantity
|
- fulfilled_quantity
|
||||||
- raw_fulfilled_quantity
|
|
||||||
- delivered_quantity
|
- delivered_quantity
|
||||||
- raw_delivered_quantity
|
|
||||||
- shipped_quantity
|
- shipped_quantity
|
||||||
- raw_shipped_quantity
|
|
||||||
- return_requested_quantity
|
- return_requested_quantity
|
||||||
- raw_return_requested_quantity
|
|
||||||
- return_received_quantity
|
- return_received_quantity
|
||||||
- raw_return_received_quantity
|
|
||||||
- return_dismissed_quantity
|
- return_dismissed_quantity
|
||||||
- raw_return_dismissed_quantity
|
|
||||||
- written_off_quantity
|
- written_off_quantity
|
||||||
- raw_written_off_quantity
|
|
||||||
- metadata
|
- metadata
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
@@ -39,58 +31,34 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: quantity
|
title: quantity
|
||||||
description: The item's quantity.
|
description: The item's quantity.
|
||||||
raw_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw quantity.
|
|
||||||
fulfilled_quantity:
|
fulfilled_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: fulfilled_quantity
|
title: fulfilled_quantity
|
||||||
description: The item's fulfilled quantity.
|
description: The item's fulfilled quantity.
|
||||||
raw_fulfilled_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw fulfilled quantity.
|
|
||||||
delivered_quantity:
|
delivered_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: delivered_quantity
|
title: delivered_quantity
|
||||||
description: The item's delivered quantity.
|
description: The item's delivered quantity.
|
||||||
raw_delivered_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw delivered quantity.
|
|
||||||
shipped_quantity:
|
shipped_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: shipped_quantity
|
title: shipped_quantity
|
||||||
description: The item's shipped quantity.
|
description: The item's shipped quantity.
|
||||||
raw_shipped_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw shipped quantity.
|
|
||||||
return_requested_quantity:
|
return_requested_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: return_requested_quantity
|
title: return_requested_quantity
|
||||||
description: The item's quantity that's requested to be returned.
|
description: The item's quantity that's requested to be returned.
|
||||||
raw_return_requested_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw return requested quantity.
|
|
||||||
return_received_quantity:
|
return_received_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: return_received_quantity
|
title: return_received_quantity
|
||||||
description: The item's quantity that's received through a return.
|
description: The item's quantity that's received through a return.
|
||||||
raw_return_received_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw return received quantity.
|
|
||||||
return_dismissed_quantity:
|
return_dismissed_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: return_dismissed_quantity
|
title: return_dismissed_quantity
|
||||||
description: The item's quantity that's returned but dismissed because it's damaged.
|
description: The item's quantity that's returned but dismissed because it's damaged.
|
||||||
raw_return_dismissed_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw return dismissed quantity.
|
|
||||||
written_off_quantity:
|
written_off_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: written_off_quantity
|
title: written_off_quantity
|
||||||
description: The item's quantity that's removed due to an order change.
|
description: The item's quantity that's removed due to an order change.
|
||||||
raw_written_off_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw written off quantity.
|
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The item's metadata, can hold custom key-value pairs.
|
description: The item's metadata, can hold custom key-value pairs.
|
||||||
|
|||||||
@@ -8,9 +8,7 @@ required:
|
|||||||
- is_discountable
|
- is_discountable
|
||||||
- is_tax_inclusive
|
- is_tax_inclusive
|
||||||
- unit_price
|
- unit_price
|
||||||
- raw_unit_price
|
|
||||||
- quantity
|
- quantity
|
||||||
- raw_quantity
|
|
||||||
- detail
|
- detail
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
@@ -27,19 +25,6 @@ required:
|
|||||||
- discount_tax_total
|
- discount_tax_total
|
||||||
- refundable_total
|
- refundable_total
|
||||||
- refundable_total_per_unit
|
- refundable_total_per_unit
|
||||||
- raw_original_total
|
|
||||||
- raw_original_subtotal
|
|
||||||
- raw_original_tax_total
|
|
||||||
- raw_item_total
|
|
||||||
- raw_item_subtotal
|
|
||||||
- raw_item_tax_total
|
|
||||||
- raw_total
|
|
||||||
- raw_subtotal
|
|
||||||
- raw_tax_total
|
|
||||||
- raw_discount_total
|
|
||||||
- raw_discount_tax_total
|
|
||||||
- raw_refundable_total
|
|
||||||
- raw_refundable_total_per_unit
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -122,56 +107,14 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: compare_at_unit_price
|
title: compare_at_unit_price
|
||||||
description: The original price of the item before a promotion or sale.
|
description: The original price of the item before a promotion or sale.
|
||||||
raw_compare_at_unit_price:
|
|
||||||
type: object
|
|
||||||
description: The item's raw compare at unit price.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw compare at unit price's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw compare at unit price's value.
|
|
||||||
unit_price:
|
unit_price:
|
||||||
type: number
|
type: number
|
||||||
title: unit_price
|
title: unit_price
|
||||||
description: The item's price for a single quantity.
|
description: The item's price for a single quantity.
|
||||||
raw_unit_price:
|
|
||||||
type: object
|
|
||||||
description: The item's raw unit price.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw unit price's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw unit price's value.
|
|
||||||
quantity:
|
quantity:
|
||||||
type: number
|
type: number
|
||||||
title: quantity
|
title: quantity
|
||||||
description: The item's quantity.
|
description: The item's quantity.
|
||||||
raw_quantity:
|
|
||||||
type: object
|
|
||||||
description: The item's raw quantity.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw quantity's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw quantity's value.
|
|
||||||
tax_lines:
|
tax_lines:
|
||||||
type: array
|
type: array
|
||||||
description: The item's tax lines.
|
description: The item's tax lines.
|
||||||
@@ -251,185 +194,3 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: refundable_total_per_unit
|
title: refundable_total_per_unit
|
||||||
description: The total amount that can be refunded of a single quantity of the item.
|
description: The total amount that can be refunded of a single quantity of the item.
|
||||||
raw_original_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw original total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw original total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw original total's value.
|
|
||||||
raw_original_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The item's raw original subtotal.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw original subtotal's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw original subtotal's value.
|
|
||||||
raw_original_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw original tax total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw original tax total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw original tax total's value.
|
|
||||||
raw_item_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw item total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw item total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw item total's value.
|
|
||||||
raw_item_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The item's raw item subtotal.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw item subtotal's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw item subtotal's value.
|
|
||||||
raw_item_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw item tax total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw item tax total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw item tax total's value.
|
|
||||||
raw_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw total's value.
|
|
||||||
raw_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The item's raw subtotal.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw subtotal's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw subtotal's value.
|
|
||||||
raw_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw tax total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw tax total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw tax total's value.
|
|
||||||
raw_discount_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw discount total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw discount total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw discount total's value.
|
|
||||||
raw_discount_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw discount tax total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw discount tax total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw discount tax total's value.
|
|
||||||
raw_refundable_total:
|
|
||||||
type: object
|
|
||||||
description: The item's raw refundable total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw refundable total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw refundable total's value.
|
|
||||||
raw_refundable_total_per_unit:
|
|
||||||
type: object
|
|
||||||
description: The item's raw refundable total per unit.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw refundable total per unit's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw refundable total per unit's value.
|
|
||||||
@@ -6,8 +6,6 @@ required:
|
|||||||
- item_id
|
- item_id
|
||||||
- total
|
- total
|
||||||
- subtotal
|
- subtotal
|
||||||
- raw_total
|
|
||||||
- raw_subtotal
|
|
||||||
- id
|
- id
|
||||||
- code
|
- code
|
||||||
- rate
|
- rate
|
||||||
@@ -28,12 +26,6 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The item's total excluding taxes, including promotions.
|
||||||
raw_total:
|
|
||||||
type: object
|
|
||||||
description: The tax line's raw total.
|
|
||||||
raw_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The tax line's raw subtotal.
|
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
|
|||||||
@@ -3,11 +3,10 @@ description: The item's items.
|
|||||||
x-schemaName: OrderReturnItem
|
x-schemaName: OrderReturnItem
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- quantity
|
|
||||||
- received_quantity
|
|
||||||
- damaged_quantity
|
|
||||||
- item_id
|
|
||||||
- return_id
|
- return_id
|
||||||
|
- order_id
|
||||||
|
- item_id
|
||||||
|
- quantity
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -23,20 +22,10 @@ properties:
|
|||||||
description: >-
|
description: >-
|
||||||
The received quantity of the item. This quantity is added to the stocked
|
The received quantity of the item. This quantity is added to the stocked
|
||||||
inventory quantity of the item.
|
inventory quantity of the item.
|
||||||
damaged_quantity:
|
|
||||||
type: number
|
|
||||||
title: damaged_quantity
|
|
||||||
description: >-
|
|
||||||
The received damaged quantity of the item, which isn't added to the
|
|
||||||
stocked inventory quantity of the item.
|
|
||||||
reason_id:
|
reason_id:
|
||||||
type: string
|
type: string
|
||||||
title: reason_id
|
title: reason_id
|
||||||
description: The ID of the return reason associated with the item.
|
description: The ID of the return reason associated with the item.
|
||||||
note:
|
|
||||||
type: string
|
|
||||||
title: note
|
|
||||||
description: A note about why the item was returned.
|
|
||||||
item_id:
|
item_id:
|
||||||
type: string
|
type: string
|
||||||
title: item_id
|
title: item_id
|
||||||
@@ -48,3 +37,17 @@ properties:
|
|||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The return item's metadata, can hold custom key-value pairs.
|
description: The return item's metadata, can hold custom key-value pairs.
|
||||||
|
order_id:
|
||||||
|
type: string
|
||||||
|
title: order_id
|
||||||
|
description: The ID of the order the return belongs to.
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: created_at
|
||||||
|
description: The date the item was created.
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: updated_at
|
||||||
|
description: The date the item was updated.
|
||||||
@@ -6,7 +6,6 @@ required:
|
|||||||
- order_id
|
- order_id
|
||||||
- name
|
- name
|
||||||
- amount
|
- amount
|
||||||
- raw_amount
|
|
||||||
- is_tax_inclusive
|
- is_tax_inclusive
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
@@ -18,14 +17,6 @@ required:
|
|||||||
- tax_total
|
- tax_total
|
||||||
- discount_total
|
- discount_total
|
||||||
- discount_tax_total
|
- discount_tax_total
|
||||||
- raw_original_total
|
|
||||||
- raw_original_subtotal
|
|
||||||
- raw_original_tax_total
|
|
||||||
- raw_total
|
|
||||||
- raw_subtotal
|
|
||||||
- raw_tax_total
|
|
||||||
- raw_discount_total
|
|
||||||
- raw_discount_tax_total
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -47,20 +38,6 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: amount
|
title: amount
|
||||||
description: The shipping method's amount.
|
description: The shipping method's amount.
|
||||||
raw_amount:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw amount.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw amount's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw amount's value.
|
|
||||||
is_tax_inclusive:
|
is_tax_inclusive:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: is_tax_inclusive
|
title: is_tax_inclusive
|
||||||
@@ -132,115 +109,3 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes of the discount amount.
|
description: The total taxes of the discount amount.
|
||||||
raw_original_total:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw original total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw original total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw original total's value.
|
|
||||||
raw_original_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw original subtotal.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw original subtotal's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw original subtotal's value.
|
|
||||||
raw_original_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw original tax total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw original tax total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw original tax total's value.
|
|
||||||
raw_total:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw total's value.
|
|
||||||
raw_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw subtotal.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw subtotal's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw subtotal's value.
|
|
||||||
raw_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw tax total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw tax total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw tax total's value.
|
|
||||||
raw_discount_total:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw discount total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw discount total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw discount total's value.
|
|
||||||
raw_discount_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The shipping method's raw discount tax total.
|
|
||||||
required:
|
|
||||||
- value
|
|
||||||
properties:
|
|
||||||
value:
|
|
||||||
oneOf:
|
|
||||||
- type: string
|
|
||||||
title: value
|
|
||||||
description: The raw discount tax total's value.
|
|
||||||
- type: number
|
|
||||||
title: value
|
|
||||||
description: The raw discount tax total's value.
|
|
||||||
@@ -6,8 +6,6 @@ required:
|
|||||||
- shipping_method_id
|
- shipping_method_id
|
||||||
- total
|
- total
|
||||||
- subtotal
|
- subtotal
|
||||||
- raw_total
|
|
||||||
- raw_subtotal
|
|
||||||
- id
|
- id
|
||||||
- code
|
- code
|
||||||
- rate
|
- rate
|
||||||
@@ -28,12 +26,6 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The shipping method's total excluding taxes, including promotions.
|
description: The shipping method's total excluding taxes, including promotions.
|
||||||
raw_total:
|
|
||||||
type: object
|
|
||||||
description: The tax line's raw total.
|
|
||||||
raw_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The tax line's raw subtotal.
|
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ x-schemaName: OrderTransaction
|
|||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- order_id
|
- order_id
|
||||||
|
- order
|
||||||
- amount
|
- amount
|
||||||
- currency_code
|
- currency_code
|
||||||
- reference
|
- reference
|
||||||
@@ -56,3 +57,5 @@ properties:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The date that the transaction was updated.
|
description: The date that the transaction was updated.
|
||||||
|
order:
|
||||||
|
type: object
|
||||||
@@ -6,54 +6,8 @@ required:
|
|||||||
- status
|
- status
|
||||||
- order_id
|
- order_id
|
||||||
- items
|
- items
|
||||||
- currency_code
|
- display_id
|
||||||
- created_at
|
- metadata
|
||||||
- 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
|
|
||||||
- discount_subtotal
|
|
||||||
- raw_original_item_total
|
|
||||||
- raw_original_item_subtotal
|
|
||||||
- raw_original_item_tax_total
|
|
||||||
- raw_item_total
|
|
||||||
- raw_item_subtotal
|
|
||||||
- raw_item_tax_total
|
|
||||||
- raw_original_total
|
|
||||||
- raw_original_subtotal
|
|
||||||
- raw_original_tax_total
|
|
||||||
- raw_total
|
|
||||||
- raw_subtotal
|
|
||||||
- raw_tax_total
|
|
||||||
- raw_discount_total
|
|
||||||
- raw_discount_tax_total
|
|
||||||
- raw_gift_card_total
|
|
||||||
- raw_gift_card_tax_total
|
|
||||||
- raw_shipping_total
|
|
||||||
- raw_shipping_subtotal
|
|
||||||
- raw_shipping_tax_total
|
|
||||||
- raw_original_shipping_total
|
|
||||||
- raw_original_shipping_subtotal
|
|
||||||
- raw_original_shipping_tax_total
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -80,32 +34,6 @@ properties:
|
|||||||
description: The return's items.
|
description: The return's items.
|
||||||
items:
|
items:
|
||||||
$ref: ./OrderReturnItem.yaml
|
$ref: ./OrderReturnItem.yaml
|
||||||
region_id:
|
|
||||||
type: string
|
|
||||||
title: region_id
|
|
||||||
description: The ID of the region this return belongs to.
|
|
||||||
customer_id:
|
|
||||||
type: string
|
|
||||||
title: customer_id
|
|
||||||
description: The ID of the customer that placed the order.
|
|
||||||
sales_channel_id:
|
|
||||||
type: string
|
|
||||||
title: sales_channel_id
|
|
||||||
description: The ID of the associated order's sales channel.
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
title: email
|
|
||||||
description: The email of the customer that placed the order.
|
|
||||||
format: email
|
|
||||||
currency_code:
|
|
||||||
type: string
|
|
||||||
title: currency_code
|
|
||||||
description: The return's currency code.
|
|
||||||
example: usd
|
|
||||||
shipping_address:
|
|
||||||
$ref: ./OrderAddress.yaml
|
|
||||||
billing_address:
|
|
||||||
$ref: ./OrderAddress.yaml
|
|
||||||
shipping_methods:
|
shipping_methods:
|
||||||
type: array
|
type: array
|
||||||
description: The return's shipping methods.
|
description: The return's shipping methods.
|
||||||
@@ -116,9 +44,6 @@ properties:
|
|||||||
description: The return's transactions.
|
description: The return's transactions.
|
||||||
items:
|
items:
|
||||||
$ref: ./OrderTransaction.yaml
|
$ref: ./OrderTransaction.yaml
|
||||||
summary:
|
|
||||||
type: object
|
|
||||||
description: The return's summary.
|
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The return's metadata, can hold custom key-value pairs.
|
description: The return's metadata, can hold custom key-value pairs.
|
||||||
@@ -132,168 +57,67 @@ properties:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The date the return was updated.
|
description: The date the return was updated.
|
||||||
original_item_total:
|
|
||||||
type: number
|
|
||||||
title: original_item_total
|
|
||||||
description: The return's original item total.
|
|
||||||
original_item_subtotal:
|
|
||||||
type: number
|
|
||||||
title: original_item_subtotal
|
|
||||||
description: The return's original item subtotal.
|
|
||||||
original_item_tax_total:
|
|
||||||
type: number
|
|
||||||
title: original_item_tax_total
|
|
||||||
description: The return's original item tax total.
|
|
||||||
item_total:
|
|
||||||
type: number
|
|
||||||
title: item_total
|
|
||||||
description: The return's item total.
|
|
||||||
item_subtotal:
|
|
||||||
type: number
|
|
||||||
title: item_subtotal
|
|
||||||
description: The return's item subtotal.
|
|
||||||
item_tax_total:
|
|
||||||
type: number
|
|
||||||
title: item_tax_total
|
|
||||||
description: The return's item tax total.
|
|
||||||
original_total:
|
|
||||||
type: number
|
|
||||||
title: original_total
|
|
||||||
description: The return's original total.
|
|
||||||
original_subtotal:
|
|
||||||
type: number
|
|
||||||
title: original_subtotal
|
|
||||||
description: The return's original subtotal.
|
|
||||||
original_tax_total:
|
|
||||||
type: number
|
|
||||||
title: original_tax_total
|
|
||||||
description: The return's original tax total.
|
|
||||||
total:
|
|
||||||
type: number
|
|
||||||
title: total
|
|
||||||
description: The return's total.
|
|
||||||
subtotal:
|
|
||||||
type: number
|
|
||||||
title: subtotal
|
|
||||||
description: The return's subtotal.
|
|
||||||
tax_total:
|
|
||||||
type: number
|
|
||||||
title: tax_total
|
|
||||||
description: The return's tax total.
|
|
||||||
discount_total:
|
|
||||||
type: number
|
|
||||||
title: discount_total
|
|
||||||
description: The return's discount total.
|
|
||||||
discount_tax_total:
|
|
||||||
type: number
|
|
||||||
title: discount_tax_total
|
|
||||||
description: The return's discount tax total.
|
|
||||||
gift_card_total:
|
|
||||||
type: number
|
|
||||||
title: gift_card_total
|
|
||||||
description: The return's gift card total.
|
|
||||||
gift_card_tax_total:
|
|
||||||
type: number
|
|
||||||
title: gift_card_tax_total
|
|
||||||
description: The return's gift card tax total.
|
|
||||||
shipping_total:
|
|
||||||
type: number
|
|
||||||
title: shipping_total
|
|
||||||
description: The return's shipping total.
|
|
||||||
shipping_subtotal:
|
|
||||||
type: number
|
|
||||||
title: shipping_subtotal
|
|
||||||
description: The return's shipping subtotal.
|
|
||||||
shipping_tax_total:
|
|
||||||
type: number
|
|
||||||
title: shipping_tax_total
|
|
||||||
description: The return's shipping tax total.
|
|
||||||
original_shipping_total:
|
|
||||||
type: number
|
|
||||||
title: original_shipping_total
|
|
||||||
description: The return's original shipping total.
|
|
||||||
original_shipping_subtotal:
|
|
||||||
type: number
|
|
||||||
title: original_shipping_subtotal
|
|
||||||
description: The return's original shipping subtotal.
|
|
||||||
original_shipping_tax_total:
|
|
||||||
type: number
|
|
||||||
title: original_shipping_tax_total
|
|
||||||
description: The return's original shipping tax total.
|
|
||||||
order_change:
|
|
||||||
$ref: ./OrderChange.yaml
|
|
||||||
canceled_at:
|
canceled_at:
|
||||||
type: string
|
type: string
|
||||||
title: canceled_at
|
title: canceled_at
|
||||||
description: The date the return was canceled.
|
description: The date the return was canceled.
|
||||||
format: date-time
|
format: date-time
|
||||||
discount_subtotal:
|
raw_refund_amount:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: raw_refund_amount
|
||||||
|
description: The return order's raw refund amount.
|
||||||
|
- type: number
|
||||||
|
title: raw_refund_amount
|
||||||
|
description: The return order's raw refund amount.
|
||||||
|
- type: string
|
||||||
|
title: raw_refund_amount
|
||||||
|
description: The return order's raw refund amount.
|
||||||
|
- type: number
|
||||||
|
title: raw_refund_amount
|
||||||
|
description: The return order's raw refund amount.
|
||||||
|
order:
|
||||||
|
$ref: ./Order.yaml
|
||||||
|
exchange_id:
|
||||||
|
type: string
|
||||||
|
title: exchange_id
|
||||||
|
description: The ID of the exchange this return belongs to, if any.
|
||||||
|
exchange:
|
||||||
|
type: object
|
||||||
|
claim_id:
|
||||||
|
type: string
|
||||||
|
title: claim_id
|
||||||
|
description: The ID of the claim this return belongs to, if any.
|
||||||
|
claim:
|
||||||
|
$ref: ./OrderClaim.yaml
|
||||||
|
display_id:
|
||||||
type: number
|
type: number
|
||||||
title: discount_subtotal
|
title: display_id
|
||||||
description: The return's discount subtotal.
|
description: The return order's display ID.
|
||||||
raw_original_item_total:
|
location_id:
|
||||||
type: object
|
type: string
|
||||||
description: The return's raw original item total.
|
title: location_id
|
||||||
raw_original_item_subtotal:
|
description: The ID of the stock location the items are returned to.
|
||||||
type: object
|
no_notification:
|
||||||
description: The return's raw original item subtotal.
|
type: boolean
|
||||||
raw_original_item_tax_total:
|
title: no_notification
|
||||||
type: object
|
description: Whether to notify the customer about changes in the return.
|
||||||
description: The return's raw original item tax total.
|
created_by:
|
||||||
raw_item_total:
|
type: string
|
||||||
type: object
|
title: created_by
|
||||||
description: The return's raw item total.
|
description: The ID of the user that created the return.
|
||||||
raw_item_subtotal:
|
deleted_at:
|
||||||
type: object
|
type: string
|
||||||
description: The return's raw item subtotal.
|
format: date-time
|
||||||
raw_item_tax_total:
|
title: deleted_at
|
||||||
type: object
|
description: The date the return was deleted.
|
||||||
description: The return's raw item tax total.
|
requested_at:
|
||||||
raw_original_total:
|
type: string
|
||||||
type: object
|
title: requested_at
|
||||||
description: The return's raw original total.
|
description: The date the return was requested.
|
||||||
raw_original_subtotal:
|
format: date-time
|
||||||
type: object
|
received_at:
|
||||||
description: The return's raw original subtotal.
|
type: string
|
||||||
raw_original_tax_total:
|
title: received_at
|
||||||
type: object
|
description: The date the return was received.
|
||||||
description: The return's raw original tax total.
|
format: date-time
|
||||||
raw_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw total.
|
|
||||||
raw_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The return's raw subtotal.
|
|
||||||
raw_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw tax total.
|
|
||||||
raw_discount_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw discount total.
|
|
||||||
raw_discount_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw discount tax total.
|
|
||||||
raw_gift_card_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw gift card total.
|
|
||||||
raw_gift_card_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw gift card tax total.
|
|
||||||
raw_shipping_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw shipping total.
|
|
||||||
raw_shipping_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The return's raw shipping subtotal.
|
|
||||||
raw_shipping_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw shipping tax total.
|
|
||||||
raw_original_shipping_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw original shipping total.
|
|
||||||
raw_original_shipping_subtotal:
|
|
||||||
type: object
|
|
||||||
description: The return's raw original shipping subtotal.
|
|
||||||
raw_original_shipping_tax_total:
|
|
||||||
type: object
|
|
||||||
description: The return's raw original shipping tax total.
|
|
||||||
@@ -3,11 +3,11 @@ description: The collection's details.
|
|||||||
x-schemaName: StoreCollection
|
x-schemaName: StoreCollection
|
||||||
required:
|
required:
|
||||||
- title
|
- title
|
||||||
- metadata
|
|
||||||
- id
|
- id
|
||||||
- handle
|
- metadata
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
|
- handle
|
||||||
- deleted_at
|
- deleted_at
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
|
|||||||
@@ -2,19 +2,17 @@ type: object
|
|||||||
description: The order's details.
|
description: The order's details.
|
||||||
x-schemaName: StoreOrder
|
x-schemaName: StoreOrder
|
||||||
required:
|
required:
|
||||||
|
- items
|
||||||
|
- shipping_methods
|
||||||
|
- currency_code
|
||||||
- id
|
- id
|
||||||
- version
|
|
||||||
- region_id
|
- region_id
|
||||||
- customer_id
|
- customer_id
|
||||||
- sales_channel_id
|
- sales_channel_id
|
||||||
- email
|
- email
|
||||||
- currency_code
|
|
||||||
- items
|
|
||||||
- shipping_methods
|
|
||||||
- payment_status
|
- payment_status
|
||||||
- fulfillment_status
|
- fulfillment_status
|
||||||
- summary
|
- summary
|
||||||
- metadata
|
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
- original_item_total
|
- original_item_total
|
||||||
@@ -44,10 +42,6 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The order's ID.
|
description: The order's ID.
|
||||||
version:
|
|
||||||
type: number
|
|
||||||
title: version
|
|
||||||
description: The order's version.
|
|
||||||
region_id:
|
region_id:
|
||||||
type: string
|
type: string
|
||||||
title: region_id
|
title: region_id
|
||||||
@@ -75,24 +69,24 @@ properties:
|
|||||||
title: display_id
|
title: display_id
|
||||||
description: The order's display ID.
|
description: The order's display ID.
|
||||||
shipping_address:
|
shipping_address:
|
||||||
$ref: ./BaseOrderAddress.yaml
|
$ref: ./StoreOrderAddress.yaml
|
||||||
billing_address:
|
billing_address:
|
||||||
$ref: ./BaseOrderAddress.yaml
|
$ref: ./StoreOrderAddress.yaml
|
||||||
items:
|
items:
|
||||||
type: array
|
type: array
|
||||||
description: The order's items.
|
description: The order's items.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderLineItem.yaml
|
$ref: ./StoreOrderLineItem.yaml
|
||||||
shipping_methods:
|
shipping_methods:
|
||||||
type: array
|
type: array
|
||||||
description: The order's shipping methods.
|
description: The order's shipping methods.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderShippingMethod.yaml
|
$ref: ./StoreOrderShippingMethod.yaml
|
||||||
payment_collections:
|
payment_collections:
|
||||||
type: array
|
type: array
|
||||||
description: The order's payment collections.
|
description: The order's payment collections.
|
||||||
items:
|
items:
|
||||||
$ref: ./BasePaymentCollection.yaml
|
$ref: ./StorePaymentCollection.yaml
|
||||||
payment_status:
|
payment_status:
|
||||||
type: string
|
type: string
|
||||||
description: The order's payment status.
|
description: The order's payment status.
|
||||||
@@ -111,7 +105,7 @@ properties:
|
|||||||
type: array
|
type: array
|
||||||
description: The order's fulfillments.
|
description: The order's fulfillments.
|
||||||
items:
|
items:
|
||||||
$ref: ./BaseOrderFulfillment.yaml
|
$ref: ./StoreOrderFulfillment.yaml
|
||||||
fulfillment_status:
|
fulfillment_status:
|
||||||
type: string
|
type: string
|
||||||
description: The order's fulfillment status.
|
description: The order's fulfillment status.
|
||||||
@@ -227,3 +221,10 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes of the order's shipping excluding promotions.
|
description: The total taxes of the order's shipping excluding promotions.
|
||||||
|
customer:
|
||||||
|
$ref: ./StoreCustomer.yaml
|
||||||
|
transactions:
|
||||||
|
type: array
|
||||||
|
description: The order's transactions.
|
||||||
|
items:
|
||||||
|
$ref: ./BaseOrderTransaction.yaml
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
type: object
|
||||||
|
description: An order address
|
||||||
|
x-schemaName: StoreOrderAddress
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- metadata
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The address's ID.
|
||||||
|
customer_id:
|
||||||
|
type: string
|
||||||
|
title: customer_id
|
||||||
|
description: The ID of the customer this address belongs to.
|
||||||
|
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.
|
||||||
|
phone:
|
||||||
|
type: string
|
||||||
|
title: phone
|
||||||
|
description: The address's phone.
|
||||||
|
company:
|
||||||
|
type: string
|
||||||
|
title: company
|
||||||
|
description: The address's company.
|
||||||
|
address_1:
|
||||||
|
type: string
|
||||||
|
title: address_1
|
||||||
|
description: The address's first line.
|
||||||
|
address_2:
|
||||||
|
type: string
|
||||||
|
title: address_2
|
||||||
|
description: The address's second line.
|
||||||
|
city:
|
||||||
|
type: string
|
||||||
|
title: city
|
||||||
|
description: The address's city.
|
||||||
|
country_code:
|
||||||
|
type: string
|
||||||
|
title: country_code
|
||||||
|
description: The address's country code.
|
||||||
|
example: us
|
||||||
|
country:
|
||||||
|
$ref: ./StoreRegionCountry.yaml
|
||||||
|
province:
|
||||||
|
type: string
|
||||||
|
title: province
|
||||||
|
description: The address's province.
|
||||||
|
postal_code:
|
||||||
|
type: string
|
||||||
|
title: postal_code
|
||||||
|
description: The address's postal code.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The address's metadata, can hold custom key-value pairs.
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: created_at
|
||||||
|
description: The date the address was created.
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: updated_at
|
||||||
|
description: The date the address was updated.
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
type: object
|
||||||
|
description: The fulfillment's details.
|
||||||
|
x-schemaName: StoreOrderFulfillment
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- location_id
|
||||||
|
- packed_at
|
||||||
|
- shipped_at
|
||||||
|
- delivered_at
|
||||||
|
- canceled_at
|
||||||
|
- requires_shipping
|
||||||
|
- data
|
||||||
|
- provider_id
|
||||||
|
- shipping_option_id
|
||||||
|
- metadata
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The fulfillment's ID.
|
||||||
|
location_id:
|
||||||
|
type: string
|
||||||
|
title: location_id
|
||||||
|
description: The ID of the location the items are fulfilled from.
|
||||||
|
packed_at:
|
||||||
|
type: string
|
||||||
|
title: packed_at
|
||||||
|
description: The date the items were packed.
|
||||||
|
format: date-time
|
||||||
|
shipped_at:
|
||||||
|
type: string
|
||||||
|
title: shipped_at
|
||||||
|
description: The date the items were shipped.
|
||||||
|
format: date-time
|
||||||
|
delivered_at:
|
||||||
|
type: string
|
||||||
|
title: delivered_at
|
||||||
|
description: The date the items were delivered.
|
||||||
|
format: date-time
|
||||||
|
canceled_at:
|
||||||
|
type: string
|
||||||
|
title: canceled_at
|
||||||
|
description: The date the items were canceled.
|
||||||
|
format: date-time
|
||||||
|
data:
|
||||||
|
type: object
|
||||||
|
description: >-
|
||||||
|
Data useful for the fulfillment provider handling it. This is taken from
|
||||||
|
the associated shipping option.
|
||||||
|
externalDocs:
|
||||||
|
url: >-
|
||||||
|
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
title: provider_id
|
||||||
|
description: The ID of the fulfillment provider used to handle the fulfillment.
|
||||||
|
shipping_option_id:
|
||||||
|
type: string
|
||||||
|
title: shipping_option_id
|
||||||
|
description: The ID of the associated shipping option.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The fulfillment's metadata, can hold custom key-value pairs.
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: created_at
|
||||||
|
description: The date the fulfillment was created.
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
title: updated_at
|
||||||
|
description: The date the fulfillment was updated.
|
||||||
|
requires_shipping:
|
||||||
|
type: boolean
|
||||||
|
title: requires_shipping
|
||||||
|
description: The fulfillment's requires shipping.
|
||||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -10,10 +10,12 @@ required:
|
|||||||
- status
|
- status
|
||||||
- description
|
- description
|
||||||
- id
|
- id
|
||||||
- handle
|
- created_at
|
||||||
|
- updated_at
|
||||||
- subtitle
|
- subtitle
|
||||||
- is_giftcard
|
|
||||||
- thumbnail
|
- thumbnail
|
||||||
|
- handle
|
||||||
|
- is_giftcard
|
||||||
- width
|
- width
|
||||||
- weight
|
- weight
|
||||||
- height
|
- height
|
||||||
@@ -25,8 +27,6 @@ required:
|
|||||||
- type_id
|
- type_id
|
||||||
- discountable
|
- discountable
|
||||||
- external_id
|
- external_id
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- deleted_at
|
- deleted_at
|
||||||
properties:
|
properties:
|
||||||
categories:
|
categories:
|
||||||
|
|||||||
@@ -122,6 +122,8 @@ required:
|
|||||||
- length
|
- length
|
||||||
- title
|
- title
|
||||||
- id
|
- id
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
- width
|
- width
|
||||||
- weight
|
- weight
|
||||||
- height
|
- height
|
||||||
@@ -129,8 +131,6 @@ required:
|
|||||||
- hs_code
|
- hs_code
|
||||||
- mid_code
|
- mid_code
|
||||||
- material
|
- material
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- deleted_at
|
- deleted_at
|
||||||
- sku
|
- sku
|
||||||
- barcode
|
- barcode
|
||||||
|
|||||||
@@ -0,0 +1,33 @@
|
|||||||
|
type: object
|
||||||
|
description: The country's details.
|
||||||
|
x-schemaName: StoreRegionCountry
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The country's ID.
|
||||||
|
iso_2:
|
||||||
|
type: string
|
||||||
|
title: iso_2
|
||||||
|
description: The country's ISO 2.
|
||||||
|
example: us
|
||||||
|
iso_3:
|
||||||
|
type: string
|
||||||
|
title: iso_3
|
||||||
|
description: The country's ISO 3.
|
||||||
|
example: usa
|
||||||
|
num_code:
|
||||||
|
type: string
|
||||||
|
title: num_code
|
||||||
|
description: The country's num code.
|
||||||
|
example: 840
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
title: name
|
||||||
|
description: The country's name.
|
||||||
|
display_name:
|
||||||
|
type: string
|
||||||
|
title: display_name
|
||||||
|
description: The country's display name.
|
||||||
@@ -3,10 +3,10 @@ description: The return's details.
|
|||||||
x-schemaName: StoreReturn
|
x-schemaName: StoreReturn
|
||||||
required:
|
required:
|
||||||
- items
|
- items
|
||||||
- order_id
|
|
||||||
- id
|
- id
|
||||||
- created_at
|
|
||||||
- display_id
|
- display_id
|
||||||
|
- created_at
|
||||||
|
- order_id
|
||||||
- canceled_at
|
- canceled_at
|
||||||
- received_at
|
- received_at
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -796,6 +796,8 @@ paths:
|
|||||||
paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml
|
paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml
|
||||||
/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments:
|
/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments:
|
||||||
$ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml
|
$ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml
|
||||||
|
/admin/orders/{id}/line-items:
|
||||||
|
$ref: paths/admin_orders_{id}_line-items.yaml
|
||||||
/admin/orders/{id}/preview:
|
/admin/orders/{id}/preview:
|
||||||
$ref: paths/admin_orders_{id}_preview.yaml
|
$ref: paths/admin_orders_{id}_preview.yaml
|
||||||
/admin/payment-collections:
|
/admin/payment-collections:
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
`id`. The API keys can also be sorted or paginated.
|
`id`. The API keys can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -82,16 +72,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
as `id`. The campaigns can also be sorted or paginated.
|
as `id`. The campaigns can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -132,16 +122,6 @@ post:
|
|||||||
description: Create a campaign.
|
description: Create a campaign.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -82,16 +72,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
`id`. The claims can also be sorted or paginated.
|
`id`. The claims can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -1032,16 +1022,6 @@ post:
|
|||||||
only applied on the order once the claim is confirmed.
|
only applied on the order once the claim is confirmed.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -23,16 +23,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -114,16 +104,6 @@ delete:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-10
@@ -24,16 +24,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -24,16 +24,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -115,16 +105,6 @@ delete:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-10
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -24,16 +24,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -115,16 +105,6 @@ delete:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -11,16 +11,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
such as `id`. The collections can also be sorted or paginated.
|
such as `id`. The collections can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -988,16 +978,6 @@ post:
|
|||||||
description: Create a collection.
|
description: Create a collection.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -82,16 +72,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
as `id`. The currencies can also be sorted or paginated.
|
as `id`. The currencies can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
fields such as `id`. The customer groups can also be sorted or paginated.
|
fields such as `id`. The customer groups can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -1038,16 +1028,6 @@ post:
|
|||||||
description: Create a customer group.
|
description: Create a customer group.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -82,16 +72,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -11,16 +11,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
as `id`. The customers can also be sorted or paginated.
|
as `id`. The customers can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -4225,16 +4215,6 @@ post:
|
|||||||
description: Create a customer.
|
description: Create a customer.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -82,16 +72,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -253,16 +243,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-30
@@ -18,16 +18,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -96,16 +86,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -264,16 +244,6 @@ delete:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
such as `id`. The draft orders can also be sorted or paginated.
|
such as `id`. The draft orders can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -1845,16 +1835,6 @@ post:
|
|||||||
property enabled.
|
property enabled.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
as `id`. The exchanges can also be sorted or paginated.
|
as `id`. The exchanges can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -1021,16 +1011,6 @@ post:
|
|||||||
the exchange is confirmed.
|
the exchange is confirmed.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-10
@@ -24,16 +24,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -24,16 +24,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -115,16 +105,6 @@ delete:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-10
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -24,16 +24,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -115,16 +105,6 @@ delete:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -10,16 +10,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -7,16 +7,6 @@ get:
|
|||||||
sorted or paginated.
|
sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-10
@@ -11,16 +11,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -17,16 +17,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -95,16 +85,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -4,16 +4,6 @@ post:
|
|||||||
description: Create a fulfillment for an order, return, exchange, and more.
|
description: Create a fulfillment for an order, return, exchange, and more.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -15,16 +15,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -13,16 +13,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,16 +6,6 @@ get:
|
|||||||
fields such as `id`. The inventory items can also be sorted or paginated.
|
fields such as `id`. The inventory items can also be sorted or paginated.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -507,16 +497,6 @@ post:
|
|||||||
description: Create an inventory item.
|
description: Create an inventory item.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,16 +12,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -82,16 +72,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -13,16 +13,6 @@ get:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -185,16 +175,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
-20
@@ -19,16 +19,6 @@ post:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -118,16 +108,6 @@ delete:
|
|||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: expand
|
|
||||||
in: query
|
|
||||||
description: Comma-separated relations that should be expanded in the returned data.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: expand
|
|
||||||
description: >-
|
|
||||||
Comma-separated relations that should be expanded in the returned
|
|
||||||
data.
|
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
Loaded 100 of 595 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user