chore(docs): Updated API Reference (v2) (#9033)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and 
GitHub committed
1 parent
20545b194e
commit
cf3c25addf
534 files changed
+3666
-23176
No files matched your search
@@ -3,7 +3,6 @@ description: SUMMARY
|
|||||||
x-schemaName: AdminCreateCollection
|
x-schemaName: AdminCreateCollection
|
||||||
required:
|
required:
|
||||||
- title
|
- title
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ description: SUMMARY
|
|||||||
x-schemaName: AdminCreateCustomerGroup
|
x-schemaName: AdminCreateCustomerGroup
|
||||||
required:
|
required:
|
||||||
- name
|
- name
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -9,12 +9,7 @@ required:
|
|||||||
- labels
|
- labels
|
||||||
- order
|
- order
|
||||||
- order_id
|
- order_id
|
||||||
- shipping_option_id
|
|
||||||
- data
|
- data
|
||||||
- packed_at
|
|
||||||
- shipped_at
|
|
||||||
- delivered_at
|
|
||||||
- canceled_at
|
|
||||||
- metadata
|
- metadata
|
||||||
properties:
|
properties:
|
||||||
location_id:
|
location_id:
|
||||||
@@ -28,18 +23,6 @@ properties:
|
|||||||
delivery_address:
|
delivery_address:
|
||||||
type: object
|
type: object
|
||||||
description: The fulfillment's delivery address.
|
description: The fulfillment's delivery address.
|
||||||
required:
|
|
||||||
- first_name
|
|
||||||
- last_name
|
|
||||||
- phone
|
|
||||||
- company
|
|
||||||
- address_1
|
|
||||||
- address_2
|
|
||||||
- city
|
|
||||||
- country_code
|
|
||||||
- province
|
|
||||||
- postal_code
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
first_name:
|
first_name:
|
||||||
type: string
|
type: string
|
||||||
@@ -95,8 +78,6 @@ properties:
|
|||||||
- sku
|
- sku
|
||||||
- quantity
|
- quantity
|
||||||
- barcode
|
- barcode
|
||||||
- line_item_id
|
|
||||||
- inventory_item_id
|
|
||||||
properties:
|
properties:
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -4,8 +4,6 @@ x-schemaName: AdminCreatePriceList
|
|||||||
required:
|
required:
|
||||||
- title
|
- title
|
||||||
- description
|
- description
|
||||||
- starts_at
|
|
||||||
- ends_at
|
|
||||||
properties:
|
properties:
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
@@ -48,8 +46,6 @@ properties:
|
|||||||
- currency_code
|
- currency_code
|
||||||
- amount
|
- amount
|
||||||
- variant_id
|
- variant_id
|
||||||
- min_quantity
|
|
||||||
- max_quantity
|
|
||||||
properties:
|
properties:
|
||||||
currency_code:
|
currency_code:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
+1
-1
@@ -1,5 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
|
x-schemaName: AdminCreateShippingProfile
|
||||||
required:
|
required:
|
||||||
- name
|
- name
|
||||||
- type
|
- type
|
||||||
@@ -15,4 +16,3 @@ properties:
|
|||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The shipping profile's metadata.
|
description: The shipping profile's metadata.
|
||||||
x-schemaName: AdminCreateShippingProfile
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
type: object
|
||||||
|
description: The removal details.
|
||||||
|
properties:
|
||||||
|
remove:
|
||||||
|
type: array
|
||||||
|
description: The products to remove from the price list.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: remove
|
||||||
|
description: The ID of a product.
|
||||||
|
x-schemaName: AdminLinkPriceListProducts
|
||||||
@@ -5,8 +5,8 @@ required:
|
|||||||
- return_requested_total
|
- return_requested_total
|
||||||
- order_change
|
- order_change
|
||||||
- currency_code
|
- currency_code
|
||||||
- id
|
|
||||||
- version
|
- version
|
||||||
|
- id
|
||||||
- region_id
|
- region_id
|
||||||
- customer_id
|
- customer_id
|
||||||
- sales_channel_id
|
- sales_channel_id
|
||||||
@@ -465,14 +465,14 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: currency_code
|
title: currency_code
|
||||||
description: The order preview's currency code.
|
description: The order preview's currency code.
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The order preview's ID.
|
|
||||||
version:
|
version:
|
||||||
type: number
|
type: number
|
||||||
title: version
|
title: version
|
||||||
description: The order preview's version.
|
description: The order preview's version.
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The order preview's ID.
|
||||||
region_id:
|
region_id:
|
||||||
type: string
|
type: string
|
||||||
title: region_id
|
title: region_id
|
||||||
|
|||||||
-2
@@ -1,8 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminPostClaimsItemsActionReqSchema
|
x-schemaName: AdminPostClaimsItemsActionReqSchema
|
||||||
required:
|
|
||||||
- reason_id
|
|
||||||
properties:
|
properties:
|
||||||
quantity:
|
quantity:
|
||||||
type: number
|
type: number
|
||||||
|
|||||||
+3
-3
@@ -2,10 +2,10 @@ type: object
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminPostClaimsShippingActionReqSchema
|
x-schemaName: AdminPostClaimsShippingActionReqSchema
|
||||||
properties:
|
properties:
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The claim's custom price.
|
description: The claim's custom amount.
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
|
|||||||
+3
-3
@@ -8,10 +8,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
description: The claim's shipping option id.
|
description: The claim's shipping option id.
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The claim's custom price.
|
description: The claim's custom amount.
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
title: description
|
title: description
|
||||||
|
|||||||
+3
-3
@@ -2,10 +2,10 @@ type: object
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminPostExchangesShippingActionReqSchema
|
x-schemaName: AdminPostExchangesShippingActionReqSchema
|
||||||
properties:
|
properties:
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The exchange's custom price.
|
description: The exchange's custom amount.
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
|
|||||||
+3
-3
@@ -8,10 +8,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
description: The exchange's shipping option id.
|
description: The exchange's shipping option id.
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The exchange's custom price.
|
description: The exchange's custom amount.
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
title: description
|
title: description
|
||||||
|
|||||||
-2
@@ -4,8 +4,6 @@ x-schemaName: AdminPostOrderClaimsReqSchema
|
|||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- order_id
|
- order_id
|
||||||
- reason_id
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
-1
@@ -3,7 +3,6 @@ description: SUMMARY
|
|||||||
x-schemaName: AdminPostOrderEditsReqSchema
|
x-schemaName: AdminPostOrderEditsReqSchema
|
||||||
required:
|
required:
|
||||||
- order_id
|
- order_id
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
+3
-3
@@ -2,10 +2,10 @@ type: object
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminPostOrderEditsShippingActionReqSchema
|
x-schemaName: AdminPostOrderEditsShippingActionReqSchema
|
||||||
properties:
|
properties:
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The order edit's custom price.
|
description: The order edit's custom amount.
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
|
|||||||
+3
-3
@@ -8,10 +8,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
description: The order edit's shipping option id.
|
description: The order edit's shipping option id.
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The order edit's custom price.
|
description: The order edit's custom amount.
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
title: description
|
title: description
|
||||||
|
|||||||
-1
@@ -3,7 +3,6 @@ description: SUMMARY
|
|||||||
x-schemaName: AdminPostOrderExchangesReqSchema
|
x-schemaName: AdminPostOrderExchangesReqSchema
|
||||||
required:
|
required:
|
||||||
- order_id
|
- order_id
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
-2
@@ -1,8 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminPostReceiveReturnsReqSchema
|
x-schemaName: AdminPostReceiveReturnsReqSchema
|
||||||
required:
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ description: SUMMARY
|
|||||||
x-schemaName: AdminPostReturnsReqSchema
|
x-schemaName: AdminPostReturnsReqSchema
|
||||||
required:
|
required:
|
||||||
- order_id
|
- order_id
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
-2
@@ -1,8 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminPostReturnsReturnReqSchema
|
x-schemaName: AdminPostReturnsReturnReqSchema
|
||||||
required:
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
location_id:
|
location_id:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
+3
-3
@@ -2,10 +2,10 @@ type: object
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminPostReturnsShippingActionReqSchema
|
x-schemaName: AdminPostReturnsShippingActionReqSchema
|
||||||
properties:
|
properties:
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The return's custom price.
|
description: The return's custom amount.
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
|
|||||||
+3
-3
@@ -8,10 +8,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
description: The exchange's shipping option id.
|
description: The exchange's shipping option id.
|
||||||
custom_price:
|
custom_amount:
|
||||||
type: number
|
type: number
|
||||||
title: custom_price
|
title: custom_amount
|
||||||
description: The exchange's custom price.
|
description: The exchange's custom amount.
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
title: description
|
title: description
|
||||||
|
|||||||
@@ -61,6 +61,10 @@ properties:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: manage_inventory
|
title: manage_inventory
|
||||||
description: The parent's manage inventory.
|
description: The parent's manage inventory.
|
||||||
|
inventory_quantity:
|
||||||
|
type: number
|
||||||
|
title: inventory_quantity
|
||||||
|
description: The parent's inventory quantity.
|
||||||
hs_code:
|
hs_code:
|
||||||
type: string
|
type: string
|
||||||
title: hs_code
|
title: hs_code
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateCollection
|
x-schemaName: AdminUpdateCollection
|
||||||
required:
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateCustomerGroup
|
x-schemaName: AdminUpdateCustomerGroup
|
||||||
required:
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -1,10 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdatePriceList
|
x-schemaName: AdminUpdatePriceList
|
||||||
required:
|
|
||||||
- description
|
|
||||||
- starts_at
|
|
||||||
- ends_at
|
|
||||||
properties:
|
properties:
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateSalesChannel
|
x-schemaName: AdminUpdateSalesChannel
|
||||||
required:
|
|
||||||
- description
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateStockLocation
|
x-schemaName: AdminUpdateStockLocation
|
||||||
required:
|
|
||||||
- address_id
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
@@ -14,13 +11,7 @@ properties:
|
|||||||
description: The stock location's address.
|
description: The stock location's address.
|
||||||
required:
|
required:
|
||||||
- address_1
|
- address_1
|
||||||
- address_2
|
|
||||||
- company
|
|
||||||
- city
|
|
||||||
- country_code
|
- country_code
|
||||||
- phone
|
|
||||||
- postal_code
|
|
||||||
- province
|
|
||||||
properties:
|
properties:
|
||||||
address_1:
|
address_1:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -1,11 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateStore
|
x-schemaName: AdminUpdateStore
|
||||||
required:
|
|
||||||
- default_sales_channel_id
|
|
||||||
- default_region_id
|
|
||||||
- default_location_id
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateTaxRate
|
x-schemaName: AdminUpdateTaxRate
|
||||||
required:
|
|
||||||
- code
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
rate:
|
rate:
|
||||||
type: number
|
type: number
|
||||||
|
|||||||
@@ -1,10 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateUser
|
x-schemaName: AdminUpdateUser
|
||||||
required:
|
|
||||||
- first_name
|
|
||||||
- last_name
|
|
||||||
- avatar_url
|
|
||||||
properties:
|
properties:
|
||||||
first_name:
|
first_name:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -5,8 +5,8 @@ required:
|
|||||||
- order_change
|
- order_change
|
||||||
- status
|
- status
|
||||||
- currency_code
|
- currency_code
|
||||||
- id
|
|
||||||
- version
|
- version
|
||||||
|
- id
|
||||||
- original_item_total
|
- original_item_total
|
||||||
- original_item_subtotal
|
- original_item_subtotal
|
||||||
- original_item_tax_total
|
- original_item_tax_total
|
||||||
@@ -671,14 +671,14 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: currency_code
|
title: currency_code
|
||||||
description: The order preview's currency code.
|
description: The order preview's currency code.
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The order preview's ID.
|
|
||||||
version:
|
version:
|
||||||
type: number
|
type: number
|
||||||
title: version
|
title: version
|
||||||
description: The order preview's version.
|
description: The order preview's version.
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The order preview's ID.
|
||||||
region_id:
|
region_id:
|
||||||
type: string
|
type: string
|
||||||
title: region_id
|
title: region_id
|
||||||
@@ -724,6 +724,8 @@ properties:
|
|||||||
- balance
|
- balance
|
||||||
- paid_total
|
- paid_total
|
||||||
- refunded_total
|
- refunded_total
|
||||||
|
- pending_difference
|
||||||
|
- raw_pending_difference
|
||||||
properties:
|
properties:
|
||||||
total:
|
total:
|
||||||
oneOf:
|
oneOf:
|
||||||
@@ -935,6 +937,23 @@ properties:
|
|||||||
- type: object
|
- type: object
|
||||||
description: The summary's refunded total.
|
description: The summary's refunded total.
|
||||||
x-schemaName: IBigNumber
|
x-schemaName: IBigNumber
|
||||||
|
pending_difference:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: pending_difference
|
||||||
|
description: The summary's pending difference.
|
||||||
|
- type: number
|
||||||
|
title: pending_difference
|
||||||
|
description: The summary's pending difference.
|
||||||
|
- type: string
|
||||||
|
title: pending_difference
|
||||||
|
description: The summary's pending difference.
|
||||||
|
- type: object
|
||||||
|
description: The summary's pending difference.
|
||||||
|
x-schemaName: IBigNumber
|
||||||
|
raw_pending_difference:
|
||||||
|
type: object
|
||||||
|
description: The summary's raw pending difference.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The order preview's metadata.
|
description: The order preview's metadata.
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ x-schemaName: StoreAddCartLineItem
|
|||||||
required:
|
required:
|
||||||
- variant_id
|
- variant_id
|
||||||
- quantity
|
- quantity
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
variant_id:
|
variant_id:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ description: SUMMARY
|
|||||||
x-schemaName: StoreUpdateCartLineItem
|
x-schemaName: StoreUpdateCartLineItem
|
||||||
required:
|
required:
|
||||||
- quantity
|
- quantity
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
quantity:
|
quantity:
|
||||||
type: number
|
type: number
|
||||||
|
|||||||
@@ -1,11 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: StoreUpdateCustomer
|
x-schemaName: StoreUpdateCustomer
|
||||||
required:
|
|
||||||
- company_name
|
|
||||||
- first_name
|
|
||||||
- last_name
|
|
||||||
- phone
|
|
||||||
properties:
|
properties:
|
||||||
company_name:
|
company_name:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -1286,9 +1286,15 @@ get:
|
|||||||
post:
|
post:
|
||||||
operationId: PostApiKeys
|
operationId: PostApiKeys
|
||||||
summary: Create Api Key
|
summary: Create Api Key
|
||||||
description: Create a api key.
|
description: >
|
||||||
|
Create a secret or publishable API key.
|
||||||
|
|
||||||
|
A secret API key is used for admin authentication.
|
||||||
|
|
||||||
|
|
||||||
|
A publishable API key is used by client applications to set the scope of the
|
||||||
|
request.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters: []
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -99,13 +70,13 @@ get:
|
|||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
post:
|
post:
|
||||||
operationId: PostApiKeysId
|
operationId: PostApiKeysId
|
||||||
summary: Update a Api Key
|
summary: Update an API Key
|
||||||
description: Update a api key's details.
|
description: Update an API key's details.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
in: path
|
in: path
|
||||||
description: The api key's ID.
|
description: The API key's ID.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -135,35 +106,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,12 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostApiKeysIdRevoke
|
operationId: PostApiKeysIdRevoke
|
||||||
summary: Add Revokes to Api Key
|
summary: Revoke API Key
|
||||||
description: Add a list of revokes to a api key.
|
description: >
|
||||||
|
Revokes an API key. If the API key is a secret, it can't be used for
|
||||||
|
authentication anymore. If it's publishable, it can't be used by client
|
||||||
|
applications.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
in: path
|
in: path
|
||||||
description: The api key's ID.
|
description: The API key's ID.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,12 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostApiKeysIdSalesChannels
|
operationId: PostApiKeysIdSalesChannels
|
||||||
summary: Add Sales Channels to Api Key
|
summary: Manage Sales Channels of a Publishable API Key
|
||||||
description: Add a list of sales channels to a api key.
|
x-sidebar-summary: Manage Sales Channels
|
||||||
|
description: >-
|
||||||
|
Manage the sales channels of a publishable API key, either to associate them
|
||||||
|
or remove them from the API key.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
in: path
|
in: path
|
||||||
description: The api key's ID.
|
description: The API key's ID.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -74,22 +48,22 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The sales channels to add or remove from the publishable API key.
|
||||||
properties:
|
properties:
|
||||||
add:
|
add:
|
||||||
type: array
|
type: array
|
||||||
description: The api key's add.
|
description: The sales channels to add to the publishable API key.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: add
|
title: add
|
||||||
description: The add's details.
|
description: A sales channel's ID.
|
||||||
remove:
|
remove:
|
||||||
type: array
|
type: array
|
||||||
description: The api key's remove.
|
description: The sales channels to remove from the publishable API key.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: remove
|
title: remove
|
||||||
description: The remove's details.
|
description: A sales channel's ID.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -152,35 +152,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -191,7 +162,7 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The campaign's details.
|
||||||
required:
|
required:
|
||||||
- name
|
- name
|
||||||
- campaign_identifier
|
- campaign_identifier
|
||||||
@@ -207,14 +178,16 @@ post:
|
|||||||
campaign_identifier:
|
campaign_identifier:
|
||||||
type: string
|
type: string
|
||||||
title: campaign_identifier
|
title: campaign_identifier
|
||||||
description: The campaign's campaign identifier.
|
description: The campaign's identifier.
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
title: description
|
title: description
|
||||||
description: The campaign's description.
|
description: The campaign's description.
|
||||||
budget:
|
budget:
|
||||||
type: object
|
type: object
|
||||||
description: The campaign's budget.
|
description: >-
|
||||||
|
The campaign's budget which, when crossed, ends the
|
||||||
|
campaign.
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- limit
|
- limit
|
||||||
@@ -222,42 +195,51 @@ post:
|
|||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
|
title: type
|
||||||
|
description: >
|
||||||
|
The budget's type. This can't be edited later. Use
|
||||||
|
`spend` to set a limit on the total amount discounted by
|
||||||
|
the campaign's promotions. Use `usage` to set a limit on
|
||||||
|
the total number of times the campaign's promotions can
|
||||||
|
be used.
|
||||||
enum:
|
enum:
|
||||||
- spend
|
- spend
|
||||||
- usage
|
- usage
|
||||||
limit:
|
limit:
|
||||||
type: number
|
type: number
|
||||||
title: limit
|
title: limit
|
||||||
description: The budget's limit.
|
description: The campaign budget's limit.
|
||||||
currency_code:
|
currency_code:
|
||||||
type: string
|
type: string
|
||||||
title: currency_code
|
title: currency_code
|
||||||
description: The budget's currency code.
|
description: >-
|
||||||
|
The campaign budget's currency code. This can't be
|
||||||
|
edited later.
|
||||||
starts_at:
|
starts_at:
|
||||||
type: string
|
type: string
|
||||||
title: starts_at
|
title: starts_at
|
||||||
description: The campaign's starts at.
|
description: The campaign's start date.
|
||||||
format: date-time
|
format: date-time
|
||||||
ends_at:
|
ends_at:
|
||||||
type: string
|
type: string
|
||||||
title: ends_at
|
title: ends_at
|
||||||
description: The campaign's ends at.
|
description: The campaign's end date.
|
||||||
format: date-time
|
format: date-time
|
||||||
promotions:
|
promotions:
|
||||||
type: array
|
type: array
|
||||||
description: The campaign's promotions.
|
description: The campaign's promotions.
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
description: The promotion's promotions.
|
description: The promotions to add to the campaign.
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The promotion's ID.
|
description: A promotion's ID.
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The campaign's details.
|
||||||
properties:
|
properties:
|
||||||
additional_data:
|
additional_data:
|
||||||
type: object
|
type: object
|
||||||
@@ -265,7 +247,7 @@ post:
|
|||||||
Pass additional custom data to the API route. This data is
|
Pass additional custom data to the API route. This data is
|
||||||
passed to the underlying workflow under the
|
passed to the underlying workflow under the
|
||||||
`additional_data` parameter.
|
`additional_data` parameter.
|
||||||
description: SUMMARY
|
description: The campaign's details.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -135,35 +106,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -174,7 +116,7 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The campaign's details.
|
||||||
required:
|
required:
|
||||||
- description
|
- description
|
||||||
- starts_at
|
- starts_at
|
||||||
@@ -187,7 +129,7 @@ post:
|
|||||||
campaign_identifier:
|
campaign_identifier:
|
||||||
type: string
|
type: string
|
||||||
title: campaign_identifier
|
title: campaign_identifier
|
||||||
description: The campaign's campaign identifier.
|
description: The campaign's identifier.
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
title: description
|
title: description
|
||||||
@@ -201,32 +143,32 @@ post:
|
|||||||
limit:
|
limit:
|
||||||
type: number
|
type: number
|
||||||
title: limit
|
title: limit
|
||||||
description: The budget's limit.
|
description: The campaign budget's limit.
|
||||||
starts_at:
|
starts_at:
|
||||||
type: string
|
type: string
|
||||||
title: starts_at
|
title: starts_at
|
||||||
description: The campaign's starts at.
|
description: The campaign's start date.
|
||||||
format: date-time
|
format: date-time
|
||||||
ends_at:
|
ends_at:
|
||||||
type: string
|
type: string
|
||||||
title: ends_at
|
title: ends_at
|
||||||
description: The campaign's ends at.
|
description: The campaign's end date.
|
||||||
format: date-time
|
format: date-time
|
||||||
promotions:
|
promotions:
|
||||||
type: array
|
type: array
|
||||||
description: The campaign's promotions.
|
description: The campaign's promotions.
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
description: The promotion's promotions.
|
description: The promotions to add to the campaign.
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The promotion's ID.
|
description: A promotion's ID.
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The campaign's details.
|
||||||
properties:
|
properties:
|
||||||
additional_data:
|
additional_data:
|
||||||
type: object
|
type: object
|
||||||
@@ -234,7 +176,7 @@ post:
|
|||||||
Pass additional custom data to the API route. This data is
|
Pass additional custom data to the API route. This data is
|
||||||
passed to the underlying workflow under the
|
passed to the underlying workflow under the
|
||||||
`additional_data` parameter.
|
`additional_data` parameter.
|
||||||
description: SUMMARY
|
description: The campaign's details.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostCampaignsIdPromotions
|
operationId: PostCampaignsIdPromotions
|
||||||
summary: Add Promotions to Campaign
|
summary: Manage the Promotions of a Campaign
|
||||||
description: Add a list of promotions to a campaign.
|
x-sidebar-summary: Manage Promotions
|
||||||
|
description: >-
|
||||||
|
Manage the promotions of a campaign, either by adding them or removing them
|
||||||
|
from the campaign.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -74,22 +48,22 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The promotions to add or remove from the campaign.
|
||||||
properties:
|
properties:
|
||||||
add:
|
add:
|
||||||
type: array
|
type: array
|
||||||
description: The campaign's add.
|
description: The promotions to add to the campaign.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: add
|
title: add
|
||||||
description: The add's details.
|
description: A promotion's ID.
|
||||||
remove:
|
remove:
|
||||||
type: array
|
type: array
|
||||||
description: The campaign's remove.
|
description: The promotions to remove from the campaign.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: remove
|
title: remove
|
||||||
description: The remove's details.
|
description: A promotion's ID.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -1020,8 +1020,10 @@ get:
|
|||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
post:
|
post:
|
||||||
operationId: PostClaims
|
operationId: PostClaims
|
||||||
summary: Create Claim
|
summary: Create a Claim
|
||||||
description: Create a claim.
|
description: >-
|
||||||
|
Create a claim. The claim is still in the request state, and the changes are
|
||||||
|
only applied on the order once the claim is confirmed.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
- name: expand
|
||||||
@@ -1050,35 +1052,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdCancel
|
operationId: PostClaimsIdCancel
|
||||||
summary: Add Cancels to Claim
|
summary: Cancel a Claim
|
||||||
description: Add a list of cancels to a claim.
|
description: Cancel a claim and its associated return.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdClaimItems
|
operationId: PostClaimsIdClaimItems
|
||||||
summary: Add Claim Items to Claim
|
summary: Add Claim Items to a Claim
|
||||||
description: Add a list of claim items to a claim.
|
x-sidebar-summary: Add Claim Items
|
||||||
|
description: >-
|
||||||
|
Add order items to a claim as claim items. These claim items will have the
|
||||||
|
action `WRITE_OFF_ITEM`.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+10
-61
@@ -1,7 +1,14 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdClaimItemsAction_id
|
operationId: PostClaimsIdClaimItemsAction_id
|
||||||
summary: Add Claim Items to Claim
|
summary: Update a Claim Item
|
||||||
description: Add a list of claim items to a claim.
|
description: >
|
||||||
|
Update an order item in a claim by the ID of the item's `WRITE_OFF_ITEM`
|
||||||
|
action.
|
||||||
|
|
||||||
|
|
||||||
|
Every item has an `actions` property, whose value is an array of actions.
|
||||||
|
You can check the action's name using its `action` property, and use the
|
||||||
|
value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +19,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The claim's action id.
|
description: The ID of the order item's `WRITE_OFF_ITEM` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +49,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -160,35 +138,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdInboundItems
|
operationId: PostClaimsIdInboundItems
|
||||||
summary: Add Items to Claim
|
summary: Add Inbound Items to a Claim
|
||||||
description: Add a list of items to a claim.
|
x-sidebar-summary: Add Inbound Items
|
||||||
|
description: >
|
||||||
|
Add inbound (or return) items to a claim. These inbound items will have a
|
||||||
|
`RETURN_ITEM` action.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
+11
-58
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdInboundItemsAction_id
|
operationId: PostClaimsIdInboundItemsAction_id
|
||||||
summary: Add Items to Claim
|
summary: Update Inbound Items of a Claim
|
||||||
description: Add a list of items to a claim.
|
x-sidebar-summary: Update Inbound Items
|
||||||
|
description: >
|
||||||
|
Update an inbound (or return) item of a claim using the `ID` of the item's
|
||||||
|
`RETURN_ITEM` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every item has an `actions` property, whose value is an array of actions.
|
||||||
|
You can check the action's name using its `action` property, and use the
|
||||||
|
value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The claim's action id.
|
description: The ID of the return item's `RETURN_ITEM` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -80,61 +88,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
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
Comma-separated fields that should be included in the returned data. if
|
|
||||||
a field is prefixed with `+` it will be added to the default fields,
|
|
||||||
using `-` will remove it from the default fields. without prefix it will
|
|
||||||
replace the entire default fields.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: fields
|
|
||||||
description: >-
|
|
||||||
Comma-separated fields that should be included in the returned data.
|
|
||||||
if a field is prefixed with `+` it will be added to the default
|
|
||||||
fields, using `-` will remove it from the default fields. without
|
|
||||||
prefix it will replace the entire default fields.
|
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+5
-2
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdInboundShippingMethod
|
operationId: PostClaimsIdInboundShippingMethod
|
||||||
summary: Add Shipping Methods to Claim
|
summary: Add an Inbound Shipping Method to a Claim
|
||||||
description: Add a list of shipping methods to a claim.
|
x-sidebar-summary: Add Inbound Shipping
|
||||||
|
description: >
|
||||||
|
Add an inbound (or return) shipping method to a claim. The inbound shipping
|
||||||
|
method will have a `SHIPPING_ADD` action.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
+11
-32
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdInboundShippingMethodAction_id
|
operationId: PostClaimsIdInboundShippingMethodAction_id
|
||||||
summary: Add Shipping Methods to Claim
|
summary: Update Inbound Shipping Method of a Claim
|
||||||
description: Add a list of shipping methods to a claim.
|
x-sidebar-summary: Update Inbound Shipping
|
||||||
|
description: >
|
||||||
|
Update the shipping method for returning items in the claim using the `ID`
|
||||||
|
of the method's `SHIPPING_ADD` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every shipping method has an `actions` property, whose value is an array of
|
||||||
|
actions. You can check the action's name using its `action` property, and
|
||||||
|
use the value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The claim's action id.
|
description: The ID of the shipping method's `SHIPPING_ADD` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +50,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdOutboundItems
|
operationId: PostClaimsIdOutboundItems
|
||||||
summary: Add Items to Claim
|
summary: Add Outbound Items to a Claim
|
||||||
description: Add a list of items to a claim.
|
x-sidebar-summary: Add Outbound Items
|
||||||
|
description: >
|
||||||
|
Add outbound (or new) items to a claim. These outbound items will have an
|
||||||
|
`ITEM_ADD` action.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+11
-61
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdOutboundItemsAction_id
|
operationId: PostClaimsIdOutboundItemsAction_id
|
||||||
summary: Add Items to Claim
|
summary: Update Outbound Item of a Claim
|
||||||
description: Add a list of items to a claim.
|
x-sidebar-summary: Update Outbound Item
|
||||||
|
description: >
|
||||||
|
Update an outbound (or new) item of a claim using the `ID` of the item's
|
||||||
|
`ITEM_ADD` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every item has an `actions` property, whose value is an array of actions.
|
||||||
|
You can check the action's name using its `action` property, and use the
|
||||||
|
value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The claim's action id.
|
description: The ID of the new claim item's `ITEM_ADD` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +50,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -160,35 +139,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+5
-31
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdOutboundShippingMethod
|
operationId: PostClaimsIdOutboundShippingMethod
|
||||||
summary: Add Shipping Methods to Claim
|
summary: Add Outbound Shipping Methods to a Claim
|
||||||
description: Add a list of shipping methods to a claim.
|
x-sidebar-summary: Add Outbound Shipping
|
||||||
|
description: >
|
||||||
|
Add an outbound shipping method to a claim. The outbound shipping method
|
||||||
|
will have a `SHIPPING_ADD` action.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+11
-61
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdOutboundShippingMethodAction_id
|
operationId: PostClaimsIdOutboundShippingMethodAction_id
|
||||||
summary: Add Shipping Methods to Claim
|
summary: Update Outbound Shipping Method of a Claim
|
||||||
description: Add a list of shipping methods to a claim.
|
x-sidebar-summary: Update Outbound Shipping
|
||||||
|
description: >
|
||||||
|
Update the shipping method for delivering outbound items in a claim using
|
||||||
|
the `ID` of the method's `SHIPPING_ADD` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every shipping method has an `actions` property, whose value is an array of
|
||||||
|
actions. You can check the action's name using its `action` property, and
|
||||||
|
use the value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The claim's action id.
|
description: The ID of the shipping method's `SHIPPING_ADD` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +50,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -160,35 +139,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostClaimsIdRequest
|
operationId: PostClaimsIdRequest
|
||||||
summary: Add Requests to Claim
|
summary: Confirm a Claim Request
|
||||||
description: Add a list of requests to a claim.
|
x-sidebar-summary: Confirm Claim
|
||||||
|
description: Confirm a claim request, applying its changes on the associated order.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +37,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1008,35 +1008,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -135,35 +106,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostCollectionsIdProducts
|
operationId: PostCollectionsIdProducts
|
||||||
summary: Add Products to Collection
|
summary: Manage Products of a Collection
|
||||||
description: Add a list of products to a collection.
|
x-sidebar-summary: Manage Products
|
||||||
|
description: >-
|
||||||
|
Manage the products of a collection by adding or removing them from the
|
||||||
|
collection.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -74,22 +48,22 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The products to add or remove.
|
||||||
properties:
|
properties:
|
||||||
add:
|
add:
|
||||||
type: array
|
type: array
|
||||||
description: The collection's add.
|
description: The products to add to the collection.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: add
|
title: add
|
||||||
description: The add's details.
|
description: A product's ID.
|
||||||
remove:
|
remove:
|
||||||
type: array
|
type: array
|
||||||
description: The collection's remove.
|
description: The products to remove from the collection.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: remove
|
title: remove
|
||||||
description: The remove's details.
|
description: A product's ID.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1056,35 +1056,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -135,35 +106,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostCustomerGroupsIdCustomers
|
operationId: PostCustomerGroupsIdCustomers
|
||||||
summary: Add Customers to Customer Group
|
summary: Manage Customers of a Customer Group
|
||||||
description: Add a list of customers to a customer group.
|
x-sidebar-summary: Manage Customers
|
||||||
|
description: Manage the customers of a group to add or remove them from the group.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +37,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -74,22 +46,22 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The customers to add or remove from the group.
|
||||||
properties:
|
properties:
|
||||||
add:
|
add:
|
||||||
type: array
|
type: array
|
||||||
description: The customer group's add.
|
description: The customers to add to the group.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: add
|
title: add
|
||||||
description: The add's details.
|
description: A customer's ID.
|
||||||
remove:
|
remove:
|
||||||
type: array
|
type: array
|
||||||
description: The customer group's remove.
|
description: The customers to remove from the group.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: remove
|
title: remove
|
||||||
description: The remove's details.
|
description: A customer's ID.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -4149,12 +4149,12 @@ get:
|
|||||||
title: $or
|
title: $or
|
||||||
- name: has_account
|
- name: has_account
|
||||||
in: query
|
in: query
|
||||||
description: The customer's has account.
|
description: Filter by whether the customer is registered.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: has_account
|
title: has_account
|
||||||
description: The customer's has account.
|
description: Filter by whether the customer is registered.
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -4245,35 +4245,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -4284,7 +4255,7 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The customer's details.
|
||||||
required:
|
required:
|
||||||
- email
|
- email
|
||||||
- company_name
|
- company_name
|
||||||
@@ -4318,7 +4289,7 @@ post:
|
|||||||
type: object
|
type: object
|
||||||
description: The customer's metadata.
|
description: The customer's metadata.
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The customer's details.
|
||||||
properties:
|
properties:
|
||||||
additional_data:
|
additional_data:
|
||||||
type: object
|
type: object
|
||||||
@@ -4326,7 +4297,7 @@ post:
|
|||||||
Pass additional custom data to the API route. This data is
|
Pass additional custom data to the API route. This data is
|
||||||
passed to the underlying workflow under the
|
passed to the underlying workflow under the
|
||||||
`additional_data` parameter.
|
`additional_data` parameter.
|
||||||
description: SUMMARY
|
description: The customer's details.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -135,35 +106,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -174,7 +116,7 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The customer's details.
|
||||||
required:
|
required:
|
||||||
- email
|
- email
|
||||||
- company_name
|
- company_name
|
||||||
@@ -208,7 +150,7 @@ post:
|
|||||||
type: object
|
type: object
|
||||||
description: The customer's metadata.
|
description: The customer's metadata.
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The customer's details.
|
||||||
properties:
|
properties:
|
||||||
additional_data:
|
additional_data:
|
||||||
type: object
|
type: object
|
||||||
@@ -216,7 +158,7 @@ post:
|
|||||||
Pass additional custom data to the API route. This data is
|
Pass additional custom data to the API route. This data is
|
||||||
passed to the underlying workflow under the
|
passed to the underlying workflow under the
|
||||||
`additional_data` parameter.
|
`additional_data` parameter.
|
||||||
description: SUMMARY
|
description: The customer's details.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -236,8 +236,9 @@ get:
|
|||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
post:
|
post:
|
||||||
operationId: PostCustomersIdAddresses
|
operationId: PostCustomersIdAddresses
|
||||||
summary: Add Addresses to Customer
|
summary: Add a Customer Address
|
||||||
description: Add a list of addresses to a customer.
|
x-sidebar-summary: Add Address
|
||||||
|
description: Add an address to a customer.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -272,35 +273,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -311,7 +283,7 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The address's details.
|
||||||
required:
|
required:
|
||||||
- address_name
|
- address_name
|
||||||
- company
|
- company
|
||||||
@@ -329,60 +301,64 @@ post:
|
|||||||
address_name:
|
address_name:
|
||||||
type: string
|
type: string
|
||||||
title: address_name
|
title: address_name
|
||||||
description: The customer's address name.
|
description: The name of the address.
|
||||||
is_default_shipping:
|
is_default_shipping:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: is_default_shipping
|
title: is_default_shipping
|
||||||
description: The customer's is default shipping.
|
description: >-
|
||||||
|
Whether this address is used by default for shipping when
|
||||||
|
placing an order.
|
||||||
is_default_billing:
|
is_default_billing:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: is_default_billing
|
title: is_default_billing
|
||||||
description: The customer's is default billing.
|
description: >-
|
||||||
|
Whether this address is used by default for billing when
|
||||||
|
placing an order.
|
||||||
company:
|
company:
|
||||||
type: string
|
type: string
|
||||||
title: company
|
title: company
|
||||||
description: The customer's company.
|
description: The address's company.
|
||||||
first_name:
|
first_name:
|
||||||
type: string
|
type: string
|
||||||
title: first_name
|
title: first_name
|
||||||
description: The customer's first name.
|
description: The address's first name.
|
||||||
last_name:
|
last_name:
|
||||||
type: string
|
type: string
|
||||||
title: last_name
|
title: last_name
|
||||||
description: The customer's last name.
|
description: The address's last name.
|
||||||
address_1:
|
address_1:
|
||||||
type: string
|
type: string
|
||||||
title: address_1
|
title: address_1
|
||||||
description: The customer's address 1.
|
description: The address's first line.
|
||||||
address_2:
|
address_2:
|
||||||
type: string
|
type: string
|
||||||
title: address_2
|
title: address_2
|
||||||
description: The customer's address 2.
|
description: The address's second line.
|
||||||
city:
|
city:
|
||||||
type: string
|
type: string
|
||||||
title: city
|
title: city
|
||||||
description: The customer's city.
|
description: The address's city.
|
||||||
country_code:
|
country_code:
|
||||||
type: string
|
type: string
|
||||||
title: country_code
|
title: country_code
|
||||||
description: The customer's country code.
|
description: The address's country code.
|
||||||
province:
|
province:
|
||||||
type: string
|
type: string
|
||||||
title: province
|
title: province
|
||||||
description: The customer's province.
|
description: The address's province.
|
||||||
postal_code:
|
postal_code:
|
||||||
type: string
|
type: string
|
||||||
title: postal_code
|
title: postal_code
|
||||||
description: The customer's postal code.
|
description: The address's postal code.
|
||||||
phone:
|
phone:
|
||||||
type: string
|
type: string
|
||||||
title: phone
|
title: phone
|
||||||
description: The customer's phone.
|
description: The address's phone.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The customer's metadata.
|
description: The address's metadata.
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The address's details.
|
||||||
properties:
|
properties:
|
||||||
additional_data:
|
additional_data:
|
||||||
type: object
|
type: object
|
||||||
@@ -390,7 +366,7 @@ post:
|
|||||||
Pass additional custom data to the API route. This data is
|
Pass additional custom data to the API route. This data is
|
||||||
passed to the underlying workflow under the
|
passed to the underlying workflow under the
|
||||||
`additional_data` parameter.
|
`additional_data` parameter.
|
||||||
description: SUMMARY
|
description: The address's details.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
+24
-106
@@ -44,35 +44,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -106,8 +77,9 @@ get:
|
|||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
post:
|
post:
|
||||||
operationId: PostCustomersIdAddressesAddress_id
|
operationId: PostCustomersIdAddressesAddress_id
|
||||||
summary: Add Addresses to Customer
|
summary: Update a Customer's Address
|
||||||
description: Add a list of addresses to a customer.
|
x-sidebar-summary: Update Address
|
||||||
|
description: Update a customer address's details.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -148,35 +120,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -187,7 +130,7 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The address's details.
|
||||||
required:
|
required:
|
||||||
- address_name
|
- address_name
|
||||||
- company
|
- company
|
||||||
@@ -205,60 +148,64 @@ post:
|
|||||||
address_name:
|
address_name:
|
||||||
type: string
|
type: string
|
||||||
title: address_name
|
title: address_name
|
||||||
description: The customer's address name.
|
description: The name of the address.
|
||||||
is_default_shipping:
|
is_default_shipping:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: is_default_shipping
|
title: is_default_shipping
|
||||||
description: The customer's is default shipping.
|
description: >-
|
||||||
|
Whether this address is used by default for shipping when
|
||||||
|
placing an order.
|
||||||
is_default_billing:
|
is_default_billing:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: is_default_billing
|
title: is_default_billing
|
||||||
description: The customer's is default billing.
|
description: >-
|
||||||
|
Whether this address is used by default for billing when
|
||||||
|
placing an order.
|
||||||
company:
|
company:
|
||||||
type: string
|
type: string
|
||||||
title: company
|
title: company
|
||||||
description: The customer's company.
|
description: The address's company.
|
||||||
first_name:
|
first_name:
|
||||||
type: string
|
type: string
|
||||||
title: first_name
|
title: first_name
|
||||||
description: The customer's first name.
|
description: The address's first name.
|
||||||
last_name:
|
last_name:
|
||||||
type: string
|
type: string
|
||||||
title: last_name
|
title: last_name
|
||||||
description: The customer's last name.
|
description: The address's last name.
|
||||||
address_1:
|
address_1:
|
||||||
type: string
|
type: string
|
||||||
title: address_1
|
title: address_1
|
||||||
description: The customer's address 1.
|
description: The address's first line
|
||||||
address_2:
|
address_2:
|
||||||
type: string
|
type: string
|
||||||
title: address_2
|
title: address_2
|
||||||
description: The customer's address 2.
|
description: The address's second line
|
||||||
city:
|
city:
|
||||||
type: string
|
type: string
|
||||||
title: city
|
title: city
|
||||||
description: The customer's city.
|
description: The address's city.
|
||||||
country_code:
|
country_code:
|
||||||
type: string
|
type: string
|
||||||
title: country_code
|
title: country_code
|
||||||
description: The customer's country code.
|
description: The address's country code.
|
||||||
province:
|
province:
|
||||||
type: string
|
type: string
|
||||||
title: province
|
title: province
|
||||||
description: The customer's province.
|
description: The address's province.
|
||||||
postal_code:
|
postal_code:
|
||||||
type: string
|
type: string
|
||||||
title: postal_code
|
title: postal_code
|
||||||
description: The customer's postal code.
|
description: The address's postal code.
|
||||||
phone:
|
phone:
|
||||||
type: string
|
type: string
|
||||||
title: phone
|
title: phone
|
||||||
description: The customer's phone.
|
description: The address's phone.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The customer's metadata.
|
description: The address's metadata.
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The address's details.
|
||||||
properties:
|
properties:
|
||||||
additional_data:
|
additional_data:
|
||||||
type: object
|
type: object
|
||||||
@@ -266,7 +213,7 @@ post:
|
|||||||
Pass additional custom data to the API route. This data is
|
Pass additional custom data to the API route. This data is
|
||||||
passed to the underlying workflow under the
|
passed to the underlying workflow under the
|
||||||
`additional_data` parameter.
|
`additional_data` parameter.
|
||||||
description: SUMMARY
|
description: The address's details.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
@@ -339,35 +286,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1165,24 +1165,25 @@ get:
|
|||||||
title: $or
|
title: $or
|
||||||
- name: sales_channel_id
|
- name: sales_channel_id
|
||||||
in: query
|
in: query
|
||||||
description: The draft order's sales channel id.
|
description: Filter by the associated sales channels to retrieve its draft orders.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: array
|
type: array
|
||||||
description: The draft order's sales channel id.
|
description: Filter by the associated sales channels to retrieve its draft orders.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: sales_channel_id
|
title: sales_channel_id
|
||||||
description: The sales channel id's details.
|
description: A sales channel's ID.
|
||||||
- name: fulfillment_status
|
- name: fulfillment_status
|
||||||
in: query
|
in: query
|
||||||
description: The draft order's fulfillment status.
|
description: Filter by the fulfillment status of the draft order.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: array
|
type: array
|
||||||
description: The draft order's fulfillment status.
|
description: Filter by the fulfillment status of the draft order.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
title: fulfillment_status
|
||||||
description: The fulfillment status's details.
|
description: The fulfillment status's details.
|
||||||
enum:
|
enum:
|
||||||
- canceled
|
- canceled
|
||||||
@@ -1195,13 +1196,14 @@ get:
|
|||||||
- delivered
|
- delivered
|
||||||
- name: payment_status
|
- name: payment_status
|
||||||
in: query
|
in: query
|
||||||
description: The draft order's payment status.
|
description: Filter by the payment status of the draft order.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: array
|
type: array
|
||||||
description: The draft order's payment status.
|
description: Filter by the payment status of the draft order.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
title: payment_status
|
||||||
description: The payment status's details.
|
description: The payment status's details.
|
||||||
enum:
|
enum:
|
||||||
- canceled
|
- canceled
|
||||||
@@ -1216,30 +1218,30 @@ get:
|
|||||||
- requires_action
|
- requires_action
|
||||||
- name: region_id
|
- name: region_id
|
||||||
in: query
|
in: query
|
||||||
description: The draft order's region id.
|
description: Filter by region IDs to retrieve their associated draft orders.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: array
|
type: array
|
||||||
description: The draft order's region id.
|
description: Filter by region IDs to retrieve their associated draft orders.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: region_id
|
title: region_id
|
||||||
description: The region id's details.
|
description: A region's ID.
|
||||||
- name: q
|
- name: q
|
||||||
in: query
|
in: query
|
||||||
description: The draft order's q.
|
description: Search term to filter the order's searchable properties.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: q
|
title: q
|
||||||
description: The draft order's q.
|
description: Search term to filter the order's searchable properties.
|
||||||
- name: created_at
|
- name: created_at
|
||||||
in: query
|
in: query
|
||||||
description: The draft order's created at.
|
description: Filter by the draft order's creation date.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: The draft order's created at.
|
description: Filter by the draft order's creation date.
|
||||||
properties:
|
properties:
|
||||||
$and:
|
$and:
|
||||||
type: array
|
type: array
|
||||||
@@ -1263,11 +1265,11 @@ get:
|
|||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: Filter by an exact match.
|
||||||
- type: array
|
- type: array
|
||||||
description: Filter by an exact match.
|
description: Filter by multiple exact matches.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: An exact match.
|
||||||
$ne:
|
$ne:
|
||||||
type: string
|
type: string
|
||||||
title: $ne
|
title: $ne
|
||||||
@@ -1278,21 +1280,19 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $in
|
title: $in
|
||||||
description: Filter by values in this array.
|
description: The value to match.
|
||||||
$nin:
|
$nin:
|
||||||
type: array
|
type: array
|
||||||
description: Filter by values not in this array.
|
description: Filter by values not in this array.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $nin
|
title: $nin
|
||||||
description: Filter by values not in this array.
|
description: The value not to match.
|
||||||
$not:
|
$not:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: string
|
- type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: Filter by values not matching this parameter.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
- type: object
|
- type: object
|
||||||
description: >-
|
description: >-
|
||||||
Filter by values not matching the conditions in this
|
Filter by values not matching the conditions in this
|
||||||
@@ -1320,50 +1320,46 @@ get:
|
|||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: Filter by an exact match.
|
||||||
- type: array
|
- type: array
|
||||||
description: Filter by an exact match.
|
description: Filter by multiple exact matches.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: The value to match.
|
||||||
$ne:
|
$ne:
|
||||||
type: string
|
type: string
|
||||||
title: $ne
|
title: $ne
|
||||||
description: Filter by values not equal to this parameter.
|
description: Filter by values not matching this parameter.
|
||||||
$in:
|
$in:
|
||||||
type: array
|
type: array
|
||||||
description: Filter by values in this array.
|
description: Filter by values in this array.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $in
|
title: $in
|
||||||
description: Filter by values in this array.
|
description: The value to match.
|
||||||
$nin:
|
$nin:
|
||||||
type: array
|
type: array
|
||||||
description: Filter by values not in this array.
|
description: Filter by values not in this array.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $nin
|
title: $nin
|
||||||
description: Filter by values not in this array.
|
description: The value to not match
|
||||||
$not:
|
$not:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: string
|
- type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: Filter by values not matching this parameter
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
- type: object
|
- type: object
|
||||||
description: >-
|
description: >-
|
||||||
Filter by values not matching the conditions in this
|
Filter by values not matching the conditions in this
|
||||||
parameter.
|
parameter.
|
||||||
- type: array
|
- type: array
|
||||||
description: >-
|
description: >-
|
||||||
Filter by values not matching the conditions in this
|
Filter by values not matching the values of this
|
||||||
parameter.
|
parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: The values to not match.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
$gt:
|
$gt:
|
||||||
type: string
|
type: string
|
||||||
title: $gt
|
title: $gt
|
||||||
@@ -1414,9 +1410,7 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $overlap
|
title: $overlap
|
||||||
description: >-
|
description: The value to match.
|
||||||
Filter arrays that have overlapping values with this
|
|
||||||
parameter.
|
|
||||||
$contains:
|
$contains:
|
||||||
type: array
|
type: array
|
||||||
description: >-
|
description: >-
|
||||||
@@ -1425,16 +1419,14 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contains
|
title: $contains
|
||||||
description: >-
|
description: The values to match.
|
||||||
Filter arrays that contain some of the values of this
|
|
||||||
parameter.
|
|
||||||
$contained:
|
$contained:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: Filter arrays that contain all values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contained
|
title: $contained
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: The values to match.
|
||||||
$exists:
|
$exists:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
@@ -1442,15 +1434,11 @@ get:
|
|||||||
Filter by whether a value for this parameter exists (not
|
Filter by whether a value for this parameter exists (not
|
||||||
`null`).
|
`null`).
|
||||||
- type: array
|
- type: array
|
||||||
description: >-
|
description: Filter by values not matching those in this parameter.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: The values to not match.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
$gt:
|
$gt:
|
||||||
type: string
|
type: string
|
||||||
title: $gt
|
title: $gt
|
||||||
@@ -1497,32 +1485,32 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $overlap
|
title: $overlap
|
||||||
description: Filter arrays that have overlapping values with this parameter.
|
description: The values to match.
|
||||||
$contains:
|
$contains:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain some of the values of this parameter.
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contains
|
title: $contains
|
||||||
description: Filter arrays that contain some of the values of this parameter.
|
description: The values to match.
|
||||||
$contained:
|
$contained:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: Filter arrays that contain all values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contained
|
title: $contained
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: The values to match.
|
||||||
$exists:
|
$exists:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: The draft order's updated at.
|
description: Filter by the draft order's update date.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: The draft order's updated at.
|
description: Filter by the draft order's update date.
|
||||||
properties:
|
properties:
|
||||||
$and:
|
$and:
|
||||||
type: array
|
type: array
|
||||||
@@ -1546,11 +1534,11 @@ get:
|
|||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: Filter by an exact match.
|
||||||
- type: array
|
- type: array
|
||||||
description: Filter by an exact match.
|
description: Filter by multiple exact matches.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: An exact match.
|
||||||
$ne:
|
$ne:
|
||||||
type: string
|
type: string
|
||||||
title: $ne
|
title: $ne
|
||||||
@@ -1561,21 +1549,19 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $in
|
title: $in
|
||||||
description: Filter by values in this array.
|
description: The value to match.
|
||||||
$nin:
|
$nin:
|
||||||
type: array
|
type: array
|
||||||
description: Filter by values not in this array.
|
description: Filter by values not in this array.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $nin
|
title: $nin
|
||||||
description: Filter by values not in this array.
|
description: The value not to match.
|
||||||
$not:
|
$not:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: string
|
- type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: Filter by values not matching this parameter.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
- type: object
|
- type: object
|
||||||
description: >-
|
description: >-
|
||||||
Filter by values not matching the conditions in this
|
Filter by values not matching the conditions in this
|
||||||
@@ -1603,50 +1589,46 @@ get:
|
|||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: Filter by an exact match.
|
||||||
- type: array
|
- type: array
|
||||||
description: Filter by an exact match.
|
description: Filter by multiple exact matches.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $eq
|
title: $eq
|
||||||
description: Filter by an exact match.
|
description: The value to match.
|
||||||
$ne:
|
$ne:
|
||||||
type: string
|
type: string
|
||||||
title: $ne
|
title: $ne
|
||||||
description: Filter by values not equal to this parameter.
|
description: Filter by values not matching this parameter.
|
||||||
$in:
|
$in:
|
||||||
type: array
|
type: array
|
||||||
description: Filter by values in this array.
|
description: Filter by values in this array.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $in
|
title: $in
|
||||||
description: Filter by values in this array.
|
description: The value to match.
|
||||||
$nin:
|
$nin:
|
||||||
type: array
|
type: array
|
||||||
description: Filter by values not in this array.
|
description: Filter by values not in this array.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $nin
|
title: $nin
|
||||||
description: Filter by values not in this array.
|
description: The value to not match
|
||||||
$not:
|
$not:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: string
|
- type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: Filter by values not matching this parameter
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
- type: object
|
- type: object
|
||||||
description: >-
|
description: >-
|
||||||
Filter by values not matching the conditions in this
|
Filter by values not matching the conditions in this
|
||||||
parameter.
|
parameter.
|
||||||
- type: array
|
- type: array
|
||||||
description: >-
|
description: >-
|
||||||
Filter by values not matching the conditions in this
|
Filter by values not matching the values of this
|
||||||
parameter.
|
parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: The values to not match.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
$gt:
|
$gt:
|
||||||
type: string
|
type: string
|
||||||
title: $gt
|
title: $gt
|
||||||
@@ -1697,9 +1679,7 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $overlap
|
title: $overlap
|
||||||
description: >-
|
description: The value to match.
|
||||||
Filter arrays that have overlapping values with this
|
|
||||||
parameter.
|
|
||||||
$contains:
|
$contains:
|
||||||
type: array
|
type: array
|
||||||
description: >-
|
description: >-
|
||||||
@@ -1708,16 +1688,14 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contains
|
title: $contains
|
||||||
description: >-
|
description: The values to match.
|
||||||
Filter arrays that contain some of the values of this
|
|
||||||
parameter.
|
|
||||||
$contained:
|
$contained:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: Filter arrays that contain all values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contained
|
title: $contained
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: The values to match.
|
||||||
$exists:
|
$exists:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
@@ -1725,15 +1703,11 @@ get:
|
|||||||
Filter by whether a value for this parameter exists (not
|
Filter by whether a value for this parameter exists (not
|
||||||
`null`).
|
`null`).
|
||||||
- type: array
|
- type: array
|
||||||
description: >-
|
description: Filter by values not matching those in this parameter.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $not
|
title: $not
|
||||||
description: >-
|
description: The values to not match.
|
||||||
Filter by values not matching the conditions in this
|
|
||||||
parameter.
|
|
||||||
$gt:
|
$gt:
|
||||||
type: string
|
type: string
|
||||||
title: $gt
|
title: $gt
|
||||||
@@ -1780,21 +1754,21 @@ get:
|
|||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $overlap
|
title: $overlap
|
||||||
description: Filter arrays that have overlapping values with this parameter.
|
description: The values to match.
|
||||||
$contains:
|
$contains:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain some of the values of this parameter.
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contains
|
title: $contains
|
||||||
description: Filter arrays that contain some of the values of this parameter.
|
description: The values to match.
|
||||||
$contained:
|
$contained:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: Filter arrays that contain all values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: $contained
|
title: $contained
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: The values to match.
|
||||||
$exists:
|
$exists:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
@@ -1858,7 +1832,9 @@ get:
|
|||||||
post:
|
post:
|
||||||
operationId: PostDraftOrders
|
operationId: PostDraftOrders
|
||||||
summary: Create Draft Order
|
summary: Create Draft Order
|
||||||
description: Create a draft order.
|
description: >-
|
||||||
|
Create a draft order. This creates an order with the `is_draft_order`
|
||||||
|
property enabled.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
- name: expand
|
||||||
@@ -1887,35 +1863,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -1926,7 +1873,7 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The draft order's details.
|
||||||
required:
|
required:
|
||||||
- sales_channel_id
|
- sales_channel_id
|
||||||
- email
|
- email
|
||||||
@@ -1937,25 +1884,27 @@ post:
|
|||||||
- metadata
|
- metadata
|
||||||
properties:
|
properties:
|
||||||
status:
|
status:
|
||||||
type: boolean
|
type: string
|
||||||
title: status
|
title: status
|
||||||
description: The draft order's status.
|
description: The draft order's status.
|
||||||
|
enum:
|
||||||
|
- completed
|
||||||
sales_channel_id:
|
sales_channel_id:
|
||||||
type: string
|
type: string
|
||||||
title: sales_channel_id
|
title: sales_channel_id
|
||||||
description: The draft order's sales channel id.
|
description: The ID of the associated sales channel.
|
||||||
email:
|
email:
|
||||||
type: string
|
type: string
|
||||||
title: email
|
title: email
|
||||||
description: The draft order's email.
|
description: The email of the draft order's customer.
|
||||||
format: email
|
format: email
|
||||||
customer_id:
|
customer_id:
|
||||||
type: string
|
type: string
|
||||||
title: customer_id
|
title: customer_id
|
||||||
description: The draft order's customer id.
|
description: The ID of the draft order's customer.
|
||||||
billing_address:
|
billing_address:
|
||||||
type: object
|
type: object
|
||||||
description: The draft order's billing address.
|
description: The billing address's details.
|
||||||
required:
|
required:
|
||||||
- first_name
|
- first_name
|
||||||
- last_name
|
- last_name
|
||||||
@@ -1988,11 +1937,11 @@ post:
|
|||||||
address_1:
|
address_1:
|
||||||
type: string
|
type: string
|
||||||
title: address_1
|
title: address_1
|
||||||
description: The billing address's address 1.
|
description: The billing address's first line.
|
||||||
address_2:
|
address_2:
|
||||||
type: string
|
type: string
|
||||||
title: address_2
|
title: address_2
|
||||||
description: The billing address's address 2.
|
description: The billing address's second line.
|
||||||
city:
|
city:
|
||||||
type: string
|
type: string
|
||||||
title: city
|
title: city
|
||||||
@@ -2047,11 +1996,11 @@ post:
|
|||||||
address_1:
|
address_1:
|
||||||
type: string
|
type: string
|
||||||
title: address_1
|
title: address_1
|
||||||
description: The shipping address's address 1.
|
description: The shipping address's first line.
|
||||||
address_2:
|
address_2:
|
||||||
type: string
|
type: string
|
||||||
title: address_2
|
title: address_2
|
||||||
description: The shipping address's address 2.
|
description: The shipping address's second line.
|
||||||
city:
|
city:
|
||||||
type: string
|
type: string
|
||||||
title: city
|
title: city
|
||||||
@@ -2076,7 +2025,7 @@ post:
|
|||||||
description: The draft order's items.
|
description: The draft order's items.
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
description: The item's items.
|
description: The item's details.
|
||||||
required:
|
required:
|
||||||
- title
|
- title
|
||||||
- sku
|
- sku
|
||||||
@@ -2093,7 +2042,7 @@ post:
|
|||||||
sku:
|
sku:
|
||||||
type: string
|
type: string
|
||||||
title: sku
|
title: sku
|
||||||
description: The item's sku.
|
description: The item's SKU.
|
||||||
barcode:
|
barcode:
|
||||||
type: string
|
type: string
|
||||||
title: barcode
|
title: barcode
|
||||||
@@ -2101,7 +2050,7 @@ post:
|
|||||||
variant_id:
|
variant_id:
|
||||||
type: string
|
type: string
|
||||||
title: variant_id
|
title: variant_id
|
||||||
description: The item's variant id.
|
description: The ID of the associated product variant.
|
||||||
unit_price:
|
unit_price:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: string
|
- type: string
|
||||||
@@ -2123,25 +2072,25 @@ post:
|
|||||||
precision:
|
precision:
|
||||||
type: number
|
type: number
|
||||||
title: precision
|
title: precision
|
||||||
description: The unit price's precision.
|
description: The unit price's rounding precision.
|
||||||
quantity:
|
quantity:
|
||||||
type: number
|
type: number
|
||||||
title: quantity
|
title: quantity
|
||||||
description: The item's quantity.
|
description: The item's ordered quantity.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The item's metadata.
|
description: The item's metadata.
|
||||||
region_id:
|
region_id:
|
||||||
type: string
|
type: string
|
||||||
title: region_id
|
title: region_id
|
||||||
description: The draft order's region id.
|
description: The ID of the associated region.
|
||||||
promo_codes:
|
promo_codes:
|
||||||
type: array
|
type: array
|
||||||
description: The draft order's promo codes.
|
description: The promotion codes applied on the draft order.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: promo_codes
|
title: promo_codes
|
||||||
description: The promo code's promo codes.
|
description: A promotion code.
|
||||||
currency_code:
|
currency_code:
|
||||||
type: string
|
type: string
|
||||||
title: currency_code
|
title: currency_code
|
||||||
@@ -2149,16 +2098,14 @@ post:
|
|||||||
no_notification_order:
|
no_notification_order:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: no_notification_order
|
title: no_notification_order
|
||||||
description: The draft order's no notification order.
|
description: Whether to send the customer notifications on order changes.
|
||||||
shipping_methods:
|
shipping_methods:
|
||||||
type: array
|
type: array
|
||||||
description: The draft order's shipping methods.
|
description: The draft order's shipping methods.
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
description: The shipping method's shipping methods.
|
description: The shipping method's details.
|
||||||
required:
|
required:
|
||||||
- shipping_method_id
|
|
||||||
- order_id
|
|
||||||
- name
|
- name
|
||||||
- option_id
|
- option_id
|
||||||
- amount
|
- amount
|
||||||
@@ -2166,11 +2113,7 @@ post:
|
|||||||
shipping_method_id:
|
shipping_method_id:
|
||||||
type: string
|
type: string
|
||||||
title: shipping_method_id
|
title: shipping_method_id
|
||||||
description: The shipping method's shipping method id.
|
description: The ID of an existing shipping method.
|
||||||
order_id:
|
|
||||||
type: string
|
|
||||||
title: order_id
|
|
||||||
description: The shipping method's order id.
|
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
title: name
|
title: name
|
||||||
@@ -2178,10 +2121,17 @@ post:
|
|||||||
option_id:
|
option_id:
|
||||||
type: string
|
type: string
|
||||||
title: option_id
|
title: option_id
|
||||||
description: The shipping method's option id.
|
description: >-
|
||||||
|
The ID of the shipping option this method is created
|
||||||
|
from.
|
||||||
data:
|
data:
|
||||||
type: object
|
type: object
|
||||||
description: The shipping method's data.
|
description: >-
|
||||||
|
The shipping method's data, useful for fulfillment
|
||||||
|
providers.
|
||||||
|
externalDocs:
|
||||||
|
url: >-
|
||||||
|
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
|
||||||
amount:
|
amount:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: string
|
- type: string
|
||||||
@@ -2203,12 +2153,12 @@ post:
|
|||||||
precision:
|
precision:
|
||||||
type: number
|
type: number
|
||||||
title: precision
|
title: precision
|
||||||
description: The amount's precision.
|
description: The amount's rounding precision.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The draft order's metadata.
|
description: The draft order's metadata.
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The draft order's details.
|
||||||
properties:
|
properties:
|
||||||
additional_data:
|
additional_data:
|
||||||
type: object
|
type: object
|
||||||
@@ -2216,7 +2166,7 @@ post:
|
|||||||
Pass additional custom data to the API route. This data is
|
Pass additional custom data to the API route. This data is
|
||||||
passed to the underlying workflow under the
|
passed to the underlying workflow under the
|
||||||
`additional_data` parameter.
|
`additional_data` parameter.
|
||||||
description: SUMMARY
|
description: The draft order's details.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -1005,7 +1005,9 @@ get:
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchanges
|
operationId: PostExchanges
|
||||||
summary: Create Exchange
|
summary: Create Exchange
|
||||||
description: Create a exchange.
|
description: >-
|
||||||
|
Create an exchange request. Its changes aren't applied on the order until
|
||||||
|
the exchange is confirmed.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
- name: expand
|
||||||
@@ -1034,35 +1036,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdCancel
|
operationId: PostExchangesIdCancel
|
||||||
summary: Add Cancels to Exchange
|
summary: Cancel an Exchange
|
||||||
description: Add a list of cancels to a exchange.
|
description: Cancel an exchange and its associated return.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdInboundItems
|
operationId: PostExchangesIdInboundItems
|
||||||
summary: Add Items to Exchange
|
summary: Add Inbound Items to an Exchange
|
||||||
description: Add a list of items to a exchange.
|
x-sidebary-summary: Add Inbound Items
|
||||||
|
description: >-
|
||||||
|
Add inbound (or return) items to an exchange. These inbound items will have
|
||||||
|
the action `RETURN_ITEM`.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
+11
-32
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdInboundItemsAction_id
|
operationId: PostExchangesIdInboundItemsAction_id
|
||||||
summary: Add Items to Exchange
|
summary: Update an Inbount Item of an Exchange
|
||||||
description: Add a list of items to a exchange.
|
x-sidebar-summary: Update Inbound Item
|
||||||
|
description: >
|
||||||
|
Update an inbound (or return) item from an exchange using the `ID` of the
|
||||||
|
item's `RETURN_ITEM` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every item has an `actions` property, whose value is an array of actions.
|
||||||
|
You can check the action's name using its `action` property, and use the
|
||||||
|
value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The exchange's action id.
|
description: The ID of the return item's `RETURN_ITEM` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -106,35 +114,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+5
-2
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdInboundShippingMethod
|
operationId: PostExchangesIdInboundShippingMethod
|
||||||
summary: Add Shipping Methods to Exchange
|
summary: Add an Inbound Shipping Method to an Exchange
|
||||||
description: Add a list of shipping methods to a exchange.
|
x-sidebar-summary: Add Inbound Shipping
|
||||||
|
description: >-
|
||||||
|
Add an inbound (or return) shipping method to an exchange. The inbound
|
||||||
|
shipping method will have a `SHIPPING_ADD` action.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
+11
-32
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdInboundShippingMethodAction_id
|
operationId: PostExchangesIdInboundShippingMethodAction_id
|
||||||
summary: Add Shipping Methods to Exchange
|
summary: Update Inbound Shipping Method of an Exchange
|
||||||
description: Add a list of shipping methods to a exchange.
|
x-sidebar-summary: Update Inbound Shipping
|
||||||
|
description: >
|
||||||
|
Update the shipping method for returning items in the exchange using the
|
||||||
|
`ID` of the method's `SHIPPING_ADD` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every shipping method has an `actions` property, whose value is an array of
|
||||||
|
actions. You can check the action's name using its `action` property, and
|
||||||
|
use the value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The exchange's action id.
|
description: The ID of the shipping method's `SHIPPING_ADD` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +50,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdOutboundItems
|
operationId: PostExchangesIdOutboundItems
|
||||||
summary: Add Items to Exchange
|
summary: Add Outbound Items to Exchange
|
||||||
description: Add a list of items to a exchange.
|
description: >-
|
||||||
|
Add outbound (or new) items to an exchange. These outbound items will have
|
||||||
|
the action `ITEM_ADD`.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +38,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+11
-61
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdOutboundItemsAction_id
|
operationId: PostExchangesIdOutboundItemsAction_id
|
||||||
summary: Add Items to Exchange
|
summary: Update Outbound Item of an Exchange
|
||||||
description: Add a list of items to a exchange.
|
x-sidebar-summary: Update Outbound Item
|
||||||
|
description: >
|
||||||
|
Update an outbound (or new) item from an exchange using the `ID` of the
|
||||||
|
item's `ITEM_ADD` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every item has an `actions` property, whose value is an array of actions.
|
||||||
|
You can check the action's name using its `action` property, and use the
|
||||||
|
value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The exchange's action id.
|
description: The ID of the new exchange item's `ITEM_ADD` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +50,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -160,35 +139,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+5
-31
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdOutboundShippingMethod
|
operationId: PostExchangesIdOutboundShippingMethod
|
||||||
summary: Add Shipping Methods to Exchange
|
summary: Add Outbound Shipping Method to Exchange
|
||||||
description: Add a list of shipping methods to a exchange.
|
x-sidebar-summary: Add Outbound Shipping
|
||||||
|
description: >-
|
||||||
|
Add an outbound shipping method to an exchange. The outbound shipping method
|
||||||
|
will have a `SHIPPING_ADD` action.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+11
-61
@@ -1,7 +1,15 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdOutboundShippingMethodAction_id
|
operationId: PostExchangesIdOutboundShippingMethodAction_id
|
||||||
summary: Add Shipping Methods to Exchange
|
summary: Update Outbound Shipping Method of Exchange
|
||||||
description: Add a list of shipping methods to a exchange.
|
x-sidebar-summary: Update Outbound Shipping
|
||||||
|
description: >
|
||||||
|
Update the shipping method for delivering outbound items in the exchange
|
||||||
|
using the `ID` of the method's `SHIPPING_ADD` action.
|
||||||
|
|
||||||
|
|
||||||
|
Every shipping method has an `actions` property, whose value is an array of
|
||||||
|
actions. You can check the action's name using its `action` property, and
|
||||||
|
use the value of the `id` property.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +20,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: action_id
|
- name: action_id
|
||||||
in: path
|
in: path
|
||||||
description: The exchange's action id.
|
description: The ID of the shipping method's `SHIPPING_ADD` action.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +50,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -160,35 +139,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostExchangesIdRequest
|
operationId: PostExchangesIdRequest
|
||||||
summary: Add Requests to Exchange
|
summary: Confirm an Exchange
|
||||||
description: Add a list of requests to a exchange.
|
description: Confirm an exchange request, applying its changes on the associated order.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +36,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+15
-39
@@ -1,7 +1,8 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostFulfillmentSetsIdServiceZones
|
operationId: PostFulfillmentSetsIdServiceZones
|
||||||
summary: Add Service Zones to Fulfillment Set
|
summary: Add a Service Zone to a Fulfillment Set
|
||||||
description: Add a list of service zones to a fulfillment set.
|
x-sidebar-summary: Add Service Zone
|
||||||
|
description: Add a service zone to a fulfillment set.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +37,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -74,21 +46,21 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The service zone's details.
|
||||||
required:
|
required:
|
||||||
- name
|
- name
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
title: name
|
title: name
|
||||||
description: The fulfillment set's name.
|
description: The service zone's name.
|
||||||
geo_zones:
|
geo_zones:
|
||||||
type: array
|
type: array
|
||||||
description: The fulfillment set's geo zones.
|
description: The service zone's geo zones.
|
||||||
items:
|
items:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A country geo zone.
|
||||||
required:
|
required:
|
||||||
- metadata
|
- metadata
|
||||||
- country_code
|
- country_code
|
||||||
@@ -105,8 +77,9 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: country
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A province geo zone.
|
||||||
required:
|
required:
|
||||||
- metadata
|
- metadata
|
||||||
- country_code
|
- country_code
|
||||||
@@ -124,12 +97,13 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: province
|
||||||
province_code:
|
province_code:
|
||||||
type: string
|
type: string
|
||||||
title: province_code
|
title: province_code
|
||||||
description: The geo zone's province code.
|
description: The geo zone's province code.
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A city geo zone
|
||||||
required:
|
required:
|
||||||
- metadata
|
- metadata
|
||||||
- country_code
|
- country_code
|
||||||
@@ -148,6 +122,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: city
|
||||||
province_code:
|
province_code:
|
||||||
type: string
|
type: string
|
||||||
title: province_code
|
title: province_code
|
||||||
@@ -157,7 +132,7 @@ post:
|
|||||||
title: city
|
title: city
|
||||||
description: The geo zone's city.
|
description: The geo zone's city.
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A ZIP geo zone.
|
||||||
required:
|
required:
|
||||||
- metadata
|
- metadata
|
||||||
- country_code
|
- country_code
|
||||||
@@ -177,6 +152,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: zip
|
||||||
province_code:
|
province_code:
|
||||||
type: string
|
type: string
|
||||||
title: province_code
|
title: province_code
|
||||||
@@ -187,7 +163,7 @@ post:
|
|||||||
description: The geo zone's city.
|
description: The geo zone's city.
|
||||||
postal_expression:
|
postal_expression:
|
||||||
type: object
|
type: object
|
||||||
description: The geo zone's postal expression.
|
description: The geo zone's postal expression or ZIP code.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
+20
-75
@@ -43,35 +43,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -105,8 +76,9 @@ get:
|
|||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
post:
|
post:
|
||||||
operationId: PostFulfillmentSetsIdServiceZonesZone_id
|
operationId: PostFulfillmentSetsIdServiceZonesZone_id
|
||||||
summary: Add Service Zones to Fulfillment Set
|
summary: Update the Service Zone of a Fulfillment Set
|
||||||
description: Add a list of service zones to a fulfillment set.
|
x-sidebar-summary: Update Service Zone
|
||||||
|
description: Update the details of a service zone in a fulfillment set.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -117,7 +89,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: zone_id
|
- name: zone_id
|
||||||
in: path
|
in: path
|
||||||
description: The fulfillment set's zone id.
|
description: The service zone's ID.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -147,35 +119,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -185,21 +128,19 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The service zone's details.
|
||||||
required:
|
|
||||||
- name
|
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
title: name
|
title: name
|
||||||
description: The fulfillment set's name.
|
description: The service zone's name.
|
||||||
geo_zones:
|
geo_zones:
|
||||||
type: array
|
type: array
|
||||||
description: The fulfillment set's geo zones.
|
description: The service zone's associated geo zones.
|
||||||
items:
|
items:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A country geo zone.
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- metadata
|
- metadata
|
||||||
@@ -209,6 +150,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: country
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The geo zone's metadata.
|
description: The geo zone's metadata.
|
||||||
@@ -219,9 +161,9 @@ post:
|
|||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The geo zone's ID.
|
description: The ID of an existing geo zone.
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A province geo zone.
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- metadata
|
- metadata
|
||||||
@@ -232,6 +174,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: province
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The geo zone's metadata.
|
description: The geo zone's metadata.
|
||||||
@@ -246,9 +189,9 @@ post:
|
|||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The geo zone's ID.
|
description: The ID of an existing geo zone.
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A city geo zone
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- metadata
|
- metadata
|
||||||
@@ -260,6 +203,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: city
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The geo zone's metadata.
|
description: The geo zone's metadata.
|
||||||
@@ -278,9 +222,9 @@ post:
|
|||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The geo zone's ID.
|
description: The ID of an existing geo zone.
|
||||||
- type: object
|
- type: object
|
||||||
description: The geo zone's geo zones.
|
description: A ZIP geo zone.
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- metadata
|
- metadata
|
||||||
@@ -293,6 +237,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
title: type
|
title: type
|
||||||
description: The geo zone's type.
|
description: The geo zone's type.
|
||||||
|
default: zip
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The geo zone's metadata.
|
description: The geo zone's metadata.
|
||||||
@@ -310,11 +255,11 @@ post:
|
|||||||
description: The geo zone's province code.
|
description: The geo zone's province code.
|
||||||
postal_expression:
|
postal_expression:
|
||||||
type: object
|
type: object
|
||||||
description: The geo zone's postal expression.
|
description: The geo zone's postal expression or ZIP code.
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: id
|
||||||
description: The geo zone's ID.
|
description: The ID of an existing geo zone.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostFulfillments
|
operationId: PostFulfillments
|
||||||
summary: Create Fulfillment
|
summary: Create Fulfillment
|
||||||
description: Create a fulfillment.
|
description: Create a fulfillment for an order, return, exchange, and more.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
- name: expand
|
||||||
@@ -30,35 +30,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,12 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostFulfillmentsIdCancel
|
operationId: PostFulfillmentsIdCancel
|
||||||
summary: Add Cancels to Fulfillment
|
summary: Cancel a Fulfillment
|
||||||
description: Add a list of cancels to a fulfillment.
|
description: >
|
||||||
|
Cancel a fulfillment. The fulfillment can't be shipped or delivered.
|
||||||
|
|
||||||
|
|
||||||
|
To cancel the fulfillment, the `cancelFulfillment` method of the associated
|
||||||
|
fulfillment provider is used.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +41,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostFulfillmentsIdShipment
|
operationId: PostFulfillmentsIdShipment
|
||||||
summary: Add Shipments to Fulfillment
|
summary: Create a Shipment for a Fulfillment
|
||||||
description: Add a list of shipments to a fulfillment.
|
x-sidebar-summary: Create Shipment
|
||||||
|
description: >-
|
||||||
|
Create a shipment for a fulfillment. The fulfillment must not be shipped or
|
||||||
|
canceled.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +39,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -496,7 +496,7 @@ get:
|
|||||||
post:
|
post:
|
||||||
operationId: PostInventoryItems
|
operationId: PostInventoryItems
|
||||||
summary: Create Inventory Item
|
summary: Create Inventory Item
|
||||||
description: Create a inventory item.
|
description: Create an inventory item.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: expand
|
- name: expand
|
||||||
@@ -525,35 +525,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -99,8 +70,8 @@ get:
|
|||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
post:
|
post:
|
||||||
operationId: PostInventoryItemsId
|
operationId: PostInventoryItemsId
|
||||||
summary: Update a Inventory Item
|
summary: Update an Inventory Item
|
||||||
description: Update a inventory item's details.
|
description: Update an inventory item's details.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -135,35 +106,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -173,30 +115,16 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The properties to update in the inventory item.
|
||||||
required:
|
|
||||||
- sku
|
|
||||||
- hs_code
|
|
||||||
- weight
|
|
||||||
- length
|
|
||||||
- height
|
|
||||||
- width
|
|
||||||
- origin_country
|
|
||||||
- mid_code
|
|
||||||
- material
|
|
||||||
- title
|
|
||||||
- description
|
|
||||||
- thumbnail
|
|
||||||
- metadata
|
|
||||||
properties:
|
properties:
|
||||||
sku:
|
sku:
|
||||||
type: string
|
type: string
|
||||||
title: sku
|
title: sku
|
||||||
description: The inventory item's sku.
|
description: The inventory item's SKU.
|
||||||
hs_code:
|
hs_code:
|
||||||
type: string
|
type: string
|
||||||
title: hs_code
|
title: hs_code
|
||||||
description: The inventory item's hs code.
|
description: The inventory item's HS code.
|
||||||
weight:
|
weight:
|
||||||
type: number
|
type: number
|
||||||
title: weight
|
title: weight
|
||||||
@@ -220,7 +148,7 @@ post:
|
|||||||
mid_code:
|
mid_code:
|
||||||
type: string
|
type: string
|
||||||
title: mid_code
|
title: mid_code
|
||||||
description: The inventory item's mid code.
|
description: The inventory item's MID code.
|
||||||
material:
|
material:
|
||||||
type: string
|
type: string
|
||||||
title: material
|
title: material
|
||||||
@@ -236,14 +164,19 @@ post:
|
|||||||
requires_shipping:
|
requires_shipping:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: requires_shipping
|
title: requires_shipping
|
||||||
description: The inventory item's requires shipping.
|
description: Whether the inventory item requires shipping.
|
||||||
thumbnail:
|
thumbnail:
|
||||||
type: string
|
type: string
|
||||||
title: thumbnail
|
title: thumbnail
|
||||||
description: The inventory item's thumbnail.
|
description: >-
|
||||||
|
The URL of an image to be used as the inventory item's
|
||||||
|
thumbnail. You can use the Upload API routes to upload an image
|
||||||
|
and get its URL.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The inventory item's metadata.
|
description: >-
|
||||||
|
The inventory item's metadata. Can be custom data in key-value
|
||||||
|
pairs.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
+7
-35
@@ -166,8 +166,9 @@ get:
|
|||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
post:
|
post:
|
||||||
operationId: PostInventoryItemsIdLocationLevels
|
operationId: PostInventoryItemsIdLocationLevels
|
||||||
summary: Add Location Levels to Inventory Item
|
summary: Create Inventory Level for Inventory Item
|
||||||
description: Add a list of location levels to a inventory item.
|
x-sidebar-summary: Create Inventory Level
|
||||||
|
description: Create an inventory level for an inventory item.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -202,35 +203,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -240,22 +212,22 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The inventory level's details.
|
||||||
required:
|
required:
|
||||||
- location_id
|
- location_id
|
||||||
properties:
|
properties:
|
||||||
location_id:
|
location_id:
|
||||||
type: string
|
type: string
|
||||||
title: location_id
|
title: location_id
|
||||||
description: The inventory item's location id.
|
description: The ID of the associated location.
|
||||||
stocked_quantity:
|
stocked_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: stocked_quantity
|
title: stocked_quantity
|
||||||
description: The inventory item's stocked quantity.
|
description: The inventory level's stocked quantity.
|
||||||
incoming_quantity:
|
incoming_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: incoming_quantity
|
title: incoming_quantity
|
||||||
description: The inventory item's incoming quantity.
|
description: The inventory level's incoming quantity.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
+16
-15
@@ -1,7 +1,8 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostInventoryItemsIdLocationLevelsBatch
|
operationId: PostInventoryItemsIdLocationLevelsBatch
|
||||||
summary: Add Location Levels to Inventory Item
|
summary: Manage Inventory Levels of Inventory Item
|
||||||
description: Add a list of location levels to a inventory item.
|
x-sidebar-summary: Manage Inventory Levels
|
||||||
|
description: Manage the inventory levels of an inventory item to create or delete them.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -19,51 +20,51 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The inventory levels to create or delete.
|
||||||
properties:
|
properties:
|
||||||
create:
|
create:
|
||||||
type: array
|
type: array
|
||||||
description: The inventory item's create.
|
description: The inventory levels to create.
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
description: The create's details.
|
description: The inventory level's details.
|
||||||
required:
|
required:
|
||||||
- location_id
|
- location_id
|
||||||
properties:
|
properties:
|
||||||
location_id:
|
location_id:
|
||||||
type: string
|
type: string
|
||||||
title: location_id
|
title: location_id
|
||||||
description: The create's location id.
|
description: The ID of the associated location.
|
||||||
stocked_quantity:
|
stocked_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: stocked_quantity
|
title: stocked_quantity
|
||||||
description: The create's stocked quantity.
|
description: The inventory level's stocked quantity.
|
||||||
incoming_quantity:
|
incoming_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: incoming_quantity
|
title: incoming_quantity
|
||||||
description: The create's incoming quantity.
|
description: The inventory level's incoming quantity.
|
||||||
update:
|
update:
|
||||||
type: array
|
type: array
|
||||||
description: The inventory item's update.
|
description: The inventory levels to update.
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
description: The update's details.
|
description: The inventory level's details.
|
||||||
properties:
|
properties:
|
||||||
stocked_quantity:
|
stocked_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: stocked_quantity
|
title: stocked_quantity
|
||||||
description: The update's stocked quantity.
|
description: The inventory level's stocked quantity.
|
||||||
incoming_quantity:
|
incoming_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: incoming_quantity
|
title: incoming_quantity
|
||||||
description: The update's incoming quantity.
|
description: The inventory level's incoming quantity.
|
||||||
delete:
|
delete:
|
||||||
type: array
|
type: array
|
||||||
description: The inventory item's delete.
|
description: The inventory levels to delete.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
title: delete
|
title: delete
|
||||||
description: The delete's details.
|
description: The ID of the inventory level to delete.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
@@ -79,7 +80,7 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The inventory item's details.
|
||||||
required:
|
required:
|
||||||
- inventory_item
|
- inventory_item
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
+9
-64
@@ -1,7 +1,10 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostInventoryItemsIdLocationLevelsLocation_id
|
operationId: PostInventoryItemsIdLocationLevelsLocation_id
|
||||||
summary: Add Location Levels to Inventory Item
|
summary: Update an Inventory Level of an Inventory Item
|
||||||
description: Add a list of location levels to a inventory item.
|
x-sidebar-summary: Update Inventory Level
|
||||||
|
description: >-
|
||||||
|
Updates the details of an inventory item's inventory level using its
|
||||||
|
associated location ID.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -12,7 +15,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
- name: location_id
|
- name: location_id
|
||||||
in: path
|
in: path
|
||||||
description: The inventory item's location id.
|
description: The ID of the location associated with the inventory level.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@@ -42,35 +45,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
@@ -80,16 +54,16 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The properties to update in the inventory level.
|
||||||
properties:
|
properties:
|
||||||
stocked_quantity:
|
stocked_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: stocked_quantity
|
title: stocked_quantity
|
||||||
description: The inventory item's stocked quantity.
|
description: The inventory level's stocked quantity.
|
||||||
incoming_quantity:
|
incoming_quantity:
|
||||||
type: number
|
type: number
|
||||||
title: incoming_quantity
|
title: incoming_quantity
|
||||||
description: The inventory item's incoming quantity.
|
description: The inventory level's incoming quantity.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
@@ -168,35 +142,6 @@ delete:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -625,52 +625,23 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The invite's details.
|
||||||
required:
|
required:
|
||||||
- email
|
- email
|
||||||
properties:
|
properties:
|
||||||
email:
|
email:
|
||||||
type: string
|
type: string
|
||||||
title: email
|
title: email
|
||||||
description: The invite's email.
|
description: The email of the user to invite.
|
||||||
format: email
|
format: email
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The invite's metadata.
|
description: The invite's metadata. Can be custom data in key-value pairs.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -1,88 +1,34 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostInvitesAccept
|
operationId: PostInvitesAccept
|
||||||
summary: Create Invite
|
summary: Accept Invite
|
||||||
description: Create a invite.
|
description: >
|
||||||
|
Accept an invite and create a new user.
|
||||||
|
|
||||||
|
Since the user isn't created yet, the JWT token used in the authorization
|
||||||
|
header is retrieved from the `/auth/user/emailpass/register` API route (or a
|
||||||
|
provider other than `emailpass`). The user can then authenticate using the
|
||||||
|
`/auth/user/emailpass` API route.
|
||||||
x-authenticated: false
|
x-authenticated: false
|
||||||
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
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
Comma-separated fields that should be included in the returned data. if
|
|
||||||
a field is prefixed with `+` it will be added to the default fields,
|
|
||||||
using `-` will remove it from the default fields. without prefix it will
|
|
||||||
replace the entire default fields.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: fields
|
|
||||||
description: >-
|
|
||||||
Comma-separated fields that should be included in the returned data.
|
|
||||||
if a field is prefixed with `+` it will be added to the default
|
|
||||||
fields, using `-` will remove it from the default fields. without
|
|
||||||
prefix it will replace the entire default fields.
|
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: The details of the user to be created.
|
||||||
required:
|
|
||||||
- email
|
|
||||||
- first_name
|
|
||||||
- last_name
|
|
||||||
properties:
|
properties:
|
||||||
email:
|
email:
|
||||||
type: string
|
type: string
|
||||||
title: email
|
title: email
|
||||||
description: The invite's email.
|
description: The user's email.
|
||||||
format: email
|
format: email
|
||||||
first_name:
|
first_name:
|
||||||
type: string
|
type: string
|
||||||
title: first_name
|
title: first_name
|
||||||
description: The invite's first name.
|
description: The user's first name.
|
||||||
last_name:
|
last_name:
|
||||||
type: string
|
type: string
|
||||||
title: last_name
|
title: last_name
|
||||||
description: The invite's last name.
|
description: The user's last name.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
@@ -98,21 +44,21 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: The created user's details.
|
||||||
required:
|
required:
|
||||||
- user
|
- user
|
||||||
properties:
|
properties:
|
||||||
user:
|
user:
|
||||||
$ref: ../components/schemas/AdminUser.yaml
|
$ref: ../components/schemas/AdminUser.yaml
|
||||||
- type: object
|
- type: object
|
||||||
description: SUMMARY
|
description: An error's details.
|
||||||
required:
|
required:
|
||||||
- message
|
- message
|
||||||
properties:
|
properties:
|
||||||
message:
|
message:
|
||||||
type: string
|
type: string
|
||||||
title: message
|
title: message
|
||||||
description: The invite's message.
|
description: The error message.
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostInvitesIdResend
|
operationId: PostInvitesIdResend
|
||||||
summary: Add Resends to Invite
|
summary: Refresh Invite Token
|
||||||
description: Add a list of resends to a invite.
|
description: Refresh the token of an invite.
|
||||||
x-authenticated: false
|
x-authenticated: false
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -36,35 +36,6 @@ post:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
|
|||||||
@@ -38,35 +38,6 @@ get:
|
|||||||
if a field is prefixed with `+` it will be added to the default
|
if a field is prefixed with `+` it will be added to the default
|
||||||
fields, using `-` will remove it from the default fields. without
|
fields, using `-` will remove it from the default fields. without
|
||||||
prefix it will replace the entire default fields.
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: offset
|
|
||||||
description: The number of items to skip when retrieving a list.
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
title: limit
|
|
||||||
description: Limit the number of items returned in the list.
|
|
||||||
- name: order
|
|
||||||
in: query
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is ascending.
|
|
||||||
To change the order to descending, prefix the field name with `-`.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
title: order
|
|
||||||
description: >-
|
|
||||||
The field to sort the data by. By default, the sort order is
|
|
||||||
ascending. To change the order to descending, prefix the field name
|
|
||||||
with `-`.
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostOrderEdits
|
operationId: PostOrderEdits
|
||||||
summary: Create Order Edit
|
summary: Create Order Edit
|
||||||
description: Create a order edit.
|
description: Create an order edit.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters: []
|
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostOrderEditsIdConfirm
|
operationId: PostOrderEditsIdConfirm
|
||||||
summary: Add Confirms to Order Edit
|
summary: Confirm Order Edit
|
||||||
description: Add a list of confirms to a order edit.
|
description: Confirm an order edit request and apply the changes on the order.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -41,7 +41,3 @@ post:
|
|||||||
'500':
|
'500':
|
||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
x-workflow: confirmOrderEditRequestWorkflow
|
x-workflow: confirmOrderEditRequestWorkflow
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema: {}
|
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostOrderEditsIdItems
|
operationId: PostOrderEditsIdItems
|
||||||
summary: Add Items to Order Edit
|
summary: Add Items to Order Edit
|
||||||
description: Add a list of items to a order edit.
|
x-sidebar-summary: Add Items
|
||||||
|
description: Add new items to an order edit. These items will have the action `ITEM_ADD`.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
+3
-2
@@ -1,7 +1,8 @@
|
|||||||
post:
|
post:
|
||||||
operationId: PostOrderEditsIdItemsItemItem_id
|
operationId: PostOrderEditsIdItemsItemItem_id
|
||||||
summary: Add Items to Order Edit
|
summary: Update Order Item Quantity of Order Edit
|
||||||
description: Add a list of items to a order edit.
|
x-sidebar-summary: Update Item Quantity
|
||||||
|
description: Update an existing order item's quantity of an order edit.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
Loaded 100 of 534 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user