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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-09 09:50:55 +02:00
committed by GitHub
parent 9997485c55
commit 14b2de94e2
952 changed files with 13745 additions and 9192 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/store/paths/auth.yaml
+16 -21
View File
@@ -4,16 +4,22 @@ post:
description: >-
Logs a Customer in and authorizes them to view their details. Successful
authentication will set a session cookie in the Customer's browser.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StorePostAuthReq.yaml
x-codegen:
method: authenticate
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/postundefined
$ref: ../code_samples/JavaScript/auth/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/postundefined
$ref: ../code_samples/Shell/auth/post.sh
tags:
- Auth
responses:
@@ -35,31 +41,18 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
description: The Customer's email.
password:
type: string
description: The Customer's password.
delete:
operationId: DeleteAuth
summary: Customer Log out
description: Destroys a Customer's authenticated session.
x-authenticated: true
x-codegen:
method: deleteSession
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/deleteundefined
$ref: ../code_samples/Shell/auth/delete.sh
security:
- cookie_auth: []
tags:
@@ -84,15 +77,17 @@ get:
summary: Get Current Customer
description: Gets the currently logged in Customer.
x-authenticated: true
x-codegen:
method: getSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/getundefined
$ref: ../code_samples/JavaScript/auth/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/getundefined
$ref: ../code_samples/Shell/auth/get.sh
security:
- cookie_auth: []
tags:
docs/api/store/paths/auth_{email}.yaml
+4 -2
View File
@@ -10,15 +10,17 @@ get:
format: email
required: true
description: The email to check if exists.
x-codegen:
method: exists
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth_{email}/getundefined
$ref: ../code_samples/JavaScript/auth_{email}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth_{email}/getundefined
$ref: ../code_samples/Shell/auth_{email}/get.sh
tags:
- Auth
responses:
docs/api/store/paths/carts.yaml
+4 -2
View File
@@ -11,15 +11,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCartReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts/postundefined
$ref: ../code_samples/JavaScript/carts/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts/postundefined
$ref: ../code_samples/Shell/carts/post.sh
tags:
- Cart
responses:
docs/api/store/paths/carts_{id}.yaml
+8 -4
View File
@@ -9,15 +9,17 @@ get:
description: The id of the Cart.
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}/getundefined
$ref: ../code_samples/JavaScript/carts_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}/getundefined
$ref: ../code_samples/Shell/carts_{id}/get.sh
tags:
- Cart
responses:
@@ -53,15 +55,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCartsCartReq.yaml
x-codegen:
method: update
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}/postundefined
$ref: ../code_samples/JavaScript/carts_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}/postundefined
$ref: ../code_samples/Shell/carts_{id}/post.sh
tags:
- Cart
responses:
docs/api/store/paths/carts_{id}_complete.yaml
+4 -2
View File
@@ -15,15 +15,17 @@ post:
description: The Cart id.
schema:
type: string
x-codegen:
method: complete
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_complete/postundefined
$ref: ../code_samples/JavaScript/carts_{id}_complete/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_complete/postundefined
$ref: ../code_samples/Shell/carts_{id}_complete/post.sh
tags:
- Cart
responses:
docs/api/store/paths/carts_{id}_discounts_{code}.yaml
+4 -2
View File
@@ -15,15 +15,17 @@ delete:
description: The unique Discount code.
schema:
type: string
x-codegen:
method: deleteDiscount
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_discounts_{code}/deleteundefined
$ref: ../code_samples/JavaScript/carts_{id}_discounts_{code}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_discounts_{code}/deleteundefined
$ref: ../code_samples/Shell/carts_{id}_discounts_{code}/delete.sh
tags:
- Cart
responses:
docs/api/store/paths/carts_{id}_line-items.yaml
+9 -22
View File
@@ -9,15 +9,22 @@ post:
description: The id of the Cart to add the Line Item to.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StorePostCartsCartLineItemsReq.yaml
x-codegen:
method: createLineItem
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_line-items/postundefined
$ref: ../code_samples/JavaScript/carts_{id}_line-items/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_line-items/postundefined
$ref: ../code_samples/Shell/carts_{id}_line-items/post.sh
tags:
- Cart
responses:
@@ -37,23 +44,3 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema:
type: object
required:
- variant_id
- quantity
properties:
variant_id:
type: string
description: The id of the Product Variant to generate the Line Item from.
quantity:
type: integer
description: The quantity of the Product Variant to add to the Line Item.
metadata:
type: object
description: >-
An optional key-value map with additional details about the Line
Item.
docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml
+13 -17
View File
@@ -15,16 +15,17 @@ delete:
description: The id of the Line Item.
schema:
type: string
x-codegen:
method: deleteLineItem
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/carts_{id}_line-items_{line_id}/deleteundefined
$ref: ../code_samples/JavaScript/carts_{id}_line-items_{line_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/deleteundefined
$ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/delete.sh
tags:
- Cart
responses:
@@ -61,16 +62,22 @@ post:
description: The id of the Line Item.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StorePostCartsCartLineItemsItemReq.yaml
x-codegen:
method: updateLineItem
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/carts_{id}_line-items_{line_id}/postundefined
$ref: ../code_samples/JavaScript/carts_{id}_line-items_{line_id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/postundefined
$ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/post.sh
tags:
- Cart
responses:
@@ -90,14 +97,3 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema:
type: object
required:
- quantity
properties:
quantity:
type: integer
description: The quantity to set the Line Item to.
docs/api/store/paths/carts_{id}_payment-session.yaml
+9 -13
View File
@@ -11,15 +11,22 @@ post:
description: The ID of the Cart.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StorePostCartsCartPaymentSessionReq.yaml
x-codegen:
method: setPaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_payment-session/postundefined
$ref: ../code_samples/JavaScript/carts_{id}_payment-session/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_payment-session/postundefined
$ref: ../code_samples/Shell/carts_{id}_payment-session/post.sh
tags:
- Cart
responses:
@@ -39,14 +46,3 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema:
type: object
required:
- provider_id
properties:
provider_id:
type: string
description: The ID of the Payment Provider.
docs/api/store/paths/carts_{id}_payment-sessions.yaml
+4 -2
View File
@@ -11,15 +11,17 @@ post:
description: The id of the Cart.
schema:
type: string
x-codegen:
method: createPaymentSessions
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_payment-sessions/postundefined
$ref: ../code_samples/JavaScript/carts_{id}_payment-sessions/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_payment-sessions/postundefined
$ref: ../code_samples/Shell/carts_{id}_payment-sessions/post.sh
tags:
- Cart
responses:
docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml
+13 -15
View File
@@ -17,17 +17,19 @@ delete:
deleted.
schema:
type: string
x-codegen:
method: deletePaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/deleteundefined
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/deleteundefined
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/delete.sh
tags:
- Cart
responses:
@@ -64,17 +66,24 @@ post:
description: The id of the payment provider.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StorePostCartsCartPaymentSessionUpdateReq.yaml
x-codegen:
method: updatePaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/postundefined
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/postundefined
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/post.sh
tags:
- Cart
responses:
@@ -94,14 +103,3 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
description: The data to update the payment session with.
docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
+4 -2
View File
@@ -19,17 +19,19 @@ post:
refreshed.
schema:
type: string
x-codegen:
method: refreshPaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}_refresh/postundefined
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}_refresh/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}_refresh/postundefined
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}_refresh/post.sh
tags:
- Cart
responses:
docs/api/store/paths/carts_{id}_shipping-methods.yaml
+9 -20
View File
@@ -9,15 +9,22 @@ post:
description: The cart ID.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StorePostCartsCartShippingMethodReq.yaml
x-codegen:
method: addShippingMethod
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_shipping-methods/postundefined
$ref: ../code_samples/JavaScript/carts_{id}_shipping-methods/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_shipping-methods/postundefined
$ref: ../code_samples/Shell/carts_{id}_shipping-methods/post.sh
tags:
- Cart
responses:
@@ -37,21 +44,3 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema:
type: object
required:
- option_id
properties:
option_id:
type: string
description: ID of the shipping option to create the method from
data:
type: object
description: >-
Used to hold any data that the shipping method may need to
process the fulfillment of the order. Look at the documentation
for your installed fulfillment providers to find out what to
send.
docs/api/store/paths/carts_{id}_taxes.yaml
+3 -1
View File
@@ -11,11 +11,13 @@ post:
description: The Cart ID.
schema:
type: string
x-codegen:
method: calculateTaxes
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_taxes/postundefined
$ref: ../code_samples/Shell/carts_{id}_taxes/post.sh
tags:
- Cart
responses:
docs/api/store/paths/collections.yaml
+5 -2
View File
@@ -61,15 +61,18 @@ get:
type: string
description: filter by dates greater than or equal to this date
format: date
x-codegen:
method: list
queryParams: StoreGetCollectionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/collections/getundefined
$ref: ../code_samples/JavaScript/collections/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections/getundefined
$ref: ../code_samples/Shell/collections/get.sh
tags:
- Collection
responses:
docs/api/store/paths/collections_{id}.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ get:
description: The id of the Product Collection
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/collections_{id}/getundefined
$ref: ../code_samples/JavaScript/collections_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections_{id}/getundefined
$ref: ../code_samples/Shell/collections_{id}/get.sh
tags:
- Collection
responses:
docs/api/store/paths/customers.yaml
+4 -2
View File
@@ -7,15 +7,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCustomersReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers/postundefined
$ref: ../code_samples/JavaScript/customers/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers/postundefined
$ref: ../code_samples/Shell/customers/post.sh
tags:
- Customer
responses:
docs/api/store/paths/customers_me.yaml
+8 -4
View File
@@ -5,15 +5,17 @@ get:
Retrieves a Customer - the Customer must be logged in to retrieve their
details.
x-authenticated: true
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me/getundefined
$ref: ../code_samples/JavaScript/customers_me/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me/getundefined
$ref: ../code_samples/Shell/customers_me/get.sh
security:
- cookie_auth: []
tags:
@@ -47,15 +49,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCustomersCustomerReq.yaml
x-codegen:
method: update
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me/postundefined
$ref: ../code_samples/JavaScript/customers_me/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me/postundefined
$ref: ../code_samples/Shell/customers_me/post.sh
security:
- cookie_auth: []
tags:
docs/api/store/paths/customers_me_addresses.yaml
+4 -2
View File
@@ -8,15 +8,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCustomersCustomerAddressesReq.yaml
x-codegen:
method: addAddress
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me_addresses/postundefined
$ref: ../code_samples/JavaScript/customers_me_addresses/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_addresses/postundefined
$ref: ../code_samples/Shell/customers_me_addresses/post.sh
security:
- cookie_auth: []
tags:
docs/api/store/paths/customers_me_addresses_{address_id}.yaml
+8 -7
View File
@@ -10,17 +10,18 @@ delete:
description: The id of the Address to remove.
schema:
type: string
x-codegen:
method: deleteAddress
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/customers_me_addresses_{address_id}/deleteundefined
../code_samples/JavaScript/customers_me_addresses_{address_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/customers_me_addresses_{address_id}/deleteundefined
$ref: ../code_samples/Shell/customers_me_addresses_{address_id}/delete.sh
security:
- cookie_auth: []
tags:
@@ -62,17 +63,17 @@ post:
schema:
$ref: >-
../components/schemas/StorePostCustomersCustomerAddressesAddressReq.yaml
x-codegen:
method: updateAddress
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/customers_me_addresses_{address_id}/postundefined
$ref: ../code_samples/JavaScript/customers_me_addresses_{address_id}/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/customers_me_addresses_{address_id}/postundefined
$ref: ../code_samples/Shell/customers_me_addresses_{address_id}/post.sh
security:
- cookie_auth: []
tags:
docs/api/store/paths/customers_me_orders.yaml
+5 -2
View File
@@ -168,15 +168,18 @@ get:
resulting orders.
schema:
type: string
x-codegen:
method: listOrders
queryParams: StoreGetCustomersCustomerOrdersParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me_orders/getundefined
$ref: ../code_samples/JavaScript/customers_me_orders/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_orders/getundefined
$ref: ../code_samples/Shell/customers_me_orders/get.sh
security:
- cookie_auth: []
tags:
docs/api/store/paths/customers_me_payment-methods.yaml
+4 -2
View File
@@ -6,15 +6,17 @@ get:
saved with Payment Providers and it is their responsibility to fetch saved
methods.
x-authenticated: true
x-codegen:
method: listPaymentMethods
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me_payment-methods/getundefined
$ref: ../code_samples/JavaScript/customers_me_payment-methods/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_payment-methods/getundefined
$ref: ../code_samples/Shell/customers_me_payment-methods/get.sh
security:
- cookie_auth: []
tags:
docs/api/store/paths/customers_password-reset.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCustomersResetPasswordReq.yaml
x-codegen:
method: resetPassword
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_password-reset/postundefined
$ref: ../code_samples/JavaScript/customers_password-reset/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_password-reset/postundefined
$ref: ../code_samples/Shell/customers_password-reset/post.sh
tags:
- Customer
responses:
docs/api/store/paths/customers_password-token.yaml
+4 -2
View File
@@ -11,15 +11,17 @@ post:
schema:
$ref: >-
../components/schemas/StorePostCustomersCustomerPasswordTokenReq.yaml
x-codegen:
method: generatePasswordToken
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_password-token/postundefined
$ref: ../code_samples/JavaScript/customers_password-token/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_password-token/postundefined
$ref: ../code_samples/Shell/customers_password-token/post.sh
tags:
- Customer
responses:
docs/api/store/paths/gift-cards_{code}.yaml
+5 -3
View File
@@ -1,7 +1,7 @@
get:
operationId: GetGiftCardsCode
summary: Get Gift Card by Code
description: Retrieves a Gift Card by its associated unqiue code.
description: Retrieves a Gift Card by its associated unique code.
parameters:
- in: path
name: code
@@ -9,15 +9,17 @@ get:
description: The unique Gift Card code.
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/gift-cards_{code}/getundefined
$ref: ../code_samples/JavaScript/gift-cards_{code}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards_{code}/getundefined
$ref: ../code_samples/Shell/gift-cards_{code}/get.sh
tags:
- Gift Card
responses:
docs/api/store/paths/order-edits_{id}.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ get:
description: The ID of the OrderEdit.
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}/getundefined
$ref: ../code_samples/JavaScript/order-edits_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}/getundefined
$ref: ../code_samples/Shell/order-edits_{id}/get.sh
tags:
- OrderEdit
responses:
docs/api/store/paths/order-edits_{id}_complete.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ post:
description: The ID of the Order Edit.
schema:
type: string
x-codegen:
method: complete
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_complete/postundefined
$ref: ../code_samples/JavaScript/order-edits_{id}_complete/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_complete/postundefined
$ref: ../code_samples/Shell/order-edits_{id}_complete/post.sh
tags:
- OrderEdit
responses:
docs/api/store/paths/order-edits_{id}_decline.yaml
+4 -2
View File
@@ -14,15 +14,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostOrderEditsOrderEditDecline.yaml
x-codegen:
method: decline
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_decline/postundefined
$ref: ../code_samples/JavaScript/order-edits_{id}_decline/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_decline/postundefined
$ref: ../code_samples/Shell/order-edits_{id}_decline/post.sh
tags:
- OrderEdit
responses:
docs/api/store/paths/orders.yaml
+15 -2
View File
@@ -9,6 +9,16 @@ get:
description: The display id given to the Order.
schema:
type: number
- in: query
name: fields
description: (Comma separated) Which fields should be included in the result.
schema:
type: string
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in the result.
schema:
type: string
- in: query
name: email
style: form
@@ -29,15 +39,18 @@ get:
postal_code:
type: string
description: The postal code of the shipping address
x-codegen:
method: lookupOrder
queryParams: StoreGetOrdersParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders/getundefined
$ref: ../code_samples/JavaScript/orders/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders/getundefined
$ref: ../code_samples/Shell/orders/get.sh
tags:
- Order
responses:
docs/api/store/paths/orders_batch_customer_token.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml
x-codegen:
method: requestCustomerOrders
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_batch_customer_token/postundefined
$ref: ../code_samples/JavaScript/orders_batch_customer_token/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_batch_customer_token/postundefined
$ref: ../code_samples/Shell/orders_batch_customer_token/post.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/orders_cart_{cart_id}.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ get:
description: The ID of Cart.
schema:
type: string
x-codegen:
method: retrieveByCartId
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_cart_{cart_id}/getundefined
$ref: ../code_samples/JavaScript/orders_cart_{cart_id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_cart_{cart_id}/getundefined
$ref: ../code_samples/Shell/orders_cart_{cart_id}/get.sh
tags:
- Order
responses:
docs/api/store/paths/orders_customer_confirm.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml
x-codegen:
method: confirmRequest
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_customer_confirm/postundefined
$ref: ../code_samples/JavaScript/orders_customer_confirm/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_customer_confirm/postundefined
$ref: ../code_samples/Shell/orders_customer_confirm/post.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/orders_{id}.yaml
+14 -2
View File
@@ -9,15 +9,27 @@ get:
description: The id of the Order.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be included in the result.
schema:
type: string
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in the result.
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}/getundefined
$ref: ../code_samples/JavaScript/orders_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}/getundefined
$ref: ../code_samples/Shell/orders_{id}/get.sh
tags:
- Order
responses:
docs/api/store/paths/payment-collections_{id}.yaml
+5 -2
View File
@@ -20,15 +20,18 @@ get:
description: Comma separated list of fields to include in the results.
schema:
type: string
x-codegen:
method: retrieve
queryParams: GetPaymentCollectionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payment-collections_{id}/getundefined
$ref: ../code_samples/JavaScript/payment-collections_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}/getundefined
$ref: ../code_samples/Shell/payment-collections_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/payment-collections_{id}_sessions.yaml
+4 -3
View File
@@ -15,16 +15,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePaymentCollectionSessionsReq.yaml
x-codegen:
method: managePaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions/postundefined
$ref: ../code_samples/JavaScript/payment-collections_{id}_sessions/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}_sessions/postundefined
$ref: ../code_samples/Shell/payment-collections_{id}_sessions/post.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml
+4 -3
View File
@@ -16,17 +16,18 @@ post:
schema:
$ref: >-
../components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml
x-codegen:
method: managePaymentSessionsBatch
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_batch/postundefined
../code_samples/JavaScript/payment-collections_{id}_sessions_batch/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_batch/postundefined
$ref: ../code_samples/Shell/payment-collections_{id}_sessions_batch/post.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml
+4 -2
View File
@@ -16,17 +16,19 @@ post:
schema:
$ref: >-
../components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml
x-codegen:
method: authorizePaymentSessionsBatch
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_batch_authorize/postundefined
../code_samples/JavaScript/payment-collections_{id}_sessions_batch_authorize/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_batch_authorize/postundefined
../code_samples/Shell/payment-collections_{id}_sessions_batch_authorize/post.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml
+4 -2
View File
@@ -18,17 +18,19 @@ post:
description: The id of the Payment Session to be refreshed.
schema:
type: string
x-codegen:
method: refreshPaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}/postundefined
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_{session_id}/postundefined
../code_samples/Shell/payment-collections_{id}_sessions_{session_id}/post.sh
tags:
- PaymentCollection
responses:
docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml
+4 -2
View File
@@ -16,17 +16,19 @@ post:
description: The ID of the Payment Session.
schema:
type: string
x-codegen:
method: authorizePaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}_authorize/postundefined
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}_authorize/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_{session_id}_authorize/postundefined
../code_samples/Shell/payment-collections_{id}_sessions_{session_id}_authorize/post.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/product-categories.yaml
+9 -16
View File
@@ -26,11 +26,18 @@ get:
schema:
type: integer
default: 100
x-codegen:
method: list
queryParams: StoreGetProductCategoriesParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-categories/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories/getundefined
$ref: ../code_samples/Shell/product-categories/get.sh
security:
- api_token: []
- cookie_auth: []
@@ -42,21 +49,7 @@ get:
content:
application/json:
schema:
type: object
properties:
product_categories:
type: array
items:
$ref: ../components/schemas/ProductCategory.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page
$ref: ../components/schemas/StoreProductCategoriesListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/product-categories_{id}.yaml
+6 -3
View File
@@ -24,15 +24,18 @@ get:
category.
schema:
type: string
x-codegen:
method: retrieve
queryParams: StoreGetProductCategoryParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-categories_{id}/getundefined
$ref: ../code_samples/JavaScript/product-categories_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories_{id}/getundefined
$ref: ../code_samples/Shell/product-categories_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
@@ -44,7 +47,7 @@ get:
content:
application/json:
schema:
$ref: ../components/schemas/StoreGetProductCategoryRes.yaml
$ref: ../components/schemas/StoreGetProductCategoriesCategoryRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/product-tags.yaml
+2 -2
View File
@@ -97,11 +97,11 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-tags/getundefined
$ref: ../code_samples/JavaScript/product-tags/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-tags/getundefined
$ref: ../code_samples/Shell/product-tags/get.sh
tags:
- Product Tag
responses:
docs/api/store/paths/product-types.yaml
+5 -2
View File
@@ -93,15 +93,18 @@ get:
type: string
description: filter by dates greater than or equal to this date
format: date
x-codegen:
method: list
queryParams: StoreGetProductTypesParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-types/getundefined
$ref: ../code_samples/JavaScript/product-types/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-types/getundefined
$ref: ../code_samples/Shell/product-types/get.sh
security:
- api_token: []
- cookie_auth: []
docs/api/store/paths/products.yaml
+36 -4
View File
@@ -121,6 +121,20 @@ get:
type: string
description: filter by dates greater than or equal to this date
format: date
- in: query
name: category_id
style: form
explode: false
description: Category ids to filter by.
schema:
type: array
items:
type: string
- in: query
name: include_category_children
description: Include category children when filtering by category_id.
schema:
type: boolean
- in: query
name: offset
description: How many products to skip in the result.
@@ -136,14 +150,14 @@ get:
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each order of the
(Comma separated) Which fields should be expanded in each product of the
result.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each order of the
(Comma separated) Which fields should be included in each product of the
result.
schema:
type: string
@@ -152,15 +166,33 @@ get:
description: the field used to order the products.
schema:
type: string
- in: query
name: cart_id
description: The id of the Cart to set prices based on.
schema:
type: string
- in: query
name: region_id
description: The id of the Region to set prices based on.
schema:
type: string
- in: query
name: currency_code
description: The currency code to use for price selection.
schema:
type: string
x-codegen:
method: list
queryParams: StoreGetProductsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products/getundefined
$ref: ../code_samples/JavaScript/products/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products/getundefined
$ref: ../code_samples/Shell/products/get.sh
tags:
- Product
responses:
docs/api/store/paths/products_search.yaml
+5 -2
View File
@@ -19,15 +19,18 @@ post:
description: Limit the number of products returned.
schema:
type: integer
x-codegen:
method: search
queryParams: StorePostSearchReq
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_search/postundefined
$ref: ../code_samples/JavaScript/products_search/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_search/postundefined
$ref: ../code_samples/Shell/products_search/post.sh
tags:
- Product
responses:
docs/api/store/paths/products_{id}.yaml
+22 -2
View File
@@ -9,6 +9,11 @@ get:
description: The id of the Product.
schema:
type: string
- in: query
name: sales_channel_id
description: The sales channel used when fetching the product.
schema:
type: string
- in: query
name: cart_id
description: The ID of the customer's cart.
@@ -21,6 +26,18 @@ get:
correct prices are retrieved for a region.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be included in the result.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each product of the
result.
schema:
type: string
- in: query
name: currency_code
style: form
@@ -33,15 +50,18 @@ get:
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
description: See a list of codes.
x-codegen:
method: retrieve
queryParams: StoreGetProductsProductParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_{id}/getundefined
$ref: ../code_samples/JavaScript/products_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_{id}/getundefined
$ref: ../code_samples/Shell/products_{id}/get.sh
tags:
- Product
responses:
docs/api/store/paths/regions.yaml
+5 -2
View File
@@ -59,15 +59,18 @@ get:
type: string
description: filter by dates greater than or equal to this date
format: date
x-codegen:
method: list
queryParams: StoreGetRegionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/regions/getundefined
$ref: ../code_samples/JavaScript/regions/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/regions/getundefined
$ref: ../code_samples/Shell/regions/get.sh
tags:
- Region
responses:
docs/api/store/paths/regions_{id}.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ get:
description: The id of the Region.
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/regions_{id}/getundefined
$ref: ../code_samples/JavaScript/regions_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/regions_{id}/getundefined
$ref: ../code_samples/Shell/regions_{id}/get.sh
tags:
- Region
responses:
docs/api/store/paths/return-reasons.yaml
+4 -2
View File
@@ -2,15 +2,17 @@ get:
operationId: GetReturnReasons
summary: List Return Reasons
description: Retrieves a list of Return Reasons.
x-codegen:
method: list
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/return-reasons/getundefined
$ref: ../code_samples/JavaScript/return-reasons/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/return-reasons/getundefined
$ref: ../code_samples/Shell/return-reasons/get.sh
tags:
- Return Reason
responses:
docs/api/store/paths/return-reasons_{id}.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ get:
description: The id of the Return Reason.
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/return-reasons_{id}/getundefined
$ref: ../code_samples/JavaScript/return-reasons_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/return-reasons_{id}/getundefined
$ref: ../code_samples/Shell/return-reasons_{id}/get.sh
tags:
- Return Reason
responses:
docs/api/store/paths/returns.yaml
+4 -2
View File
@@ -7,15 +7,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostReturnsReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/returns/postundefined
$ref: ../code_samples/JavaScript/returns/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/returns/postundefined
$ref: ../code_samples/Shell/returns/post.sh
tags:
- Return
responses:
docs/api/store/paths/shipping-options.yaml
+5 -2
View File
@@ -20,15 +20,18 @@ get:
description: the Region to retrieve Shipping Options from.
schema:
type: string
x-codegen:
method: list
queryParams: StoreGetShippingOptionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/shipping-options/getundefined
$ref: ../code_samples/JavaScript/shipping-options/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/shipping-options/getundefined
$ref: ../code_samples/Shell/shipping-options/get.sh
tags:
- Shipping Option
responses:
docs/api/store/paths/shipping-options_{cart_id}.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ get:
description: The id of the Cart.
schema:
type: string
x-codegen:
method: listCartOptions
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/shipping-options_{cart_id}/getundefined
$ref: ../code_samples/JavaScript/shipping-options_{cart_id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/shipping-options_{cart_id}/getundefined
$ref: ../code_samples/Shell/shipping-options_{cart_id}/get.sh
tags:
- Shipping Option
responses:
docs/api/store/paths/swaps.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ post:
application/json:
schema:
$ref: ../components/schemas/StorePostSwapsReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/swaps/postundefined
$ref: ../code_samples/JavaScript/swaps/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/swaps/postundefined
$ref: ../code_samples/Shell/swaps/post.sh
tags:
- Swap
responses:
docs/api/store/paths/swaps_{cart_id}.yaml
+4 -2
View File
@@ -9,15 +9,17 @@ get:
description: The id of the Cart
schema:
type: string
x-codegen:
method: retrieveByCartId
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/swaps_{cart_id}/getundefined
$ref: ../code_samples/JavaScript/swaps_{cart_id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/swaps_{cart_id}/getundefined
$ref: ../code_samples/Shell/swaps_{cart_id}/get.sh
tags:
- Swap
responses:
docs/api/store/paths/variants.yaml
+24 -1
View File
@@ -8,6 +8,11 @@ get:
description: A comma separated list of Product Variant ids to filter by.
schema:
type: string
- in: query
name: sales_channel_id
description: A sales channel id for result configuration.
schema:
type: string
- in: query
name: expand
description: A comma separated list of Product Variant relations to load.
@@ -25,6 +30,21 @@ get:
schema:
type: number
default: '100'
- in: query
name: cart_id
description: The id of the Cart to set prices based on.
schema:
type: string
- in: query
name: region_id
description: The id of the Region to set prices based on.
schema:
type: string
- in: query
name: currency_code
description: The currency code to use for price selection.
schema:
type: string
- in: query
name: title
style: form
@@ -62,11 +82,14 @@ get:
description: >-
filter by inventory quantity greater than or equal to this
number
x-codegen:
method: list
queryParams: StoreGetVariantsParams
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/variants/getundefined
$ref: ../code_samples/Shell/variants/get.sh
tags:
- Product Variant
responses:
docs/api/store/paths/variants_{variant_id}.yaml
+9 -1
View File
@@ -14,6 +14,11 @@ get:
description: The id of the Cart to set prices based on.
schema:
type: string
- in: query
name: sales_channel_id
description: A sales channel id for result configuration.
schema:
type: string
- in: query
name: region_id
description: The id of the Region to set prices based on.
@@ -29,11 +34,14 @@ get:
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
description: See a list of codes.
x-codegen:
method: retrieve
queryParams: StoreGetVariantsVariantParams
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/variants_{variant_id}/getundefined
$ref: ../code_samples/Shell/variants_{variant_id}/get.sh
tags:
- Product Variant
responses: