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

chore(docs): Generated API Reference (v2) (#8643)

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-18 16:55:04 +02:00
committed by GitHub
parent fb0644b8f6
commit 46310e32d0
83 changed files with 5312 additions and 19940 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml
+73 -54
View File
@@ -189,64 +189,83 @@ post:
content:
application/json:
schema:
description: SUMMARY
properties:
name:
type: string
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
allOf:
- type: object
description: SUMMARY
required:
- type
- limit
- currency_code
- name
- campaign_identifier
- description
- budget
- starts_at
- ends_at
properties:
type:
name:
type: string
enum:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
currency_code:
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: currency_code
description: The budget's currency code.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
required:
- type
- limit
- currency_code
properties:
type:
type: string
enum:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
currency_code:
type: string
title: currency_code
description: The budget's currency code.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml
+61 -45
View File
@@ -172,53 +172,69 @@ post:
content:
application/json:
schema:
description: SUMMARY
properties:
name:
type: string
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
allOf:
- type: object
description: SUMMARY
required:
- limit
- description
- starts_at
- ends_at
properties:
limit:
type: number
title: limit
description: The budget's limit.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
name:
type: string
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
required:
- limit
properties:
limit:
type: number
title: limit
description: The budget's limit.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
+44 -25
View File
@@ -186,32 +186,51 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- email
- company_name
- first_name
- last_name
- phone
- metadata
properties:
email:
type: string
title: email
description: The customer's email.
format: email
company_name:
type: string
title: company_name
description: The customer's company name.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
email:
type: string
title: email
description: The customer's email.
format: email
company_name:
type: string
title: company_name
description: The customer's company name.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml
+44 -25
View File
@@ -172,32 +172,51 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- email
- company_name
- first_name
- last_name
- phone
- metadata
properties:
email:
type: string
title: email
description: The customer's email.
format: email
company_name:
type: string
title: company_name
description: The customer's company name.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
email:
type: string
title: email
description: The customer's email.
format: email
company_name:
type: string
title: company_name
description: The customer's company name.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml
+81 -56
View File
@@ -201,63 +201,88 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- address_name
- company
- first_name
- last_name
- address_1
- address_2
- city
- country_code
- province
- postal_code
- phone
- metadata
properties:
address_name:
type: string
title: address_name
description: The customer's address name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: The customer's is default shipping.
is_default_billing:
type: boolean
title: is_default_billing
description: The customer's is default billing.
company:
type: string
title: company
description: The customer's company.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
address_1:
type: string
title: address_1
description: The customer's address 1.
address_2:
type: string
title: address_2
description: The customer's address 2.
city:
type: string
title: city
description: The customer's city.
country_code:
type: string
title: country_code
description: The customer's country code.
province:
type: string
title: province
description: The customer's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
address_name:
type: string
title: address_name
description: The customer's address name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: The customer's is default shipping.
is_default_billing:
type: boolean
title: is_default_billing
description: The customer's is default billing.
company:
type: string
title: company
description: The customer's company.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
address_1:
type: string
title: address_1
description: The customer's address 1.
address_2:
type: string
title: address_2
description: The customer's address 2.
city:
type: string
title: city
description: The customer's city.
country_code:
type: string
title: country_code
description: The customer's country code.
province:
type: string
title: province
description: The customer's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml
+81 -56
View File
@@ -185,63 +185,88 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- address_name
- company
- first_name
- last_name
- address_1
- address_2
- city
- country_code
- province
- postal_code
- phone
- metadata
properties:
address_name:
type: string
title: address_name
description: The customer's address name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: The customer's is default shipping.
is_default_billing:
type: boolean
title: is_default_billing
description: The customer's is default billing.
company:
type: string
title: company
description: The customer's company.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
address_1:
type: string
title: address_1
description: The customer's address 1.
address_2:
type: string
title: address_2
description: The customer's address 2.
city:
type: string
title: city
description: The customer's city.
country_code:
type: string
title: country_code
description: The customer's country code.
province:
type: string
title: province
description: The customer's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
address_name:
type: string
title: address_name
description: The customer's address name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: The customer's is default shipping.
is_default_billing:
type: boolean
title: is_default_billing
description: The customer's is default billing.
company:
type: string
title: company
description: The customer's company.
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
address_1:
type: string
title: address_1
description: The customer's address 1.
address_2:
type: string
title: address_2
description: The customer's address 2.
city:
type: string
title: city
description: The customer's city.
country_code:
type: string
title: country_code
description: The customer's country code.
province:
type: string
title: province
description: The customer's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
phone:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml
+292 -272
View File
@@ -186,279 +186,299 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- sales_channel_id
- email
- customer_id
- region_id
- currency_code
- shipping_methods
- metadata
properties:
status:
type: boolean
title: status
description: The draft order's status.
sales_channel_id:
type: string
title: sales_channel_id
description: The draft order's sales channel id.
email:
type: string
title: email
description: The draft order's email.
format: email
customer_id:
type: string
title: customer_id
description: The draft order's customer id.
billing_address:
type: object
description: The draft order's billing address.
required:
- first_name
- last_name
- phone
- company
- address_1
- address_2
- city
- country_code
- province
- postal_code
- metadata
properties:
first_name:
type: string
title: first_name
description: The billing address's first name.
last_name:
type: string
title: last_name
description: The billing address's last name.
phone:
type: string
title: phone
description: The billing address's phone.
company:
type: string
title: company
description: The billing address's company.
address_1:
type: string
title: address_1
description: The billing address's address 1.
address_2:
type: string
title: address_2
description: The billing address's address 2.
city:
type: string
title: city
description: The billing address's city.
country_code:
type: string
title: country_code
description: The billing address's country code.
province:
type: string
title: province
description: The billing address's province.
postal_code:
type: string
title: postal_code
description: The billing address's postal code.
metadata:
type: object
description: The billing address's metadata.
shipping_address:
type: object
description: The draft order's shipping address.
required:
- first_name
- last_name
- phone
- company
- address_1
- address_2
- city
- country_code
- province
- postal_code
- metadata
properties:
first_name:
type: string
title: first_name
description: The shipping address's first name.
last_name:
type: string
title: last_name
description: The shipping address's last name.
phone:
type: string
title: phone
description: The shipping address's phone.
company:
type: string
title: company
description: The shipping address's company.
address_1:
type: string
title: address_1
description: The shipping address's address 1.
address_2:
type: string
title: address_2
description: The shipping address's address 2.
city:
type: string
title: city
description: The shipping address's city.
country_code:
type: string
title: country_code
description: The shipping address's country code.
province:
type: string
title: province
description: The shipping address's province.
postal_code:
type: string
title: postal_code
description: The shipping address's postal code.
metadata:
type: object
description: The shipping address's metadata.
items:
type: array
description: The draft order's items.
items:
type: object
description: The item's items.
required:
- title
- sku
- barcode
- variant_id
- unit_price
- quantity
- metadata
properties:
title:
type: string
title: title
description: The item's title.
sku:
type: string
title: sku
description: The item's sku.
barcode:
type: string
title: barcode
description: The item's barcode.
variant_id:
type: string
title: variant_id
description: The item's variant id.
unit_price:
oneOf:
- type: string
title: unit_price
description: The item's unit price.
- type: number
title: unit_price
description: The item's unit price.
- type: object
description: The item's unit price.
required:
- value
- precision
properties:
value:
type: string
title: value
description: The unit price's value.
precision:
type: number
title: precision
description: The unit price's precision.
quantity:
type: number
title: quantity
description: The item's quantity.
metadata:
type: object
description: The item's metadata.
region_id:
type: string
title: region_id
description: The draft order's region id.
promo_codes:
type: array
description: The draft order's promo codes.
items:
type: string
title: promo_codes
description: The promo code's promo codes.
currency_code:
type: string
title: currency_code
description: The draft order's currency code.
no_notification_order:
type: boolean
title: no_notification_order
description: The draft order's no notification order.
shipping_methods:
type: array
description: The draft order's shipping methods.
items:
type: object
description: The shipping method's shipping methods.
required:
- shipping_method_id
- order_id
- name
- option_id
- amount
properties:
shipping_method_id:
type: string
title: shipping_method_id
description: The shipping method's shipping method id.
order_id:
type: string
title: order_id
description: The shipping method's order id.
name:
type: string
title: name
description: The shipping method's name.
option_id:
type: string
title: option_id
description: The shipping method's option id.
data:
type: object
description: The shipping method's data.
amount:
oneOf:
- type: string
title: amount
description: The shipping method's amount.
- type: number
title: amount
description: The shipping method's amount.
- type: object
description: The shipping method's amount.
required:
- value
- precision
properties:
value:
type: string
title: value
description: The amount's value.
precision:
type: number
title: precision
description: The amount's precision.
metadata:
type: object
description: The draft order's metadata.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
status:
type: boolean
title: status
description: The draft order's status.
sales_channel_id:
type: string
title: sales_channel_id
description: The draft order's sales channel id.
email:
type: string
title: email
description: The draft order's email.
format: email
customer_id:
type: string
title: customer_id
description: The draft order's customer id.
billing_address:
type: object
description: The draft order's billing address.
required:
- first_name
- last_name
- phone
- company
- address_1
- address_2
- city
- country_code
- province
- postal_code
- metadata
properties:
first_name:
type: string
title: first_name
description: The billing address's first name.
last_name:
type: string
title: last_name
description: The billing address's last name.
phone:
type: string
title: phone
description: The billing address's phone.
company:
type: string
title: company
description: The billing address's company.
address_1:
type: string
title: address_1
description: The billing address's address 1.
address_2:
type: string
title: address_2
description: The billing address's address 2.
city:
type: string
title: city
description: The billing address's city.
country_code:
type: string
title: country_code
description: The billing address's country code.
province:
type: string
title: province
description: The billing address's province.
postal_code:
type: string
title: postal_code
description: The billing address's postal code.
metadata:
type: object
description: The billing address's metadata.
shipping_address:
type: object
description: The draft order's shipping address.
required:
- first_name
- last_name
- phone
- company
- address_1
- address_2
- city
- country_code
- province
- postal_code
- metadata
properties:
first_name:
type: string
title: first_name
description: The shipping address's first name.
last_name:
type: string
title: last_name
description: The shipping address's last name.
phone:
type: string
title: phone
description: The shipping address's phone.
company:
type: string
title: company
description: The shipping address's company.
address_1:
type: string
title: address_1
description: The shipping address's address 1.
address_2:
type: string
title: address_2
description: The shipping address's address 2.
city:
type: string
title: city
description: The shipping address's city.
country_code:
type: string
title: country_code
description: The shipping address's country code.
province:
type: string
title: province
description: The shipping address's province.
postal_code:
type: string
title: postal_code
description: The shipping address's postal code.
metadata:
type: object
description: The shipping address's metadata.
items:
type: array
description: The draft order's items.
items:
type: object
description: The item's items.
required:
- title
- sku
- barcode
- variant_id
- unit_price
- quantity
- metadata
properties:
title:
type: string
title: title
description: The item's title.
sku:
type: string
title: sku
description: The item's sku.
barcode:
type: string
title: barcode
description: The item's barcode.
variant_id:
type: string
title: variant_id
description: The item's variant id.
unit_price:
oneOf:
- type: string
title: unit_price
description: The item's unit price.
- type: number
title: unit_price
description: The item's unit price.
- type: object
description: The item's unit price.
required:
- value
- precision
properties:
value:
type: string
title: value
description: The unit price's value.
precision:
type: number
title: precision
description: The unit price's precision.
quantity:
type: number
title: quantity
description: The item's quantity.
metadata:
type: object
description: The item's metadata.
region_id:
type: string
title: region_id
description: The draft order's region id.
promo_codes:
type: array
description: The draft order's promo codes.
items:
type: string
title: promo_codes
description: The promo code's promo codes.
currency_code:
type: string
title: currency_code
description: The draft order's currency code.
no_notification_order:
type: boolean
title: no_notification_order
description: The draft order's no notification order.
shipping_methods:
type: array
description: The draft order's shipping methods.
items:
type: object
description: The shipping method's shipping methods.
required:
- shipping_method_id
- order_id
- name
- option_id
- amount
properties:
shipping_method_id:
type: string
title: shipping_method_id
description: The shipping method's shipping method id.
order_id:
type: string
title: order_id
description: The shipping method's order id.
name:
type: string
title: name
description: The shipping method's name.
option_id:
type: string
title: option_id
description: The shipping method's option id.
data:
type: object
description: The shipping method's data.
amount:
oneOf:
- type: string
title: amount
description: The shipping method's amount.
- type: number
title: amount
description: The shipping method's amount.
- type: object
description: The shipping method's amount.
required:
- value
- precision
properties:
value:
type: string
title: value
description: The amount's value.
precision:
type: number
title: precision
description: The amount's precision.
metadata:
type: object
description: The draft order's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml
+9 -7
View File
@@ -24,18 +24,20 @@ get:
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.
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: |-
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.
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.
www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml
+9 -7
View File
@@ -16,18 +16,20 @@ post:
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.
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: |-
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.
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.
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml
+9 -7
View File
@@ -22,18 +22,20 @@ delete:
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.
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: |-
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.
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.
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml
+13 -7
View File
@@ -22,18 +22,20 @@ post:
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.
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: |-
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.
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.
@@ -94,3 +96,7 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: confirmOrderEditRequestWorkflow
requestBody:
content:
application/json:
schema: {}
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml
+9 -7
View File
@@ -22,18 +22,20 @@ post:
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.
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: |-
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.
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.
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml
+18 -14
View File
@@ -28,18 +28,20 @@ post:
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.
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: |-
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.
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.
@@ -137,18 +139,20 @@ delete:
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.
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: |-
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.
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.
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml
+9 -7
View File
@@ -22,18 +22,20 @@ post:
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.
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: |-
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.
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.
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml
+18 -14
View File
@@ -28,18 +28,20 @@ post:
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.
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: |-
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.
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.
@@ -140,18 +142,20 @@ delete:
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.
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: |-
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.
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.
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml
+19 -5
View File
@@ -73,12 +73,26 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- order_id
properties:
order_id:
type: string
title: order_id
description: The order's order id.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
order_id:
type: string
title: order_id
description: The order's order id.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml
+46 -30
View File
@@ -73,37 +73,53 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- items
- location_id
- metadata
properties:
items:
type: array
description: The order's items.
items:
type: object
description: The item's items.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
location_id:
type: string
title: location_id
description: The order's location id.
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
metadata:
type: object
description: The order's metadata.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
items:
type: array
description: The order's items.
items:
type: object
description: The item's items.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
location_id:
type: string
title: location_id
description: The order's location id.
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
metadata:
type: object
description: The order's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+17 -5
View File
@@ -79,12 +79,24 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
properties:
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml
+64 -49
View File
@@ -79,56 +79,71 @@ post:
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- items
- metadata
properties:
items:
type: array
description: The order's items.
items:
type: object
description: The item's items.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
labels:
type: array
description: The order's labels.
items:
type: object
description: The label's labels.
required:
- tracking_number
- tracking_url
- label_url
properties:
tracking_number:
type: string
title: tracking_number
description: The label's tracking number.
tracking_url:
type: string
title: tracking_url
description: The label's tracking url.
label_url:
type: string
title: label_url
description: The label's label url.
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
metadata:
type: object
description: The order's metadata.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
items:
type: array
description: The order's items.
items:
type: object
description: The item's items.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
labels:
type: array
description: The order's labels.
items:
type: object
description: The label's labels.
required:
- tracking_number
- tracking_url
- label_url
properties:
tracking_number:
type: string
title: tracking_number
description: The label's tracking number.
tracking_url:
type: string
title: tracking_url
description: The label's tracking url.
label_url:
type: string
title: label_url
description: The label's label url.
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
metadata:
type: object
description: The order's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml
+107
View File
@@ -0,0 +1,107 @@
post:
operationId: PostPaymentCollections
summary: Create Payment Collection
description: Create a payment collection.
x-authenticated: true
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 `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
type: object
description: SUMMARY
required:
- order_id
properties:
order_id:
type: string
title: order_id
description: The payment collection's order id.
amount:
type: number
title: amount
description: The payment collection's amount.
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_payment-collections/post.sh
tags:
- Payment Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPaymentCollectionResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createOrderPaymentCollectionWorkflow
www/apps/api-reference/specs/admin/paths/admin_products.yaml
+13 -3953
View File
File diff suppressed because it is too large Load Diff
www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml
+11 -143
View File
@@ -172,150 +172,18 @@ post:
content:
application/json:
schema:
allOf:
- $ref: ../components/schemas/AdminUpdateProduct.yaml
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
title:
type: string
title: title
description: The product's title.
subtitle:
type: string
title: subtitle
description: The product's subtitle.
description:
type: string
title: description
description: The product's description.
is_giftcard:
type: boolean
title: is_giftcard
description: The product's is giftcard.
discountable:
type: boolean
title: discountable
description: The product's discountable.
images:
type: array
description: The product's images.
items:
type: object
description: The image's images.
required:
- url
properties:
url:
type: string
title: url
description: The image's url.
thumbnail:
type: string
title: thumbnail
description: The product's thumbnail.
handle:
type: string
title: handle
description: The product's handle.
status:
type: string
enum:
- draft
- proposed
- published
- rejected
type_id:
type: string
title: type_id
description: The product's type id.
collection_id:
type: string
title: collection_id
description: The product's collection id.
categories:
type: array
description: The product's categories.
items:
type: object
description: The category's categories.
required:
- id
properties:
id:
type: string
title: id
description: The category's ID.
tags:
type: array
description: The product's tags.
items:
type: object
description: The tag's tags.
required:
- id
properties:
id:
type: string
title: id
description: The tag's ID.
options:
type: array
description: The product's options.
items:
$ref: ../components/schemas/AdminUpdateProductOption.yaml
variants:
type: array
description: The product's variants.
items:
oneOf:
- $ref: ../components/schemas/AdminCreateProductVariant.yaml
- $ref: ../components/schemas/AdminUpdateProductVariant.yaml
sales_channels:
type: array
description: The product's sales channels.
items:
type: object
description: The sales channel's sales channels.
required:
- id
properties:
id:
type: string
title: id
description: The sales channel's ID.
weight:
type: number
title: weight
description: The product's weight.
length:
type: number
title: length
description: The product's length.
height:
type: number
title: height
description: The product's height.
width:
type: number
title: width
description: The product's width.
hs_code:
type: string
title: hs_code
description: The product's hs code.
mid_code:
type: string
title: mid_code
description: The product's mid code.
origin_country:
type: string
title: origin_country
description: The product's origin country.
material:
type: string
title: material
description: The product's material.
metadata:
type: object
description: The product's metadata.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml
+13 -974
View File
File diff suppressed because it is too large Load Diff
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml
+11 -12
View File
@@ -184,19 +184,18 @@ post:
content:
application/json:
schema:
allOf:
- $ref: ../components/schemas/AdminUpdateProductOption.yaml
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
title:
type: string
title: title
description: The product's title.
values:
type: array
description: The product's values.
items:
type: string
title: values
description: The value's values.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml
+11 -76
View File
@@ -201,83 +201,18 @@ post:
content:
application/json:
schema:
allOf:
- $ref: ../components/schemas/AdminCreateProductVariant.yaml
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
title:
type: string
title: title
description: The product's title.
sku:
type: string
title: sku
description: The product's sku.
ean:
type: string
title: ean
description: The product's ean.
upc:
type: string
title: upc
description: The product's upc.
barcode:
type: string
title: barcode
description: The product's barcode.
hs_code:
type: string
title: hs_code
description: The product's hs code.
mid_code:
type: string
title: mid_code
description: The product's mid code.
allow_backorder:
type: boolean
title: allow_backorder
description: The product's allow backorder.
manage_inventory:
type: boolean
title: manage_inventory
description: The product's manage inventory.
variant_rank:
type: number
title: variant_rank
description: The product's variant rank.
weight:
type: number
title: weight
description: The product's weight.
length:
type: number
title: length
description: The product's length.
height:
type: number
title: height
description: The product's height.
width:
type: number
title: width
description: The product's width.
origin_country:
type: string
title: origin_country
description: The product's origin country.
material:
type: string
title: material
description: The product's material.
metadata:
type: object
description: The product's metadata.
prices:
type: array
description: The product's prices.
items:
$ref: ../components/schemas/AdminCreateProductVariantPrice.yaml
options:
type: object
description: The product's options.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml
+11 -76
View File
@@ -184,83 +184,18 @@ post:
content:
application/json:
schema:
allOf:
- $ref: ../components/schemas/AdminUpdateProductVariant.yaml
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
properties:
title:
type: string
title: title
description: The product's title.
sku:
type: string
title: sku
description: The product's sku.
ean:
type: string
title: ean
description: The product's ean.
upc:
type: string
title: upc
description: The product's upc.
barcode:
type: string
title: barcode
description: The product's barcode.
hs_code:
type: string
title: hs_code
description: The product's hs code.
mid_code:
type: string
title: mid_code
description: The product's mid code.
allow_backorder:
type: boolean
title: allow_backorder
description: The product's allow backorder.
manage_inventory:
type: boolean
title: manage_inventory
description: The product's manage inventory.
variant_rank:
type: number
title: variant_rank
description: The product's variant rank.
weight:
type: number
title: weight
description: The product's weight.
length:
type: number
title: length
description: The product's length.
height:
type: number
title: height
description: The product's height.
width:
type: number
title: width
description: The product's width.
origin_country:
type: string
title: origin_country
description: The product's origin country.
material:
type: string
title: material
description: The product's material.
metadata:
type: object
description: The product's metadata.
prices:
type: array
description: The product's prices.
items:
$ref: ../components/schemas/AdminCreateProductVariantPrice.yaml
options:
type: object
description: The product's options.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_promotions.yaml
+270 -253
View File
@@ -364,268 +364,285 @@ post:
content:
application/json:
schema:
description: SUMMARY
properties:
code:
type: string
title: code
description: The promotion's code.
is_automatic:
type: boolean
title: is_automatic
description: The promotion's is automatic.
type:
type: string
enum:
- standard
- buyget
campaign_id:
type: string
title: campaign_id
description: The promotion's campaign id.
campaign:
type: object
description: The promotion's campaign.
allOf:
- type: object
description: SUMMARY
required:
- name
- campaign_identifier
- description
- budget
- starts_at
- ends_at
properties:
name:
type: string
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
required:
- type
- limit
- currency_code
properties:
type:
type: string
enum:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
currency_code:
type: string
title: currency_code
description: The budget's currency code.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
application_method:
type: object
description: The promotion's application method.
required:
- description
- value
- currency_code
- max_quantity
- code
- type
- target_type
- apply_to_quantity
- buy_rules_min_quantity
- campaign_id
- application_method
properties:
description:
code:
type: string
title: description
description: The application method's description.
value:
type: number
title: value
description: The application method's value.
currency_code:
type: string
title: currency_code
description: The application method's currency code.
max_quantity:
type: number
title: max_quantity
description: The application method's max quantity.
title: code
description: The promotion's code.
is_automatic:
type: boolean
title: is_automatic
description: The promotion's is automatic.
type:
type: string
enum:
- fixed
- percentage
target_type:
- standard
- buyget
campaign_id:
type: string
enum:
- order
- shipping_methods
- items
allocation:
type: string
enum:
- each
- across
target_rules:
type: array
description: The application method's target rules.
items:
type: object
description: The target rule's target rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The target rule's description.
attribute:
type: string
title: attribute
description: The target rule's attribute.
values:
oneOf:
- type: string
title: values
description: The target rule's values.
- type: array
description: The target rule's values.
items:
type: string
title: values
description: The value's values.
buy_rules:
type: array
description: The application method's buy rules.
items:
type: object
description: The buy rule's buy rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The buy rule's description.
attribute:
type: string
title: attribute
description: The buy rule's attribute.
values:
oneOf:
- type: string
title: values
description: The buy rule's values.
- type: array
description: The buy rule's values.
items:
type: string
title: values
description: The value's values.
apply_to_quantity:
type: number
title: apply_to_quantity
description: The application method's apply to quantity.
buy_rules_min_quantity:
type: number
title: buy_rules_min_quantity
description: The application method's buy rules min quantity.
rules:
type: array
description: The promotion's rules.
items:
type: object
description: The rule's rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The rule's description.
attribute:
type: string
title: attribute
description: The rule's attribute.
values:
oneOf:
- type: string
title: values
description: The rule's values.
- type: array
description: The rule's values.
items:
title: campaign_id
description: The promotion's campaign id.
campaign:
type: object
description: The promotion's campaign.
required:
- name
- campaign_identifier
- description
- budget
- starts_at
- ends_at
properties:
name:
type: string
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
required:
- type
- limit
- currency_code
properties:
type:
type: string
title: values
description: The value's values.
enum:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
currency_code:
type: string
title: currency_code
description: The budget's currency code.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
application_method:
type: object
description: The promotion's application method.
required:
- description
- value
- currency_code
- max_quantity
- type
- target_type
- apply_to_quantity
- buy_rules_min_quantity
properties:
description:
type: string
title: description
description: The application method's description.
value:
type: number
title: value
description: The application method's value.
currency_code:
type: string
title: currency_code
description: The application method's currency code.
max_quantity:
type: number
title: max_quantity
description: The application method's max quantity.
type:
type: string
enum:
- fixed
- percentage
target_type:
type: string
enum:
- order
- shipping_methods
- items
allocation:
type: string
enum:
- each
- across
target_rules:
type: array
description: The application method's target rules.
items:
type: object
description: The target rule's target rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The target rule's description.
attribute:
type: string
title: attribute
description: The target rule's attribute.
values:
oneOf:
- type: string
title: values
description: The target rule's values.
- type: array
description: The target rule's values.
items:
type: string
title: values
description: The value's values.
buy_rules:
type: array
description: The application method's buy rules.
items:
type: object
description: The buy rule's buy rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The buy rule's description.
attribute:
type: string
title: attribute
description: The buy rule's attribute.
values:
oneOf:
- type: string
title: values
description: The buy rule's values.
- type: array
description: The buy rule's values.
items:
type: string
title: values
description: The value's values.
apply_to_quantity:
type: number
title: apply_to_quantity
description: The application method's apply to quantity.
buy_rules_min_quantity:
type: number
title: buy_rules_min_quantity
description: The application method's buy rules min quantity.
rules:
type: array
description: The promotion's rules.
items:
type: object
description: The rule's rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The rule's description.
attribute:
type: string
title: attribute
description: The rule's attribute.
values:
oneOf:
- type: string
title: values
description: The rule's values.
- type: array
description: The rule's values.
items:
type: string
title: values
description: The value's values.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml
+265 -251
View File
@@ -172,265 +172,279 @@ post:
content:
application/json:
schema:
description: SUMMARY
properties:
code:
type: string
title: code
description: The promotion's code.
is_automatic:
type: boolean
title: is_automatic
description: The promotion's is automatic.
type:
type: string
enum:
- standard
- buyget
campaign_id:
type: string
title: campaign_id
description: The promotion's campaign id.
campaign:
type: object
description: The promotion's campaign.
allOf:
- type: object
description: SUMMARY
required:
- name
- campaign_identifier
- description
- budget
- starts_at
- ends_at
- campaign_id
properties:
name:
code:
type: string
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
required:
- type
- limit
- currency_code
properties:
type:
type: string
enum:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
currency_code:
type: string
title: currency_code
description: The budget's currency code.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
application_method:
type: object
description: The promotion's application method.
required:
- description
- max_quantity
- currency_code
- apply_to_quantity
- buy_rules_min_quantity
properties:
description:
type: string
title: description
description: The application method's description.
value:
type: number
title: value
description: The application method's value.
max_quantity:
type: number
title: max_quantity
description: The application method's max quantity.
currency_code:
type: string
title: currency_code
description: The application method's currency code.
title: code
description: The promotion's code.
is_automatic:
type: boolean
title: is_automatic
description: The promotion's is automatic.
type:
type: string
enum:
- fixed
- percentage
target_type:
- standard
- buyget
campaign_id:
type: string
enum:
- order
- shipping_methods
- items
allocation:
type: string
enum:
- each
- across
target_rules:
type: array
description: The application method's target rules.
items:
type: object
description: The target rule's target rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The target rule's description.
attribute:
type: string
title: attribute
description: The target rule's attribute.
values:
oneOf:
- type: string
title: values
description: The target rule's values.
- type: array
description: The target rule's values.
items:
type: string
title: values
description: The value's values.
buy_rules:
type: array
description: The application method's buy rules.
items:
type: object
description: The buy rule's buy rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The buy rule's description.
attribute:
type: string
title: attribute
description: The buy rule's attribute.
values:
oneOf:
- type: string
title: values
description: The buy rule's values.
- type: array
description: The buy rule's values.
items:
type: string
title: values
description: The value's values.
apply_to_quantity:
type: number
title: apply_to_quantity
description: The application method's apply to quantity.
buy_rules_min_quantity:
type: number
title: buy_rules_min_quantity
description: The application method's buy rules min quantity.
rules:
type: array
description: The promotion's rules.
items:
type: object
description: The rule's rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The rule's description.
attribute:
type: string
title: attribute
description: The rule's attribute.
values:
oneOf:
- type: string
title: values
description: The rule's values.
- type: array
description: The rule's values.
items:
title: campaign_id
description: The promotion's campaign id.
campaign:
type: object
description: The promotion's campaign.
required:
- name
- campaign_identifier
- description
- budget
- starts_at
- ends_at
properties:
name:
type: string
title: name
description: The campaign's name.
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
required:
- type
- limit
- currency_code
properties:
type:
type: string
title: values
description: The value's values.
enum:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
currency_code:
type: string
title: currency_code
description: The budget's currency code.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
application_method:
type: object
description: The promotion's application method.
required:
- description
- max_quantity
- currency_code
- apply_to_quantity
- buy_rules_min_quantity
properties:
description:
type: string
title: description
description: The application method's description.
value:
type: number
title: value
description: The application method's value.
max_quantity:
type: number
title: max_quantity
description: The application method's max quantity.
currency_code:
type: string
title: currency_code
description: The application method's currency code.
type:
type: string
enum:
- fixed
- percentage
target_type:
type: string
enum:
- order
- shipping_methods
- items
allocation:
type: string
enum:
- each
- across
target_rules:
type: array
description: The application method's target rules.
items:
type: object
description: The target rule's target rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The target rule's description.
attribute:
type: string
title: attribute
description: The target rule's attribute.
values:
oneOf:
- type: string
title: values
description: The target rule's values.
- type: array
description: The target rule's values.
items:
type: string
title: values
description: The value's values.
buy_rules:
type: array
description: The application method's buy rules.
items:
type: object
description: The buy rule's buy rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The buy rule's description.
attribute:
type: string
title: attribute
description: The buy rule's attribute.
values:
oneOf:
- type: string
title: values
description: The buy rule's values.
- type: array
description: The buy rule's values.
items:
type: string
title: values
description: The value's values.
apply_to_quantity:
type: number
title: apply_to_quantity
description: The application method's apply to quantity.
buy_rules_min_quantity:
type: number
title: buy_rules_min_quantity
description: The application method's buy rules min quantity.
rules:
type: array
description: The promotion's rules.
items:
type: object
description: The rule's rules.
required:
- operator
- description
- attribute
- values
properties:
operator:
type: string
enum:
- gte
- lte
- gt
- lt
- eq
- ne
- in
description:
type: string
title: description
description: The rule's description.
attribute:
type: string
title: attribute
description: The rule's attribute.
values:
oneOf:
- type: string
title: values
description: The rule's values.
- type: array
description: The rule's values.
items:
type: string
title: values
description: The value's values.
- type: object
description: SUMMARY
properties:
additional_data:
type: object
description: >-
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_users.yaml
-93
View File
@@ -87,96 +87,3 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostUsers
summary: Create User
description: Create a user.
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:
content:
application/json:
schema:
$ref: ../components/schemas/CreateUser.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_users/post.sh
tags:
- Users
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminUserResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createUserAccountWorkflow