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

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

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-30 08:35:10 +02:00
committed by GitHub
parent 891037081d
commit 524be62312
749 changed files with 9092 additions and 52161 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml
+1 -56
View File
@@ -125,62 +125,7 @@ post:
summary: Create Api Key
description: Create a api key.
x-authenticated: true
parameters:
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
required: false
schema:
type: string
title: fields
description: >-
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
parameters: []
security:
- api_token: []
- cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml
+11 -62
View File
@@ -199,73 +199,20 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateApiKeysWorkflow
delete:
operationId: DeleteApiKeysId
summary: Delete a Api Key
description: Delete a api key.
summary: Delete an Api Key
description: |
Delete a publishable or secret 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
- 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: []
@@ -293,18 +240,19 @@ delete:
id:
type: string
title: id
description: The api key's ID.
description: The API key's ID.
object:
type: string
title: object
description: The api key's object.
description: The name of the object that was deleted.
default: api_key
deleted:
type: boolean
title: deleted
description: The api key's deleted.
description: Whether the API key was deleted.
parent:
type: object
description: The api key's parent.
description: The API key's parent.
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -317,3 +265,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteApiKeysWorkflow
www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml
+1
View File
@@ -100,3 +100,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: revokeApiKeysWorkflow
www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml
+1
View File
@@ -116,3 +116,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: linkSalesChannelsToApiKeyWorkflow
www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml
+1
View File
@@ -292,3 +292,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCampaignsWorkflow
www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml
+8 -58
View File
@@ -261,10 +261,13 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCampaignsWorkflow
delete:
operationId: DeleteCampaignsId
summary: Delete a Campaign
description: Delete a campaign.
description: >
Delete a campaign by its ID. This doesn't delete promotions that belong to
this campaign.
x-authenticated: true
parameters:
- name: id
@@ -273,61 +276,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: []
@@ -359,11 +307,12 @@ delete:
object:
type: string
title: object
description: The campaign's object.
description: The name of the object that was deleted.
default: campaign
deleted:
type: boolean
title: deleted
description: The campaign's deleted.
description: Whether the campaign was deleted.
parent:
type: object
description: The campaign's parent.
@@ -379,3 +328,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteCampaignsWorkflow
www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml
+1
View File
@@ -116,3 +116,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: addOrRemoveCampaignPromotionsWorkflow
www/apps/api-reference/specs/admin/paths/admin_claims.yaml
+1
View File
@@ -187,3 +187,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: beginClaimOrderWorkflow
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml
+1 -55
View File
@@ -10,61 +10,6 @@ post:
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: []
@@ -100,3 +45,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelOrderClaimWorkflow
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml
+11 -5
View File
@@ -110,10 +110,16 @@ post:
x-workflow: updateClaimItemWorkflow
delete:
operationId: DeleteClaimsIdClaimItemsAction_id
summary: Remove Claim Items from Claim
description: >-
Remove a list of claim items from a claim. This doesn't delete the Claim
Item, only the association between the Claim Item and the claim.
summary: Remove a Claim Item from a Claim
x-sidebar-summary: Remove Claim Item
description: >
Remove an order item from 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
@@ -124,7 +130,7 @@ delete:
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
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_items_{action_id}.yaml
+11 -60
View File
@@ -16,61 +16,6 @@ post:
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: []
@@ -111,10 +56,16 @@ post:
x-workflow: updateRequestItemReturnWorkflow
delete:
operationId: DeleteClaimsIdInboundItemsAction_id
summary: Remove Items from Claim
description: >-
Remove a list of items from a claim. This doesn't delete the Item, only the
association between the Item and the claim.
summary: Remove an Inbound Item from Claim
x-sidebar-summary: Remove Inbound Item
description: >
Remove an inbound (or return) item from 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
@@ -125,7 +76,7 @@ delete:
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
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_{action_id}.yaml
+11 -61
View File
@@ -110,11 +110,16 @@ post:
x-workflow: updateReturnShippingMethodWorkflow
delete:
operationId: DeleteClaimsIdInboundShippingMethodAction_id
summary: Remove Shipping Methods from Claim
description: >-
Remove a list of shipping methods from a claim. This doesn't delete the
Shipping Method, only the association between the Shipping Method and the
claim.
summary: Remove Inbound Shipping Method from Claim
x-sidebar-summary: Remove Inbound Shipping Method
description: >
Remove 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
@@ -125,65 +130,10 @@ delete:
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
- 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}_outbound_items_{action_id}.yaml
+11 -5
View File
@@ -110,10 +110,16 @@ post:
x-workflow: updateClaimAddItemWorkflow
delete:
operationId: DeleteClaimsIdOutboundItemsAction_id
summary: Remove Items from Claim
description: >-
Remove a list of items from a claim. This doesn't delete the Item, only the
association between the Item and the claim.
summary: Remove an Outbound Item from Claim
x-sidebar-summary: Remove Outbound Item
description: >
Remove an outbound (or new) item from 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
@@ -124,7 +130,7 @@ delete:
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
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml
+11 -6
View File
@@ -110,11 +110,16 @@ post:
x-workflow: updateClaimShippingMethodWorkflow
delete:
operationId: DeleteClaimsIdOutboundShippingMethodAction_id
summary: Remove Shipping Methods from Claim
description: >-
Remove a list of shipping methods from a claim. This doesn't delete the
Shipping Method, only the association between the Shipping Method and the
claim.
summary: Remove Outbound Shipping Method from Claim
x-sidebar-summary: Remove Outbound Shipping Method
description: >
Remove the shipping method for delivering outbound 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
@@ -125,7 +130,7 @@ delete:
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
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml
+3 -59
View File
@@ -102,10 +102,8 @@ post:
x-workflow: confirmClaimRequestWorkflow
delete:
operationId: DeleteClaimsIdRequest
summary: Remove Requests from Claim
description: >-
Remove a list of requests from a claim. This doesn't delete the Request,
only the association between the Request and the claim.
summary: Cancel Claim Request
description: Cancel a requested claim.
x-authenticated: true
parameters:
- name: id
@@ -114,61 +112,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: []
@@ -199,3 +142,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelBeginOrderClaimWorkflow
www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml
+3 -56
View File
@@ -199,10 +199,11 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCollectionsWorkflow
delete:
operationId: DeleteCollectionsId
summary: Delete a Collection
description: Delete a collection.
description: Delete a product collection.
x-authenticated: true
parameters:
- name: id
@@ -211,61 +212,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: []
@@ -296,3 +242,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteCollectionsWorkflow
www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml
+1
View File
@@ -116,3 +116,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: batchLinkProductsToCollectionWorkflow
www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml
+1
View File
@@ -216,3 +216,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCustomerGroupsWorkflow
www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml
+4 -56
View File
@@ -199,10 +199,12 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCustomerGroupsWorkflow
delete:
operationId: DeleteCustomerGroupsId
summary: Delete a Customer Group
description: Delete a customer group.
description: |
Delete a customer group. Customers in the group aren't deleted.
x-authenticated: true
parameters:
- name: id
@@ -211,61 +213,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: []
@@ -317,3 +264,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteCustomerGroupsWorkflow
www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml
+1
View File
@@ -116,3 +116,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: linkCustomersToCustomerGroupWorkflow
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
+1
View File
@@ -257,3 +257,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCustomersWorkflow
www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml
+2 -55
View File
@@ -243,6 +243,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCustomersWorkflow
delete:
operationId: DeleteCustomersId
summary: Delete a Customer
@@ -255,61 +256,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: []
@@ -361,3 +307,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteCustomersWorkflow
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml
+1
View File
@@ -309,3 +309,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCustomerAddressesWorkflow
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml
+5 -5
View File
@@ -294,12 +294,11 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCustomerAddressesWorkflow
delete:
operationId: DeleteCustomersIdAddressesAddress_id
summary: Remove Addresses from Customer
description: >-
Remove a list of addresses from a customer. This doesn't delete the Address,
only the association between the Address and the customer.
summary: Remove an Address from Customer
description: Remove a customer's address.
x-authenticated: true
parameters:
- name: id
@@ -310,7 +309,7 @@ delete:
type: string
- name: address_id
in: path
description: The customer's address id.
description: The customer address's ID.
required: true
schema:
type: string
@@ -421,3 +420,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteCustomerAddressesWorkflow
www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml
-55
View File
@@ -12,61 +12,6 @@ get:
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_exchanges.yaml
+1
View File
@@ -213,3 +213,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: beginExchangeOrderWorkflow
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml
+1 -55
View File
@@ -10,61 +10,6 @@ post:
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: []
@@ -100,3 +45,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelOrderExchangeWorkflow
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_exchanges_{id}_inbound_items_{action_id}.yaml
+11 -60
View File
@@ -16,61 +16,6 @@ post:
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: []
@@ -111,10 +56,16 @@ post:
x-workflow: updateRequestItemReturnWorkflow
delete:
operationId: DeleteExchangesIdInboundItemsAction_id
summary: Remove Items from Exchange
description: >-
Remove a list of items from a exchange. This doesn't delete the Item, only
the association between the Item and the exchange.
summary: Remove Inbound Item from Exchange
x-sidebar-summary: Remove Inbound Item
description: >
Remove 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
@@ -125,7 +76,7 @@ delete:
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
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_exchanges_{id}_inbound_shipping-method_{action_id}.yaml
+11 -61
View File
@@ -110,11 +110,16 @@ post:
x-workflow: updateReturnShippingMethodWorkflow
delete:
operationId: DeleteExchangesIdInboundShippingMethodAction_id
summary: Remove Shipping Methods from Exchange
description: >-
Remove a list of shipping methods from a exchange. This doesn't delete the
Shipping Method, only the association between the Shipping Method and the
exchange.
summary: Remove Inbound Shipping Method from Exchange
x-sidebar-summary: Remove Inbound Shipping Method
description: >
Remove 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
@@ -125,65 +130,10 @@ delete:
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
- 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_exchanges_{id}_outbound_items_{action_id}.yaml
+11 -5
View File
@@ -110,10 +110,16 @@ post:
x-workflow: updateExchangeAddItemWorkflow
delete:
operationId: DeleteExchangesIdOutboundItemsAction_id
summary: Remove Items from Exchange
description: >-
Remove a list of items from a exchange. This doesn't delete the Item, only
the association between the Item and the exchange.
summary: Remove Outbound Item from Exchange
x-sidebar-summary: Remove Outbound Item
description: >
Remove 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
@@ -124,7 +130,7 @@ delete:
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
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml
+11 -6
View File
@@ -110,11 +110,16 @@ post:
x-workflow: updateExchangeShippingMethodWorkflow
delete:
operationId: DeleteExchangesIdOutboundShippingMethodAction_id
summary: Remove Shipping Methods from Exchange
description: >-
Remove a list of shipping methods from a exchange. This doesn't delete the
Shipping Method, only the association between the Shipping Method and the
exchange.
summary: Remove Outbound Shipping Method from Exchange
x-sidebar-summary: Remove Outbound Shipping Method
description: >
Remove 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
@@ -125,7 +130,7 @@ delete:
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
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml
+6 -61
View File
@@ -102,10 +102,8 @@ post:
schema: {}
delete:
operationId: DeleteExchangesIdRequest
summary: Remove Requests from Exchange
description: >-
Remove a list of requests from a exchange. This doesn't delete the Request,
only the association between the Request and the exchange.
summary: Cancel Exchange Request
description: Cancel a requested exchange.
x-authenticated: true
parameters:
- name: id
@@ -114,61 +112,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: []
@@ -200,11 +143,12 @@ delete:
object:
type: string
title: object
description: The exchange's object.
description: The name of the deleted object.
default: exchange
deleted:
type: boolean
title: deleted
description: The exchange's deleted.
description: Whether the exchange was deleted.
parent:
type: object
description: The exchange's parent.
@@ -220,3 +164,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelBeginOrderExchangeWorkflow
www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml
+1 -1
View File
@@ -79,7 +79,7 @@ get:
- name: is_enabled
in: query
description: The fulfillment provider's is enabled.
required: true
required: false
schema:
type: boolean
title: is_enabled
www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml
+2 -56
View File
@@ -1,6 +1,6 @@
delete:
operationId: DeleteFulfillmentSetsId
summary: Delete a Fulfillment Set
summary: Delete Fulfillment Set
description: Delete a fulfillment set.
x-authenticated: true
parameters:
@@ -10,61 +10,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: []
@@ -95,3 +40,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteFulfillmentSetsWorkflow
www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml
+1
View File
@@ -215,3 +215,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createServiceZonesWorkflow
www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml
+11 -65
View File
@@ -344,13 +344,12 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateServiceZonesWorkflow
delete:
operationId: DeleteFulfillmentSetsIdServiceZonesZone_id
summary: Remove Service Zones from Fulfillment Set
description: >-
Remove a list of service zones from a fulfillment set. This doesn't delete
the Service Zone, only the association between the Service Zone and the
fulfillment set.
summary: Remove a Service Zone from Fulfillment Set
x-sidebar-summary: Remove Service Zone
description: Remove a service zone that belongs to a fulfillment set.
x-authenticated: true
parameters:
- name: id
@@ -361,65 +360,10 @@ delete:
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
- 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: []
@@ -448,18 +392,19 @@ delete:
id:
type: string
title: id
description: The fulfillment set's ID.
description: The service zone's ID.
object:
type: string
title: object
description: The fulfillment set's object.
description: The name of the deleted object.
default: service_zone
deleted:
type: boolean
title: deleted
description: The fulfillment set's deleted.
description: Whether the service zone was deleted.
parent:
type: object
description: The fulfillment set's parent.
description: The fulfillment set that the service zone belongs to.
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -472,3 +417,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteServiceZonesWorkflow
www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml
+1
View File
@@ -100,3 +100,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelFulfillmentWorkflow
www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml
+1
View File
@@ -100,3 +100,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createShipmentWorkflow
www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml
+1 -1
View File
@@ -156,7 +156,7 @@ get:
- name: requires_shipping
in: query
description: The inventory item's requires shipping.
required: true
required: false
schema:
type: boolean
title: requires_shipping
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml
+7 -59
View File
@@ -270,10 +270,11 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateInventoryItemsWorkflow
delete:
operationId: DeleteInventoryItemsId
summary: Delete a Inventory Item
description: Delete a inventory item.
summary: Delete Inventory Item
description: Delete an inventory item.
x-authenticated: true
parameters:
- name: id
@@ -282,61 +283,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: []
@@ -368,11 +314,12 @@ delete:
object:
type: string
title: object
description: The inventory item's object.
description: The name of the deleted object.
default: inventory_item
deleted:
type: boolean
title: deleted
description: The inventory item's deleted.
description: Whether the inventory item was deleted.
parent:
type: object
description: The inventory item's parent.
@@ -388,3 +335,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteInventoryItemWorkflow
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml
+1
View File
@@ -279,3 +279,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createInventoryLevelsWorkflow
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml
+1 -55
View File
@@ -10,61 +10,6 @@ post:
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: []
@@ -153,3 +98,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: bulkCreateDeleteLevelsWorkflow
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
+15 -9
View File
@@ -117,13 +117,17 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateInventoryLevelsWorkflow
delete:
operationId: DeleteInventoryItemsIdLocationLevelsLocation_id
summary: Remove Location Levels from Inventory Item
description: >-
Remove a list of location levels from a inventory item. This doesn't delete
the Location Level, only the association between the Location Level and the
inventory item.
summary: Remove Inventory Level of Inventory Item
x-sidebar-summary: Remove Inventory Level
description: >
Remove the inventory level of an inventory item.
If the inventory level has reserved quantity greater than `0`, an error is
thrown.
x-authenticated: true
parameters:
- name: id
@@ -221,18 +225,19 @@ delete:
id:
type: string
title: id
description: The inventory item's ID.
description: The inventory level's ID.
object:
type: string
title: object
description: The inventory item's object.
description: The name of the deleted object.
default: inventory-level
deleted:
type: boolean
title: deleted
description: The inventory item's deleted.
description: Whether the inventory level was deleted.
parent:
type: object
description: The inventory item's parent.
description: The inventory item of the level.
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -245,3 +250,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteInventoryLevelsWorkflow
www/apps/api-reference/specs/admin/paths/admin_invites.yaml
+4 -90
View File
@@ -103,104 +103,17 @@ get:
in: query
description: The invite's created at.
required: false
schema:
type: string
description: The invite's created at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: created_at
schema: {}
- name: updated_at
in: query
description: The invite's updated at.
required: false
schema:
type: string
description: The invite's updated at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: updated_at
schema: {}
- name: deleted_at
in: query
description: The invite's deleted at.
required: false
schema:
type: string
description: The invite's deleted at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
schema: {}
- name: $and
in: query
required: false
@@ -375,3 +288,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createInvitesWorkflow
www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml
+1
View File
@@ -125,3 +125,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: acceptInviteWorkflow
www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml
+6 -59
View File
@@ -95,8 +95,8 @@ get:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteInvitesId
summary: Delete a Invite
description: Delete a invite.
summary: Delete Invite
description: Delete an invite.
x-authenticated: false
parameters:
- name: id
@@ -105,61 +105,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 `-`.
x-codeSamples:
- lang: Shell
label: cURL
@@ -187,11 +132,12 @@ delete:
object:
type: string
title: object
description: The invite's object.
description: The name of the deleted object.
default: invite
deleted:
type: boolean
title: deleted
description: The invite's deleted.
description: Whether the invite was deleted.
parent:
type: object
description: The invite's parent.
@@ -207,3 +153,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteInvitesWorkflow
www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml
+1
View File
@@ -95,3 +95,4 @@ post:
content:
application/json:
schema: {}
x-workflow: refreshInviteTokensWorkflow
www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml
+2 -56
View File
@@ -3,62 +3,7 @@ post:
summary: Create Order Edit
description: Create a order edit.
x-authenticated: true
parameters:
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
required: false
schema:
type: string
title: fields
description: >-
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
parameters: []
security:
- api_token: []
- cookie_auth: []
@@ -94,3 +39,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: beginOrderEditOrderWorkflow
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml
+6 -59
View File
@@ -1,7 +1,7 @@
delete:
operationId: DeleteOrderEditsId
summary: Delete a Order Edit
description: Delete a order edit.
summary: Cancel Order Edit
description: Cancel an order edit.
x-authenticated: true
parameters:
- name: id
@@ -10,61 +10,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: []
@@ -96,11 +41,12 @@ delete:
object:
type: string
title: object
description: The order edit's object.
description: The name of the deleted object.
default: order-edit
deleted:
type: boolean
title: deleted
description: The order edit's deleted.
description: Whether the order edit was deleted.
parent:
type: object
description: The order edit's parent.
@@ -116,3 +62,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelBeginOrderEditWorkflow
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_order-edits_{id}_items.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_order-edits_{id}_items_item_{item_id}.yaml
-55
View File
@@ -16,61 +16,6 @@ post:
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_order-edits_{id}_items_{action_id}.yaml
+11 -115
View File
@@ -16,61 +16,6 @@ post:
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: []
@@ -109,10 +54,16 @@ post:
x-workflow: updateOrderEditAddItemWorkflow
delete:
operationId: DeleteOrderEditsIdItemsAction_id
summary: Remove Items from Order Edit
description: >-
Remove a list of items from a order edit. This doesn't delete the Item, only
the association between the Item and the order edit.
summary: Remove Item from Order Edit
x-sidebar-summary: Remove Item
description: >
Remove 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
@@ -123,65 +74,10 @@ delete:
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
- 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_order-edits_{id}_request.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_order-edits_{id}_shipping-method.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_order-edits_{id}_shipping-method_{action_id}.yaml
+11 -116
View File
@@ -16,61 +16,6 @@ post:
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: []
@@ -111,11 +56,16 @@ post:
x-workflow: updateOrderEditShippingMethodWorkflow
delete:
operationId: DeleteOrderEditsIdShippingMethodAction_id
summary: Remove Shipping Methods from Order Edit
description: >-
Remove a list of shipping methods from a order edit. This doesn't delete the
Shipping Method, only the association between the Shipping Method and the
order edit.
summary: Remove Shipping Method from Order Edit
x-sidebar-summary: Remove Shipping Method
description: >
Remove 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
@@ -126,65 +76,10 @@ delete:
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
- 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_orders.yaml
+1
View File
@@ -120,3 +120,4 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: getOrdersListWorkflow
www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml
+1
View File
@@ -97,6 +97,7 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: getOrderDetailWorkflow
post:
operationId: PostOrdersId
summary: Update a Order
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml
+1
View File
@@ -100,3 +100,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: archiveOrderWorkflow
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml
+1
View File
@@ -99,3 +99,4 @@ post:
content:
application/json:
schema: {}
x-workflow: cancelOrderWorkflow
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml
+97
View File
@@ -0,0 +1,97 @@
get:
operationId: GetOrdersIdChanges
summary: List Changes
description: >-
Retrieve a list of changes in a order. The changes can be filtered by fields
like FILTER FIELDS. The changes can also be paginated.
x-authenticated: true
parameters:
- name: id
in: path
description: The order's ID.
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: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_orders_{id}_changes/get.sh
tags:
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrderChangesResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml
+1
View File
@@ -119,3 +119,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: completeOrderWorkflow
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml
+1
View File
@@ -146,3 +146,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createOrderFulfillmentWorkflow
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+1
View File
@@ -124,3 +124,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: cancelOrderFulfillmentWorkflow
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml
+1
View File
@@ -171,3 +171,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createOrderShipmentWorkflow
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml
-55
View File
@@ -12,61 +12,6 @@ get:
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_payment-collections_{id}.yaml
+4 -57
View File
@@ -10,61 +10,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: []
@@ -96,11 +41,12 @@ delete:
object:
type: string
title: object
description: The payment collection's object.
description: The name of the deleted object.
default: payment-collection
deleted:
type: boolean
title: deleted
description: The payment collection's deleted.
description: Whether the payment collection was deleted.
parent:
type: object
description: The payment collection's parent.
@@ -116,3 +62,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteOrderPaymentCollections
www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml
+1
View File
@@ -109,3 +109,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: markPaymentCollectionAsPaid
www/apps/api-reference/specs/admin/paths/admin_payments.yaml
+3 -90
View File
@@ -101,104 +101,17 @@ get:
in: query
description: The payment's created at.
required: false
schema:
type: string
description: The payment's created at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: created_at
schema: {}
- name: updated_at
in: query
description: The payment's updated at.
required: false
schema:
type: string
description: The payment's updated at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: updated_at
schema: {}
- name: deleted_at
in: query
description: The payment's deleted at.
required: false
schema:
type: string
description: The payment's deleted at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
schema: {}
- name: $and
in: query
required: false
www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml
+1
View File
@@ -106,3 +106,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: capturePaymentWorkflow
www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml
+1
View File
@@ -114,3 +114,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: refundPaymentWorkflow
www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml
+1
View File
@@ -187,3 +187,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createPriceListsWorkflow
www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml
+2 -55
View File
@@ -199,6 +199,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updatePriceListsWorkflow
delete:
operationId: DeletePriceListsId
summary: Delete a Price List
@@ -211,61 +212,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: []
@@ -296,3 +242,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deletePriceListsWorkflow
www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml
+1 -55
View File
@@ -10,61 +10,6 @@ post:
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: []
@@ -184,3 +129,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: batchPriceListPricesWorkflow
www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml
+1
View File
@@ -116,3 +116,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: batchPriceListPricesWorkflow
www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml
+1
View File
@@ -188,3 +188,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createPricePreferencesWorkflow
www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml
+2 -55
View File
@@ -199,6 +199,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updatePricePreferencesWorkflow
delete:
operationId: DeletePricePreferencesId
summary: Delete a Price Preference
@@ -211,61 +212,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: []
@@ -296,3 +242,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deletePricePreferencesWorkflow
www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml
+7 -94
View File
@@ -129,7 +129,7 @@ get:
- name: include_ancestors_tree
in: query
description: The product category's include ancestors tree.
required: true
required: false
schema:
type: boolean
title: include_ancestors_tree
@@ -137,7 +137,7 @@ get:
- name: include_descendants_tree
in: query
description: The product category's include descendants tree.
required: true
required: false
schema:
type: boolean
title: include_descendants_tree
@@ -145,7 +145,7 @@ get:
- name: is_internal
in: query
description: The product category's is internal.
required: true
required: false
schema:
type: boolean
title: is_internal
@@ -153,7 +153,7 @@ get:
- name: is_active
in: query
description: The product category's is active.
required: true
required: false
schema:
type: boolean
title: is_active
@@ -162,104 +162,17 @@ get:
in: query
description: The product category's created at.
required: false
schema:
type: string
description: The product category's created at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: created_at
schema: {}
- name: updated_at
in: query
description: The product category's updated at.
required: false
schema:
type: string
description: The product category's updated at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: updated_at
schema: {}
- name: deleted_at
in: query
description: The product category's deleted at.
required: false
schema:
type: string
description: The product category's deleted at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
schema: {}
- name: $and
in: query
required: false
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml
+5 -58
View File
@@ -70,7 +70,7 @@ get:
- name: include_ancestors_tree
in: query
description: The product category's include ancestors tree.
required: true
required: false
schema:
type: boolean
title: include_ancestors_tree
@@ -78,7 +78,7 @@ get:
- name: include_descendants_tree
in: query
description: The product category's include descendants tree.
required: true
required: false
schema:
type: boolean
title: include_descendants_tree
@@ -251,10 +251,11 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateProductCategoriesWorkflow
delete:
operationId: DeleteProductCategoriesId
summary: Delete a Product Category
description: Delete a product category.
description: Delete a product category. This doesn't deleted products in that category.
x-authenticated: true
parameters:
- name: id
@@ -263,61 +264,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: []
@@ -348,3 +294,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteProductCategoriesWorkflow
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml
+1
View File
@@ -116,3 +116,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: batchLinkProductsToCategoryWorkflow
www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml
+3 -90
View File
@@ -101,104 +101,17 @@ get:
in: query
description: The product tag's created at.
required: false
schema:
type: string
description: The product tag's created at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: created_at
schema: {}
- name: updated_at
in: query
description: The product tag's updated at.
required: false
schema:
type: string
description: The product tag's updated at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: updated_at
schema: {}
- name: deleted_at
in: query
description: The product tag's deleted at.
required: false
schema:
type: string
description: The product tag's deleted at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
schema: {}
- name: $and
in: query
required: false
www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml
+2 -56
View File
@@ -214,7 +214,7 @@ post:
delete:
operationId: DeleteProductTagsId
summary: Delete a Product Tag
description: Delete a product tag.
description: Delete a product tag. This doesn't delete products using the tag.
x-authenticated: true
parameters:
- name: id
@@ -223,61 +223,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: []
@@ -308,3 +253,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteProductTagsWorkflow
www/apps/api-reference/specs/admin/paths/admin_product-types.yaml
+3 -90
View File
@@ -101,104 +101,17 @@ get:
in: query
description: The product type's created at.
required: false
schema:
type: string
description: The product type's created at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: created_at
schema: {}
- name: updated_at
in: query
description: The product type's updated at.
required: false
schema:
type: string
description: The product type's updated at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: updated_at
schema: {}
- name: deleted_at
in: query
description: The product type's deleted at.
required: false
schema:
type: string
description: The product type's deleted at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
schema: {}
- name: $and
in: query
required: false
www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml
+2 -56
View File
@@ -214,7 +214,7 @@ post:
delete:
operationId: DeleteProductTypesId
summary: Delete a Product Type
description: Delete a product type.
description: Delete a product type. This doesn't delete products of this type.
x-authenticated: true
parameters:
- name: id
@@ -223,61 +223,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: []
@@ -308,3 +253,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteProductTypesWorkflow
www/apps/api-reference/specs/admin/paths/admin_products.yaml
+340 -5312
View File
File diff suppressed because it is too large Load Diff
www/apps/api-reference/specs/admin/paths/admin_products_import.yaml
+1 -56
View File
@@ -3,62 +3,7 @@ post:
summary: Create Product
description: Create a product.
x-authenticated: true
parameters:
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
required: false
schema:
type: string
title: fields
description: >-
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
parameters: []
security:
- api_token: []
- cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml
+1 -55
View File
@@ -10,61 +10,6 @@ post:
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: []
@@ -94,3 +39,4 @@ post:
content:
application/json:
schema: {}
x-workflow: importProductsWorkflowId
www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml
+1 -55
View File
@@ -223,61 +223,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: []
@@ -308,3 +253,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteProductsWorkflow
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml
+5 -8
View File
@@ -125,10 +125,8 @@ get:
type: array
description: The product's $and.
items:
type: array
items:
type: object
title: $and
type: object
title: $and
- name: $or
in: query
description: The product's $or.
@@ -137,10 +135,8 @@ get:
type: array
description: The product's $or.
items:
type: array
items:
type: object
title: $or
type: object
title: $or
security:
- api_token: []
- cookie_auth: []
@@ -313,3 +309,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createProductOptionsWorkflow
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml
+9 -5
View File
@@ -222,12 +222,15 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateProductOptionsWorkflow
delete:
operationId: DeleteProductsIdOptionsOption_id
summary: Remove Options from Product
description: >-
Remove a list of options from a product. This doesn't delete the Option,
only the association between the Option and the product.
summary: Delete an Option from Product
x-sidebar-summary: Delete Option
description: |
Delete an option from a product.
Values of this option in the product's variants are removed.
x-authenticated: true
parameters:
- name: id
@@ -238,7 +241,7 @@ delete:
type: string
- name: option_id
in: path
description: The product's option id.
description: The product option's ID.
required: true
schema:
type: string
@@ -328,3 +331,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteProductOptionsWorkflow
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml
+1
View File
@@ -239,3 +239,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createProductVariantsWorkflow
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml
-55
View File
@@ -10,61 +10,6 @@ post:
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_products_{id}_variants_{variant_id}.yaml
+6 -5
View File
@@ -223,12 +223,12 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateProductVariantsWorkflow
delete:
operationId: DeleteProductsIdVariantsVariant_id
summary: Remove Variants from Product
description: >-
Remove a list of variants from a product. This doesn't delete the Variant,
only the association between the Variant and the product.
summary: Delete Product Variant
x-sidebar-summary: Delete Variant
description: Delete a variant of a product.
x-authenticated: true
parameters:
- name: id
@@ -239,7 +239,7 @@ delete:
type: string
- name: variant_id
in: path
description: The product's variant id.
description: The product variant's ID.
required: true
schema:
type: string
@@ -329,3 +329,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteProductVariantsWorkflow
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml
+1
View File
@@ -107,3 +107,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createLinksWorkflow
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml
+6 -7
View File
@@ -113,13 +113,12 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateLinksWorkflow
delete:
operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id
summary: Remove Inventory Items from Product
description: >-
Remove a list of inventory items from a product. This doesn't delete the
Inventory Item, only the association between the Inventory Item and the
product.
summary: Remove Inventory Item Association with Product Variant
x-sidebar-summary: Remove Inventory Item
description: Remove the association between an inventory item and its product variant.
x-authenticated: true
parameters:
- name: id
@@ -130,13 +129,13 @@ delete:
type: string
- name: variant_id
in: path
description: The product's variant id.
description: The products variant's ID.
required: true
schema:
type: string
- name: inventory_item_id
in: path
description: The product's inventory item id.
description: The inventory item's ID.
required: true
schema:
type: string
www/apps/api-reference/specs/admin/paths/admin_promotions.yaml
+4 -90
View File
@@ -120,104 +120,17 @@ get:
in: query
description: The promotion's created at.
required: false
schema:
type: string
description: The promotion's created at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: created_at
schema: {}
- name: updated_at
in: query
description: The promotion's updated at.
required: false
schema:
type: string
description: The promotion's updated at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: updated_at
schema: {}
- name: deleted_at
in: query
description: The promotion's deleted at.
required: false
schema:
type: string
description: The promotion's deleted at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
schema: {}
- name: $and
in: query
required: false
@@ -669,3 +582,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createPromotionsWorkflow

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