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

chore(docs): Updated API Reference (v2) (#9033)

Browse Source 
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]
2024-09-06 12:25:48 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 20545b194e
commit cf3c25addf
535 changed files with 3668 additions and 23178 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml
+8 -2
View File
@@ -1286,9 +1286,15 @@ get:
post:
operationId: PostApiKeys
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
parameters: []
security:
- api_token: []
- cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml
+3 -61
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -99,13 +70,13 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostApiKeysId
summary: Update a Api Key
description: Update a api key's details.
summary: Update an API Key
description: Update an API key's details.
x-authenticated: true
parameters:
- name: id
in: path
description: The api key's ID.
description: The API key's ID.
required: true
schema:
type: string
@@ -135,35 +106,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml
+6 -32
View File
@@ -1,12 +1,15 @@
post:
operationId: PostApiKeysIdRevoke
summary: Add Revokes to Api Key
description: Add a list of revokes to a api key.
summary: Revoke 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
parameters:
- name: id
in: path
description: The api key's ID.
description: The API key's ID.
required: true
schema:
type: string
@@ -36,35 +39,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml
+11 -37
View File
@@ -1,12 +1,15 @@
post:
operationId: PostApiKeysIdSalesChannels
summary: Add Sales Channels to Api Key
description: Add a list of sales channels to a api key.
summary: Manage Sales Channels of a Publishable 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
parameters:
- name: id
in: path
description: The api key's ID.
description: The API key's ID.
required: true
schema:
type: string
@@ -36,35 +39,6 @@ post:
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: []
@@ -74,22 +48,22 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The sales channels to add or remove from the publishable API key.
properties:
add:
type: array
description: The api key's add.
description: The sales channels to add to the publishable API key.
items:
type: string
title: add
description: The add's details.
description: A sales channel's ID.
remove:
type: array
description: The api key's remove.
description: The sales channels to remove from the publishable API key.
items:
type: string
title: remove
description: The remove's details.
description: A sales channel's ID.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml
+22 -40
View File
@@ -152,35 +152,6 @@ post:
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: []
@@ -191,7 +162,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The campaign's details.
required:
- name
- campaign_identifier
@@ -207,14 +178,16 @@ post:
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description: The campaign's identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
description: >-
The campaign's budget which, when crossed, ends the
campaign.
required:
- type
- limit
@@ -222,42 +195,51 @@ post:
properties:
type:
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:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
description: The campaign budget's limit.
currency_code:
type: string
title: currency_code
description: The budget's currency code.
description: >-
The campaign budget's currency code. This can't be
edited later.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
description: The campaign's start date.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
description: The campaign's end date.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
description: The promotions to add to the campaign.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
description: A promotion's ID.
- type: object
description: SUMMARY
description: The campaign's details.
properties:
additional_data:
type: object
@@ -265,7 +247,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The campaign's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml
+9 -67
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
@@ -174,7 +116,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The campaign's details.
required:
- description
- starts_at
@@ -187,7 +129,7 @@ post:
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description: The campaign's identifier.
description:
type: string
title: description
@@ -201,32 +143,32 @@ post:
limit:
type: number
title: limit
description: The budget's limit.
description: The campaign budget's limit.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
description: The campaign's start date.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
description: The campaign's end date.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
description: The promotions to add to the campaign.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
description: A promotion's ID.
- type: object
description: SUMMARY
description: The campaign's details.
properties:
additional_data:
type: object
@@ -234,7 +176,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The campaign's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml
+10 -36
View File
@@ -1,7 +1,10 @@
post:
operationId: PostCampaignsIdPromotions
summary: Add Promotions to Campaign
description: Add a list of promotions to a campaign.
summary: Manage the Promotions of 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
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
@@ -74,22 +48,22 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The promotions to add or remove from the campaign.
properties:
add:
type: array
description: The campaign's add.
description: The promotions to add to the campaign.
items:
type: string
title: add
description: The add's details.
description: A promotion's ID.
remove:
type: array
description: The campaign's remove.
description: The promotions to remove from the campaign.
items:
type: string
title: remove
description: The remove's details.
description: A promotion's ID.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_claims.yaml
+4 -31
View File
@@ -1020,8 +1020,10 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostClaims
summary: Create Claim
description: Create a claim.
summary: 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
parameters:
- name: expand
@@ -1050,35 +1052,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml
-29
View File
@@ -38,35 +38,6 @@ get:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
post:
operationId: PostClaimsIdCancel
summary: Add Cancels to Claim
description: Add a list of cancels to a claim.
summary: Cancel a Claim
description: Cancel a claim and its associated return.
x-authenticated: true
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml
+5 -31
View File
@@ -1,7 +1,10 @@
post:
operationId: PostClaimsIdClaimItems
summary: Add Claim Items to Claim
description: Add a list of claim items to a claim.
summary: Add 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
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml
+10 -61
View File
@@ -1,7 +1,14 @@
post:
operationId: PostClaimsIdClaimItemsAction_id
summary: Add Claim Items to Claim
description: Add a list of claim items to a claim.
summary: Update a Claim Item
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
parameters:
- name: id
@@ -12,7 +19,7 @@ post:
type: string
- name: action_id
in: path
description: The claim's action id.
description: The ID of the order item's `WRITE_OFF_ITEM` action.
required: true
schema:
type: string
@@ -42,35 +49,6 @@ post:
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: []
@@ -160,35 +138,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml
+5 -2
View File
@@ -1,7 +1,10 @@
post:
operationId: PostClaimsIdInboundItems
summary: Add Items to Claim
description: Add a list of items to a claim.
summary: Add Inbound 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
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml
+11 -58
View File
@@ -1,7 +1,15 @@
post:
operationId: PostClaimsIdInboundItemsAction_id
summary: Add Items to Claim
description: Add a list of items to a claim.
summary: Update Inbound Items of 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The claim's action id.
description: The ID of the return item's `RETURN_ITEM` action.
required: true
schema:
type: string
@@ -80,61 +88,6 @@ delete:
required: true
schema:
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:
- api_token: []
- cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml
+5 -2
View File
@@ -1,7 +1,10 @@
post:
operationId: PostClaimsIdInboundShippingMethod
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
summary: Add an Inbound Shipping Method 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
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml
+11 -32
View File
@@ -1,7 +1,15 @@
post:
operationId: PostClaimsIdInboundShippingMethodAction_id
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
summary: Update Inbound Shipping Method of 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The claim's action id.
description: The ID of the shipping method's `SHIPPING_ADD` action.
required: true
schema:
type: string
@@ -42,35 +50,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml
+5 -31
View File
@@ -1,7 +1,10 @@
post:
operationId: PostClaimsIdOutboundItems
summary: Add Items to Claim
description: Add a list of items to a claim.
summary: Add Outbound 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
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml
+11 -61
View File
@@ -1,7 +1,15 @@
post:
operationId: PostClaimsIdOutboundItemsAction_id
summary: Add Items to Claim
description: Add a list of items to a claim.
summary: Update Outbound Item of 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The claim's action id.
description: The ID of the new claim item's `ITEM_ADD` action.
required: true
schema:
type: string
@@ -42,35 +50,6 @@ post:
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: []
@@ -160,35 +139,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml
+5 -31
View File
@@ -1,7 +1,10 @@
post:
operationId: PostClaimsIdOutboundShippingMethod
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
summary: Add Outbound 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
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml
+11 -61
View File
@@ -1,7 +1,15 @@
post:
operationId: PostClaimsIdOutboundShippingMethodAction_id
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
summary: Update Outbound Shipping Method of 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The claim's action id.
description: The ID of the shipping method's `SHIPPING_ADD` action.
required: true
schema:
type: string
@@ -42,35 +50,6 @@ post:
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: []
@@ -160,35 +139,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml
+3 -31
View File
@@ -1,7 +1,8 @@
post:
operationId: PostClaimsIdRequest
summary: Add Requests to Claim
description: Add a list of requests to a claim.
summary: Confirm a Claim Request
x-sidebar-summary: Confirm Claim
description: Confirm a claim request, applying its changes on the associated order.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +37,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_collections.yaml
-29
View File
@@ -1008,35 +1008,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml
-58
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml
+10 -36
View File
@@ -1,7 +1,10 @@
post:
operationId: PostCollectionsIdProducts
summary: Add Products to Collection
description: Add a list of products to a collection.
summary: Manage Products of 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
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
@@ -74,22 +48,22 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The products to add or remove.
properties:
add:
type: array
description: The collection's add.
description: The products to add to the collection.
items:
type: string
title: add
description: The add's details.
description: A product's ID.
remove:
type: array
description: The collection's remove.
description: The products to remove from the collection.
items:
type: string
title: remove
description: The remove's details.
description: A product's ID.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml
-29
View File
@@ -38,35 +38,6 @@ get:
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: []
www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml
-29
View File
@@ -1056,35 +1056,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml
-58
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml
+8 -36
View File
@@ -1,7 +1,8 @@
post:
operationId: PostCustomerGroupsIdCustomers
summary: Add Customers to Customer Group
description: Add a list of customers to a customer group.
summary: Manage Customers of 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
parameters:
- name: id
@@ -36,35 +37,6 @@ post:
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: []
@@ -74,22 +46,22 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The customers to add or remove from the group.
properties:
add:
type: array
description: The customer group's add.
description: The customers to add to the group.
items:
type: string
title: add
description: The add's details.
description: A customer's ID.
remove:
type: array
description: The customer group's remove.
description: The customers to remove from the group.
items:
type: string
title: remove
description: The remove's details.
description: A customer's ID.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
+5 -34
View File
@@ -4149,12 +4149,12 @@ get:
title: $or
- name: has_account
in: query
description: The customer's has account.
description: Filter by whether the customer is registered.
required: false
schema:
type: boolean
title: has_account
description: The customer's has account.
description: Filter by whether the customer is registered.
security:
- api_token: []
- cookie_auth: []
@@ -4245,35 +4245,6 @@ post:
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: []
@@ -4284,7 +4255,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The customer's details.
required:
- email
- company_name
@@ -4318,7 +4289,7 @@ post:
type: object
description: The customer's metadata.
- type: object
description: SUMMARY
description: The customer's details.
properties:
additional_data:
type: object
@@ -4326,7 +4297,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The customer's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml
+3 -61
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
@@ -174,7 +116,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The customer's details.
required:
- email
- company_name
@@ -208,7 +150,7 @@ post:
type: object
description: The customer's metadata.
- type: object
description: SUMMARY
description: The customer's details.
properties:
additional_data:
type: object
@@ -216,7 +158,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The customer's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml
+24 -48
View File
@@ -236,8 +236,9 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomersIdAddresses
summary: Add Addresses to Customer
description: Add a list of addresses to a customer.
summary: Add a Customer Address
x-sidebar-summary: Add Address
description: Add an address to a customer.
x-authenticated: true
parameters:
- name: id
@@ -272,35 +273,6 @@ post:
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: []
@@ -311,7 +283,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The address's details.
required:
- address_name
- company
@@ -329,60 +301,64 @@ post:
address_name:
type: string
title: address_name
description: The customer's address name.
description: The name of the address.
is_default_shipping:
type: boolean
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:
type: boolean
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:
type: string
title: company
description: The customer's company.
description: The address's company.
first_name:
type: string
title: first_name
description: The customer's first name.
description: The address's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
description: The address's last name.
address_1:
type: string
title: address_1
description: The customer's address 1.
description: The address's first line.
address_2:
type: string
title: address_2
description: The customer's address 2.
description: The address's second line.
city:
type: string
title: city
description: The customer's city.
description: The address's city.
country_code:
type: string
title: country_code
description: The customer's country code.
description: The address's country code.
province:
type: string
title: province
description: The customer's province.
description: The address's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
description: The address's postal code.
phone:
type: string
title: phone
description: The customer's phone.
description: The address's phone.
metadata:
type: object
description: The customer's metadata.
description: The address's metadata.
- type: object
description: SUMMARY
description: The address's details.
properties:
additional_data:
type: object
@@ -390,7 +366,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The address's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml
+24 -106
View File
@@ -44,35 +44,6 @@ get:
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: []
@@ -106,8 +77,9 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomersIdAddressesAddress_id
summary: Add Addresses to Customer
description: Add a list of addresses to a customer.
summary: Update a Customer's Address
x-sidebar-summary: Update Address
description: Update a customer address's details.
x-authenticated: true
parameters:
- name: id
@@ -148,35 +120,6 @@ post:
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: []
@@ -187,7 +130,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The address's details.
required:
- address_name
- company
@@ -205,60 +148,64 @@ post:
address_name:
type: string
title: address_name
description: The customer's address name.
description: The name of the address.
is_default_shipping:
type: boolean
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:
type: boolean
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:
type: string
title: company
description: The customer's company.
description: The address's company.
first_name:
type: string
title: first_name
description: The customer's first name.
description: The address's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
description: The address's last name.
address_1:
type: string
title: address_1
description: The customer's address 1.
description: The address's first line
address_2:
type: string
title: address_2
description: The customer's address 2.
description: The address's second line
city:
type: string
title: city
description: The customer's city.
description: The address's city.
country_code:
type: string
title: country_code
description: The customer's country code.
description: The address's country code.
province:
type: string
title: province
description: The customer's province.
description: The address's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
description: The address's postal code.
phone:
type: string
title: phone
description: The customer's phone.
description: The address's phone.
metadata:
type: object
description: The customer's metadata.
description: The address's metadata.
- type: object
description: SUMMARY
description: The address's details.
properties:
additional_data:
type: object
@@ -266,7 +213,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The address's details.
x-codeSamples:
- lang: Shell
label: cURL
@@ -339,35 +286,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml
+98 -148
View File
@@ -1165,24 +1165,25 @@ get:
title: $or
- name: sales_channel_id
in: query
description: The draft order's sales channel id.
description: Filter by the associated sales channels to retrieve its draft orders.
required: false
schema:
type: array
description: The draft order's sales channel id.
description: Filter by the associated sales channels to retrieve its draft orders.
items:
type: string
title: sales_channel_id
description: The sales channel id's details.
description: A sales channel's ID.
- name: fulfillment_status
in: query
description: The draft order's fulfillment status.
description: Filter by the fulfillment status of the draft order.
required: false
schema:
type: array
description: The draft order's fulfillment status.
description: Filter by the fulfillment status of the draft order.
items:
type: string
title: fulfillment_status
description: The fulfillment status's details.
enum:
- canceled
@@ -1195,13 +1196,14 @@ get:
- delivered
- name: payment_status
in: query
description: The draft order's payment status.
description: Filter by the payment status of the draft order.
required: false
schema:
type: array
description: The draft order's payment status.
description: Filter by the payment status of the draft order.
items:
type: string
title: payment_status
description: The payment status's details.
enum:
- canceled
@@ -1216,30 +1218,30 @@ get:
- requires_action
- name: region_id
in: query
description: The draft order's region id.
description: Filter by region IDs to retrieve their associated draft orders.
required: false
schema:
type: array
description: The draft order's region id.
description: Filter by region IDs to retrieve their associated draft orders.
items:
type: string
title: region_id
description: The region id's details.
description: A region's ID.
- name: q
in: query
description: The draft order's q.
description: Search term to filter the order's searchable properties.
required: false
schema:
type: string
title: q
description: The draft order's q.
description: Search term to filter the order's searchable properties.
- name: created_at
in: query
description: The draft order's created at.
description: Filter by the draft order's creation date.
required: false
schema:
type: object
description: The draft order's created at.
description: Filter by the draft order's creation date.
properties:
$and:
type: array
@@ -1263,11 +1265,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -1278,21 +1280,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -1320,50 +1320,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -1414,9 +1410,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -1425,16 +1419,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -1442,15 +1434,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -1497,32 +1485,32 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at
in: query
description: The draft order's updated at.
description: Filter by the draft order's update date.
required: false
schema:
type: object
description: The draft order's updated at.
description: Filter by the draft order's update date.
properties:
$and:
type: array
@@ -1546,11 +1534,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -1561,21 +1549,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -1603,50 +1589,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -1697,9 +1679,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -1708,16 +1688,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -1725,15 +1703,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -1780,21 +1754,21 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -1858,7 +1832,9 @@ get:
post:
operationId: PostDraftOrders
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
parameters:
- name: expand
@@ -1887,35 +1863,6 @@ post:
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: []
@@ -1926,7 +1873,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The draft order's details.
required:
- sales_channel_id
- email
@@ -1937,25 +1884,27 @@ post:
- metadata
properties:
status:
type: boolean
type: string
title: status
description: The draft order's status.
enum:
- completed
sales_channel_id:
type: string
title: sales_channel_id
description: The draft order's sales channel id.
description: The ID of the associated sales channel.
email:
type: string
title: email
description: The draft order's email.
description: The email of the draft order's customer.
format: email
customer_id:
type: string
title: customer_id
description: The draft order's customer id.
description: The ID of the draft order's customer.
billing_address:
type: object
description: The draft order's billing address.
description: The billing address's details.
required:
- first_name
- last_name
@@ -1988,11 +1937,11 @@ post:
address_1:
type: string
title: address_1
description: The billing address's address 1.
description: The billing address's first line.
address_2:
type: string
title: address_2
description: The billing address's address 2.
description: The billing address's second line.
city:
type: string
title: city
@@ -2047,11 +1996,11 @@ post:
address_1:
type: string
title: address_1
description: The shipping address's address 1.
description: The shipping address's first line.
address_2:
type: string
title: address_2
description: The shipping address's address 2.
description: The shipping address's second line.
city:
type: string
title: city
@@ -2076,7 +2025,7 @@ post:
description: The draft order's items.
items:
type: object
description: The item's items.
description: The item's details.
required:
- title
- sku
@@ -2093,7 +2042,7 @@ post:
sku:
type: string
title: sku
description: The item's sku.
description: The item's SKU.
barcode:
type: string
title: barcode
@@ -2101,7 +2050,7 @@ post:
variant_id:
type: string
title: variant_id
description: The item's variant id.
description: The ID of the associated product variant.
unit_price:
oneOf:
- type: string
@@ -2123,25 +2072,25 @@ post:
precision:
type: number
title: precision
description: The unit price's precision.
description: The unit price's rounding precision.
quantity:
type: number
title: quantity
description: The item's quantity.
description: The item's ordered quantity.
metadata:
type: object
description: The item's metadata.
region_id:
type: string
title: region_id
description: The draft order's region id.
description: The ID of the associated region.
promo_codes:
type: array
description: The draft order's promo codes.
description: The promotion codes applied on the draft order.
items:
type: string
title: promo_codes
description: The promo code's promo codes.
description: A promotion code.
currency_code:
type: string
title: currency_code
@@ -2149,16 +2098,14 @@ post:
no_notification_order:
type: boolean
title: no_notification_order
description: The draft order's no notification order.
description: Whether to send the customer notifications on order changes.
shipping_methods:
type: array
description: The draft order's shipping methods.
items:
type: object
description: The shipping method's shipping methods.
description: The shipping method's details.
required:
- shipping_method_id
- order_id
- name
- option_id
- amount
@@ -2166,11 +2113,7 @@ post:
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.
description: The ID of an existing shipping method.
name:
type: string
title: name
@@ -2178,10 +2121,17 @@ post:
option_id:
type: string
title: option_id
description: The shipping method's option id.
description: >-
The ID of the shipping option this method is created
from.
data:
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:
oneOf:
- type: string
@@ -2203,12 +2153,12 @@ post:
precision:
type: number
title: precision
description: The amount's precision.
description: The amount's rounding precision.
metadata:
type: object
description: The draft order's metadata.
- type: object
description: SUMMARY
description: The draft order's details.
properties:
additional_data:
type: object
@@ -2216,7 +2166,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The draft order's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml
+3 -30
View File
@@ -1005,7 +1005,9 @@ get:
post:
operationId: PostExchanges
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
parameters:
- name: expand
@@ -1034,35 +1036,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml
-29
View File
@@ -38,35 +38,6 @@ get:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
post:
operationId: PostExchangesIdCancel
summary: Add Cancels to Exchange
description: Add a list of cancels to a exchange.
summary: Cancel an Exchange
description: Cancel an exchange and its associated return.
x-authenticated: true
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml
+5 -2
View File
@@ -1,7 +1,10 @@
post:
operationId: PostExchangesIdInboundItems
summary: Add Items to Exchange
description: Add a list of items to a exchange.
summary: Add Inbound Items to an 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
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml
+11 -32
View File
@@ -1,7 +1,15 @@
post:
operationId: PostExchangesIdInboundItemsAction_id
summary: Add Items to Exchange
description: Add a list of items to a exchange.
summary: Update an Inbount Item of an 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The exchange's action id.
description: The ID of the return item's `RETURN_ITEM` action.
required: true
schema:
type: string
@@ -106,35 +114,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml
+5 -2
View File
@@ -1,7 +1,10 @@
post:
operationId: PostExchangesIdInboundShippingMethod
summary: Add Shipping Methods to Exchange
description: Add a list of shipping methods to a exchange.
summary: Add an Inbound Shipping Method to an 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
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml
+11 -32
View File
@@ -1,7 +1,15 @@
post:
operationId: PostExchangesIdInboundShippingMethodAction_id
summary: Add Shipping Methods to Exchange
description: Add a list of shipping methods to a exchange.
summary: Update Inbound Shipping Method of an 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The exchange's action id.
description: The ID of the shipping method's `SHIPPING_ADD` action.
required: true
schema:
type: string
@@ -42,35 +50,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml
+4 -31
View File
@@ -1,7 +1,9 @@
post:
operationId: PostExchangesIdOutboundItems
summary: Add Items to Exchange
description: Add a list of items to a exchange.
summary: Add Outbound Items to Exchange
description: >-
Add outbound (or new) items to an exchange. These outbound items will have
the action `ITEM_ADD`.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +38,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml
+11 -61
View File
@@ -1,7 +1,15 @@
post:
operationId: PostExchangesIdOutboundItemsAction_id
summary: Add Items to Exchange
description: Add a list of items to a exchange.
summary: Update Outbound Item of an 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The exchange's action id.
description: The ID of the new exchange item's `ITEM_ADD` action.
required: true
schema:
type: string
@@ -42,35 +50,6 @@ post:
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: []
@@ -160,35 +139,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml
+5 -31
View File
@@ -1,7 +1,10 @@
post:
operationId: PostExchangesIdOutboundShippingMethod
summary: Add Shipping Methods to Exchange
description: Add a list of shipping methods to a exchange.
summary: Add Outbound Shipping Method to 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
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml
+11 -61
View File
@@ -1,7 +1,15 @@
post:
operationId: PostExchangesIdOutboundShippingMethodAction_id
summary: Add Shipping Methods to Exchange
description: Add a list of shipping methods to a exchange.
summary: Update Outbound Shipping Method of 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The exchange's action id.
description: The ID of the shipping method's `SHIPPING_ADD` action.
required: true
schema:
type: string
@@ -42,35 +50,6 @@ post:
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: []
@@ -160,35 +139,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml
+2 -31
View File
@@ -1,7 +1,7 @@
post:
operationId: PostExchangesIdRequest
summary: Add Requests to Exchange
description: Add a list of requests to a exchange.
summary: Confirm an Exchange
description: Confirm an exchange request, applying its changes on the associated order.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +36,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml
+15 -39
View File
@@ -1,7 +1,8 @@
post:
operationId: PostFulfillmentSetsIdServiceZones
summary: Add Service Zones to Fulfillment Set
description: Add a list of service zones to a fulfillment set.
summary: Add a Service Zone to a Fulfillment Set
x-sidebar-summary: Add Service Zone
description: Add a service zone to a fulfillment set.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +37,6 @@ post:
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: []
@@ -74,21 +46,21 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The service zone's details.
required:
- name
properties:
name:
type: string
title: name
description: The fulfillment set's name.
description: The service zone's name.
geo_zones:
type: array
description: The fulfillment set's geo zones.
description: The service zone's geo zones.
items:
oneOf:
- type: object
description: The geo zone's geo zones.
description: A country geo zone.
required:
- metadata
- country_code
@@ -105,8 +77,9 @@ post:
type: string
title: type
description: The geo zone's type.
default: country
- type: object
description: The geo zone's geo zones.
description: A province geo zone.
required:
- metadata
- country_code
@@ -124,12 +97,13 @@ post:
type: string
title: type
description: The geo zone's type.
default: province
province_code:
type: string
title: province_code
description: The geo zone's province code.
- type: object
description: The geo zone's geo zones.
description: A city geo zone
required:
- metadata
- country_code
@@ -148,6 +122,7 @@ post:
type: string
title: type
description: The geo zone's type.
default: city
province_code:
type: string
title: province_code
@@ -157,7 +132,7 @@ post:
title: city
description: The geo zone's city.
- type: object
description: The geo zone's geo zones.
description: A ZIP geo zone.
required:
- metadata
- country_code
@@ -177,6 +152,7 @@ post:
type: string
title: type
description: The geo zone's type.
default: zip
province_code:
type: string
title: province_code
@@ -187,7 +163,7 @@ post:
description: The geo zone's city.
postal_expression:
type: object
description: The geo zone's postal expression.
description: The geo zone's postal expression or ZIP code.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml
+20 -75
View File
@@ -43,35 +43,6 @@ get:
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: []
@@ -105,8 +76,9 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostFulfillmentSetsIdServiceZonesZone_id
summary: Add Service Zones to Fulfillment Set
description: Add a list of service zones to a fulfillment set.
summary: Update the Service Zone of a Fulfillment Set
x-sidebar-summary: Update Service Zone
description: Update the details of a service zone in a fulfillment set.
x-authenticated: true
parameters:
- name: id
@@ -117,7 +89,7 @@ post:
type: string
- name: zone_id
in: path
description: The fulfillment set's zone id.
description: The service zone's ID.
required: true
schema:
type: string
@@ -147,35 +119,6 @@ post:
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: []
@@ -185,21 +128,19 @@ post:
application/json:
schema:
type: object
description: SUMMARY
required:
- name
description: The service zone's details.
properties:
name:
type: string
title: name
description: The fulfillment set's name.
description: The service zone's name.
geo_zones:
type: array
description: The fulfillment set's geo zones.
description: The service zone's associated geo zones.
items:
oneOf:
- type: object
description: The geo zone's geo zones.
description: A country geo zone.
required:
- type
- metadata
@@ -209,6 +150,7 @@ post:
type: string
title: type
description: The geo zone's type.
default: country
metadata:
type: object
description: The geo zone's metadata.
@@ -219,9 +161,9 @@ post:
id:
type: string
title: id
description: The geo zone's ID.
description: The ID of an existing geo zone.
- type: object
description: The geo zone's geo zones.
description: A province geo zone.
required:
- type
- metadata
@@ -232,6 +174,7 @@ post:
type: string
title: type
description: The geo zone's type.
default: province
metadata:
type: object
description: The geo zone's metadata.
@@ -246,9 +189,9 @@ post:
id:
type: string
title: id
description: The geo zone's ID.
description: The ID of an existing geo zone.
- type: object
description: The geo zone's geo zones.
description: A city geo zone
required:
- type
- metadata
@@ -260,6 +203,7 @@ post:
type: string
title: type
description: The geo zone's type.
default: city
metadata:
type: object
description: The geo zone's metadata.
@@ -278,9 +222,9 @@ post:
id:
type: string
title: id
description: The geo zone's ID.
description: The ID of an existing geo zone.
- type: object
description: The geo zone's geo zones.
description: A ZIP geo zone.
required:
- type
- metadata
@@ -293,6 +237,7 @@ post:
type: string
title: type
description: The geo zone's type.
default: zip
metadata:
type: object
description: The geo zone's metadata.
@@ -310,11 +255,11 @@ post:
description: The geo zone's province code.
postal_expression:
type: object
description: The geo zone's postal expression.
description: The geo zone's postal expression or ZIP code.
id:
type: string
title: id
description: The geo zone's ID.
description: The ID of an existing geo zone.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml
+1 -30
View File
@@ -1,7 +1,7 @@
post:
operationId: PostFulfillments
summary: Create Fulfillment
description: Create a fulfillment.
description: Create a fulfillment for an order, return, exchange, and more.
x-authenticated: true
parameters:
- name: expand
@@ -30,35 +30,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml
+7 -31
View File
@@ -1,7 +1,12 @@
post:
operationId: PostFulfillmentsIdCancel
summary: Add Cancels to Fulfillment
description: Add a list of cancels to a fulfillment.
summary: Cancel 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
parameters:
- name: id
@@ -36,35 +41,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml
+5 -31
View File
@@ -1,7 +1,10 @@
post:
operationId: PostFulfillmentsIdShipment
summary: Add Shipments to Fulfillment
description: Add a list of shipments to a fulfillment.
summary: Create a Shipment for 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
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml
+1 -30
View File
@@ -496,7 +496,7 @@ get:
post:
operationId: PostInventoryItems
summary: Create Inventory Item
description: Create a inventory item.
description: Create an inventory item.
x-authenticated: true
parameters:
- name: expand
@@ -525,35 +525,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml
+14 -81
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -99,8 +70,8 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostInventoryItemsId
summary: Update a Inventory Item
description: Update a inventory item's details.
summary: Update an Inventory Item
description: Update an inventory item's details.
x-authenticated: true
parameters:
- name: id
@@ -135,35 +106,6 @@ post:
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: []
@@ -173,30 +115,16 @@ post:
application/json:
schema:
type: object
description: SUMMARY
required:
- sku
- hs_code
- weight
- length
- height
- width
- origin_country
- mid_code
- material
- title
- description
- thumbnail
- metadata
description: The properties to update in the inventory item.
properties:
sku:
type: string
title: sku
description: The inventory item's sku.
description: The inventory item's SKU.
hs_code:
type: string
title: hs_code
description: The inventory item's hs code.
description: The inventory item's HS code.
weight:
type: number
title: weight
@@ -220,7 +148,7 @@ post:
mid_code:
type: string
title: mid_code
description: The inventory item's mid code.
description: The inventory item's MID code.
material:
type: string
title: material
@@ -236,14 +164,19 @@ post:
requires_shipping:
type: boolean
title: requires_shipping
description: The inventory item's requires shipping.
description: Whether the inventory item requires shipping.
thumbnail:
type: string
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:
type: object
description: The inventory item's metadata.
description: >-
The inventory item's metadata. Can be custom data in key-value
pairs.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml
+7 -35
View File
@@ -166,8 +166,9 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostInventoryItemsIdLocationLevels
summary: Add Location Levels to Inventory Item
description: Add a list of location levels to a inventory item.
summary: Create Inventory Level for Inventory Item
x-sidebar-summary: Create Inventory Level
description: Create an inventory level for an inventory item.
x-authenticated: true
parameters:
- name: id
@@ -202,35 +203,6 @@ post:
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: []
@@ -240,22 +212,22 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The inventory level's details.
required:
- location_id
properties:
location_id:
type: string
title: location_id
description: The inventory item's location id.
description: The ID of the associated location.
stocked_quantity:
type: number
title: stocked_quantity
description: The inventory item's stocked quantity.
description: The inventory level's stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The inventory item's incoming quantity.
description: The inventory level's incoming quantity.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml
+16 -15
View File
@@ -1,7 +1,8 @@
post:
operationId: PostInventoryItemsIdLocationLevelsBatch
summary: Add Location Levels to Inventory Item
description: Add a list of location levels to a inventory item.
summary: Manage Inventory Levels of 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
parameters:
- name: id
@@ -19,51 +20,51 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The inventory levels to create or delete.
properties:
create:
type: array
description: The inventory item's create.
description: The inventory levels to create.
items:
type: object
description: The create's details.
description: The inventory level's details.
required:
- location_id
properties:
location_id:
type: string
title: location_id
description: The create's location id.
description: The ID of the associated location.
stocked_quantity:
type: number
title: stocked_quantity
description: The create's stocked quantity.
description: The inventory level's stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The create's incoming quantity.
description: The inventory level's incoming quantity.
update:
type: array
description: The inventory item's update.
description: The inventory levels to update.
items:
type: object
description: The update's details.
description: The inventory level's details.
properties:
stocked_quantity:
type: number
title: stocked_quantity
description: The update's stocked quantity.
description: The inventory level's stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The update's incoming quantity.
description: The inventory level's incoming quantity.
delete:
type: array
description: The inventory item's delete.
description: The inventory levels to delete.
items:
type: string
title: delete
description: The delete's details.
description: The ID of the inventory level to delete.
x-codeSamples:
- lang: Shell
label: cURL
@@ -79,7 +80,7 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The inventory item's details.
required:
- inventory_item
properties:
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
+9 -64
View File
@@ -1,7 +1,10 @@
post:
operationId: PostInventoryItemsIdLocationLevelsLocation_id
summary: Add Location Levels to Inventory Item
description: Add a list of location levels to a inventory item.
summary: Update an Inventory Level of an 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
parameters:
- name: id
@@ -12,7 +15,7 @@ post:
type: string
- name: location_id
in: path
description: The inventory item's location id.
description: The ID of the location associated with the inventory level.
required: true
schema:
type: string
@@ -42,35 +45,6 @@ post:
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: []
@@ -80,16 +54,16 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The properties to update in the inventory level.
properties:
stocked_quantity:
type: number
title: stocked_quantity
description: The inventory item's stocked quantity.
description: The inventory level's stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The inventory item's incoming quantity.
description: The inventory level's incoming quantity.
x-codeSamples:
- lang: Shell
label: cURL
@@ -168,35 +142,6 @@ delete:
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: []
www/apps/api-reference/specs/admin/paths/admin_invites.yaml
+3 -32
View File
@@ -625,52 +625,23 @@ post:
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:
type: object
description: SUMMARY
description: The invite's details.
required:
- email
properties:
email:
type: string
title: email
description: The invite's email.
description: The email of the user to invite.
format: email
metadata:
type: object
description: The invite's metadata.
description: The invite's metadata. Can be custom data in key-value pairs.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml
+15 -69
View File
@@ -1,88 +1,34 @@
post:
operationId: PostInvitesAccept
summary: Create Invite
description: Create a invite.
summary: Accept 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
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:
type: object
description: SUMMARY
required:
- email
- first_name
- last_name
description: The details of the user to be created.
properties:
email:
type: string
title: email
description: The invite's email.
description: The user's email.
format: email
first_name:
type: string
title: first_name
description: The invite's first name.
description: The user's first name.
last_name:
type: string
title: last_name
description: The invite's last name.
description: The user's last name.
x-codeSamples:
- lang: Shell
label: cURL
@@ -98,21 +44,21 @@ post:
schema:
oneOf:
- type: object
description: SUMMARY
description: The created user's details.
required:
- user
properties:
user:
$ref: ../components/schemas/AdminUser.yaml
- type: object
description: SUMMARY
description: An error's details.
required:
- message
properties:
message:
type: string
title: message
description: The invite's message.
description: The error message.
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml
-29
View File
@@ -38,35 +38,6 @@ get:
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 `-`.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml
+2 -31
View File
@@ -1,7 +1,7 @@
post:
operationId: PostInvitesIdResend
summary: Add Resends to Invite
description: Add a list of resends to a invite.
summary: Refresh Invite Token
description: Refresh the token of an invite.
x-authenticated: false
parameters:
- name: id
@@ -36,35 +36,6 @@ post:
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 `-`.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml
-29
View File
@@ -38,35 +38,6 @@ get:
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: []
www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml
+1 -2
View File
@@ -1,9 +1,8 @@
post:
operationId: PostOrderEdits
summary: Create Order Edit
description: Create a order edit.
description: Create an order edit.
x-authenticated: true
parameters: []
security:
- api_token: []
- cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml
+2 -6
View File
@@ -1,7 +1,7 @@
post:
operationId: PostOrderEditsIdConfirm
summary: Add Confirms to Order Edit
description: Add a list of confirms to a order edit.
summary: Confirm Order Edit
description: Confirm an order edit request and apply the changes on the order.
x-authenticated: true
parameters:
- name: id
@@ -41,7 +41,3 @@ 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
+2 -1
View File
@@ -1,7 +1,8 @@
post:
operationId: PostOrderEditsIdItems
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
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml
+3 -2
View File
@@ -1,7 +1,8 @@
post:
operationId: PostOrderEditsIdItemsItemItem_id
summary: Add Items to Order Edit
description: Add a list of items to a order edit.
summary: Update Order Item Quantity of Order Edit
x-sidebar-summary: Update Item Quantity
description: Update an existing order item's quantity of an order edit.
x-authenticated: true
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml
+11 -3
View File
@@ -1,7 +1,15 @@
post:
operationId: PostOrderEditsIdItemsAction_id
summary: Add Items to Order Edit
description: Add a list of items to a order edit.
summary: Update an Item in an Order Edit
x-sidebar-summary: Update Item
description: >
Update an added item in the order edit by 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The order edit's action id.
description: The ID of the new item's `ITEM_ADD` action.
required: true
schema:
type: string
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml
+2 -6
View File
@@ -1,7 +1,7 @@
post:
operationId: PostOrderEditsIdRequest
summary: Add Requests to Order Edit
description: Add a list of requests to a order edit.
summary: Request Order Edit
description: Change the status of an active order edit to requested.
x-authenticated: true
parameters:
- name: id
@@ -41,7 +41,3 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: requestOrderEditRequestWorkflow
requestBody:
content:
application/json:
schema: {}
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml
+5 -2
View File
@@ -1,7 +1,10 @@
post:
operationId: PostOrderEditsIdShippingMethod
summary: Add Shipping Methods to Order Edit
description: Add a list of shipping methods to a order edit.
summary: Add Shipping Method to Order Edit
x-sidebar-summary: Add Shipping Method
description: >-
Add a shipping method to an exchange. The shipping method will have a
`SHIPPING_ADD` action.
x-authenticated: true
parameters:
- name: id
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml
+11 -3
View File
@@ -1,7 +1,15 @@
post:
operationId: PostOrderEditsIdShippingMethodAction_id
summary: Add Shipping Methods to Order Edit
description: Add a list of shipping methods to a order edit.
summary: Update Shipping Method of an Order Edit
x-sidebar-summary: Update Shipping Method
description: >
Update a shipping method in the order edit by 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
parameters:
- name: id
@@ -12,7 +20,7 @@ post:
type: string
- name: action_id
in: path
description: The order edit's action id.
description: The ID of the shipping method's `SHIPPING_ADD` action.
required: true
schema:
type: string
www/apps/api-reference/specs/admin/paths/admin_orders.yaml
+62 -88
View File
@@ -119,25 +119,27 @@ get:
title: $or
- name: sales_channel_id
in: query
description: The order's sales channel id.
description: Filter by sales channel IDs to retrieve the orders associated with them.
required: false
schema:
type: array
description: The order's sales channel id.
description: >-
Filter by sales channel IDs to retrieve the orders associated with
them.
items:
type: string
title: sales_channel_id
description: The sales channel id's details.
description: A sales channel's ID.
- name: fulfillment_status
in: query
description: The order's fulfillment status.
description: Filter by the order's fulfillment status.
required: false
schema:
type: array
description: The order's fulfillment status.
description: Filter by the order's fulfillment status.
items:
type: string
description: The fulfillment status's details.
description: A fulfillment status.
enum:
- canceled
- not_fulfilled
@@ -149,14 +151,14 @@ get:
- delivered
- name: payment_status
in: query
description: The order's payment status.
description: Filter by the order's payment status.
required: false
schema:
type: array
description: The order's payment status.
description: Filter by the order's payment status.
items:
type: string
description: The payment status's details.
description: A payment status
enum:
- canceled
- not_paid
@@ -170,30 +172,30 @@ get:
- requires_action
- name: region_id
in: query
description: The order's region id.
description: Filter by region IDs to retrieve their associated orders.
required: false
schema:
type: array
description: The order's region id.
description: Filter by region IDs to retrieve their associated orders.
items:
type: string
title: region_id
description: The region id's details.
description: A region ID.
- name: q
in: query
description: The order's q.
description: Search term to filter the order's searchable properties.
required: false
schema:
type: string
title: q
description: The order's q.
description: Search term to filter the order's searchable properties.
- name: created_at
in: query
description: The order's created at.
description: Filter by the order's creation date.
required: false
schema:
type: object
description: The order's created at.
description: Filter by the order's creation date.
properties:
$and:
type: array
@@ -217,11 +219,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -232,21 +234,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -274,50 +274,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -368,9 +364,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -379,16 +373,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -396,15 +388,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -451,32 +439,32 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at
in: query
description: The order's updated at.
description: Filter by the order's update date.
required: false
schema:
type: object
description: The order's updated at.
description: Filter by the order's update date.
properties:
$and:
type: array
@@ -500,11 +488,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -515,21 +503,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -557,50 +543,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -651,9 +633,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -662,16 +642,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -679,15 +657,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -734,21 +708,21 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml
+2 -60
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -100,8 +71,8 @@ get:
x-workflow: getOrderDetailWorkflow
post:
operationId: PostOrdersId
summary: Update a Order
description: Update a order's details.
summary: Update an Order
description: Update an order's details.
x-authenticated: true
parameters:
- name: id
@@ -136,35 +107,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml
+2 -31
View File
@@ -1,7 +1,7 @@
post:
operationId: PostOrdersIdArchive
summary: Add Archives to Order
description: Add a list of archives to a order.
summary: Archive an Order
description: Change the status of an order to archived.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +36,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml
+10 -31
View File
@@ -1,7 +1,15 @@
post:
operationId: PostOrdersIdCancel
summary: Add Cancels to Order
description: Add a list of cancels to a order.
summary: Cancel Order
description: |
Cancel an order. The cancelation fails if:
- The order has captured payments.
- The order has refund payments.
- The order has fulfillments that aren't canceled.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +44,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml
-29
View File
@@ -47,35 +47,6 @@ get:
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: []
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml
+13 -51
View File
@@ -1,7 +1,7 @@
post:
operationId: PostOrdersIdComplete
summary: Add Completes to Order
description: Add a list of completes to a order.
summary: Complete Order
description: Mark an order as completed.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +36,6 @@ post:
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: []
@@ -73,26 +44,17 @@ 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
type: object
description: >-
Pass additional custom data to the API route. This data is passed to
the underlying workflow under the `additional_data` parameter.
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.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml
+19 -40
View File
@@ -1,7 +1,10 @@
post:
operationId: PostOrdersIdFulfillments
summary: Add Fulfillments to Order
description: Add a list of fulfillments to a order.
summary: Create an Order Fulfillment
x-sidebar-summary: Create Fulfillment
description: >-
Create a fulfillment for an order. The creation fails if the order is
canceled.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
@@ -75,7 +49,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The fulfillment's details.
required:
- items
- location_id
@@ -83,10 +57,10 @@ post:
properties:
items:
type: array
description: The order's items.
description: The items to fulfill.
items:
type: object
description: The item's items.
description: An item's details.
required:
- id
- quantity
@@ -98,20 +72,25 @@ post:
quantity:
type: number
title: quantity
description: The item's quantity.
description: The item's quantity to fulfill.
location_id:
type: string
title: location_id
description: The order's location id.
description: >-
The ID of the location to fulfill the items from. If not
provided, the location associated with the shipping option
of the order's shipping method is used.
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
description: >-
Whether to send the customer a notification about the
created fulfillment.
metadata:
type: object
description: The order's metadata.
description: The order's metadata. Can hold custom key-value pairs.
- type: object
description: SUMMARY
description: The fulfillment's details.
properties:
additional_data:
type: object
@@ -119,7 +98,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The fulfillment's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+10 -35
View File
@@ -1,7 +1,9 @@
post:
operationId: PostOrdersIdFulfillmentsFulfillment_idCancel
summary: Add Cancels to Order
description: Add a list of cancels to a order.
summary: Cancel Fulfillment
description: >-
Cancel an order's fulfillment. The fulfillment can't be canceled if it's
shipped.
x-authenticated: true
parameters:
- name: id
@@ -42,35 +44,6 @@ post:
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: []
@@ -81,14 +54,16 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The cancelation details.
properties:
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
description: >-
Whether the customer should receive a notification about
this change.
- type: object
description: SUMMARY
description: The cancelation details.
properties:
additional_data:
type: object
@@ -96,7 +71,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The cancelation details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml
+16 -42
View File
@@ -1,7 +1,8 @@
post:
operationId: PostOrdersIdFulfillmentsFulfillment_idShipments
summary: Add Shipments to Order
description: Add a list of shipments to a order.
summary: Create Shipment for an Order's Fulfillment
x-sidebar-summary: Create Shipment
description: Create a shipment for an order's fulfillment.
x-authenticated: true
parameters:
- name: id
@@ -12,7 +13,7 @@ post:
type: string
- name: fulfillment_id
in: path
description: The order's fulfillment id.
description: The fulfillment's ID.
required: true
schema:
type: string
@@ -42,35 +43,6 @@ post:
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: []
@@ -81,17 +53,17 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The shipment's details.
required:
- items
- metadata
properties:
items:
type: array
description: The order's items.
description: The items to create shipment for.
items:
type: object
description: The item's items.
description: The details of the item to create shipment for.
required:
- id
- quantity
@@ -103,10 +75,10 @@ post:
quantity:
type: number
title: quantity
description: The item's quantity.
description: The item's quantity to ship.
labels:
type: array
description: The order's labels.
description: The labels to create for the shipment.
items:
type: object
description: The label's labels.
@@ -126,16 +98,18 @@ post:
label_url:
type: string
title: label_url
description: The label's label url.
description: The label's url.
no_notification:
type: boolean
title: no_notification
description: The order's no notification.
description: >-
Whether to send the customer a notification about the
created shipment.
metadata:
type: object
description: The order's metadata.
description: The shipment's metadata. Can hold custom key-value pairs.
- type: object
description: SUMMARY
description: The shipment's details.
properties:
additional_data:
type: object
@@ -143,7 +117,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The shipment's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml
+3 -32
View File
@@ -30,35 +30,6 @@ post:
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: []
@@ -68,7 +39,7 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The payment collection's details.
required:
- order_id
- amount
@@ -76,11 +47,11 @@ post:
order_id:
type: string
title: order_id
description: The payment collection's order id.
description: The ID of the associated order.
amount:
type: number
title: amount
description: The payment collection's amount.
description: The amount to be paid.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml
+7 -33
View File
@@ -1,7 +1,10 @@
post:
operationId: PostPaymentCollectionsIdMarkAsPaid
summary: Add Mark As Paids to Payment Collection
description: Add a list of mark as paids to a payment collection.
summary: Mark a Payment Collection as Paid
x-sidebar-summary: Mark as Paid
description: >-
Mark a payment collection as paid. This creates and authorizes a payment
session, then capture its payment, using the manual payment provider.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +39,6 @@ post:
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: []
@@ -74,14 +48,14 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The payment details.
required:
- order_id
properties:
order_id:
type: string
title: order_id
description: The payment collection's order id.
description: The ID of the order associated with the payment collection.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml
-29
View File
@@ -38,35 +38,6 @@ get:
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: []
www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml
+6 -33
View File
@@ -1,7 +1,9 @@
post:
operationId: PostPaymentsIdCapture
summary: Add Captures to Payment
description: Add a list of captures to a payment.
summary: Capture Payment
description: >-
Capture an amount of a payment. This uses the `capturePayment` method of the
payment provider associated with the payment's collection.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +38,6 @@ post:
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: []
@@ -74,12 +47,12 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The payment's details.
properties:
amount:
type: number
title: amount
description: The payment's amount.
description: The amount to capture.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml
+8 -35
View File
@@ -1,7 +1,9 @@
post:
operationId: PostPaymentsIdRefund
summary: Add Refunds to Payment
description: Add a list of refunds to a payment.
summary: Refund Payment
description: >-
Refund an amount of a payment. This uses the `refundPayment` method of the
payment provider associated with the payment's collection.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +38,6 @@ post:
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: []
@@ -74,20 +47,20 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The refund's details.
properties:
amount:
type: number
title: amount
description: The payment's amount.
description: The amount to refund.
refund_reason_id:
type: string
title: refund_reason_id
description: The payment's refund reason id.
description: The ID of a refund reason.
note:
type: string
title: note
description: The payment's note.
description: A note to attach to the refund.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml
-29
View File
@@ -475,35 +475,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml
-58
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml
+37 -26
View File
@@ -1,7 +1,8 @@
post:
operationId: PostPriceListsIdPricesBatch
summary: Add Prices to Price List
description: Add a list of prices to a price list.
summary: Manage Prices in Price List
x-sidebar-summary: Manage Prices
description: Manage the prices of a price list to create, update, or delete them.
x-authenticated: true
parameters:
- name: id
@@ -19,90 +20,100 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The prices to create, update, or delete.
properties:
create:
type: array
description: The price list's create.
description: The prices to create.
items:
type: object
description: The create's details.
description: A price's details.
required:
- currency_code
- amount
- variant_id
- min_quantity
- max_quantity
properties:
currency_code:
type: string
title: currency_code
description: The create's currency code.
description: The price's currency code.
amount:
type: number
title: amount
description: The create's amount.
description: The price's amount.
variant_id:
type: string
title: variant_id
description: The create's variant id.
description: The ID of the variant this price is for.
min_quantity:
type: number
title: min_quantity
description: The create's min quantity.
description: >-
The minimum quantity that must be available of the
associated variant in the cart for this price to apply.
max_quantity:
type: number
title: max_quantity
description: The create's max quantity.
description: >-
The maximum quantity that must be available of the
associated variant in the cart for this price list to
apply.
rules:
type: object
description: The create's rules.
description: Key-value pair rules to apply on the price.
example:
region_id: 123
update:
type: array
description: The price list's update.
description: The prices to update.
items:
type: object
description: The update's details.
description: The properties to update in a price.
required:
- id
- variant_id
- min_quantity
- max_quantity
properties:
id:
type: string
title: id
description: The update's ID.
description: The price's ID.
currency_code:
type: string
title: currency_code
description: The update's currency code.
description: The price's currency code.
amount:
type: number
title: amount
description: The update's amount.
description: The price's amount.
variant_id:
type: string
title: variant_id
description: The update's variant id.
description: The ID of the variant this price is for.
min_quantity:
type: number
title: min_quantity
description: The update's min quantity.
description: >-
The minimum quantity that must be available of the
associated variant in the cart for this price to apply.
max_quantity:
type: number
title: max_quantity
description: The update's max quantity.
description: >-
The maximum quantity that must be available of the
associated variant in the cart for this price list to
apply.
rules:
type: object
description: The update's rules.
description: Key-value pair rules to apply on the price.
example:
region_id: 123
delete:
type: array
description: The price list's delete.
description: The prices to delete.
items:
type: string
title: delete
description: The delete's details.
description: A price's ID.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml
+3 -48
View File
@@ -1,7 +1,7 @@
post:
operationId: PostPriceListsIdProducts
summary: Add Products to Price List
description: Add a list of products to a price list.
summary: Remove Products from Price List
description: Remove products from a price list.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +36,6 @@ post:
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: []
@@ -73,23 +44,7 @@ post:
content:
application/json:
schema:
type: object
description: SUMMARY
properties:
add:
type: array
description: The price list's add.
items:
type: string
title: add
description: The add's details.
remove:
type: array
description: The price list's remove.
items:
type: string
title: remove
description: The remove's details.
$ref: ../components/schemas/AdminLinkPriceListProducts.yaml
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml
-29
View File
@@ -202,35 +202,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml
-58
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml
-29
View File
@@ -689,35 +689,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml
+11 -68
View File
@@ -38,35 +38,6 @@ get:
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 `-`.
- name: include_ancestors_tree
in: query
description: >-
@@ -159,35 +130,6 @@ post:
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: []
@@ -197,10 +139,7 @@ post:
application/json:
schema:
type: object
description: SUMMARY
required:
- parent_category_id
- metadata
description: The properties to update in the product category.
properties:
name:
type: string
@@ -213,26 +152,30 @@ post:
handle:
type: string
title: handle
description: The product category's handle.
description: The product category's handle. Must be a unique value.
is_internal:
type: boolean
title: is_internal
description: The product category's is internal.
description: >-
Whether the product category is only used for internal purposes
and shouldn't be shown the customer.
is_active:
type: boolean
title: is_active
description: The product category's is active.
description: Whether the product category is active.
parent_category_id:
type: string
title: parent_category_id
description: The product category's parent category id.
description: The ID of a parent category.
metadata:
type: object
description: The product category's metadata.
description: >-
The product category's metadata. Can hold custom key-value
pairs.
rank:
type: number
title: rank
description: The product category's rank.
description: The product category's rank among other categories.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml
+8 -36
View File
@@ -1,7 +1,8 @@
post:
operationId: PostProductCategoriesIdProducts
summary: Add Products to Product Category
description: Add a list of products to a product category.
summary: Manage Products in Product Category
x-sidebar-summary: Manage Products
description: Manage products of a category to add or remove them.
x-authenticated: true
parameters:
- name: id
@@ -36,35 +37,6 @@ post:
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: []
@@ -74,22 +46,22 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The products to add or remove from the category.
properties:
add:
type: array
description: The product category's add.
description: The products to add.
items:
type: string
title: add
description: The add's details.
description: A product ID.
remove:
type: array
description: The product category's remove.
description: The product to remove.
items:
type: string
title: remove
description: The remove's details.
description: A product ID.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml
-29
View File
@@ -598,35 +598,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml
+2 -62
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
@@ -173,9 +115,7 @@ post:
application/json:
schema:
type: object
description: SUMMARY
required:
- metadata
description: The properties to update in the product tag.
properties:
value:
type: string
@@ -183,7 +123,7 @@ post:
description: The product tag's value.
metadata:
type: object
description: The product tag's metadata.
description: The product tag's metadata. Can hold custom key-value pairs.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_product-types.yaml
-29
View File
@@ -598,35 +598,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml
+2 -62
View File
@@ -38,35 +38,6 @@ get:
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: []
@@ -135,35 +106,6 @@ post:
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: []
@@ -173,9 +115,7 @@ post:
application/json:
schema:
type: object
description: SUMMARY
required:
- metadata
description: The properties to update in the product type.
properties:
value:
type: string
@@ -183,7 +123,7 @@ post:
description: The product type's value.
metadata:
type: object
description: The product type's metadata.
description: The product type's metadata. Can hold custom key-value pairs.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_products.yaml
+2 -31
View File
@@ -766,35 +766,6 @@ post:
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: []
@@ -806,7 +777,7 @@ post:
allOf:
- $ref: ../components/schemas/AdminCreateProduct.yaml
- type: object
description: SUMMARY
description: The product's details.
properties:
additional_data:
type: object
@@ -814,7 +785,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The product's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml
+2 -31
View File
@@ -1,7 +1,7 @@
post:
operationId: PostProductsBatch
summary: Create Product
description: Create a product.
summary: Manage Products
description: Manage products to create, update, or delete them.
x-authenticated: true
parameters:
- name: expand
@@ -30,35 +30,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_products_export.yaml
+12 -31
View File
@@ -1,7 +1,17 @@
post:
operationId: PostProductsExport
summary: Create Product
description: Create a product.
summary: Export Products
description: >
Start a product export process to retrieve a CSV of exported products.
You'll receive in the response the transaction ID of the workflow generating
the CSV file. To check the status of the execution, send a GET request to
`/admin/workflows-executions/export-products/:transaction-id`.
Once the execution finishes successfully, a notification is created for the
export. You can retrieve the notifications using the `/admin/notification`
API route to retrieve the file's download URL.
x-authenticated: true
parameters:
- name: expand
@@ -30,35 +40,6 @@ post:
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: []
www/apps/api-reference/specs/admin/paths/admin_products_import.yaml
+5 -3
View File
@@ -1,9 +1,11 @@
post:
operationId: PostProductsImport
summary: Create Product
description: Create a product.
summary: Create Product Import
description: >-
Create a new product import process. The products aren't imported until the
import is confirmed with the `/admin/products/:transaction-id/import` API
route.
x-authenticated: true
parameters: []
security:
- api_token: []
- cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml
+5 -7
View File
@@ -1,12 +1,14 @@
post:
operationId: PostProductsImportTransaction_idConfirm
summary: Add Confirms to Product
description: Add a list of confirms to a product.
summary: Confirm Product Import
description: >-
Confirm that a created product import should start importing the products
into Medusa.
x-authenticated: true
parameters:
- name: transaction_id
in: path
description: The product's transaction id.
description: The ID of the transaction returned when the product import was created.
required: true
schema:
type: string
@@ -35,8 +37,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema: {}
x-workflow: importProductsWorkflowId

Some files were not shown because too many files have changed in this diff Show More