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

chore(docs): Generated API Reference (#3718)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-04-04 21:02:44 +03:00
committed by GitHub
co-authored by olivermrbl
parent 51d0b88404
commit 70435d5631
1031 changed files with 104669 additions and 4209 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/admin/paths/apps.yaml → docs/api/admin/paths/admin_apps.yaml
+2 -2
View File
@@ -9,12 +9,12 @@ get:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/apps/get.sh
$ref: ../code_samples/Shell/admin_apps/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- App
- Apps
responses:
'200':
description: OK
docs/api/admin/paths/apps_authorizations.yaml → docs/api/admin/paths/admin_apps_authorizations.yaml
+2 -2
View File
@@ -14,12 +14,12 @@ post:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/apps_authorizations/post.sh
$ref: ../code_samples/Shell/admin_apps_authorizations/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- App
- Apps
responses:
'200':
description: OK
docs/api/admin/paths/auth.yaml → docs/api/admin/paths/admin_auth.yaml
+44 -44
View File
@@ -1,3 +1,43 @@
get:
operationId: GetAuth
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/admin_auth/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_auth/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Auth
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminAuthRes.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: PostAuth
summary: User Login
@@ -25,11 +65,11 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/post.js
$ref: ../code_samples/JavaScript/admin_auth/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/post.sh
$ref: ../code_samples/Shell/admin_auth/post.sh
tags:
- Auth
responses:
@@ -62,11 +102,11 @@ delete:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/delete.js
$ref: ../code_samples/JavaScript/admin_auth/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/delete.sh
$ref: ../code_samples/Shell/admin_auth/delete.sh
security:
- api_token: []
- cookie_auth: []
@@ -87,43 +127,3 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
get:
operationId: GetAuth
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/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Auth
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminAuthRes.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
docs/api/admin/paths/batch-jobs.yaml → docs/api/admin/paths/admin_batch-jobs.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostBatchJobs
summary: Create a Batch Job
description: Creates a Batch Job.
x-authenticated: true
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/batch-jobs/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Batch Job
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminBatchJobRes.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: GetBatchJobs
summary: List Batch Jobs
@@ -291,16 +246,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/batch-jobs/get.js
$ref: ../code_samples/JavaScript/admin_batch-jobs/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/batch-jobs/get.sh
$ref: ../code_samples/Shell/admin_batch-jobs/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Batch Job
- Batch Jobs
responses:
'200':
description: OK
@@ -320,3 +275,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostBatchJobs
summary: Create a Batch Job
description: Creates a Batch Job.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostBatchesReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_batch-jobs/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_batch-jobs/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Batch Jobs
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminBatchJobRes.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
docs/api/admin/paths/batch-jobs_{id}.yaml → docs/api/admin/paths/admin_batch-jobs_{id}.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/batch-jobs_{id}/get.js
$ref: ../code_samples/JavaScript/admin_batch-jobs_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/batch-jobs_{id}/get.sh
$ref: ../code_samples/Shell/admin_batch-jobs_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Batch Job
- Batch Jobs
responses:
'200':
description: OK
docs/api/admin/paths/batch-jobs_{id}_cancel.yaml → docs/api/admin/paths/admin_batch-jobs_{id}_cancel.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/batch-jobs_{id}_cancel/post.js
$ref: ../code_samples/JavaScript/admin_batch-jobs_{id}_cancel/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/batch-jobs_{id}_cancel/post.sh
$ref: ../code_samples/Shell/admin_batch-jobs_{id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Batch Job
- Batch Jobs
responses:
'200':
description: OK
docs/api/admin/paths/batch-jobs_{id}_confirm.yaml → docs/api/admin/paths/admin_batch-jobs_{id}_confirm.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/batch-jobs_{id}_confirm/post.js
$ref: ../code_samples/JavaScript/admin_batch-jobs_{id}_confirm/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/batch-jobs_{id}_confirm/post.sh
$ref: ../code_samples/Shell/admin_batch-jobs_{id}_confirm/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Batch Job
- Batch Jobs
responses:
'200':
description: OK
docs/api/admin/paths/collections.yaml → docs/api/admin/paths/admin_collections.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostCollections
summary: Create a Collection
description: Creates a Product Collection.
x-authenticated: true
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collection
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCollectionsRes.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: GetCollections
summary: List Collections
@@ -154,16 +109,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/collections/get.js
$ref: ../code_samples/JavaScript/admin_collections/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections/get.sh
$ref: ../code_samples/Shell/admin_collections/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collection
- Collections
responses:
'200':
description: OK
@@ -183,3 +138,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCollections
summary: Create a Collection
description: Creates a Product Collection.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostCollectionsReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_collections/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_collections/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCollectionsRes.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
docs/api/admin/paths/collections_{id}.yaml → docs/api/admin/paths/admin_collections_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeleteCollectionsCollection
summary: Delete a Collection
description: Deletes a Product Collection.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collection
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCollectionsDeleteRes.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: GetCollectionsCollection
summary: Get a Collection
@@ -63,16 +16,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/collections_{id}/get.js
$ref: ../code_samples/JavaScript/admin_collections_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections_{id}/get.sh
$ref: ../code_samples/Shell/admin_collections_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collection
- Collections
responses:
'200':
description: OK
@@ -115,16 +68,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/collections_{id}/post.js
$ref: ../code_samples/JavaScript/admin_collections_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections_{id}/post.sh
$ref: ../code_samples/Shell/admin_collections_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collection
- Collections
responses:
'200':
description: OK
@@ -144,3 +97,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteCollectionsCollection
summary: Delete a Collection
description: Deletes a Product Collection.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_collections_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_collections_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCollectionsDeleteRes.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
docs/api/admin/paths/collections_{id}_products_batch.yaml → docs/api/admin/paths/admin_collections_{id}_products_batch.yaml
+4 -4
View File
@@ -21,12 +21,12 @@ post:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections_{id}_products_batch/post.sh
$ref: ../code_samples/Shell/admin_collections_{id}_products_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collection
- Collections
responses:
'200':
description: OK
@@ -69,12 +69,12 @@ delete:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections_{id}_products_batch/delete.sh
$ref: ../code_samples/Shell/admin_collections_{id}_products_batch/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collection
- Collections
responses:
'200':
description: OK
docs/api/admin/paths/currencies.yaml → docs/api/admin/paths/admin_currencies.yaml
+3 -3
View File
@@ -38,13 +38,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/currencies/get.js
$ref: ../code_samples/JavaScript/admin_currencies/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/currencies/get.sh
$ref: ../code_samples/Shell/admin_currencies/get.sh
tags:
- Currency
- Currencies
responses:
'200':
description: OK
docs/api/admin/paths/currencies_{code}.yaml → docs/api/admin/paths/admin_currencies_{code}.yaml
+3 -3
View File
@@ -21,13 +21,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/currencies_{code}/post.js
$ref: ../code_samples/JavaScript/admin_currencies_{code}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/currencies_{code}/post.sh
$ref: ../code_samples/Shell/admin_currencies_{code}/post.sh
tags:
- Currency
- Currencies
responses:
'200':
description: OK
docs/api/admin/paths/customer-groups.yaml → docs/api/admin/paths/admin_customer-groups.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostCustomerGroups
summary: Create a Customer Group
description: Creates a CustomerGroup.
x-authenticated: true
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomerGroupsRes.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: GetCustomerGroups
summary: List Customer Groups
@@ -172,16 +127,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customer-groups/get.js
$ref: ../code_samples/JavaScript/admin_customer-groups/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups/get.sh
$ref: ../code_samples/Shell/admin_customer-groups/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
- Customer Groups
responses:
'200':
description: OK
@@ -201,3 +156,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomerGroups
summary: Create a Customer Group
description: Creates a CustomerGroup.
x-authenticated: true
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/admin_customer-groups/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_customer-groups/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Groups
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomerGroupsRes.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
docs/api/admin/paths/customer-groups_{id}.yaml → docs/api/admin/paths/admin_customer-groups_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeleteCustomerGroupsCustomerGroup
summary: Delete a Customer Group
description: Deletes a CustomerGroup.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomerGroupsDeleteRes.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: GetCustomerGroupsGroup
summary: Get a Customer Group
@@ -74,16 +27,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customer-groups_{id}/get.js
$ref: ../code_samples/JavaScript/admin_customer-groups_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}/get.sh
$ref: ../code_samples/Shell/admin_customer-groups_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
- Customer Groups
responses:
'200':
description: OK
@@ -126,16 +79,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customer-groups_{id}/post.js
$ref: ../code_samples/JavaScript/admin_customer-groups_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}/post.sh
$ref: ../code_samples/Shell/admin_customer-groups_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
- Customer Groups
responses:
'200':
description: OK
@@ -155,3 +108,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteCustomerGroupsCustomerGroup
summary: Delete a Customer Group
description: Deletes a CustomerGroup.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_customer-groups_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_customer-groups_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Groups
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomerGroupsDeleteRes.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
docs/api/admin/paths/customer-groups_{id}_customers.yaml → docs/api/admin/paths/admin_customer-groups_{id}_customers.yaml
+3 -3
View File
@@ -39,16 +39,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customer-groups_{id}_customers/get.js
$ref: ../code_samples/JavaScript/admin_customer-groups_{id}_customers/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}_customers/get.sh
$ref: ../code_samples/Shell/admin_customer-groups_{id}_customers/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
- Customer Groups
responses:
'200':
description: OK
docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml → docs/api/admin/paths/admin_customer-groups_{id}_customers_batch.yaml
+8 -6
View File
@@ -23,16 +23,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/customer-groups_{id}_customers_batch/post.js
../code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}_customers_batch/post.sh
$ref: >-
../code_samples/Shell/admin_customer-groups_{id}_customers_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
- Customer Groups
responses:
'200':
description: OK
@@ -77,16 +78,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/customer-groups_{id}_customers_batch/delete.js
../code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}_customers_batch/delete.sh
$ref: >-
../code_samples/Shell/admin_customer-groups_{id}_customers_batch/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
- Customer Groups
responses:
'200':
description: OK
docs/api/admin/paths/customers.yaml → docs/api/admin/paths/admin_customers.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostCustomers
summary: Create a Customer
description: Creates a Customer.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostCustomersReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomersRes.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: GetCustomers
summary: List Customers
@@ -78,16 +33,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers/get.js
$ref: ../code_samples/JavaScript/admin_customers/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers/get.sh
$ref: ../code_samples/Shell/admin_customers/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
@@ -107,3 +62,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomers
summary: Create a Customer
description: Creates a Customer.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostCustomersReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_customers/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_customers/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customers
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomersRes.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
docs/api/admin/paths/customers_{id}.yaml → docs/api/admin/paths/admin_customers_{id}.yaml
+6 -6
View File
@@ -26,16 +26,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_{id}/get.js
$ref: ../code_samples/JavaScript/admin_customers_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_{id}/get.sh
$ref: ../code_samples/Shell/admin_customers_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
@@ -88,16 +88,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_{id}/post.js
$ref: ../code_samples/JavaScript/admin_customers_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_{id}/post.sh
$ref: ../code_samples/Shell/admin_customers_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
docs/api/admin/paths/discounts.yaml → docs/api/admin/paths/admin_discounts.yaml
+62 -62
View File
@@ -1,62 +1,3 @@
post:
operationId: PostDiscounts
summary: Creates a Discount
x-authenticated: true
description: >-
Creates a Discount with a given set of rules that define how the Discount
behaves.
parameters:
- 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 retrieved in the results.
schema:
type: string
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDiscountsRes.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: GetDiscounts
summary: List Discounts
@@ -126,16 +67,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/discounts/get.js
$ref: ../code_samples/JavaScript/admin_discounts/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts/get.sh
$ref: ../code_samples/Shell/admin_discounts/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
@@ -155,3 +96,62 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostDiscounts
summary: Creates a Discount
x-authenticated: true
description: >-
Creates a Discount with a given set of rules that define how the Discount
behaves.
parameters:
- 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 retrieved in the results.
schema:
type: string
requestBody:
content:
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/admin_discounts/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_discounts/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discounts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDiscountsRes.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
docs/api/admin/paths/discounts_code_{code}.yaml → docs/api/admin/paths/admin_discounts_code_{code}.yaml
+3 -3
View File
@@ -27,16 +27,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/discounts_code_{code}/get.js
$ref: ../code_samples/JavaScript/admin_discounts_code_{code}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_code_{code}/get.sh
$ref: ../code_samples/Shell/admin_discounts_code_{code}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
docs/api/admin/paths/discounts_{discount_id}_conditions.yaml → docs/api/admin/paths/admin_discounts_{discount_id}_conditions.yaml
+4 -3
View File
@@ -39,16 +39,17 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/discounts_{discount_id}_conditions/post.js
$ref: >-
../code_samples/JavaScript/admin_discounts_{discount_id}_conditions/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{discount_id}_conditions/post.sh
$ref: ../code_samples/Shell/admin_discounts_{discount_id}_conditions/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount Condition
- Discounts
responses:
'200':
description: OK
docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml → docs/api/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml
+72 -72
View File
@@ -1,69 +1,3 @@
delete:
operationId: DeleteDiscountsDiscountConditionsCondition
summary: Delete a Condition
description: Deletes a DiscountCondition
x-authenticated: true
parameters:
- in: path
name: discount_id
required: true
description: The ID of the Discount
schema:
type: string
- in: path
name: condition_id
required: true
description: The ID of the DiscountCondition
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: deleteCondition
queryParams: AdminDeleteDiscountsDiscountConditionsConditionParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../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}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount Condition
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDiscountConditionsDeleteRes.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: GetDiscountsDiscountConditionsCondition
summary: Get a Condition
@@ -100,17 +34,17 @@ get:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/get.js
../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/get.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/get.sh
../code_samples/Shell/admin_discounts_{discount_id}_conditions_{condition_id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount Condition
- Discounts
responses:
'200':
description: OK
@@ -179,17 +113,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}/post.js
../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/discounts_{discount_id}_conditions_{condition_id}/post.sh
../code_samples/Shell/admin_discounts_{discount_id}_conditions_{condition_id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
@@ -209,3 +143,69 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteDiscountsDiscountConditionsCondition
summary: Delete a Condition
description: Deletes a DiscountCondition
x-authenticated: true
parameters:
- in: path
name: discount_id
required: true
description: The ID of the Discount
schema:
type: string
- in: path
name: condition_id
required: true
description: The ID of the DiscountCondition
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: deleteCondition
queryParams: AdminDeleteDiscountsDiscountConditionsConditionParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_discounts_{discount_id}_conditions_{condition_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discounts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDiscountConditionsDeleteRes.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
docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml → docs/api/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml
+6 -6
View File
@@ -44,17 +44,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}_batch/post.js
../code_samples/JavaScript/admin_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/post.sh
../code_samples/Shell/admin_discounts_{discount_id}_conditions_{condition_id}_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount Condition
- Discounts
responses:
'200':
description: OK
@@ -119,17 +119,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/discounts_{discount_id}_conditions_{condition_id}_batch/delete.js
../code_samples/JavaScript/admin_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/delete.sh
../code_samples/Shell/admin_discounts_{discount_id}_conditions_{condition_id}_batch/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount Condition
- Discounts
responses:
'200':
description: OK
docs/api/admin/paths/discounts_{id}.yaml → docs/api/admin/paths/admin_discounts_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeleteDiscountsDiscount
summary: Delete a Discount
description: Deletes a Discount.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDiscountsDeleteRes.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: GetDiscountsDiscount
summary: Get a Discount
@@ -74,16 +27,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/discounts_{id}/get.js
$ref: ../code_samples/JavaScript/admin_discounts_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{id}/get.sh
$ref: ../code_samples/Shell/admin_discounts_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
@@ -143,16 +96,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/discounts_{id}/post.js
$ref: ../code_samples/JavaScript/admin_discounts_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{id}/post.sh
$ref: ../code_samples/Shell/admin_discounts_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
@@ -172,3 +125,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteDiscountsDiscount
summary: Delete a Discount
description: Deletes a Discount.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_discounts_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_discounts_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discounts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDiscountsDeleteRes.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
docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml → docs/api/admin/paths/admin_discounts_{id}_dynamic-codes.yaml
+3 -3
View File
@@ -23,16 +23,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/discounts_{id}_dynamic-codes/post.js
$ref: ../code_samples/JavaScript/admin_discounts_{id}_dynamic-codes/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{id}_dynamic-codes/post.sh
$ref: ../code_samples/Shell/admin_discounts_{id}_dynamic-codes/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml → docs/api/admin/paths/admin_discounts_{id}_dynamic-codes_{code}.yaml
+4 -3
View File
@@ -23,16 +23,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/discounts_{id}_dynamic-codes_{code}/delete.js
../code_samples/JavaScript/admin_discounts_{id}_dynamic-codes_{code}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{id}_dynamic-codes_{code}/delete.sh
$ref: >-
../code_samples/Shell/admin_discounts_{id}_dynamic-codes_{code}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml → docs/api/admin/paths/admin_discounts_{id}_regions_{region_id}.yaml
+8 -6
View File
@@ -22,16 +22,17 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/discounts_{id}_regions_{region_id}/post.js
$ref: >-
../code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{id}_regions_{region_id}/post.sh
$ref: ../code_samples/Shell/admin_discounts_{id}_regions_{region_id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
@@ -76,16 +77,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/discounts_{id}_regions_{region_id}/delete.js
../code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/discounts_{id}_regions_{region_id}/delete.sh
$ref: >-
../code_samples/Shell/admin_discounts_{id}_regions_{region_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Discount
- Discounts
responses:
'200':
description: OK
docs/api/admin/paths/draft-orders.yaml → docs/api/admin/paths/admin_draft-orders.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostDraftOrders
summary: Create a Draft Order
description: Creates a Draft Order
x-authenticated: true
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/draft-orders/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Order
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDraftOrdersRes.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: GetDraftOrders
summary: List Draft Orders
@@ -75,16 +30,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/draft-orders/get.js
$ref: ../code_samples/JavaScript/admin_draft-orders/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/draft-orders/get.sh
$ref: ../code_samples/Shell/admin_draft-orders/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Order
- Draft Orders
responses:
'200':
description: OK
@@ -104,3 +59,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostDraftOrders
summary: Create a Draft Order
description: Creates a Draft Order
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostDraftOrdersReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_draft-orders/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_draft-orders/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDraftOrdersRes.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
docs/api/admin/paths/admin_draft-orders_{id}.yaml
+95 -1
View File
@@ -1,3 +1,50 @@
get:
operationId: GetDraftOrdersDraftOrder
summary: Get a Draft Order
description: Retrieves a Draft Order.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_draft-orders_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_draft-orders_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDraftOrdersRes.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: PostDraftOrdersDraftOrder
summary: Update a Draft Order
@@ -30,7 +77,7 @@ post:
- api_token: []
- cookie_auth: []
tags:
- Draft Order
- Draft Orders
responses:
'200':
description: OK
@@ -50,3 +97,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteDraftOrdersDraftOrder
summary: Delete a Draft Order
description: Deletes a Draft Order
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_draft-orders_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_draft-orders_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDraftOrdersDeleteRes.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
docs/api/admin/paths/draft-orders_{id}_line-items.yaml → docs/api/admin/paths/admin_draft-orders_{id}_line-items.yaml
+3 -3
View File
@@ -22,16 +22,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/draft-orders_{id}_line-items/post.js
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}_line-items/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/draft-orders_{id}_line-items/post.sh
$ref: ../code_samples/Shell/admin_draft-orders_{id}_line-items/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Order
- Draft Orders
responses:
'200':
description: OK
docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml → docs/api/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml
+59 -57
View File
@@ -1,57 +1,3 @@
delete:
operationId: DeleteDraftOrdersDraftOrderLineItemsItem
summary: Delete a Line Item
description: Removes a Line Item from a Draft Order.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Draft Order.
schema:
type: string
- in: path
name: line_id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/draft-orders_{id}_line-items_{line_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Order
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDraftOrdersRes.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: PostDraftOrdersDraftOrderLineItemsItem
summary: Update a Line Item
@@ -83,16 +29,72 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/draft-orders_{id}_line-items_{line_id}/post.js
../code_samples/JavaScript/admin_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}/post.sh
$ref: >-
../code_samples/Shell/admin_draft-orders_{id}_line-items_{line_id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Order
- Draft Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDraftOrdersRes.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: DeleteDraftOrdersDraftOrderLineItemsItem
summary: Delete a Line Item
description: Removes a Line Item from a Draft Order.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Draft Order.
schema:
type: string
- in: path
name: line_id
required: true
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/admin_draft-orders_{id}_line-items_{line_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_draft-orders_{id}_line-items_{line_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Orders
responses:
'200':
description: OK
docs/api/admin/paths/draft-orders_{id}_pay.yaml → docs/api/admin/paths/admin_draft-orders_{id}_pay.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/draft-orders_{id}_pay/post.js
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}_pay/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/draft-orders_{id}_pay/post.sh
$ref: ../code_samples/Shell/admin_draft-orders_{id}_pay/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Draft Order
- Draft Orders
responses:
'200':
description: OK
docs/api/admin/paths/gift-cards.yaml → docs/api/admin/paths/admin_gift-cards.yaml
+50 -50
View File
@@ -1,50 +1,3 @@
post:
operationId: PostGiftCards
summary: Create a Gift Card
description: >-
Creates a Gift Card that can redeemed by its unique code. The Gift Card is
only valid within 1 region.
x-authenticated: true
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Gift Card
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminGiftCardsRes.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: GetGiftCards
summary: List Gift Cards
@@ -75,16 +28,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/gift-cards/get.js
$ref: ../code_samples/JavaScript/admin_gift-cards/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards/get.sh
$ref: ../code_samples/Shell/admin_gift-cards/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Gift Card
- Gift Cards
responses:
'200':
description: OK
@@ -104,3 +57,50 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostGiftCards
summary: Create a Gift Card
description: >-
Creates a Gift Card that can redeemed by its unique code. The Gift Card is
only valid within 1 region.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostGiftCardsReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_gift-cards/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_gift-cards/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Gift Cards
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminGiftCardsRes.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
docs/api/admin/paths/gift-cards_{id}.yaml → docs/api/admin/paths/admin_gift-cards_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeleteGiftCardsGiftCard
summary: Delete a Gift Card
description: Deletes a Gift Card
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Gift Card
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminGiftCardsDeleteRes.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: GetGiftCardsGiftCard
summary: Get a Gift Card
@@ -63,16 +16,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/gift-cards_{id}/get.js
$ref: ../code_samples/JavaScript/admin_gift-cards_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards_{id}/get.sh
$ref: ../code_samples/Shell/admin_gift-cards_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Gift Card
- Gift Cards
responses:
'200':
description: OK
@@ -117,16 +70,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/gift-cards_{id}/post.js
$ref: ../code_samples/JavaScript/admin_gift-cards_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards_{id}/post.sh
$ref: ../code_samples/Shell/admin_gift-cards_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Gift Card
- Gift Cards
responses:
'200':
description: OK
@@ -146,3 +99,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteGiftCardsGiftCard
summary: Delete a Gift Card
description: Deletes a Gift Card
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_gift-cards_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_gift-cards_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Gift Cards
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminGiftCardsDeleteRes.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
docs/api/admin/paths/inventory-items.yaml → docs/api/admin/paths/admin_inventory-items.yaml
+62 -2
View File
@@ -95,15 +95,18 @@ get:
description: requires_shipping to search for.
schema:
type: string
x-codegen:
method: list
queryParams: AdminGetInventoryItemsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/inventory-items/get.js
$ref: ../code_samples/JavaScript/admin_inventory-items/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/inventory-items/get.sh
$ref: ../code_samples/Shell/admin_inventory-items/get.sh
security:
- api_token: []
- cookie_auth: []
@@ -129,3 +132,60 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostInventoryItems
summary: Create an Inventory Item.
description: Creates an Inventory Item.
x-authenticated: true
parameters:
- 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/AdminPostInventoryItemsReq.yaml
x-codegen:
method: create
queryParams: AdminPostInventoryItemsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_inventory-items/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_inventory-items/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
docs/api/admin/paths/inventory-items_{id}.yaml → docs/api/admin/paths/admin_inventory-items_{id}.yaml
+47 -39
View File
@@ -1,38 +1,3 @@
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.
@@ -55,15 +20,18 @@ get:
description: Comma separated list of fields to include in the results.
schema:
type: string
x-codegen:
method: retrieve
queryParams: AdminGetInventoryItemsItemParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/inventory-items_{id}/get.js
$ref: ../code_samples/JavaScript/admin_inventory-items_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/inventory-items_{id}/get.sh
$ref: ../code_samples/Shell/admin_inventory-items_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
@@ -115,15 +83,18 @@ post:
application/json:
schema:
$ref: ../components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
x-codegen:
method: update
queryParams: AdminPostInventoryItemsInventoryItemParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/inventory-items_{id}/post.js
$ref: ../code_samples/JavaScript/admin_inventory-items_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/inventory-items_{id}/post.sh
$ref: ../code_samples/Shell/admin_inventory-items_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
@@ -148,3 +119,40 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
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-codegen:
method: delete
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_inventory-items_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_inventory-items_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Inventory Items
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminInventoryItemsDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
docs/api/admin/paths/inventory-items_{id}_location-levels.yaml → docs/api/admin/paths/admin_inventory-items_{id}_location-levels.yaml
+73 -64
View File
@@ -1,65 +1,3 @@
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.
@@ -94,15 +32,20 @@ get:
description: Comma separated list of fields to include in the results.
schema:
type: string
x-codegen:
method: listLocationLevels
queryParams: AdminGetInventoryItemsItemLocationLevelsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/inventory-items_{id}_location-levels/get.js
$ref: >-
../code_samples/JavaScript/admin_inventory-items_{id}_location-levels/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/inventory-items_{id}_location-levels/get.sh
$ref: >-
../code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh
security:
- api_token: []
- cookie_auth: []
@@ -127,3 +70,69 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
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-codegen:
method: createLocationLevel
queryParams: AdminPostInventoryItemsItemLocationLevelsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_inventory-items_{id}_location-levels/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_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
docs/api/admin/paths/inventory-items_{id}_location-levels_{location_id}.yaml → docs/api/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
+60 -65
View File
@@ -1,66 +1,3 @@
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.
@@ -95,17 +32,75 @@ post:
schema:
$ref: >-
../components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
x-codegen:
method: updateLocationLevel
queryParams: AdminPostInventoryItemsItemLocationLevelsLevelParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/inventory-items_{id}_location-levels_{location_id}/post.js
../code_samples/JavaScript/admin_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
../code_samples/Shell/admin_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
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
x-codegen:
method: deleteLocationLevel
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
docs/api/admin/paths/invites.yaml → docs/api/admin/paths/admin_invites.yaml
+44 -44
View File
@@ -1,44 +1,3 @@
post:
operationId: PostInvites
summary: Create an Invite
description: Creates an Invite and triggers an 'invite' created event
x-authenticated: true
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/invites/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
responses:
'200':
description: OK
'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: GetInvites
summary: Lists Invites
@@ -50,16 +9,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/invites/get.js
$ref: ../code_samples/JavaScript/admin_invites/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/invites/get.sh
$ref: ../code_samples/Shell/admin_invites/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
- Invites
responses:
'200':
description: OK
@@ -79,3 +38,44 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostInvites
summary: Create an Invite
description: Creates an Invite and triggers an 'invite' created event
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostInvitesReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_invites/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_invites/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Invites
responses:
'200':
description: OK
'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
docs/api/admin/paths/invites_accept.yaml → docs/api/admin/paths/admin_invites_accept.yaml
+3 -3
View File
@@ -13,16 +13,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/invites_accept/post.js
$ref: ../code_samples/JavaScript/admin_invites_accept/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/invites_accept/post.sh
$ref: ../code_samples/Shell/admin_invites_accept/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
- Invites
responses:
'200':
description: OK
docs/api/admin/paths/invites_{invite_id}.yaml → docs/api/admin/paths/admin_invites_{invite_id}.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ delete:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/invites_{invite_id}/delete.js
$ref: ../code_samples/JavaScript/admin_invites_{invite_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/invites_{invite_id}/delete.sh
$ref: ../code_samples/Shell/admin_invites_{invite_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
- Invites
responses:
'200':
description: OK
docs/api/admin/paths/invites_{invite_id}_resend.yaml → docs/api/admin/paths/admin_invites_{invite_id}_resend.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/invites_{invite_id}_resend/post.js
$ref: ../code_samples/JavaScript/admin_invites_{invite_id}_resend/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/invites_{invite_id}_resend/post.sh
$ref: ../code_samples/Shell/admin_invites_{invite_id}_resend/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
- Invites
responses:
'200':
description: OK
docs/api/admin/paths/notes.yaml → docs/api/admin/paths/admin_notes.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostNotes
summary: Creates a Note
description: Creates a Note which can be associated with any resource as required.
x-authenticated: true
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Note
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminNotesRes.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: GetNotes
summary: List Notes
@@ -73,16 +28,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notes/get.js
$ref: ../code_samples/JavaScript/admin_notes/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes/get.sh
$ref: ../code_samples/Shell/admin_notes/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Note
- Notes
responses:
'200':
description: OK
@@ -102,3 +57,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostNotes
summary: Creates a Note
description: Creates a Note which can be associated with any resource as required.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostNotesReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_notes/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_notes/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Notes
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminNotesRes.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
docs/api/admin/paths/notes_{id}.yaml → docs/api/admin/paths/admin_notes_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeleteNotesNote
summary: Delete a Note
description: Deletes a Note.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Note
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminNotesDeleteRes.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: GetNotesNote
summary: Get a Note
@@ -63,16 +16,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notes_{id}/get.js
$ref: ../code_samples/JavaScript/admin_notes_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes_{id}/get.sh
$ref: ../code_samples/Shell/admin_notes_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Note
- Notes
responses:
'200':
description: OK
@@ -115,16 +68,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notes_{id}/post.js
$ref: ../code_samples/JavaScript/admin_notes_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes_{id}/post.sh
$ref: ../code_samples/Shell/admin_notes_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Note
- Notes
responses:
'200':
description: OK
@@ -144,3 +97,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteNotesNote
summary: Delete a Note
description: Deletes a Note.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_notes_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_notes_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Notes
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminNotesDeleteRes.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
docs/api/admin/paths/notifications.yaml → docs/api/admin/paths/admin_notifications.yaml
+3 -3
View File
@@ -64,16 +64,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notifications/get.js
$ref: ../code_samples/JavaScript/admin_notifications/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notifications/get.sh
$ref: ../code_samples/Shell/admin_notifications/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Notification
- Notifications
responses:
'200':
description: OK
docs/api/admin/paths/notifications_{id}_resend.yaml → docs/api/admin/paths/admin_notifications_{id}_resend.yaml
+3 -3
View File
@@ -24,16 +24,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notifications_{id}_resend/post.js
$ref: ../code_samples/JavaScript/admin_notifications_{id}_resend/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notifications_{id}_resend/post.sh
$ref: ../code_samples/Shell/admin_notifications_{id}_resend/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Notification
- Notifications
responses:
'200':
description: OK
docs/api/admin/paths/order-edits.yaml → docs/api/admin/paths/admin_order-edits.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostOrderEdits
summary: Create an OrderEdit
description: Creates an OrderEdit.
requestBody:
content:
application/json:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrderEditsRes.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: GetOrderEdits
summary: List OrderEdits
@@ -88,16 +43,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits/get.js
$ref: ../code_samples/JavaScript/admin_order-edits/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits/get.sh
$ref: ../code_samples/Shell/admin_order-edits/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
@@ -117,3 +72,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostOrderEdits
summary: Create an OrderEdit
description: Creates an OrderEdit.
requestBody:
content:
application/json:
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/admin_order-edits/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_order-edits/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order Edits
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrderEditsRes.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
docs/api/admin/paths/order-edits_{id}.yaml → docs/api/admin/paths/admin_order-edits_{id}.yaml
+43 -43
View File
@@ -1,40 +1,3 @@
delete:
operationId: DeleteOrderEditsOrderEdit
summary: Delete an Order Edit
description: Delete an Order Edit
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrderEditDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
get:
operationId: GetOrderEditsOrderEdit
summary: Get an OrderEdit
@@ -64,16 +27,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}/get.js
$ref: ../code_samples/JavaScript/admin_order-edits_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}/get.sh
$ref: ../code_samples/Shell/admin_order-edits_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
@@ -116,16 +79,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}/post.js
$ref: ../code_samples/JavaScript/admin_order-edits_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}/post.sh
$ref: ../code_samples/Shell/admin_order-edits_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
@@ -145,3 +108,40 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteOrderEditsOrderEdit
summary: Delete an Order Edit
description: Delete an Order Edit
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_order-edits_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_order-edits_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order Edits
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrderEditDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
docs/api/admin/paths/order-edits_{id}_cancel.yaml → docs/api/admin/paths/admin_order-edits_{id}_cancel.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_cancel/post.js
$ref: ../code_samples/JavaScript/admin_order-edits_{id}_cancel/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_cancel/post.sh
$ref: ../code_samples/Shell/admin_order-edits_{id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml → docs/api/admin/paths/admin_order-edits_{id}_changes_{change_id}.yaml
+4 -3
View File
@@ -23,16 +23,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/order-edits_{id}_changes_{change_id}/delete.js
../code_samples/JavaScript/admin_order-edits_{id}_changes_{change_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_changes_{change_id}/delete.sh
$ref: >-
../code_samples/Shell/admin_order-edits_{id}_changes_{change_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
docs/api/admin/paths/order-edits_{id}_confirm.yaml → docs/api/admin/paths/admin_order-edits_{id}_confirm.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_confirm/post.js
$ref: ../code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_confirm/post.sh
$ref: ../code_samples/Shell/admin_order-edits_{id}_confirm/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
docs/api/admin/paths/order-edits_{id}_items.yaml → docs/api/admin/paths/admin_order-edits_{id}_items.yaml
+3 -3
View File
@@ -21,16 +21,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_items/post.js
$ref: ../code_samples/JavaScript/admin_order-edits_{id}_items/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_items/post.sh
$ref: ../code_samples/Shell/admin_order-edits_{id}_items/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml → docs/api/admin/paths/admin_order-edits_{id}_items_{item_id}.yaml
+58 -56
View File
@@ -1,56 +1,3 @@
delete:
operationId: DeleteOrderEditsOrderEditLineItemsLineItem
summary: Delete a Line Item
description: Delete line items from an order edit and create change item
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order Edit to delete from.
schema:
type: string
- in: path
name: item_id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrderEditsRes.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: PostOrderEditsEditLineItemsLineItem
summary: Upsert Line Item Change
@@ -81,16 +28,71 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_items_{item_id}/post.js
$ref: >-
../code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/post.sh
$ref: ../code_samples/Shell/admin_order-edits_{id}_items_{item_id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminOrderEditsRes.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: DeleteOrderEditsOrderEditLineItemsLineItem
summary: Delete a Line Item
description: Delete line items from an order edit and create change item
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order Edit to delete from.
schema:
type: string
- in: path
name: item_id
required: true
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/admin_order-edits_{id}_items_{item_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_order-edits_{id}_items_{item_id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order Edits
responses:
'200':
description: OK
docs/api/admin/paths/order-edits_{id}_request.yaml → docs/api/admin/paths/admin_order-edits_{id}_request.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_request/post.js
$ref: ../code_samples/JavaScript/admin_order-edits_{id}_request/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_request/post.sh
$ref: ../code_samples/Shell/admin_order-edits_{id}_request/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
docs/api/admin/paths/orders.yaml → docs/api/admin/paths/admin_orders.yaml
+3 -3
View File
@@ -224,16 +224,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders/get.js
$ref: ../code_samples/JavaScript/admin_orders/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders/get.sh
$ref: ../code_samples/Shell/admin_orders/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}.yaml → docs/api/admin/paths/admin_orders_{id}.yaml
+6 -6
View File
@@ -27,16 +27,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}/get.js
$ref: ../code_samples/JavaScript/admin_orders_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}/get.sh
$ref: ../code_samples/Shell/admin_orders_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
@@ -90,16 +90,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_archive.yaml → docs/api/admin/paths/admin_orders_{id}_archive.yaml
+3 -3
View File
@@ -27,16 +27,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_archive/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_archive/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_archive/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_archive/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_cancel.yaml → docs/api/admin/paths/admin_orders_{id}_cancel.yaml
+3 -3
View File
@@ -30,16 +30,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_cancel/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_cancel/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_cancel/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_capture.yaml → docs/api/admin/paths/admin_orders_{id}_capture.yaml
+3 -3
View File
@@ -27,16 +27,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_capture/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_capture/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_capture/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_capture/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/order_{id}_claims.yaml → docs/api/admin/paths/admin_orders_{id}_claims.yaml
+3 -3
View File
@@ -32,16 +32,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order_{id}_claims/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_claims/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order_{id}_claims/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_claims/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Claim
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml → docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}.yaml
+3 -3
View File
@@ -38,16 +38,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order_{id}_claims_{claim_id}/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order_{id}_claims_{claim_id}/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_claims_{claim_id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Claim
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml → docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_cancel.yaml
+4 -3
View File
@@ -34,16 +34,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_cancel/post.js
../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_cancel/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_claims_{claim_id}_cancel/post.sh
$ref: >-
../code_samples/Shell/admin_orders_{id}_claims_{claim_id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Claim
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml → docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml
+3 -3
View File
@@ -40,17 +40,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_fulfillments/post.js
../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/orders_{id}_claims_{claim_id}_fulfillments/post.sh
../code_samples/Shell/admin_orders_{id}_claims_{claim_id}_fulfillments/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Fulfillment
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml → docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
+3 -3
View File
@@ -40,17 +40,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.js
../code_samples/JavaScript/admin_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/post.sh
../code_samples/Shell/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Fulfillment
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml → docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml
+4 -3
View File
@@ -40,16 +40,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_claims_{claim_id}_shipments/post.js
../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_shipments/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_claims_{claim_id}_shipments/post.sh
$ref: >-
../code_samples/Shell/admin_orders_{id}_claims_{claim_id}_shipments/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Claim
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_complete.yaml → docs/api/admin/paths/admin_orders_{id}_complete.yaml
+3 -3
View File
@@ -27,16 +27,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_complete/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_complete/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_complete/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_complete/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_fulfillment.yaml → docs/api/admin/paths/admin_orders_{id}_fulfillment.yaml
+3 -3
View File
@@ -34,16 +34,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_fulfillment/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_fulfillment/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_fulfillment/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_fulfillment/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Fulfillment
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml → docs/api/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+3 -3
View File
@@ -34,17 +34,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js
../code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh
../code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Fulfillment
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_line-items_{line_item_id}_reserve.yaml → docs/api/admin/paths/admin_orders_{id}_line-items_{line_item_id}_reserve.yaml
+3 -3
View File
@@ -28,17 +28,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/post.js
../code_samples/JavaScript/admin_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/post.sh
../code_samples/Shell/admin_orders_{id}_line-items_{line_item_id}_reserve/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_refund.yaml → docs/api/admin/paths/admin_orders_{id}_refund.yaml
+3 -3
View File
@@ -32,16 +32,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_refund/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_refund/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_refund/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_refund/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_reservations.yaml → docs/api/admin/paths/admin_orders_{id}_reservations.yaml
+4 -4
View File
@@ -26,23 +26,23 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_reservations/get.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_reservations/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_reservations/get.sh
$ref: ../code_samples/Shell/admin_orders_{id}_reservations/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminGetReservationReservationsReq.yaml
$ref: ../components/schemas/AdminReservationsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/admin/paths/orders_{id}_return.yaml → docs/api/admin/paths/admin_orders_{id}_return.yaml
+3 -4
View File
@@ -34,17 +34,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_return/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_return/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_return/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_return/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Return
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_shipment.yaml → docs/api/admin/paths/admin_orders_{id}_shipment.yaml
+3 -3
View File
@@ -32,16 +32,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_shipment/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_shipment/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_shipment/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_shipment/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_shipping-methods.yaml → docs/api/admin/paths/admin_orders_{id}_shipping-methods.yaml
+3 -3
View File
@@ -34,16 +34,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_shipping-methods/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_shipping-methods/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_shipping-methods/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_shipping-methods/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/order_{id}_swaps.yaml → docs/api/admin/paths/admin_orders_{id}_swaps.yaml
+3 -3
View File
@@ -38,16 +38,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order_{id}_swaps/post.js
$ref: ../code_samples/JavaScript/admin_orders_{id}_swaps/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order_{id}_swaps/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_swaps/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Swap
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml → docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_cancel.yaml
+4 -3
View File
@@ -33,16 +33,17 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_cancel/post.js
$ref: >-
../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_cancel/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_swaps_{swap_id}_cancel/post.sh
$ref: ../code_samples/Shell/admin_orders_{id}_swaps_{swap_id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Swap
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml → docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml
+4 -3
View File
@@ -40,16 +40,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_fulfillments/post.js
../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_swaps_{swap_id}_fulfillments/post.sh
$ref: >-
../code_samples/Shell/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Fulfillment
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml → docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
+3 -3
View File
@@ -40,17 +40,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.js
../code_samples/JavaScript/admin_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/post.sh
../code_samples/Shell/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Fulfillment
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml → docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_process-payment.yaml
+3 -3
View File
@@ -37,17 +37,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_process-payment/post.js
../code_samples/JavaScript/admin_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/post.sh
../code_samples/Shell/admin_orders_{id}_swaps_{swap_id}_process-payment/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Swap
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml → docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml
+4 -3
View File
@@ -39,16 +39,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/orders_{id}_swaps_{swap_id}_shipments/post.js
../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_shipments/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}_swaps_{swap_id}_shipments/post.sh
$ref: >-
../code_samples/Shell/admin_orders_{id}_swaps_{swap_id}_shipments/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Swap
- Orders
responses:
'200':
description: OK
docs/api/admin/paths/payment-collections_{id}.yaml → docs/api/admin/paths/admin_payment-collections_{id}.yaml
+46 -46
View File
@@ -1,42 +1,3 @@
delete:
operationId: DeletePaymentCollectionsPaymentCollection
summary: Del a PaymentCollection
description: Deletes a Payment Collection
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPaymentCollectionDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
get:
operationId: GetPaymentCollectionsPaymentCollection
summary: Get a PaymentCollection
@@ -61,21 +22,21 @@ get:
type: string
x-codegen:
method: retrieve
queryParams: GetPaymentCollectionsParams
queryParams: AdminGetPaymentCollectionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payment-collections_{id}/get.js
$ref: ../code_samples/JavaScript/admin_payment-collections_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}/get.sh
$ref: ../code_samples/Shell/admin_payment-collections_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -118,16 +79,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payment-collections_{id}/post.js
$ref: ../code_samples/JavaScript/admin_payment-collections_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}/post.sh
$ref: ../code_samples/Shell/admin_payment-collections_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -147,3 +108,42 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeletePaymentCollectionsPaymentCollection
summary: Del a PaymentCollection
description: Deletes a Payment Collection
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_payment-collections_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_payment-collections_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Payment Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPaymentCollectionDeleteRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
docs/api/admin/paths/payment-collections_{id}_authorize.yaml → docs/api/admin/paths/admin_payment-collections_{id}_authorize.yaml
+4 -3
View File
@@ -16,16 +16,17 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payment-collections_{id}_authorize/post.js
$ref: >-
../code_samples/JavaScript/admin_payment-collections_{id}_authorize/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}_authorize/post.sh
$ref: ../code_samples/Shell/admin_payment-collections_{id}_authorize/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
docs/api/admin/paths/payments_{id}.yaml → docs/api/admin/paths/admin_payments_{id}.yaml
+3 -3
View File
@@ -17,16 +17,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payments_{id}/get.js
$ref: ../code_samples/JavaScript/admin_payments_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payments_{id}/get.sh
$ref: ../code_samples/Shell/admin_payments_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Payment
- Payments
responses:
'200':
description: OK
docs/api/admin/paths/payments_{id}_capture.yaml → docs/api/admin/paths/admin_payments_{id}_capture.yaml
+3 -3
View File
@@ -16,16 +16,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payments_{id}_capture/post.js
$ref: ../code_samples/JavaScript/admin_payments_{id}_capture/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payments_{id}_capture/post.sh
$ref: ../code_samples/Shell/admin_payments_{id}_capture/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Payment
- Payments
responses:
'200':
description: OK
docs/api/admin/paths/payments_{id}_refund.yaml → docs/api/admin/paths/admin_payments_{id}_refund.yaml
+3 -3
View File
@@ -21,16 +21,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payments_{id}_refund/post.js
$ref: ../code_samples/JavaScript/admin_payments_{id}_refund/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payments_{id}_refund/post.sh
$ref: ../code_samples/Shell/admin_payments_{id}_refund/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Payment
- Payments
responses:
'200':
description: OK
docs/api/admin/paths/price-lists.yaml → docs/api/admin/paths/admin_price-lists.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostPriceListsPriceList
summary: Create a Price List
description: Creates a Price List
x-authenticated: true
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPriceListRes.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: GetPriceLists
summary: List Price Lists
@@ -196,16 +151,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/price-lists/get.js
$ref: ../code_samples/JavaScript/admin_price-lists/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists/get.sh
$ref: ../code_samples/Shell/admin_price-lists/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
@@ -225,3 +180,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostPriceListsPriceList
summary: Create a Price List
description: Creates a Price List
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostPriceListsPriceListReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_price-lists/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_price-lists/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price Lists
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPriceListRes.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
docs/api/admin/paths/price-lists_{id}.yaml → docs/api/admin/paths/admin_price-lists_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeletePriceListsPriceList
summary: Delete a Price List
description: Deletes a Price List
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPriceListDeleteRes.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: GetPriceListsPriceList
summary: Get a Price List
@@ -63,16 +16,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/price-lists_{id}/get.js
$ref: ../code_samples/JavaScript/admin_price-lists_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists_{id}/get.sh
$ref: ../code_samples/Shell/admin_price-lists_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
@@ -115,16 +68,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/price-lists_{id}/post.js
$ref: ../code_samples/JavaScript/admin_price-lists_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists_{id}/post.sh
$ref: ../code_samples/Shell/admin_price-lists_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
@@ -144,3 +97,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeletePriceListsPriceList
summary: Delete a Price List
description: Deletes a Price List
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_price-lists_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_price-lists_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price Lists
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPriceListDeleteRes.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
docs/api/admin/paths/price-lists_{id}_prices_batch.yaml → docs/api/admin/paths/admin_price-lists_{id}_prices_batch.yaml
+7 -6
View File
@@ -21,16 +21,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/price-lists_{id}_prices_batch/post.js
$ref: ../code_samples/JavaScript/admin_price-lists_{id}_prices_batch/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists_{id}_prices_batch/post.sh
$ref: ../code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
@@ -75,16 +75,17 @@ delete:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/price-lists_{id}_prices_batch/delete.js
$ref: >-
../code_samples/JavaScript/admin_price-lists_{id}_prices_batch/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists_{id}_prices_batch/delete.sh
$ref: ../code_samples/Shell/admin_price-lists_{id}_prices_batch/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
docs/api/admin/paths/price-lists_{id}_products.yaml → docs/api/admin/paths/admin_price-lists_{id}_products.yaml
+3 -3
View File
@@ -183,16 +183,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/price-lists_{id}_products/get.js
$ref: ../code_samples/JavaScript/admin_price-lists_{id}_products/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/price-lists_{id}_products/get.sh
$ref: ../code_samples/Shell/admin_price-lists_{id}_products/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml → docs/api/admin/paths/admin_price-lists_{id}_products_{product_id}_prices.yaml
+3 -3
View File
@@ -25,17 +25,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/price-lists_{id}_products_{product_id}_prices/delete.js
../code_samples/JavaScript/admin_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/delete.sh
../code_samples/Shell/admin_price-lists_{id}_products_{product_id}_prices/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml → docs/api/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml
+3 -3
View File
@@ -25,17 +25,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/price-lists_{id}_variants_{variant_id}_prices/delete.js
../code_samples/JavaScript/admin_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/delete.sh
../code_samples/Shell/admin_price-lists_{id}_variants_{variant_id}_prices/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Price List
- Price Lists
responses:
'200':
description: OK
docs/api/admin/paths/product-categories.yaml → docs/api/admin/paths/admin_product-categories.yaml
+65 -60
View File
@@ -1,60 +1,3 @@
post:
operationId: PostProductCategories
summary: Create a Product Category
description: Creates a Product Category.
x-authenticated: true
parameters:
- 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 retrieved in the results.
schema:
type: string
requestBody:
content:
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/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
get:
operationId: GetProductCategories
summary: List Product Categories
@@ -76,6 +19,11 @@ get:
description: Search for only active categories
schema:
type: boolean
- in: query
name: include_descendants_tree
description: Include all nested descendants of category
schema:
type: boolean
- in: query
name: parent_category_id
description: Returns categories scoped by parent
@@ -114,16 +62,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-categories/get.js
$ref: ../code_samples/JavaScript/admin_product-categories/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories/get.sh
$ref: ../code_samples/Shell/admin_product-categories/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
- Product Categories
responses:
'200':
description: OK
@@ -143,3 +91,60 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostProductCategories
summary: Create a Product Category
description: Creates a Product Category.
x-authenticated: true
parameters:
- 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 retrieved in the results.
schema:
type: string
requestBody:
content:
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/admin_product-categories/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_product-categories/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Categories
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
docs/api/admin/paths/product-categories_{id}.yaml → docs/api/admin/paths/admin_product-categories_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeleteProductCategoriesCategory
summary: Delete a Product Category
description: Deletes a ProductCategory.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminProductCategoriesCategoryDeleteRes.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: GetProductCategoriesCategory
summary: Get a Product Category
@@ -74,16 +27,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-categories_{id}/get.js
$ref: ../code_samples/JavaScript/admin_product-categories_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories_{id}/get.sh
$ref: ../code_samples/Shell/admin_product-categories_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
- Product Categories
responses:
'200':
description: OK
@@ -141,16 +94,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-categories_{id}/post.js
$ref: ../code_samples/JavaScript/admin_product-categories_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories_{id}/post.sh
$ref: ../code_samples/Shell/admin_product-categories_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
- Product Categories
responses:
'200':
description: OK
@@ -170,3 +123,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteProductCategoriesCategory
summary: Delete a Product Category
description: Deletes a ProductCategory.
x-authenticated: true
parameters:
- in: path
name: id
required: true
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/admin_product-categories_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_product-categories_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Categories
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminProductCategoriesCategoryDeleteRes.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
docs/api/admin/paths/product-categories_{id}_products_batch.yaml → docs/api/admin/paths/admin_product-categories_{id}_products_batch.yaml
+8 -6
View File
@@ -34,16 +34,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/product-categories_{id}_products_batch/post.js
../code_samples/JavaScript/admin_product-categories_{id}_products_batch/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories_{id}_products_batch/post.sh
$ref: >-
../code_samples/Shell/admin_product-categories_{id}_products_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
- Product Categories
responses:
'200':
description: OK
@@ -99,16 +100,17 @@ delete:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/product-categories_{id}_products_batch/delete.js
../code_samples/JavaScript/admin_product-categories_{id}_products_batch/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories_{id}_products_batch/delete.sh
$ref: >-
../code_samples/Shell/admin_product-categories_{id}_products_batch/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
- Product Categories
responses:
'200':
description: OK
docs/api/admin/paths/product-tags.yaml → docs/api/admin/paths/admin_product-tags.yaml
+3 -3
View File
@@ -100,16 +100,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-tags/get.js
$ref: ../code_samples/JavaScript/admin_product-tags/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-tags/get.sh
$ref: ../code_samples/Shell/admin_product-tags/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Tag
- Product Tags
responses:
'200':
description: OK
docs/api/admin/paths/product-types.yaml → docs/api/admin/paths/admin_product-types.yaml
+3 -3
View File
@@ -100,16 +100,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-types/get.js
$ref: ../code_samples/JavaScript/admin_product-types/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-types/get.sh
$ref: ../code_samples/Shell/admin_product-types/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Type
- Product Types
responses:
'200':
description: OK
docs/api/admin/paths/products.yaml → docs/api/admin/paths/admin_products.yaml
+48 -48
View File
@@ -1,48 +1,3 @@
post:
operationId: PostProducts
summary: Create a Product
x-authenticated: true
description: Creates a Product
requestBody:
content:
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/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminProductsRes.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: GetProducts
summary: List Products
@@ -271,16 +226,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products/get.js
$ref: ../code_samples/JavaScript/admin_products/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products/get.sh
$ref: ../code_samples/Shell/admin_products/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product
- Products
responses:
'200':
description: OK
@@ -300,3 +255,48 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostProducts
summary: Create a Product
x-authenticated: true
description: Creates a Product
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostProductsReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_products/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_products/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Products
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminProductsRes.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
docs/api/admin/paths/products_tag-usage.yaml → docs/api/admin/paths/admin_products_tag-usage.yaml
+3 -3
View File
@@ -9,16 +9,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_tag-usage/get.js
$ref: ../code_samples/JavaScript/admin_products_tag-usage/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_tag-usage/get.sh
$ref: ../code_samples/Shell/admin_products_tag-usage/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Tag
- Products
responses:
'200':
description: OK
docs/api/admin/paths/products_types.yaml → docs/api/admin/paths/admin_products_types.yaml
+3 -3
View File
@@ -10,16 +10,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_types/get.js
$ref: ../code_samples/JavaScript/admin_products_types/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_types/get.sh
$ref: ../code_samples/Shell/admin_products_types/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product
- Products
responses:
'200':
description: OK
docs/api/admin/paths/products_{id}.yaml → docs/api/admin/paths/admin_products_{id}.yaml
+53 -53
View File
@@ -1,50 +1,3 @@
delete:
operationId: DeleteProductsProduct
summary: Delete a Product
description: Deletes a Product and it's associated Product Variants.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Product.
schema:
type: string
x-codegen:
method: delete
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminProductsDeleteRes.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: GetProductsProduct
summary: Get a Product
@@ -63,16 +16,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_{id}/get.js
$ref: ../code_samples/JavaScript/admin_products_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_{id}/get.sh
$ref: ../code_samples/Shell/admin_products_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product
- Products
responses:
'200':
description: OK
@@ -115,16 +68,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_{id}/post.js
$ref: ../code_samples/JavaScript/admin_products_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_{id}/post.sh
$ref: ../code_samples/Shell/admin_products_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product
- Products
responses:
'200':
description: OK
@@ -144,3 +97,50 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteProductsProduct
summary: Delete a Product
description: Deletes a Product and it's associated Product Variants.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Product.
schema:
type: string
x-codegen:
method: delete
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_products_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_products_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Products
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminProductsDeleteRes.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

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