chore(docs): Updated API Reference (v2) (#8609)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
Shahed Nasser
Shahed Nasser
parent
4bd0917aed
commit
b23ddcdde8
@@ -73,6 +73,41 @@ get:
|
||||
tags:
|
||||
- Api Keys
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The api key's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The api key's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The api key's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- api_keys
|
||||
properties:
|
||||
api_keys:
|
||||
type: array
|
||||
description: The api key's api keys.
|
||||
items:
|
||||
$ref: ../components/schemas/ApiKeyResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -163,6 +198,12 @@ post:
|
||||
tags:
|
||||
- Api Keys
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminApiKeyResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -175,3 +216,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createApiKeysWorkflow
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Api Keys
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminApiKeyResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -175,6 +181,12 @@ post:
|
||||
tags:
|
||||
- Api Keys
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminApiKeyResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -266,6 +278,33 @@ delete:
|
||||
tags:
|
||||
- Api Keys
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The api key's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The api key's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The api key's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The api key's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Api Keys
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminApiKeyResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -98,6 +98,12 @@ post:
|
||||
tags:
|
||||
- Api Keys
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminApiKeyResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,41 @@ get:
|
||||
tags:
|
||||
- Campaigns
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The campaign's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The campaign's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The campaign's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- campaigns
|
||||
properties:
|
||||
campaigns:
|
||||
type: array
|
||||
description: The campaign's campaigns.
|
||||
items:
|
||||
$ref: ../components/schemas/CampaignResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -154,15 +189,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- name
|
||||
- campaign_identifier
|
||||
- description
|
||||
- budget
|
||||
- starts_at
|
||||
- ends_at
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
@@ -228,6 +255,12 @@ post:
|
||||
tags:
|
||||
- Campaigns
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCampaignResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Campaigns
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCampaignResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -166,7 +172,53 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateCampaign.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The campaign's name.
|
||||
campaign_identifier:
|
||||
type: string
|
||||
title: campaign_identifier
|
||||
description: The campaign's campaign identifier.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The campaign's description.
|
||||
budget:
|
||||
type: object
|
||||
description: The campaign's budget.
|
||||
required:
|
||||
- limit
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The budget's limit.
|
||||
starts_at:
|
||||
type: string
|
||||
title: starts_at
|
||||
description: The campaign's starts at.
|
||||
format: date-time
|
||||
ends_at:
|
||||
type: string
|
||||
title: ends_at
|
||||
description: The campaign's ends at.
|
||||
format: date-time
|
||||
promotions:
|
||||
type: array
|
||||
description: The campaign's promotions.
|
||||
items:
|
||||
type: object
|
||||
description: The promotion's promotions.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The promotion's ID.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -175,6 +227,12 @@ post:
|
||||
tags:
|
||||
- Campaigns
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCampaignResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -266,6 +324,33 @@ delete:
|
||||
tags:
|
||||
- Campaigns
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The campaign's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The campaign's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The campaign's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The campaign's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -98,6 +98,12 @@ post:
|
||||
tags:
|
||||
- Campaigns
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCampaignResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,12 @@ get:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -163,6 +169,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
get:
|
||||
operationId: GetClaimsId
|
||||
summary: Get a Claim
|
||||
description: >-
|
||||
Retrieve a claim by its ID. You can expand the claim's relations or select
|
||||
the fields that should be returned.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The claim'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_claims_{id}/get.sh
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimResponse.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
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -94,3 +100,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: orderClaimItemWorkflow
|
||||
|
||||
+14
@@ -89,6 +89,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -101,6 +107,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateClaimItemWorkflow
|
||||
delete:
|
||||
operationId: DeleteClaimsIdClaimItemsAction_id
|
||||
summary: Remove Claim Items from Claim
|
||||
@@ -189,6 +196,12 @@ delete:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -201,3 +214,4 @@ delete:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeItemClaimActionWorkflow
|
||||
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -94,3 +100,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: orderClaimRequestItemReturnWorkflow
|
||||
|
||||
+14
@@ -90,6 +90,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -102,6 +108,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateRequestItemReturnWorkflow
|
||||
delete:
|
||||
operationId: DeleteClaimsIdInboundItemsAction_id
|
||||
summary: Remove Items from Claim
|
||||
@@ -190,6 +197,12 @@ delete:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -202,3 +215,4 @@ delete:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeItemReturnActionWorkflow
|
||||
|
||||
+7
@@ -83,6 +83,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -95,3 +101,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createClaimShippingMethodWorkflow
|
||||
|
||||
+14
@@ -89,6 +89,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -101,6 +107,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateReturnShippingMethodWorkflow
|
||||
delete:
|
||||
operationId: DeleteClaimsIdInboundShippingMethodAction_id
|
||||
summary: Remove Shipping Methods from Claim
|
||||
@@ -190,6 +197,12 @@ delete:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -202,3 +215,4 @@ delete:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeClaimShippingMethodWorkflow
|
||||
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -94,3 +100,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: orderClaimAddNewItemWorkflow
|
||||
|
||||
+14
@@ -89,6 +89,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -101,6 +107,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateClaimAddItemWorkflow
|
||||
delete:
|
||||
operationId: DeleteClaimsIdOutboundItemsAction_id
|
||||
summary: Remove Items from Claim
|
||||
@@ -189,6 +196,12 @@ delete:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -201,3 +214,4 @@ delete:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeAddItemClaimActionWorkflow
|
||||
|
||||
+7
@@ -83,6 +83,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -95,3 +101,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createClaimShippingMethodWorkflow
|
||||
|
||||
+14
@@ -89,6 +89,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -101,6 +107,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateClaimShippingMethodWorkflow
|
||||
delete:
|
||||
operationId: DeleteClaimsIdOutboundShippingMethodAction_id
|
||||
summary: Remove Shipping Methods from Claim
|
||||
@@ -190,6 +197,12 @@ delete:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -202,3 +215,4 @@ delete:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeClaimShippingMethodWorkflow
|
||||
|
||||
@@ -77,6 +77,12 @@ post:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimRequestResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -93,6 +99,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
x-workflow: confirmClaimRequestWorkflow
|
||||
delete:
|
||||
operationId: DeleteClaimsIdRequest
|
||||
summary: Remove Requests from Claim
|
||||
@@ -174,6 +181,12 @@ delete:
|
||||
tags:
|
||||
- Claims
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminClaimDeleteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,12 @@ get:
|
||||
tags:
|
||||
- Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCollectionListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -163,6 +169,12 @@ post:
|
||||
tags:
|
||||
- Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCollectionResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -175,3 +187,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createCollectionsWorkflow
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCollectionResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -175,6 +181,12 @@ post:
|
||||
tags:
|
||||
- Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCollectionResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -266,6 +278,12 @@ delete:
|
||||
tags:
|
||||
- Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCollectionDeleteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -98,6 +98,12 @@ post:
|
||||
tags:
|
||||
- Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCollectionResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,12 @@ get:
|
||||
tags:
|
||||
- Currencies
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCurrencyListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Currencies
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCurrencyResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,41 @@ get:
|
||||
tags:
|
||||
- Customer Groups
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The customer group's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The customer group's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The customer group's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- customer_groups
|
||||
properties:
|
||||
customer_groups:
|
||||
type: array
|
||||
description: The customer group's customer groups.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminCustomerGroup.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -163,6 +198,12 @@ post:
|
||||
tags:
|
||||
- Customer Groups
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerGroupResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Customer Groups
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerGroupResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -175,6 +181,12 @@ post:
|
||||
tags:
|
||||
- Customer Groups
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerGroupResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -266,6 +278,33 @@ delete:
|
||||
tags:
|
||||
- Customer Groups
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer group's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The customer group's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The customer group's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The customer group's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -98,6 +98,12 @@ post:
|
||||
tags:
|
||||
- Customer Groups
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerGroupResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -186,7 +186,32 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateCustomer.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The customer's email.
|
||||
format: email
|
||||
company_name:
|
||||
type: string
|
||||
title: company_name
|
||||
description: The customer's company name.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -200,13 +225,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ../components/schemas/AdminCustomer.yaml
|
||||
$ref: ../components/schemas/AdminCustomerResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -84,13 +84,7 @@ get:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ../components/schemas/AdminCustomer.yaml
|
||||
$ref: ../components/schemas/AdminCustomerResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -178,7 +172,32 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateCustomer.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The customer's email.
|
||||
format: email
|
||||
company_name:
|
||||
type: string
|
||||
title: company_name
|
||||
description: The customer's company name.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -192,13 +211,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ../components/schemas/AdminCustomer.yaml
|
||||
$ref: ../components/schemas/AdminCustomerResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -290,6 +303,33 @@ delete:
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The customer's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The customer's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The customer's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,41 @@ get:
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The customer's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The customer's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The customer's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- addresses
|
||||
properties:
|
||||
addresses:
|
||||
type: array
|
||||
description: The customer's addresses.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminCustomerAddress.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -166,7 +201,63 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateCustomerAddress.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
address_name:
|
||||
type: string
|
||||
title: address_name
|
||||
description: The customer's address name.
|
||||
is_default_shipping:
|
||||
type: boolean
|
||||
title: is_default_shipping
|
||||
description: The customer's is default shipping.
|
||||
is_default_billing:
|
||||
type: boolean
|
||||
title: is_default_billing
|
||||
description: The customer's is default billing.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The customer's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The customer's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The customer's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The customer's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The customer's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The customer's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The customer's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -175,6 +266,12 @@ post:
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+96
-1
@@ -86,6 +86,12 @@ get:
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerAddressResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -179,7 +185,63 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateCustomerAddress.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
address_name:
|
||||
type: string
|
||||
title: address_name
|
||||
description: The customer's address name.
|
||||
is_default_shipping:
|
||||
type: boolean
|
||||
title: is_default_shipping
|
||||
description: The customer's is default shipping.
|
||||
is_default_billing:
|
||||
type: boolean
|
||||
title: is_default_billing
|
||||
description: The customer's is default billing.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The customer's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The customer's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The customer's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The customer's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The customer's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The customer's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The customer's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -189,6 +251,12 @@ post:
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -289,6 +357,33 @@ delete:
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The customer's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The customer's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The customer's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,38 @@ get:
|
||||
tags:
|
||||
- Draft Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The draft order's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The draft order's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The draft order's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- draft_orders
|
||||
properties:
|
||||
draft_orders:
|
||||
$ref: ../components/schemas/AdminOrder.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -154,16 +186,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- sales_channel_id
|
||||
- email
|
||||
- customer_id
|
||||
- region_id
|
||||
- currency_code
|
||||
- shipping_methods
|
||||
- metadata
|
||||
properties:
|
||||
status:
|
||||
type: boolean
|
||||
@@ -444,6 +467,12 @@ post:
|
||||
tags:
|
||||
- Draft Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDraftOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -456,3 +485,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createOrdersWorkflow
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Draft Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDraftOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -0,0 +1,211 @@
|
||||
get:
|
||||
operationId: GetExchanges
|
||||
summary: List Exchanges
|
||||
description: >-
|
||||
Retrieve a list of exchanges. The exchanges can be filtered by fields such
|
||||
as `id`. The exchanges can also be sorted or paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
data.
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_exchanges/get.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The exchange's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The exchange's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The exchange's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- exchanges
|
||||
properties:
|
||||
exchanges:
|
||||
$ref: ../components/schemas/AdminExchange.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
|
||||
post:
|
||||
operationId: PostExchanges
|
||||
summary: Create Exchange
|
||||
description: Create a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
data.
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderExchangesReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_exchanges/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeOrderResponse.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
|
||||
@@ -0,0 +1,100 @@
|
||||
post:
|
||||
operationId: PostExchangesIdCancel
|
||||
summary: Add Cancels to Exchange
|
||||
description: Add a list of cancels to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange'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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCancelExchangeReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_exchanges_{id}_cancel/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeResponse.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
|
||||
@@ -0,0 +1,102 @@
|
||||
post:
|
||||
operationId: PostExchangesIdInboundItems
|
||||
summary: Add Items to Exchange
|
||||
description: Add a list of items to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange'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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeReturnResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: orderExchangeRequestItemReturnWorkflow
|
||||
+214
@@ -0,0 +1,214 @@
|
||||
post:
|
||||
operationId: PostExchangesIdInboundItemsAction_id
|
||||
summary: Add Items to Exchange
|
||||
description: Add a list of items to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeReturnResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: 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.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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_exchanges_{id}_inbound_items_{action_id}/delete.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeReturnResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeItemReturnActionWorkflow
|
||||
+102
@@ -0,0 +1,102 @@
|
||||
post:
|
||||
operationId: PostExchangesIdInboundShippingMethod
|
||||
summary: Add Shipping Methods to Exchange
|
||||
description: Add a list of shipping methods to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange'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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeReturnResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createExchangeShippingMethodWorkflow
|
||||
+214
@@ -0,0 +1,214 @@
|
||||
post:
|
||||
operationId: PostExchangesIdInboundShippingMethodAction_id
|
||||
summary: Add Shipping Methods to Exchange
|
||||
description: Add a list of shipping methods to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangePreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: 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.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeReturnResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeReturnShippingMethodWorkflow
|
||||
@@ -0,0 +1,101 @@
|
||||
post:
|
||||
operationId: PostExchangesIdOutboundItems
|
||||
summary: Add Items to Exchange
|
||||
description: Add a list of items to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange'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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesAddItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangePreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: orderExchangeAddNewItemWorkflow
|
||||
+213
@@ -0,0 +1,213 @@
|
||||
post:
|
||||
operationId: PostExchangesIdOutboundItemsAction_id
|
||||
summary: Add Items to Exchange
|
||||
description: Add a list of items to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExhangesItemsActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangePreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: 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.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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_exchanges_{id}_outbound_items_{action_id}/delete.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangePreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeItemExchangeActionWorkflow
|
||||
+102
@@ -0,0 +1,102 @@
|
||||
post:
|
||||
operationId: PostExchangesIdOutboundShippingMethod
|
||||
summary: Add Shipping Methods to Exchange
|
||||
description: Add a list of shipping methods to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange'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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesShippingReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangePreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createExchangeShippingMethodWorkflow
|
||||
+214
@@ -0,0 +1,214 @@
|
||||
post:
|
||||
operationId: PostExchangesIdOutboundShippingMethodAction_id
|
||||
summary: Add Shipping Methods to Exchange
|
||||
description: Add a list of shipping methods to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangePreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: 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.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The exchange's action 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_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangePreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeExchangeShippingMethodWorkflow
|
||||
@@ -0,0 +1,214 @@
|
||||
post:
|
||||
operationId: PostExchangesIdRequest
|
||||
summary: Add Requests to Exchange
|
||||
description: Add a list of requests to a exchange.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange'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_exchanges_{id}_request/post.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExchangeRequestResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: confirmExchangeRequestWorkflow
|
||||
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.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The exchange'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_exchanges_{id}_request/delete.sh
|
||||
tags:
|
||||
- Exchanges
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The exchange's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The exchange's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The exchange's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The exchange's parent.
|
||||
'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
|
||||
@@ -118,6 +118,12 @@ get:
|
||||
tags:
|
||||
- Fulfillment Providers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminFulfillmentProviderListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+6
@@ -197,6 +197,12 @@ post:
|
||||
tags:
|
||||
- Fulfillment Sets
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminFulfillmentSetResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+27
@@ -433,6 +433,33 @@ delete:
|
||||
tags:
|
||||
- Fulfillment Sets
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The fulfillment set's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The fulfillment set's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The fulfillment set's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The fulfillment set's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -76,6 +76,12 @@ post:
|
||||
tags:
|
||||
- Fulfillments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminFulfillmentResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -88,3 +94,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createFulfillmentWorkflow
|
||||
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Fulfillments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminFulfillmentResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Fulfillments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminFulfillmentResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -311,11 +311,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The inventory item's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The inventory item's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -328,6 +338,41 @@ get:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The inventory item's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The inventory item's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The inventory item's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- inventory_items
|
||||
properties:
|
||||
inventory_items:
|
||||
type: array
|
||||
description: The inventory item's inventory items.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminInventoryItem.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -510,6 +555,12 @@ post:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -522,3 +573,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createInventoryItemsWorkflow
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -246,6 +252,12 @@ post:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -337,6 +349,33 @@ delete:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The inventory item's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The inventory item's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The inventory item's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The inventory item's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+53
-2
@@ -85,11 +85,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The inventory item's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The inventory item's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -103,6 +113,41 @@ get:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The inventory item's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The inventory item's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The inventory item's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- inventory_levels
|
||||
properties:
|
||||
inventory_levels:
|
||||
type: array
|
||||
description: The inventory item's inventory levels.
|
||||
items:
|
||||
$ref: ../components/schemas/InventoryLevel.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -216,6 +261,12 @@ post:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+13
@@ -128,6 +128,19 @@ post:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- inventory_item
|
||||
properties:
|
||||
inventory_item:
|
||||
type: object
|
||||
description: The inventory item's details.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+33
@@ -99,6 +99,12 @@ post:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -200,6 +206,33 @@ delete:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The inventory item's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The inventory item's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The inventory item's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The inventory item's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -204,11 +204,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The invite's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The invite's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -217,6 +227,41 @@ get:
|
||||
tags:
|
||||
- Invites
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The invite's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The invite's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The invite's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- invites
|
||||
properties:
|
||||
invites:
|
||||
type: array
|
||||
description: The invite's invites.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminInvite.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -312,6 +357,12 @@ post:
|
||||
tags:
|
||||
- Invites
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInviteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -91,6 +91,28 @@ post:
|
||||
tags:
|
||||
- Invites
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- user
|
||||
properties:
|
||||
user:
|
||||
$ref: ../components/schemas/AdminUser.yaml
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- message
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
title: message
|
||||
description: The invite's message.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -75,6 +75,12 @@ get:
|
||||
tags:
|
||||
- Invites
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInviteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -162,6 +168,33 @@ delete:
|
||||
tags:
|
||||
- Invites
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The invite's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The invite's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The invite's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The invite's parent.
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,12 @@ post:
|
||||
tags:
|
||||
- Invites
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInviteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -100,11 +100,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The notification's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The notification's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -117,6 +127,12 @@ get:
|
||||
tags:
|
||||
- Notifications
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminNotificationListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Notifications
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminNotificationResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,41 @@ get:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The order's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The order's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The order's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- orders
|
||||
properties:
|
||||
orders:
|
||||
type: array
|
||||
description: The order's orders.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminOrder.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -170,6 +176,12 @@ post:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -82,6 +82,12 @@ post:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -77,6 +77,12 @@ post:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,7 +73,12 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCompleteOrder.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The order's order id.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -82,6 +87,12 @@ post:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,7 +73,37 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderCreateFulfillment.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
description: The order's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
required:
|
||||
- id
|
||||
- quantity
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The order's location id.
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: The order's no notification.
|
||||
metadata:
|
||||
type: object
|
||||
description: The order's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -82,6 +112,12 @@ post:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+12
-1
@@ -79,7 +79,12 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderCancelFulfillment.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: The order's no notification.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -89,6 +94,12 @@ post:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+56
-1
@@ -79,7 +79,56 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderCreateShipment.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
description: The order's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
required:
|
||||
- id
|
||||
- quantity
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
labels:
|
||||
type: array
|
||||
description: The order's labels.
|
||||
items:
|
||||
type: object
|
||||
description: The label's labels.
|
||||
required:
|
||||
- tracking_number
|
||||
- tracking_url
|
||||
- label_url
|
||||
properties:
|
||||
tracking_number:
|
||||
type: string
|
||||
title: tracking_number
|
||||
description: The label's tracking number.
|
||||
tracking_url:
|
||||
type: string
|
||||
title: tracking_url
|
||||
description: The label's tracking url.
|
||||
label_url:
|
||||
type: string
|
||||
title: label_url
|
||||
description: The label's label url.
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: The order's no notification.
|
||||
metadata:
|
||||
type: object
|
||||
description: The order's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -89,6 +138,12 @@ post:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -202,11 +202,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The payment's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The payment's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -219,6 +229,41 @@ get:
|
||||
tags:
|
||||
- Payments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The payment's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The payment's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The payment's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- payments
|
||||
properties:
|
||||
payments:
|
||||
type: array
|
||||
description: The payment's payments.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminPayment.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -86,11 +86,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The payment's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The payment's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -103,6 +113,41 @@ get:
|
||||
tags:
|
||||
- Payments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The payment's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The payment's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The payment's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- payment_providers
|
||||
properties:
|
||||
payment_providers:
|
||||
type: array
|
||||
description: The payment's payment providers.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminPaymentProvider.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Payments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPaymentResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -88,6 +88,12 @@ post:
|
||||
tags:
|
||||
- Payments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPaymentResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -80,6 +80,14 @@ post:
|
||||
type: number
|
||||
title: amount
|
||||
description: The payment's amount.
|
||||
refund_reason_id:
|
||||
type: string
|
||||
title: refund_reason_id
|
||||
description: The payment's refund reason id.
|
||||
note:
|
||||
type: string
|
||||
title: note
|
||||
description: The payment's note.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -88,6 +96,12 @@ post:
|
||||
tags:
|
||||
- Payments
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPaymentResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -73,6 +73,12 @@ get:
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -163,6 +169,12 @@ post:
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -175,6 +181,12 @@ post:
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -266,6 +278,12 @@ delete:
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListDeleteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -166,6 +166,12 @@ post:
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListBatchResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -98,6 +98,12 @@ post:
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -74,6 +74,12 @@ get:
|
||||
tags:
|
||||
- Price Preferences
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPricePreferenceListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -164,6 +170,12 @@ post:
|
||||
tags:
|
||||
- Price Preferences
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPricePreferenceResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Price Preferences
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPricePreferenceResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -175,6 +181,12 @@ post:
|
||||
tags:
|
||||
- Price Preferences
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPricePreferenceResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -266,6 +278,12 @@ delete:
|
||||
tags:
|
||||
- Price Preferences
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPricePreferenceDeleteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -263,11 +263,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The product category's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The product category's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -431,3 +441,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createProductCategoriesWorkflow
|
||||
|
||||
@@ -330,6 +330,12 @@ delete:
|
||||
tags:
|
||||
- Product Categories
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductCategoryDeleteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -202,11 +202,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The product tag's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The product tag's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -219,6 +229,12 @@ get:
|
||||
tags:
|
||||
- Product Tags
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTagListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -321,6 +337,12 @@ post:
|
||||
tags:
|
||||
- Product Tags
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTagResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -333,3 +355,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createProductTagsWorkflow
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Product Tags
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTagResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -186,6 +192,12 @@ post:
|
||||
tags:
|
||||
- Product Tags
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTagResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -198,6 +210,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateProductTagsWorkflow
|
||||
delete:
|
||||
operationId: DeleteProductTagsId
|
||||
summary: Delete a Product Tag
|
||||
@@ -277,6 +290,12 @@ delete:
|
||||
tags:
|
||||
- Product Tags
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTagDeleteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -202,11 +202,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The product type's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The product type's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -219,6 +229,12 @@ get:
|
||||
tags:
|
||||
- Product Types
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTypeListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -321,6 +337,12 @@ post:
|
||||
tags:
|
||||
- Product Types
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTypeResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -333,3 +355,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createProductTypesWorkflow
|
||||
|
||||
@@ -79,6 +79,12 @@ get:
|
||||
tags:
|
||||
- Product Types
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTypeResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -186,6 +192,12 @@ post:
|
||||
tags:
|
||||
- Product Types
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTypeResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -198,6 +210,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateProductTypesWorkflow
|
||||
delete:
|
||||
operationId: DeleteProductTypesId
|
||||
summary: Delete a Product Type
|
||||
@@ -277,6 +290,12 @@ delete:
|
||||
tags:
|
||||
- Product Types
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductTypeDeleteResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
get:
|
||||
operationId: GetProductVariants
|
||||
summary: List Product Variants
|
||||
description: >-
|
||||
Retrieve a list of product variants. The product variants can be filtered by
|
||||
fields such as `id`. The product variants can also be sorted or paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
data.
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_product-variants/get.sh
|
||||
tags:
|
||||
- Product Variants
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The product variant's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The product variant's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The product variant's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- variants
|
||||
properties:
|
||||
variants:
|
||||
type: array
|
||||
description: The product variant's variants.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminProductVariant.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
|
||||
@@ -12062,6 +12062,9 @@ get:
|
||||
x-schemaName: BaseProductListParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
- name: $or
|
||||
in: query
|
||||
description: The product's $or.
|
||||
@@ -13976,6 +13979,9 @@ get:
|
||||
x-schemaName: BaseProductListParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -14104,7 +14110,148 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateProduct.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
subtitle:
|
||||
type: string
|
||||
title: subtitle
|
||||
description: The product's subtitle.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The product's description.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
discountable:
|
||||
type: boolean
|
||||
title: discountable
|
||||
description: The product's discountable.
|
||||
images:
|
||||
type: array
|
||||
description: The product's images.
|
||||
items:
|
||||
type: object
|
||||
description: The image's images.
|
||||
required:
|
||||
- url
|
||||
properties:
|
||||
url:
|
||||
type: string
|
||||
title: url
|
||||
description: The image's url.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The product's thumbnail.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
type_id:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The product's type id.
|
||||
collection_id:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The product's collection id.
|
||||
categories:
|
||||
type: array
|
||||
description: The product's categories.
|
||||
items:
|
||||
type: object
|
||||
description: The category's categories.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The category's ID.
|
||||
tags:
|
||||
type: array
|
||||
description: The product's tags.
|
||||
items:
|
||||
type: object
|
||||
description: The tag's tags.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The tag's ID.
|
||||
options:
|
||||
type: array
|
||||
description: The product's options.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminCreateProductOption.yaml
|
||||
variants:
|
||||
type: array
|
||||
description: The product's variants.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminCreateProductVariant.yaml
|
||||
sales_channels:
|
||||
type: array
|
||||
description: The product's sales channels.
|
||||
items:
|
||||
type: object
|
||||
description: The sales channel's sales channels.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The sales channel's ID.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The product's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The product's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The product's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The product's width.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The product's hs code.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The product's mid code.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The product's origin country.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The product's material.
|
||||
metadata:
|
||||
type: object
|
||||
description: The product's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -14131,3 +14278,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createProductsWorkflow
|
||||
|
||||
@@ -94,3 +94,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: batchProductsWorkflow
|
||||
|
||||
@@ -94,3 +94,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: exportProductsWorkflow
|
||||
|
||||
@@ -94,3 +94,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: importProductsWorkflow
|
||||
|
||||
@@ -172,7 +172,150 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateProduct.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
subtitle:
|
||||
type: string
|
||||
title: subtitle
|
||||
description: The product's subtitle.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The product's description.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
discountable:
|
||||
type: boolean
|
||||
title: discountable
|
||||
description: The product's discountable.
|
||||
images:
|
||||
type: array
|
||||
description: The product's images.
|
||||
items:
|
||||
type: object
|
||||
description: The image's images.
|
||||
required:
|
||||
- url
|
||||
properties:
|
||||
url:
|
||||
type: string
|
||||
title: url
|
||||
description: The image's url.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The product's thumbnail.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
type_id:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The product's type id.
|
||||
collection_id:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The product's collection id.
|
||||
categories:
|
||||
type: array
|
||||
description: The product's categories.
|
||||
items:
|
||||
type: object
|
||||
description: The category's categories.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The category's ID.
|
||||
tags:
|
||||
type: array
|
||||
description: The product's tags.
|
||||
items:
|
||||
type: object
|
||||
description: The tag's tags.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The tag's ID.
|
||||
options:
|
||||
type: array
|
||||
description: The product's options.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminUpdateProductOption.yaml
|
||||
variants:
|
||||
type: array
|
||||
description: The product's variants.
|
||||
items:
|
||||
oneOf:
|
||||
- $ref: ../components/schemas/AdminCreateProductVariant.yaml
|
||||
- $ref: ../components/schemas/AdminUpdateProductVariant.yaml
|
||||
sales_channels:
|
||||
type: array
|
||||
description: The product's sales channels.
|
||||
items:
|
||||
type: object
|
||||
description: The sales channel's sales channels.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The sales channel's ID.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The product's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The product's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The product's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The product's width.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The product's hs code.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The product's mid code.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The product's origin country.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The product's material.
|
||||
metadata:
|
||||
type: object
|
||||
description: The product's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -199,6 +342,7 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateProductsWorkflow
|
||||
delete:
|
||||
operationId: DeleteProductsId
|
||||
summary: Delete a Product
|
||||
|
||||
@@ -606,6 +606,9 @@ get:
|
||||
x-schemaName: BaseProductOptionParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
- name: $or
|
||||
in: query
|
||||
description: The product's $or.
|
||||
@@ -1095,6 +1098,9 @@ get:
|
||||
x-schemaName: BaseProductOptionParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -1229,7 +1235,19 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateProductOption.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
values:
|
||||
type: array
|
||||
description: The product's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
|
||||
+13
-1
@@ -184,7 +184,19 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateProductOption.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
values:
|
||||
type: array
|
||||
description: The product's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
|
||||
@@ -201,7 +201,83 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateProductVariant.yaml
|
||||
description: SUMMARY
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The product's sku.
|
||||
ean:
|
||||
type: string
|
||||
title: ean
|
||||
description: The product's ean.
|
||||
upc:
|
||||
type: string
|
||||
title: upc
|
||||
description: The product's upc.
|
||||
barcode:
|
||||
type: string
|
||||
title: barcode
|
||||
description: The product's barcode.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The product's hs code.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The product's mid code.
|
||||
allow_backorder:
|
||||
type: boolean
|
||||
title: allow_backorder
|
||||
description: The product's allow backorder.
|
||||
manage_inventory:
|
||||
type: boolean
|
||||
title: manage_inventory
|
||||
description: The product's manage inventory.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The product's variant rank.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The product's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The product's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The product's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The product's width.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The product's origin country.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The product's material.
|
||||
metadata:
|
||||
type: object
|
||||
description: The product's metadata.
|
||||
prices:
|
||||
type: array
|
||||
description: The product's prices.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminCreateProductVariantPrice.yaml
|
||||
options:
|
||||
type: object
|
||||
description: The product's options.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
|
||||
@@ -100,3 +100,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: batchProductVariantsWorkflow
|
||||
|
||||
+8
@@ -149,6 +149,13 @@ post:
|
||||
tags:
|
||||
- Products
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminProductVariantInventoryBatchResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -161,3 +168,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: batchLinksWorkflow
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user