docs: generate OAS manually for 2.7.0 (#12158)
* original changes * changes * fixes for delete operations * generate oas
This commit is contained in:
1 parent
f8023f419e
commit
cd66cdd2bb
1028 files changed
+29859
-286
No files matched your search
@@ -1227,6 +1227,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_api-keys/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -1303,6 +1307,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateApiKey.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_api-keys/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_api-keys_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -100,6 +104,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateApiKey.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_api-keys_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -144,6 +152,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_api-keys_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -41,6 +41,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminRevokeApiKey.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_api-keys_{id}_revoke/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -57,6 +57,10 @@ post:
|
||||
title: remove
|
||||
description: A sales channel's ID.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_api-keys_{id}_sales-channels/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -62,6 +62,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_campaigns/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -237,6 +241,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The campaign's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_campaigns/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_campaigns_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -162,6 +166,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The campaign's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_campaigns_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -207,6 +215,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_campaigns_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -57,6 +57,10 @@ post:
|
||||
title: remove
|
||||
description: A promotion's ID.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_campaigns_{id}_promotions/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -989,6 +989,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -1050,6 +1054,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderClaimsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -20,6 +20,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCancelClaimReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims_{id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -41,6 +41,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostClaimItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims_{id}_claim-items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -51,6 +51,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_claim-items_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -127,6 +132,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_claim-items_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -23,6 +23,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims_{id}_inbound_items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -35,6 +35,11 @@ post:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_inbound_items_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -93,6 +98,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_inbound_items_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -23,6 +23,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_inbound_shipping-method/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -52,6 +52,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_inbound_shipping-method_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -110,6 +115,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -41,6 +41,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostClaimsAddItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims_{id}_outbound_items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -52,6 +52,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_outbound_items_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -128,6 +133,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_outbound_items_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -41,6 +41,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostClaimsShippingReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_outbound_shipping-method/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -52,6 +52,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_outbound_shipping-method_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -128,6 +133,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -34,6 +34,10 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims_{id}_request/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -77,6 +81,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_claims_{id}_request/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -947,6 +947,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_collections/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -1006,6 +1010,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateCollection.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_collections/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_collections_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -100,6 +104,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateCollection.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_collections_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -143,6 +151,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_collections_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -57,6 +57,10 @@ post:
|
||||
title: remove
|
||||
description: A product's ID.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_collections_{id}_products/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -112,6 +112,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_currencies/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_currencies_{code}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -966,6 +966,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customer-groups/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -1056,6 +1060,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateCustomerGroup.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customer-groups/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customer-groups_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -100,6 +104,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateCustomerGroup.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customer-groups_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -144,6 +152,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customer-groups_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -55,6 +55,11 @@ post:
|
||||
title: remove
|
||||
description: A customer's ID.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_customer-groups_{id}_customers/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -4158,6 +4158,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customers/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -4291,6 +4295,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The customer's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customers/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -37,6 +37,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customers_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -148,6 +152,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The customer's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customers_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -191,6 +199,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customers_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -176,6 +176,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customers_{id}_addresses/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -360,6 +364,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The address's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_customers_{id}_addresses/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+15
@@ -43,6 +43,11 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_customers_{id}_addresses_{address_id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -203,6 +208,11 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The address's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_customers_{id}_addresses_{address_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -273,6 +283,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_customers_{id}_addresses_{address_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -61,6 +61,11 @@ post:
|
||||
title: remove
|
||||
description: The ID of the group to remove the customer from.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_customers_{id}_customer-groups/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -1750,6 +1750,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -2107,6 +2111,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The draft order's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -37,6 +37,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -105,6 +109,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateDraftOrder.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -130,4 +138,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateOrderWorkflow
|
||||
x-workflow: updateDraftOrderWorkflow
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdConvertToOrder
|
||||
summary: Convert a Draft Order to an Order
|
||||
x-sidebar-summary: Convert to Order
|
||||
description: >-
|
||||
Convert a draft order to an order. This will finalize the draft order and
|
||||
create a new order with the same details.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
|
||||
if a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields.
|
||||
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_convert-to-order/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}_convert-to-order/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: convertDraftOrderWorkflow
|
||||
@@ -0,0 +1,91 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEdit
|
||||
summary: Create a Draft Order Edit
|
||||
x-sidebar-summary: Create Edit
|
||||
description: >-
|
||||
Create an edit on a draft order. This will allow you to make changes to the
|
||||
draft order's items, shipping methods, or promotions before confirming them
|
||||
later.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}_edit/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}_edit/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: beginDraftOrderEditWorkflow
|
||||
delete:
|
||||
operationId: DeleteDraftOrdersIdEdit
|
||||
summary: Cancel Edit on Draft Order
|
||||
x-sidebar-summary: Cancel Edit
|
||||
description: Cancel an unconfirmed edit on a draft order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}_edit/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}_edit/delete.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: cancelDraftOrderEditWorkflow
|
||||
@@ -0,0 +1,47 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditConfirm
|
||||
summary: Confirm an Edit on a Draft Order
|
||||
x-sidebar-summary: Confirm Edit
|
||||
description: >-
|
||||
Confirm an edit on a draft order. This will apply the changes made to the
|
||||
draft order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_confirm/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}_edit_confirm/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: confirmDraftOrderEditWorkflow
|
||||
@@ -0,0 +1,49 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditItems
|
||||
summary: Add Item to Draft Order
|
||||
x-sidebar-summary: Add Item
|
||||
description: Add an Item to a draft order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminAddDraftOrderItems.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders_{id}_edit_items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}_edit_items/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: addDraftOrderItemsWorkflow
|
||||
+57
@@ -0,0 +1,57 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditItemsItemItem_id
|
||||
summary: Update Item in Draft Order
|
||||
x-sidebar-summary: Update Item
|
||||
description: Update an item in a draft order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: item_id
|
||||
in: path
|
||||
description: The item's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateDraftOrderItem.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_items_item_{item_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_items_item_{item_id}/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: updateDraftOrderItemWorkflow
|
||||
+123
@@ -0,0 +1,123 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditItemsAction_id
|
||||
summary: Update Item Changes in Draft Order
|
||||
x-sidebar-summary: Update Item Changes
|
||||
description: >
|
||||
Update changes made on an item (addition or update) in the draft order by
|
||||
the ID of the item's `ITEM_ADD` or `ITEM_UPDATE` action.
|
||||
|
||||
|
||||
Every item has an `actions` property, whose value is an array of actions.
|
||||
You can check the action's name using its `action` property, and use the
|
||||
value of the `id` property.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The ID of the item's `ITEM_ADD` or `ITEM_UPDATE` action.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateDraftOrderItem.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_items_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_items_{action_id}/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: updateDraftOrderActionItemWorkflow
|
||||
delete:
|
||||
operationId: DeleteDraftOrdersIdEditItemsAction_id
|
||||
summary: Remove Item from Draft Order
|
||||
x-sidebar-summary: Remove Item
|
||||
description: >
|
||||
Remove an order item from a draft order by the ID of the item's
|
||||
`ITEM_REMOVE` action.
|
||||
|
||||
|
||||
Every item has an `actions` property, whose value is an array of actions.
|
||||
You can check the action's name using its `action` property, and use the
|
||||
value of the `id` property.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The ID of the order item's `ITEM_REMOVE` action.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_items_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_items_{action_id}/delete.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: removeDraftOrderActionItemWorkflow
|
||||
+109
@@ -0,0 +1,109 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditPromotions
|
||||
summary: Add Promotions to Draft Order
|
||||
x-sidebar-summary: Add Promotions
|
||||
description: Add promotions to a draft order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminAddDraftOrderPromotions.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_promotions/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}_edit_promotions/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDraftOrderPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: addDraftOrderPromotionWorkflow
|
||||
delete:
|
||||
operationId: DeleteDraftOrdersIdEditPromotions
|
||||
summary: Remove Promotions from Draft Order
|
||||
x-sidebar-summary: Remove Promotions
|
||||
description: Remove specified promotions from a draft order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_promotions/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_promotions/delete.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDraftOrderPreviewResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: removeDraftOrderPromotionsWorkflow
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminRemoveDraftOrderPromotions.yaml
|
||||
@@ -0,0 +1,47 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditRequest
|
||||
summary: Request Edit on Draft Order
|
||||
x-sidebar-summary: Request Edit
|
||||
description: >-
|
||||
Change the status of a draft order's edit to be requested. Later, the edit
|
||||
can be confirmed or canceled.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_request/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders_{id}_edit_request/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: requestDraftOrderEditWorkflow
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditShippingMethods
|
||||
summary: Add Shipping Method to Draft Order
|
||||
x-sidebar-summary: Add Shipping Method
|
||||
description: Add a shipping method to a draft order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminAddDraftOrderShippingMethod.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: addDraftOrderShippingMethodsWorkflow
|
||||
+57
@@ -0,0 +1,57 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditShippingMethodsMethodMethod_id
|
||||
summary: Update Shipping Method in Draft Order
|
||||
x-sidebar-summary: Update Shipping Method
|
||||
description: Update a shipping method in a draft order
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: method_id
|
||||
in: path
|
||||
description: The ID of the shipping method.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateDraftOrderShippingMethod.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: updateDraftOrderShippingMethodWorkflow
|
||||
+126
@@ -0,0 +1,126 @@
|
||||
post:
|
||||
operationId: PostDraftOrdersIdEditShippingMethodsAction_id
|
||||
summary: Update Shipping Method Changes in Draft Order
|
||||
x-sidebar-summary: Update Shipping Method Changes
|
||||
description: >
|
||||
Update changes made on a shipping method (addition or update) in a draft
|
||||
order using the `ID` of the method's `SHIPPING_ADD` or `SHIPPING_UPDATE`
|
||||
action.
|
||||
|
||||
|
||||
Every shipping method has an `actions` property, whose value is an array of
|
||||
actions. You can check the action's name using its `action` property, and
|
||||
use the value of the `id` property.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: >-
|
||||
The ID of the shipping method's `SHIPPING_ADD` or `SHIPPING_UPDATE`
|
||||
action.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_{action_id}/post.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: updateDraftOrderActionShippingMethodWorkflow
|
||||
delete:
|
||||
operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id
|
||||
summary: Remove Shipping Method from Draft Order
|
||||
x-sidebar-summary: Remove Shipping Method
|
||||
description: >
|
||||
Remove the shipping method in a draft order using the `ID` of the method's
|
||||
`SHIPPING_ADD` action.
|
||||
|
||||
|
||||
Every shipping method has an `actions` property, whose value is an array of
|
||||
actions. You can check the action's name using its `action` property, and
|
||||
use the value of the `id` property.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The draft order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: action_id
|
||||
in: path
|
||||
description: The ID of the shipping method's `SHIPPING_ADD` action.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_{action_id}/delete.sh
|
||||
tags:
|
||||
- Draft Orders
|
||||
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
|
||||
x-workflow: removeDraftOrderActionShippingMethodWorkflow
|
||||
@@ -911,6 +911,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -1003,6 +1007,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderExchangesReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -20,6 +20,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostCancelExchangeReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges_{id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -24,6 +24,10 @@ post:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges_{id}_inbound_items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -35,6 +35,11 @@ post:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_inbound_items_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -93,6 +98,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_inbound_items_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -23,6 +23,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_inbound_shipping-method/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -52,6 +52,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -110,6 +115,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -40,6 +40,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesAddItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges_{id}_outbound_items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -52,6 +52,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesItemsActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_outbound_items_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -128,6 +133,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_outbound_items_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -41,6 +41,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesShippingReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_outbound_shipping-method/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -52,6 +52,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -128,6 +133,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -33,6 +33,10 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges_{id}_request/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -76,6 +80,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_exchanges_{id}_request/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -107,6 +107,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_fulfillment-providers/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -17,6 +17,11 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_fulfillment-providers_{id}_options/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -15,6 +15,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_fulfillment-sets_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -157,6 +157,11 @@ post:
|
||||
type: object
|
||||
description: The geo zone's postal expression or ZIP code.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_fulfillment-sets_{id}_service-zones/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+15
@@ -40,6 +40,11 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -245,6 +250,11 @@ post:
|
||||
title: id
|
||||
description: The ID of an existing geo zone.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -296,6 +306,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -32,6 +32,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateFulfillment.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_fulfillments/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -38,6 +38,10 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_fulfillments_{id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -41,6 +41,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateShipment.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_fulfillments_{id}_shipment/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -435,6 +435,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_inventory-items/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -525,6 +529,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateInventoryItem.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_inventory-items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -13,6 +13,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminBatchInventoryItemsLocationLevels.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_inventory-items_location-levels_batch/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_inventory-items_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -162,6 +166,10 @@ post:
|
||||
The inventory item's metadata. Can be custom data in key-value
|
||||
pairs.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_inventory-items_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -205,6 +213,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_inventory-items_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -91,6 +91,11 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_inventory-items_{id}_location-levels/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+7
@@ -21,6 +21,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminBatchInventoryItemLocationsLevel.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_inventory-items_{id}_location-levels_batch/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -29,6 +34,8 @@ post:
|
||||
tags:
|
||||
- Inventory Items
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
|
||||
+10
@@ -57,6 +57,11 @@ post:
|
||||
title: incoming_quantity
|
||||
description: The inventory level's incoming quantity.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -131,6 +136,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -535,6 +535,10 @@ get:
|
||||
type: object
|
||||
title: $or
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_invites/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -635,6 +639,10 @@ post:
|
||||
type: object
|
||||
description: The invite's metadata. Can be custom data in key-value pairs.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_invites/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -30,6 +30,10 @@ post:
|
||||
title: last_name
|
||||
description: The user's last name.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_invites_accept/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -31,6 +31,10 @@ get:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_invites_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -73,6 +77,10 @@ delete:
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_invites_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -29,6 +29,10 @@ post:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_invites_{id}_resend/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -122,6 +122,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_notifications/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -35,6 +35,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_notifications_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -13,6 +13,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderEditsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_order-edits/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -15,6 +15,10 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_order-edits_{id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -15,6 +15,10 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -21,6 +21,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_order-edits_{id}_items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -28,6 +28,11 @@ post:
|
||||
$ref: >-
|
||||
../components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_order-edits_{id}_items_item_{item_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+10
@@ -34,6 +34,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_order-edits_{id}_items_{action_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -91,6 +96,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_order-edits_{id}_items_{action_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -15,6 +15,10 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_order-edits_{id}_request/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -706,6 +706,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -83,6 +83,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -151,6 +155,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminUpdateOrder.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -41,6 +41,10 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -42,6 +42,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_changes/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
post:
|
||||
operationId: PostOrdersIdCreditLines
|
||||
summary: Create Credit Line for Order
|
||||
x-sidebar-summary: Create Credit Line
|
||||
description: Create a credit line for an order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The order's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
|
||||
if a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields.
|
||||
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCreateOrderCreditLines.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_credit-lines/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_orders_{id}_credit-lines/post.sh
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createOrderCreditLinesWorkflow
|
||||
@@ -92,6 +92,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The fulfillment's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_fulfillments/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -65,6 +65,11 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The cancelation details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -40,6 +40,11 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
+5
@@ -111,6 +111,11 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The shipment's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -128,6 +128,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_line-items/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -15,6 +15,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_preview/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -45,6 +45,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminTransferOrder.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_transfer/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -36,6 +36,10 @@ post:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_{id}_transfer_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -45,6 +45,10 @@ post:
|
||||
title: amount
|
||||
description: The amount to be paid.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_payment-collections/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
Loaded 100 of 1028 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user