chore(docs): Generated API Reference (#3211)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
9997485c55
commit
14b2de94e2
@@ -15,15 +15,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -3,11 +3,13 @@ get:
|
||||
summary: List Applications
|
||||
description: Retrieve a list of applications.
|
||||
x-authenticated: true
|
||||
x-codegen:
|
||||
method: list
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/apps/getundefined
|
||||
$ref: ../code_samples/Shell/apps/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,11 +8,13 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostAppsReq.yaml
|
||||
x-codegen:
|
||||
method: authorize
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/apps_authorizations/postundefined
|
||||
$ref: ../code_samples/Shell/apps_authorizations/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -19,15 +19,17 @@ post:
|
||||
password:
|
||||
type: string
|
||||
description: The User's password.
|
||||
x-codegen:
|
||||
method: createSession
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/auth/postundefined
|
||||
$ref: ../code_samples/JavaScript/auth/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/auth/postundefined
|
||||
$ref: ../code_samples/Shell/auth/post.sh
|
||||
tags:
|
||||
- Auth
|
||||
responses:
|
||||
@@ -54,15 +56,17 @@ delete:
|
||||
summary: User Logout
|
||||
x-authenticated: true
|
||||
description: Deletes the current session for the logged in user.
|
||||
x-codegen:
|
||||
method: deleteSession
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/auth/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/auth/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/auth/deleteundefined
|
||||
$ref: ../code_samples/Shell/auth/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -88,15 +92,17 @@ get:
|
||||
summary: Get Current User
|
||||
x-authenticated: true
|
||||
description: Gets the currently logged in User.
|
||||
x-codegen:
|
||||
method: getSession
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/auth/getundefined
|
||||
$ref: ../code_samples/JavaScript/auth/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/auth/getundefined
|
||||
$ref: ../code_samples/Shell/auth/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostBatchesReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/batch-jobs/postundefined
|
||||
$ref: ../code_samples/JavaScript/batch-jobs/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/batch-jobs/postundefined
|
||||
$ref: ../code_samples/Shell/batch-jobs/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -282,15 +284,18 @@ get:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetBatchParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/batch-jobs/getundefined
|
||||
$ref: ../code_samples/JavaScript/batch-jobs/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/batch-jobs/getundefined
|
||||
$ref: ../code_samples/Shell/batch-jobs/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ get:
|
||||
description: The ID of the Batch Job
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/batch-jobs_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/batch-jobs_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/batch-jobs_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/batch-jobs_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the batch job.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancel
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/batch-jobs_{id}_cancel/postundefined
|
||||
$ref: ../code_samples/JavaScript/batch-jobs_{id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/batch-jobs_{id}_cancel/postundefined
|
||||
$ref: ../code_samples/Shell/batch-jobs_{id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the batch job.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: confirm
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/batch-jobs_{id}_confirm/postundefined
|
||||
$ref: ../code_samples/JavaScript/batch-jobs_{id}_confirm/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/batch-jobs_{id}_confirm/postundefined
|
||||
$ref: ../code_samples/Shell/batch-jobs_{id}_confirm/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCollectionsReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/collections/postundefined
|
||||
$ref: ../code_samples/JavaScript/collections/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/collections/postundefined
|
||||
$ref: ../code_samples/Shell/collections/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -145,15 +147,18 @@ get:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetCollectionsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/collections/getundefined
|
||||
$ref: ../code_samples/JavaScript/collections/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/collections/getundefined
|
||||
$ref: ../code_samples/Shell/collections/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Collection.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/collections_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/collections_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/collections_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/collections_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -55,15 +57,17 @@ get:
|
||||
description: The ID of the Product Collection
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/collections_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/collections_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/collections_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/collections_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -105,15 +109,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCollectionsCollectionReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/collections_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/collections_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/collections_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/collections_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -15,11 +15,13 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostProductsToCollectionReq.yaml
|
||||
x-codegen:
|
||||
method: addProducts
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/collections_{id}_products_batch/postundefined
|
||||
$ref: ../code_samples/Shell/collections_{id}_products_batch/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -61,11 +63,13 @@ delete:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDeleteProductsFromCollectionReq.yaml
|
||||
x-codegen:
|
||||
method: removeProducts
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/collections_{id}_products_batch/deleteundefined
|
||||
$ref: ../code_samples/Shell/collections_{id}_products_batch/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -31,15 +31,18 @@ get:
|
||||
schema:
|
||||
type: number
|
||||
default: '20'
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetCurrenciesParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/currencies/getundefined
|
||||
$ref: ../code_samples/JavaScript/currencies/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/currencies/getundefined
|
||||
$ref: ../code_samples/Shell/currencies/get.sh
|
||||
tags:
|
||||
- Currency
|
||||
responses:
|
||||
|
||||
@@ -15,15 +15,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCurrenciesCurrencyReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/currencies_{code}/postundefined
|
||||
$ref: ../code_samples/JavaScript/currencies_{code}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/currencies_{code}/postundefined
|
||||
$ref: ../code_samples/Shell/currencies_{code}/post.sh
|
||||
tags:
|
||||
- Currency
|
||||
responses:
|
||||
|
||||
@@ -3,16 +3,22 @@ post:
|
||||
summary: Create a Customer Group
|
||||
description: Creates a CustomerGroup.
|
||||
x-authenticated: true
|
||||
parameters: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCustomerGroupsReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customer-groups/postundefined
|
||||
$ref: ../code_samples/JavaScript/customer-groups/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customer-groups/postundefined
|
||||
$ref: ../code_samples/Shell/customer-groups/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -37,20 +43,6 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: Name of the customer group
|
||||
metadata:
|
||||
type: object
|
||||
description: Metadata for the customer.
|
||||
get:
|
||||
operationId: GetCustomerGroups
|
||||
summary: List Customer Groups
|
||||
@@ -173,15 +165,18 @@ get:
|
||||
groups of the result.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetCustomerGroupsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customer-groups/getundefined
|
||||
$ref: ../code_samples/JavaScript/customer-groups/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customer-groups/getundefined
|
||||
$ref: ../code_samples/Shell/customer-groups/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Customer Group
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -65,15 +67,18 @@ get:
|
||||
description: (Comma separated) Which fields should be included in the customer group.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: AdminGetCustomerGroupsGroupParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -115,15 +120,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCustomerGroupsGroupReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,40 @@ get:
|
||||
description: The ID of the customer group.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: limit
|
||||
description: The number of items to return.
|
||||
schema:
|
||||
type: integer
|
||||
default: 50
|
||||
- in: query
|
||||
name: offset
|
||||
description: The items to skip before result.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in each customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: q
|
||||
description: a search term to search email, first_name, and last_name.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: listCustomers
|
||||
queryParams: AdminGetGroupsGroupCustomersParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}_customers/getundefined
|
||||
$ref: ../code_samples/JavaScript/customer-groups_{id}_customers/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}_customers/getundefined
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}_customers/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,17 +16,18 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
|
||||
x-codegen:
|
||||
method: addCustomers
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/customer-groups_{id}_customers_batch/postundefined
|
||||
../code_samples/JavaScript/customer-groups_{id}_customers_batch/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/customer-groups_{id}_customers_batch/postundefined
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}_customers_batch/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -69,17 +70,18 @@ delete:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml
|
||||
x-codegen:
|
||||
method: removeCustomers
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/customer-groups_{id}_customers_batch/deleteundefined
|
||||
../code_samples/JavaScript/customer-groups_{id}_customers_batch/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/customer-groups_{id}_customers_batch/deleteundefined
|
||||
$ref: ../code_samples/Shell/customer-groups_{id}_customers_batch/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,20 +8,22 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCustomersReq.yaml
|
||||
tags:
|
||||
- Customer
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customers/postundefined
|
||||
$ref: ../code_samples/JavaScript/customers/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customers/postundefined
|
||||
$ref: ../code_samples/Shell/customers/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'201':
|
||||
description: OK
|
||||
@@ -69,15 +71,18 @@ get:
|
||||
description: a search term to search email, first_name, and last_name.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetCustomersParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customers/getundefined
|
||||
$ref: ../code_samples/JavaScript/customers/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customers/getundefined
|
||||
$ref: ../code_samples/Shell/customers/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -20,15 +20,17 @@ get:
|
||||
description: (Comma separated) Which fields should be included in the customer.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customers_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/customers_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customers_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/customers_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -80,15 +82,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCustomersCustomerReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/customers_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/customers_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/customers_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/customers_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,12 +8,12 @@ post:
|
||||
parameters:
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in each customer.
|
||||
description: (Comma separated) Which fields should be expanded in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Which fields should be retrieved in each customer.
|
||||
description: (Comma separated) Which fields should be retrieved in the results.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
@@ -21,15 +21,18 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostDiscountsReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
queryParams: AdminPostDiscountsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/discounts/postundefined
|
||||
$ref: ../code_samples/JavaScript/discounts/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts/postundefined
|
||||
$ref: ../code_samples/Shell/discounts/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -116,15 +119,18 @@ get:
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetDiscountsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/discounts/getundefined
|
||||
$ref: ../code_samples/JavaScript/discounts/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts/getundefined
|
||||
$ref: ../code_samples/Shell/discounts/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -20,15 +20,18 @@ get:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieveByCode
|
||||
queryParams: AdminGetDiscountsDiscountCodeParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/discounts_code_{code}/getundefined
|
||||
$ref: ../code_samples/JavaScript/discounts_code_{code}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts_code_{code}/getundefined
|
||||
$ref: ../code_samples/Shell/discounts_code_{code}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -32,16 +32,18 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostDiscountsDiscountConditions.yaml
|
||||
x-codegen:
|
||||
method: createCondition
|
||||
queryParams: AdminPostDiscountsDiscountConditionsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions/postundefined
|
||||
$ref: ../code_samples/JavaScript/discounts_{discount_id}_conditions/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts_{discount_id}_conditions/postundefined
|
||||
$ref: ../code_samples/Shell/discounts_{discount_id}_conditions/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -26,17 +26,20 @@ delete:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: deleteCondition
|
||||
queryParams: AdminDeleteDiscountsDiscountConditionsConditionParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/deleteundefined
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/deleteundefined
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -89,17 +92,20 @@ get:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: getCondition
|
||||
queryParams: AdminGetDiscountsDiscountConditionsConditionParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/getundefined
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/getundefined
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -165,17 +171,20 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostDiscountsDiscountConditionsCondition.yaml
|
||||
x-codegen:
|
||||
method: updateCondition
|
||||
queryParams: AdminPostDiscountsDiscountConditionsConditionParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/postundefined
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/postundefined
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -36,17 +36,20 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml
|
||||
x-codegen:
|
||||
method: addConditionResourceBatch
|
||||
queryParams: AdminPostDiscountsDiscountConditionsConditionBatchParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}_batch/postundefined
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}_batch/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}_batch/postundefined
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}_batch/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -109,17 +112,19 @@ delete:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml
|
||||
x-codegen:
|
||||
method: deleteConditionResourceBatch
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}_batch/deleteundefined
|
||||
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}_batch/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}_batch/deleteundefined
|
||||
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}_batch/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Discount
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/discounts_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -65,15 +67,18 @@ get:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: AdminGetDiscountParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/discounts_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -131,15 +136,18 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostDiscountsDiscountReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
queryParams: AdminPostDiscountsDiscountParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/discounts_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -12,15 +12,22 @@ post:
|
||||
description: The ID of the Discount to create the dynamic code from."
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml
|
||||
x-codegen:
|
||||
method: createDynamicCode
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}_dynamic-codes/postundefined
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}_dynamic-codes/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts_{id}_dynamic-codes/postundefined
|
||||
$ref: ../code_samples/Shell/discounts_{id}_dynamic-codes/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -45,23 +52,3 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
description: The unique code that will be used to redeem the Discount.
|
||||
usage_limit:
|
||||
type: number
|
||||
default: '1'
|
||||
description: amount of times the discount can be applied.
|
||||
metadata:
|
||||
type: object
|
||||
description: >-
|
||||
An optional set of key-value paris to hold additional
|
||||
information.
|
||||
|
||||
@@ -16,17 +16,18 @@ delete:
|
||||
description: The ID of the Discount
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: deleteDynamicCode
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{id}_dynamic-codes_{code}/deleteundefined
|
||||
../code_samples/JavaScript/discounts_{id}_dynamic-codes_{code}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/discounts_{id}_dynamic-codes_{code}/deleteundefined
|
||||
$ref: ../code_samples/Shell/discounts_{id}_dynamic-codes_{code}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,16 +16,17 @@ post:
|
||||
description: The ID of the Region.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: addRegion
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{id}_regions_{region_id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/discounts_{id}_regions_{region_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/discounts_{id}_regions_{region_id}/postundefined
|
||||
$ref: ../code_samples/Shell/discounts_{id}_regions_{region_id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -68,17 +69,18 @@ delete:
|
||||
description: The ID of the Region.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: removeRegion
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/discounts_{id}_regions_{region_id}/deleteundefined
|
||||
../code_samples/JavaScript/discounts_{id}_regions_{region_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/discounts_{id}_regions_{region_id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/discounts_{id}_regions_{region_id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostDraftOrdersReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/draft-orders/postundefined
|
||||
$ref: ../code_samples/JavaScript/draft-orders/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/draft-orders/postundefined
|
||||
$ref: ../code_samples/Shell/draft-orders/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -66,15 +68,18 @@ get:
|
||||
display IDs of draft orders
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetDraftOrdersParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/draft-orders/getundefined
|
||||
$ref: ../code_samples/JavaScript/draft-orders/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/draft-orders/getundefined
|
||||
$ref: ../code_samples/Shell/draft-orders/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Draft Order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -55,15 +57,17 @@ get:
|
||||
description: The ID of the Draft Order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,15 +16,17 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml
|
||||
x-codegen:
|
||||
method: addLineItem
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}_line-items/postundefined
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}_line-items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}_line-items/postundefined
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}_line-items/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,17 +16,18 @@ delete:
|
||||
description: The ID of the Draft Order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: removeLineItem
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/draft-orders_{id}_line-items_{line_id}/deleteundefined
|
||||
../code_samples/JavaScript/draft-orders_{id}_line-items_{line_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/draft-orders_{id}_line-items_{line_id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}_line-items_{line_id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -75,17 +76,18 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml
|
||||
x-codegen:
|
||||
method: updateLineItem
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/draft-orders_{id}_line-items_{line_id}/postundefined
|
||||
../code_samples/JavaScript/draft-orders_{id}_line-items_{line_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/draft-orders_{id}_line-items_{line_id}/postundefined
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}_line-items_{line_id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The Draft Order id.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: markPaid
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}_pay/postundefined
|
||||
$ref: ../code_samples/JavaScript/draft-orders_{id}_pay/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}_pay/postundefined
|
||||
$ref: ../code_samples/Shell/draft-orders_{id}_pay/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostGiftCardsReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/gift-cards/postundefined
|
||||
$ref: ../code_samples/JavaScript/gift-cards/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/gift-cards/postundefined
|
||||
$ref: ../code_samples/Shell/gift-cards/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -66,15 +68,18 @@ get:
|
||||
description: a search term to search by code or display ID
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetGiftCardsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/gift-cards/getundefined
|
||||
$ref: ../code_samples/JavaScript/gift-cards/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/gift-cards/getundefined
|
||||
$ref: ../code_samples/Shell/gift-cards/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Gift Card to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/gift-cards_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/gift-cards_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/gift-cards_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/gift-cards_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -55,15 +57,17 @@ get:
|
||||
description: The ID of the Gift Card.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/gift-cards_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/gift-cards_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/gift-cards_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/gift-cards_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -107,15 +111,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostGiftCardsGiftCardReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/gift-cards_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/gift-cards_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/gift-cards_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/gift-cards_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
131
docs/api/admin/paths/inventory-items.yaml
Normal file
131
docs/api/admin/paths/inventory-items.yaml
Normal file
@@ -0,0 +1,131 @@
|
||||
get:
|
||||
operationId: GetInventoryItems
|
||||
summary: List inventory items.
|
||||
description: Lists inventory items.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: offset
|
||||
description: How many inventory items to skip in the result.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: limit
|
||||
description: Limit the number of inventory items returned.
|
||||
schema:
|
||||
type: integer
|
||||
default: 20
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: q
|
||||
description: Query used for searching product inventory items and their properties.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: location_id
|
||||
style: form
|
||||
explode: false
|
||||
description: Locations ids to search for.
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
- in: query
|
||||
name: id
|
||||
description: id to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: sku
|
||||
description: sku to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: origin_country
|
||||
description: origin_country to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: mid_code
|
||||
description: mid_code to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: material
|
||||
description: material to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: hs_code
|
||||
description: hs_code to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: weight
|
||||
description: weight to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: length
|
||||
description: length to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: height
|
||||
description: height to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: width
|
||||
description: width to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: requires_shipping
|
||||
description: requires_shipping to search for.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/inventory-items/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/inventory-items/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminInventoryItemsListWithVariantsAndLocationLevelsRes.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
|
||||
150
docs/api/admin/paths/inventory-items_{id}.yaml
Normal file
150
docs/api/admin/paths/inventory-items_{id}.yaml
Normal file
@@ -0,0 +1,150 @@
|
||||
delete:
|
||||
operationId: DeleteInventoryItemsInventoryItem
|
||||
summary: Delete an Inventory Item
|
||||
description: Delete an Inventory Item
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Inventory Item to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/inventory-items_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/inventory-items_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- InventoryItem
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemsDeleteRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
get:
|
||||
operationId: GetInventoryItemsInventoryItem
|
||||
summary: Retrive an Inventory Item.
|
||||
description: Retrives an Inventory Item.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Inventory Item.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/inventory-items_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/inventory-items_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemsRes.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: PostInventoryItemsInventoryItem
|
||||
summary: Update an Inventory Item.
|
||||
description: Updates an Inventory Item.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Inventory Item.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/inventory-items_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/inventory-items_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemsRes.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
|
||||
129
docs/api/admin/paths/inventory-items_{id}_location-levels.yaml
Normal file
129
docs/api/admin/paths/inventory-items_{id}_location-levels.yaml
Normal file
@@ -0,0 +1,129 @@
|
||||
post:
|
||||
operationId: PostInventoryItemsInventoryItemLocationLevels
|
||||
summary: Create an Inventory Location Level for a given Inventory Item.
|
||||
description: Creates an Inventory Location Level for a given Inventory Item.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Inventory Item.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/inventory-items_{id}_location-levels/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/inventory-items_{id}_location-levels/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemsRes.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
|
||||
get:
|
||||
operationId: GetInventoryItemsInventoryItemLocationLevels
|
||||
summary: List stock levels of a given location.
|
||||
description: Lists stock levels of a given location.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Inventory Item.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: offset
|
||||
description: How many stock locations levels to skip in the result.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: limit
|
||||
description: Limit the number of stock locations levels returned.
|
||||
schema:
|
||||
type: integer
|
||||
default: 20
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/inventory-items_{id}_location-levels/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/inventory-items_{id}_location-levels/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemsLocationLevelsRes.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,132 @@
|
||||
delete:
|
||||
operationId: DeleteInventoryItemsInventoryIteLocationLevelsLocation
|
||||
summary: Delete a location level of an Inventory Item.
|
||||
description: Delete a location level of an Inventory Item.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Inventory Item.
|
||||
schema:
|
||||
type: string
|
||||
- in: path
|
||||
name: location_id
|
||||
required: true
|
||||
description: The ID of the location.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/inventory-items_{id}_location-levels_{location_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/inventory-items_{id}_location-levels_{location_id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemsRes.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: PostInventoryItemsInventoryItemLocationLevelsLocationLevel
|
||||
summary: Update an Inventory Location Level for a given Inventory Item.
|
||||
description: Updates an Inventory Location Level for a given Inventory Item.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Inventory Item.
|
||||
schema:
|
||||
type: string
|
||||
- in: path
|
||||
name: location_id
|
||||
required: true
|
||||
description: The ID of the Location.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/inventory-items_{id}_location-levels_{location_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/inventory-items_{id}_location-levels_{location_id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminInventoryItemsRes.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
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostInvitesReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/invites/postundefined
|
||||
$ref: ../code_samples/JavaScript/invites/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/invites/postundefined
|
||||
$ref: ../code_samples/Shell/invites/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -42,15 +44,17 @@ get:
|
||||
summary: Lists Invites
|
||||
description: Lists all Invites
|
||||
x-authenticated: true
|
||||
x-codegen:
|
||||
method: list
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/invites/getundefined
|
||||
$ref: ../code_samples/JavaScript/invites/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/invites/getundefined
|
||||
$ref: ../code_samples/Shell/invites/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -7,15 +7,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostInvitesInviteAcceptReq.yaml
|
||||
x-codegen:
|
||||
method: accept
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/invites_accept/postundefined
|
||||
$ref: ../code_samples/JavaScript/invites_accept/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/invites_accept/postundefined
|
||||
$ref: ../code_samples/Shell/invites_accept/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Invite
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/invites_{invite_id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/invites_{invite_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/invites_{invite_id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/invites_{invite_id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the Invite
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: resend
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/invites_{invite_id}_resend/postundefined
|
||||
$ref: ../code_samples/JavaScript/invites_{invite_id}_resend/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/invites_{invite_id}_resend/postundefined
|
||||
$ref: ../code_samples/Shell/invites_{invite_id}_resend/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostNotesReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/notes/postundefined
|
||||
$ref: ../code_samples/JavaScript/notes/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/notes/postundefined
|
||||
$ref: ../code_samples/Shell/notes/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -64,15 +66,18 @@ get:
|
||||
description: The ID which the notes belongs to
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetNotesParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/notes/getundefined
|
||||
$ref: ../code_samples/JavaScript/notes/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/notes/getundefined
|
||||
$ref: ../code_samples/Shell/notes/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Note to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/notes_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/notes_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/notes_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/notes_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -55,15 +57,17 @@ get:
|
||||
description: The ID of the note to retrieve.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/notes_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/notes_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/notes_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/notes_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -105,15 +109,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostNotesNoteReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/notes_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/notes_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/notes_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/notes_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -57,15 +57,18 @@ get:
|
||||
notifications or not
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetNotificationsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/notifications/getundefined
|
||||
$ref: ../code_samples/JavaScript/notifications/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/notifications/getundefined
|
||||
$ref: ../code_samples/Shell/notifications/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -18,15 +18,17 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostNotificationsNotificationResendReq.yaml
|
||||
x-codegen:
|
||||
method: resend
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/notifications_{id}_resend/postundefined
|
||||
$ref: ../code_samples/JavaScript/notifications_{id}_resend/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/notifications_{id}_resend/postundefined
|
||||
$ref: ../code_samples/Shell/notifications_{id}_resend/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderEditsReq.yaml
|
||||
x-authenticated: true
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits/postundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits/postundefined
|
||||
$ref: ../code_samples/Shell/order-edits/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -79,15 +81,18 @@ get:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: GetOrderEditsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits/getundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits/getundefined
|
||||
$ref: ../code_samples/Shell/order-edits/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Order Edit to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -55,15 +57,18 @@ get:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: GetOrderEditsOrderEditParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -105,15 +110,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderEditsOrderEditReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the OrderEdit.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancel
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_cancel/postundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_cancel/postundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,17 +16,18 @@ delete:
|
||||
description: The ID of the Order Edit Item Change to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: deleteItemChange
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/order-edits_{id}_changes_{change_id}/deleteundefined
|
||||
../code_samples/JavaScript/order-edits_{id}_changes_{change_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/order-edits_{id}_changes_{change_id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_changes_{change_id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the order edit.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: confirm
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_confirm/postundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_confirm/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_confirm/postundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_confirm/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -15,15 +15,17 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml
|
||||
x-authenticated: true
|
||||
x-codegen:
|
||||
method: addLineItem
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_items/postundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_items/postundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_items/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,16 +16,17 @@ delete:
|
||||
description: The ID of the order edit item to delete from order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: removeLineItem
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/order-edits_{id}_items_{item_id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_items_{item_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -74,16 +75,17 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml
|
||||
x-codegen:
|
||||
method: updateLineItem
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/order-edits_{id}_items_{item_id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_items_{item_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/postundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the Order Edit to request confirmation from.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: requestConfirmation
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_request/postundefined
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_request/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_request/postundefined
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_request/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -15,15 +15,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderClaimsReq.yaml
|
||||
x-codegen:
|
||||
method: createClaim
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order_{id}_claims/postundefined
|
||||
$ref: ../code_samples/JavaScript/order_{id}_claims/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order_{id}_claims/postundefined
|
||||
$ref: ../code_samples/Shell/order_{id}_claims/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -21,15 +21,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderClaimsClaimReq.yaml
|
||||
x-codegen:
|
||||
method: updateClaim
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order_{id}_claims_{claim_id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/order_{id}_claims_{claim_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order_{id}_claims_{claim_id}/postundefined
|
||||
$ref: ../code_samples/Shell/order_{id}_claims_{claim_id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -17,15 +17,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderSwapsReq.yaml
|
||||
x-codegen:
|
||||
method: createSwap
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order_{id}_swaps/postundefined
|
||||
$ref: ../code_samples/JavaScript/order_{id}_swaps/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order_{id}_swaps/postundefined
|
||||
$ref: ../code_samples/Shell/order_{id}_swaps/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -217,15 +217,18 @@ get:
|
||||
result.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetOrdersParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders/getundefined
|
||||
$ref: ../code_samples/JavaScript/orders/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders/getundefined
|
||||
$ref: ../code_samples/Shell/orders/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,28 @@ get:
|
||||
description: The ID of the Order.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated list of relations to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: AdminGetOrdersOrderParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -60,15 +73,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the Order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: archive
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_archive/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_archive/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_archive/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_archive/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -13,15 +13,17 @@ post:
|
||||
description: The ID of the Order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancel
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_cancel/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_cancel/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the Order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: capturePayment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_capture/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_capture/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_capture/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_capture/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,17 +16,18 @@ post:
|
||||
description: The ID of the Claim.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancelClaim
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_cancel/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_claims_{claim_id}_cancel/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_claims_{claim_id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -22,17 +22,19 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml
|
||||
x-codegen:
|
||||
method: fulfillClaim
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_fulfillments/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_fulfillments/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_claims_{claim_id}_fulfillments/postundefined
|
||||
../code_samples/Shell/orders_{id}_claims_{claim_id}_fulfillments/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -22,17 +22,19 @@ post:
|
||||
description: The ID of the Fulfillment.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancelClaimFulfillment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/postundefined
|
||||
../code_samples/Shell/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -22,17 +22,18 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq.yaml
|
||||
x-codegen:
|
||||
method: createClaimShipment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_shipments/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_shipments/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_claims_{claim_id}_shipments/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_claims_{claim_id}_shipments/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the Order.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: complete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_complete/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_complete/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_complete/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_complete/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -17,15 +17,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml
|
||||
x-codegen:
|
||||
method: createFulfillment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_fulfillment/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_fulfillment/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_fulfillment/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_fulfillment/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -16,17 +16,19 @@ post:
|
||||
description: The ID of the Fulfillment
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancelFulfillment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_fulfillments_{fulfillment_id}_cancel/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_fulfillments_{fulfillment_id}_cancel/postundefined
|
||||
../code_samples/Shell/orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -28,12 +28,12 @@ post:
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_line-items_{line_item_id}_reserve/postundefined
|
||||
../code_samples/Shell/orders_{id}_line-items_{line_item_id}_reserve/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -15,15 +15,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderRefundsReq.yaml
|
||||
x-codegen:
|
||||
method: refundPayment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_refund/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_refund/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_refund/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_refund/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -26,11 +26,11 @@ get:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_reservations/getundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_reservations/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_reservations/getundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_reservations/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -17,15 +17,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderReturnsReq.yaml
|
||||
x-codegen:
|
||||
method: requestReturn
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_return/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_return/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_return/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_return/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -15,15 +15,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderShipmentReq.yaml
|
||||
x-codegen:
|
||||
method: createShipment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_shipment/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_shipment/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_shipment/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_shipment/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -4,7 +4,6 @@ post:
|
||||
description: >-
|
||||
Adds a Shipping Method to an Order. If another Shipping Method exists with
|
||||
the same Shipping Profile, the previous Shipping Method will be replaced.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
@@ -12,15 +11,23 @@ post:
|
||||
description: The ID of the Order.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml
|
||||
x-authenticated: true
|
||||
x-codegen:
|
||||
method: addShippingMethod
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_shipping-methods/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_shipping-methods/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_shipping-methods/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_shipping-methods/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -45,27 +52,3 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- price
|
||||
- option_id
|
||||
properties:
|
||||
price:
|
||||
type: integer
|
||||
description: >-
|
||||
The price (excluding VAT) that should be charged for the
|
||||
Shipping Method
|
||||
option_id:
|
||||
type: string
|
||||
description: >-
|
||||
The ID of the Shipping Option to create the Shipping Method
|
||||
from.
|
||||
data:
|
||||
type: object
|
||||
description: >-
|
||||
The data required for the Shipping Option to create a Shipping
|
||||
Method. This will depend on the Fulfillment Provider.
|
||||
|
||||
@@ -16,16 +16,17 @@ post:
|
||||
description: The ID of the Swap.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancelSwap
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_cancel/postundefined
|
||||
$ref: ../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/orders_{id}_swaps_{swap_id}_cancel/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_swaps_{swap_id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -22,17 +22,18 @@ post:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml
|
||||
x-codegen:
|
||||
method: fulfillSwap
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_fulfillments/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_fulfillments/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_swaps_{swap_id}_fulfillments/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_swaps_{swap_id}_fulfillments/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -22,17 +22,19 @@ post:
|
||||
description: The ID of the Fulfillment.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: cancelSwapFulfillment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/postundefined
|
||||
../code_samples/Shell/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -19,17 +19,19 @@ post:
|
||||
description: The ID of the Swap.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: processSwapPayment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_process-payment/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_process-payment/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_swaps_{swap_id}_process-payment/postundefined
|
||||
../code_samples/Shell/orders_{id}_swaps_{swap_id}_process-payment/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -21,17 +21,18 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq.yaml
|
||||
x-codegen:
|
||||
method: createSwapShipment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_shipments/postundefined
|
||||
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_shipments/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/orders_{id}_swaps_{swap_id}_shipments/postundefined
|
||||
$ref: ../code_samples/Shell/orders_{id}_swaps_{swap_id}_shipments/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Payment Collection to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/payment-collections_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/payment-collections_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -57,15 +59,18 @@ get:
|
||||
description: Comma separated list of fields to include in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: GetPaymentCollectionsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/payment-collections_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/payment-collections_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -107,15 +112,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdatePaymentCollectionsReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/payment-collections_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/payment-collections_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,16 +10,17 @@ post:
|
||||
description: The ID of the PaymentCollection.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: markAsAuthorized
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/payment-collections_{id}_authorize/postundefined
|
||||
$ref: ../code_samples/JavaScript/payment-collections_{id}_authorize/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}_authorize/postundefined
|
||||
$ref: ../code_samples/Shell/payment-collections_{id}_authorize/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,18 @@ get:
|
||||
description: The ID of the Payment.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: GetPaymentsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/payments_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/payments_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/payments_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/payments_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ post:
|
||||
description: The ID of the Payment.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: capturePayment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/payments_{id}_capture/postundefined
|
||||
$ref: ../code_samples/JavaScript/payments_{id}_capture/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/payments_{id}_capture/postundefined
|
||||
$ref: ../code_samples/Shell/payments_{id}_capture/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -15,15 +15,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostPaymentRefundsReq.yaml
|
||||
x-codegen:
|
||||
method: refundPayment
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/payments_{id}_refund/postundefined
|
||||
$ref: ../code_samples/JavaScript/payments_{id}_refund/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/payments_{id}_refund/postundefined
|
||||
$ref: ../code_samples/Shell/payments_{id}_refund/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostPriceListsPriceListReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/price-lists/postundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists/postundefined
|
||||
$ref: ../code_samples/Shell/price-lists/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -187,15 +189,18 @@ get:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetPriceListPaginationParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/price-lists/getundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists/getundefined
|
||||
$ref: ../code_samples/Shell/price-lists/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -10,15 +10,17 @@ delete:
|
||||
description: The ID of the Price List to delete.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/price-lists_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -55,15 +57,17 @@ get:
|
||||
description: The ID of the Price List.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}/getundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/price-lists_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -105,15 +109,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}/postundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/price-lists_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -15,15 +15,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostPriceListPricesPricesReq.yaml
|
||||
x-codegen:
|
||||
method: addPrices
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}_prices_batch/postundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}_prices_batch/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists_{id}_prices_batch/postundefined
|
||||
$ref: ../code_samples/Shell/price-lists_{id}_prices_batch/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -67,16 +69,17 @@ delete:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDeletePriceListPricesPricesReq.yaml
|
||||
x-codegen:
|
||||
method: deletePrices
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/price-lists_{id}_prices_batch/deleteundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}_prices_batch/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists_{id}_prices_batch/deleteundefined
|
||||
$ref: ../code_samples/Shell/price-lists_{id}_prices_batch/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -176,15 +176,18 @@ get:
|
||||
result.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: listProducts
|
||||
queryParams: AdminGetPriceListsPriceListProductsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}_products/getundefined
|
||||
$ref: ../code_samples/JavaScript/price-lists_{id}_products/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/price-lists_{id}_products/getundefined
|
||||
$ref: ../code_samples/Shell/price-lists_{id}_products/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -18,17 +18,19 @@ delete:
|
||||
description: The ID of the product from which the money amount will be deleted.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: deleteProductPrices
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/price-lists_{id}_products_{product_id}_prices/deleteundefined
|
||||
../code_samples/JavaScript/price-lists_{id}_products_{product_id}_prices/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/price-lists_{id}_products_{product_id}_prices/deleteundefined
|
||||
../code_samples/Shell/price-lists_{id}_products_{product_id}_prices/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -18,17 +18,19 @@ delete:
|
||||
description: The ID of the variant from which the money amount will be deleted.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: deleteVariantPrices
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/price-lists_{id}_variants_{variant_id}_prices/deleteundefined
|
||||
../code_samples/JavaScript/price-lists_{id}_variants_{variant_id}_prices/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/price-lists_{id}_variants_{variant_id}_prices/deleteundefined
|
||||
../code_samples/Shell/price-lists_{id}_variants_{variant_id}_prices/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -6,16 +6,12 @@ post:
|
||||
parameters:
|
||||
- in: query
|
||||
name: expand
|
||||
description: >-
|
||||
(Comma separated) Which fields should be expanded in each product
|
||||
category.
|
||||
description: (Comma separated) Which fields should be expanded in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: >-
|
||||
(Comma separated) Which fields should be retrieved in each product
|
||||
category.
|
||||
description: (Comma separated) Which fields should be retrieved in the results.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
@@ -23,11 +19,18 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostProductCategoriesReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
queryParams: AdminPostProductCategoriesParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/product-categories/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-categories/postundefined
|
||||
$ref: ../code_samples/Shell/product-categories/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -39,10 +42,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
product_category:
|
||||
$ref: ../components/schemas/ProductCategory.yaml
|
||||
$ref: ../components/schemas/AdminProductCategoriesCategoryRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -107,11 +107,18 @@ get:
|
||||
category.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetProductCategoriesParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/product-categories/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-categories/getundefined
|
||||
$ref: ../code_samples/Shell/product-categories/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -123,21 +130,7 @@ get:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
product_categories:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../components/schemas/ProductCategory.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
$ref: ../components/schemas/AdminProductCategoriesListRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
@@ -10,11 +10,17 @@ delete:
|
||||
description: The ID of the Product Category
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: delete
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/product-categories_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-categories_{id}/deleteundefined
|
||||
$ref: ../code_samples/Shell/product-categories_{id}/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -26,19 +32,7 @@ delete:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The ID of the deleted product category.
|
||||
object:
|
||||
type: string
|
||||
description: The type of the object that was deleted.
|
||||
default: product_category
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether the product category was deleted successfully or not.
|
||||
default: true
|
||||
$ref: ../components/schemas/AdminProductCategoriesCategoryDeleteRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -63,11 +57,28 @@ get:
|
||||
description: The ID of the Product Category
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in the results.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Which fields should be included in the results.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: retrieve
|
||||
queryParams: AdminGetProductCategoryParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/product-categories_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-categories_{id}/getundefined
|
||||
$ref: ../code_samples/Shell/product-categories_{id}/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -79,10 +90,7 @@ get:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
product_category:
|
||||
$ref: ../components/schemas/ProductCategory.yaml
|
||||
$ref: ../components/schemas/AdminProductCategoriesCategoryRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -126,11 +134,18 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostProductCategoriesCategoryReq.yaml
|
||||
x-codegen:
|
||||
method: update
|
||||
queryParams: AdminPostProductCategoriesCategoryParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/product-categories_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-categories_{id}/postundefined
|
||||
$ref: ../code_samples/Shell/product-categories_{id}/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -142,10 +157,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
product_category:
|
||||
$ref: ../components/schemas/ProductCategory.yaml
|
||||
$ref: ../components/schemas/AdminProductCategoriesCategoryRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
130
docs/api/admin/paths/product-categories_{id}_products_batch.yaml
Normal file
130
docs/api/admin/paths/product-categories_{id}_products_batch.yaml
Normal file
@@ -0,0 +1,130 @@
|
||||
post:
|
||||
operationId: PostProductCategoriesCategoryProductsBatch
|
||||
summary: Add Products to a category
|
||||
description: Assign a batch of products to a product category.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Product Category.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Category fields to be expanded in the response.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Category fields to be retrieved in the response.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml
|
||||
x-codegen:
|
||||
method: addProducts
|
||||
queryParams: AdminPostProductCategoriesCategoryProductsBatchParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/product-categories_{id}_products_batch/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-categories_{id}_products_batch/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Product Category
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductCategoriesCategoryRes.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
|
||||
delete:
|
||||
operationId: DeleteProductCategoriesCategoryProductsBatch
|
||||
summary: Delete Products
|
||||
description: Remove a list of products from a product category.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Product Category.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Category fields to be expanded in the response.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Category fields to be retrieved in the response.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml
|
||||
x-codegen:
|
||||
method: removeProducts
|
||||
queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/product-categories_{id}_products_batch/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-categories_{id}_products_batch/delete.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Product Category
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminProductCategoriesCategoryRes.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
|
||||
@@ -93,15 +93,18 @@ get:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetProductTagsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/product-tags/getundefined
|
||||
$ref: ../code_samples/JavaScript/product-tags/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-tags/getundefined
|
||||
$ref: ../code_samples/Shell/product-tags/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -93,15 +93,18 @@ get:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetProductTypesParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/product-types/getundefined
|
||||
$ref: ../code_samples/JavaScript/product-types/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/product-types/getundefined
|
||||
$ref: ../code_samples/Shell/product-types/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -8,15 +8,17 @@ post:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostProductsReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/products/postundefined
|
||||
$ref: ../code_samples/JavaScript/products/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/products/postundefined
|
||||
$ref: ../code_samples/Shell/products/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -131,6 +133,20 @@ get:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
- in: query
|
||||
name: category_id
|
||||
style: form
|
||||
explode: false
|
||||
description: Category IDs to filter products by
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
- in: query
|
||||
name: include_category_children
|
||||
description: Include category children when filtering by category_id
|
||||
schema:
|
||||
type: boolean
|
||||
- in: query
|
||||
name: title
|
||||
description: title to search for.
|
||||
@@ -248,15 +264,18 @@ get:
|
||||
description: the field used to order the products.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetProductsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/products/getundefined
|
||||
$ref: ../code_samples/JavaScript/products/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/products/getundefined
|
||||
$ref: ../code_samples/Shell/products/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -3,15 +3,17 @@ get:
|
||||
summary: List Tags Usage Number
|
||||
description: Retrieves a list of Product Tags with how many times each is used.
|
||||
x-authenticated: true
|
||||
x-codegen:
|
||||
method: listTags
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/products_tag-usage/getundefined
|
||||
$ref: ../code_samples/JavaScript/products_tag-usage/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/products_tag-usage/getundefined
|
||||
$ref: ../code_samples/Shell/products_tag-usage/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -4,15 +4,17 @@ get:
|
||||
summary: List Product Types
|
||||
description: Retrieves a list of Product Types.
|
||||
x-authenticated: true
|
||||
x-codegen:
|
||||
method: listTypes
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/products_types/getundefined
|
||||
$ref: ../code_samples/JavaScript/products_types/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/products_types/getundefined
|
||||
$ref: ../code_samples/Shell/products_types/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user