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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-04-04 21:02:44 +03:00
committed by GitHub
co-authored by olivermrbl
parent 51d0b88404
commit 70435d5631
1031 changed files with 104669 additions and 4209 deletions
@@ -1,3 +1,42 @@
get:
operationId: GetAuth
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/store_auth/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/store_auth/get.sh
security:
- cookie_auth: []
tags:
- Auth
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreAuthRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostAuth
summary: Customer Login
@@ -15,11 +54,11 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/post.js
$ref: ../code_samples/JavaScript/store_auth/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/post.sh
$ref: ../code_samples/Shell/store_auth/post.sh
tags:
- Auth
responses:
@@ -52,7 +91,7 @@ delete:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/delete.sh
$ref: ../code_samples/Shell/store_auth/delete.sh
security:
- cookie_auth: []
tags:
@@ -72,42 +111,3 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
get:
operationId: GetAuth
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/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/get.sh
security:
- cookie_auth: []
tags:
- Auth
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreAuthRes.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
@@ -16,11 +16,11 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth_{email}/get.js
$ref: ../code_samples/JavaScript/store_auth_{email}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth_{email}/get.sh
$ref: ../code_samples/Shell/store_auth_{email}/get.sh
tags:
- Auth
responses:
@@ -17,13 +17,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts/post.js
$ref: ../code_samples/JavaScript/store_carts/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts/post.sh
$ref: ../code_samples/Shell/store_carts/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: Successfully created a new Cart
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}/get.js
$ref: ../code_samples/JavaScript/store_carts_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}/get.sh
$ref: ../code_samples/Shell/store_carts_{id}/get.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -61,13 +61,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}/post.js
$ref: ../code_samples/JavaScript/store_carts_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}/post.sh
$ref: ../code_samples/Shell/store_carts_{id}/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -21,13 +21,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_complete/post.js
$ref: ../code_samples/JavaScript/store_carts_{id}_complete/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_complete/post.sh
$ref: ../code_samples/Shell/store_carts_{id}_complete/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: >-
@@ -21,13 +21,13 @@ delete:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_discounts_{code}/delete.js
$ref: ../code_samples/JavaScript/store_carts_{id}_discounts_{code}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_discounts_{code}/delete.sh
$ref: ../code_samples/Shell/store_carts_{id}_discounts_{code}/delete.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -20,13 +20,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_line-items/post.js
$ref: ../code_samples/JavaScript/store_carts_{id}_line-items/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_line-items/post.sh
$ref: ../code_samples/Shell/store_carts_{id}_line-items/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -1,50 +1,3 @@
delete:
operationId: DeleteCartsCartLineItemsItem
summary: Delete a Line Item
description: Removes a Line Item from a Cart.
parameters:
- in: path
name: id
required: true
description: The id of the Cart.
schema:
type: string
- in: path
name: line_id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/delete.sh
tags:
- Cart
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCartsCartLineItemsItem
summary: Update a Line Item
@@ -73,13 +26,62 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_line-items_{line_id}/post.js
$ref: >-
../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_line-items_{line_id}/post.sh
$ref: ../code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteCartsCartLineItemsItem
summary: Delete a Line Item
description: Removes a Line Item from a Cart.
parameters:
- in: path
name: id
required: true
description: The id of the Cart.
schema:
type: string
- in: path
name: line_id
required: true
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/store_carts_{id}_line-items_{line_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/store_carts_{id}_line-items_{line_id}/delete.sh
tags:
- Carts
responses:
'200':
description: OK
@@ -22,13 +22,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_payment-session/post.js
$ref: ../code_samples/JavaScript/store_carts_{id}_payment-session/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_payment-session/post.sh
$ref: ../code_samples/Shell/store_carts_{id}_payment-session/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -17,13 +17,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_payment-sessions/post.js
$ref: ../code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_payment-sessions/post.sh
$ref: ../code_samples/Shell/store_carts_{id}_payment-sessions/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -1,54 +1,3 @@
delete:
operationId: DeleteCartsCartPaymentSessionsSession
summary: Delete a Payment Session
description: Deletes a Payment Session on a Cart. May be useful if a payment has failed.
parameters:
- in: path
name: id
required: true
description: The id of the Cart.
schema:
type: string
- in: path
name: provider_id
required: true
description: >-
The id of the Payment Provider used to create the Payment Session to be
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/delete.sh
tags:
- Cart
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCartsCartPaymentSessionUpdate
summary: Update a Payment Session
@@ -78,14 +27,65 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/post.js
../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/post.sh
../code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteCartsCartPaymentSessionsSession
summary: Delete a Payment Session
description: Deletes a Payment Session on a Cart. May be useful if a payment has failed.
parameters:
- in: path
name: id
required: true
description: The id of the Cart.
schema:
type: string
- in: path
name: provider_id
required: true
description: >-
The id of the Payment Provider used to create the Payment Session to be
deleted.
schema:
type: string
x-codegen:
method: deletePaymentSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/delete.sh
tags:
- Carts
responses:
'200':
description: OK
@@ -26,14 +26,14 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}_refresh/post.js
../code_samples/JavaScript/store_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/post.sh
../code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -20,13 +20,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/carts_{id}_shipping-methods/post.js
$ref: ../code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_shipping-methods/post.sh
$ref: ../code_samples/Shell/store_carts_{id}_shipping-methods/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -17,9 +17,9 @@ post:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/carts_{id}_taxes/post.sh
$ref: ../code_samples/Shell/store_carts_{id}_taxes/post.sh
tags:
- Cart
- Carts
responses:
'200':
description: OK
@@ -17,6 +17,15 @@ get:
schema:
type: integer
default: 10
- in: query
name: handle
style: form
explode: false
description: Filter by the collection handle
schema:
type: array
items:
type: string
- in: query
name: created_at
description: Date comparison for when resulting collections were created.
@@ -68,13 +77,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/collections/get.js
$ref: ../code_samples/JavaScript/store_collections/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections/get.sh
$ref: ../code_samples/Shell/store_collections/get.sh
tags:
- Collection
- Collections
responses:
'200':
description: OK
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/collections_{id}/get.js
$ref: ../code_samples/JavaScript/store_collections_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/collections_{id}/get.sh
$ref: ../code_samples/Shell/store_collections_{id}/get.sh
tags:
- Collection
- Collections
responses:
'200':
description: OK
@@ -13,13 +13,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers/post.js
$ref: ../code_samples/JavaScript/store_customers/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers/post.sh
$ref: ../code_samples/Shell/store_customers/post.sh
tags:
- Customer
- Customers
responses:
'200':
description: OK
@@ -11,15 +11,15 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me/get.js
$ref: ../code_samples/JavaScript/store_customers_me/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me/get.sh
$ref: ../code_samples/Shell/store_customers_me/get.sh
security:
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
@@ -55,15 +55,15 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me/post.js
$ref: ../code_samples/JavaScript/store_customers_me/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me/post.sh
$ref: ../code_samples/Shell/store_customers_me/post.sh
security:
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
@@ -14,15 +14,15 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me_addresses/post.js
$ref: ../code_samples/JavaScript/store_customers_me_addresses/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_addresses/post.sh
$ref: ../code_samples/Shell/store_customers_me_addresses/post.sh
security:
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: A successful response
@@ -1,50 +1,3 @@
delete:
operationId: DeleteCustomersCustomerAddressesAddress
summary: Delete an Address
description: Removes an Address from the Customer's saved addresses.
x-authenticated: true
parameters:
- in: path
name: address_id
required: true
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}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_addresses_{address_id}/delete.sh
security:
- cookie_auth: []
tags:
- Customer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomersCustomerAddressesAddress
summary: Update a Shipping Address
@@ -69,15 +22,65 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me_addresses_{address_id}/post.js
$ref: >-
../code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_addresses_{address_id}/post.sh
$ref: >-
../code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh
security:
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteCustomersCustomerAddressesAddress
summary: Delete an Address
description: Removes an Address from the Customer's saved addresses.
x-authenticated: true
parameters:
- in: path
name: address_id
required: true
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/store_customers_me_addresses_{address_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh
security:
- cookie_auth: []
tags:
- Customers
responses:
'200':
description: OK
@@ -175,15 +175,15 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me_orders/get.js
$ref: ../code_samples/JavaScript/store_customers_me_orders/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_orders/get.sh
$ref: ../code_samples/Shell/store_customers_me_orders/get.sh
security:
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
@@ -12,15 +12,15 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_me_payment-methods/get.js
$ref: ../code_samples/JavaScript/store_customers_me_payment-methods/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_me_payment-methods/get.sh
$ref: ../code_samples/Shell/store_customers_me_payment-methods/get.sh
security:
- cookie_auth: []
tags:
- Customer
- Customers
responses:
'200':
description: OK
@@ -15,20 +15,20 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_password-reset/post.js
$ref: ../code_samples/JavaScript/store_customers_password-reset/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_password-reset/post.sh
$ref: ../code_samples/Shell/store_customers_password-reset/post.sh
tags:
- Customer
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomersRes.yaml
$ref: ../components/schemas/StoreCustomersResetPasswordRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -17,13 +17,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/customers_password-token/post.js
$ref: ../code_samples/JavaScript/store_customers_password-token/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customers_password-token/post.sh
$ref: ../code_samples/Shell/store_customers_password-token/post.sh
tags:
- Customer
- Customers
responses:
'204':
description: OK
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/gift-cards_{code}/get.js
$ref: ../code_samples/JavaScript/store_gift-cards_{code}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards_{code}/get.sh
$ref: ../code_samples/Shell/store_gift-cards_{code}/get.sh
tags:
- Gift Card
- Gift Cards
responses:
'200':
description: OK
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}/get.js
$ref: ../code_samples/JavaScript/store_order-edits_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}/get.sh
$ref: ../code_samples/Shell/store_order-edits_{id}/get.sh
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
@@ -15,13 +15,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_complete/post.js
$ref: ../code_samples/JavaScript/store_order-edits_{id}_complete/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_complete/post.sh
$ref: ../code_samples/Shell/store_order-edits_{id}_complete/post.sh
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
@@ -20,13 +20,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_decline/post.js
$ref: ../code_samples/JavaScript/store_order-edits_{id}_decline/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_decline/post.sh
$ref: ../code_samples/Shell/store_order-edits_{id}_decline/post.sh
tags:
- OrderEdit
- Order Edits
responses:
'200':
description: OK
@@ -46,13 +46,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders/get.js
$ref: ../code_samples/JavaScript/store_orders/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders/get.sh
$ref: ../code_samples/Shell/store_orders/get.sh
tags:
- Order
- Orders
responses:
'200':
description: OK
@@ -15,16 +15,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_batch_customer_token/post.js
$ref: ../code_samples/JavaScript/store_orders_batch_customer_token/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_batch_customer_token/post.sh
$ref: ../code_samples/Shell/store_orders_batch_customer_token/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Invite
- Orders
responses:
'200':
description: OK
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_cart_{cart_id}/get.js
$ref: ../code_samples/JavaScript/store_orders_cart_{cart_id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_cart_{cart_id}/get.sh
$ref: ../code_samples/Shell/store_orders_cart_{cart_id}/get.sh
tags:
- Order
- Orders
responses:
'200':
description: OK
@@ -15,16 +15,16 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_customer_confirm/post.js
$ref: ../code_samples/JavaScript/store_orders_customer_confirm/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_customer_confirm/post.sh
$ref: ../code_samples/Shell/store_orders_customer_confirm/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Order
- Orders
responses:
'200':
description: OK
@@ -25,13 +25,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/orders_{id}/get.js
$ref: ../code_samples/JavaScript/store_orders_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/orders_{id}/get.sh
$ref: ../code_samples/Shell/store_orders_{id}/get.sh
tags:
- Order
- Orders
responses:
'200':
description: OK
@@ -22,21 +22,21 @@ get:
type: string
x-codegen:
method: retrieve
queryParams: GetPaymentCollectionsParams
queryParams: StoreGetPaymentCollectionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payment-collections_{id}/get.js
$ref: ../code_samples/JavaScript/store_payment-collections_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}/get.sh
$ref: ../code_samples/Shell/store_payment-collections_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -21,16 +21,17 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/payment-collections_{id}_sessions/post.js
$ref: >-
../code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}_sessions/post.sh
$ref: ../code_samples/Shell/store_payment-collections_{id}_sessions/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -23,16 +23,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_batch/post.js
../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/payment-collections_{id}_sessions_batch/post.sh
$ref: >-
../code_samples/Shell/store_payment-collections_{id}_sessions_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -23,17 +23,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_batch_authorize/post.js
../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_batch_authorize/post.sh
../code_samples/Shell/store_payment-collections_{id}_sessions_batch_authorize/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -25,14 +25,14 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}/post.js
../code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/payment-collections_{id}_sessions_{session_id}/post.sh
../code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}/post.sh
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -23,17 +23,17 @@ post:
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/payment-collections_{id}_sessions_{session_id}_authorize/post.js
../code_samples/JavaScript/store_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/post.sh
../code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}_authorize/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- PaymentCollection
- Payment Collections
responses:
'200':
description: OK
@@ -6,7 +6,7 @@ get:
parameters:
- in: query
name: q
description: Query used for searching product category names orhandles.
description: Query used for searching product category names or handles.
schema:
type: string
- in: query
@@ -14,6 +14,11 @@ get:
description: Returns categories scoped by parent
schema:
type: string
- in: query
name: include_descendants_tree
description: Include all nested descendants of category
schema:
type: boolean
- in: query
name: offset
description: How many product categories to skip in the result.
@@ -33,23 +38,23 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-categories/get.js
$ref: ../code_samples/JavaScript/store_product-categories/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories/get.sh
$ref: ../code_samples/Shell/store_product-categories/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
- Product Categories
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreProductCategoriesListRes.yaml
$ref: ../components/schemas/StoreGetProductCategoriesRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -26,21 +26,21 @@ get:
type: string
x-codegen:
method: retrieve
queryParams: StoreGetProductCategoryParams
queryParams: StoreGetProductCategoriesCategoryParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-categories_{id}/get.js
$ref: ../code_samples/JavaScript/store_product-categories_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-categories_{id}/get.sh
$ref: ../code_samples/Shell/store_product-categories_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Category
- Product Categories
responses:
'200':
description: OK
@@ -3,6 +3,9 @@ get:
summary: List Product Tags
description: Retrieve a list of Product Tags.
x-authenticated: true
x-codegen:
method: list
queryParams: StoreGetProductTagsParams
parameters:
- in: query
name: limit
@@ -97,32 +100,20 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-tags/get.js
$ref: ../code_samples/JavaScript/store_product-tags/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-tags/get.sh
$ref: ../code_samples/Shell/store_product-tags/get.sh
tags:
- Product Tag
- Product Tags
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
product_tags:
$ref: ../components/schemas/ProductTag.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/StoreProductTagsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -100,16 +100,16 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/product-types/get.js
$ref: ../code_samples/JavaScript/store_product-types/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/product-types/get.sh
$ref: ../code_samples/Shell/store_product-types/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Product Type
- Product Types
responses:
'200':
description: OK
@@ -188,13 +188,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products/get.js
$ref: ../code_samples/JavaScript/store_products/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products/get.sh
$ref: ../code_samples/Shell/store_products/get.sh
tags:
- Product
- Products
responses:
'200':
description: OK
@@ -26,13 +26,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_search/post.js
$ref: ../code_samples/JavaScript/store_products_search/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_search/post.sh
$ref: ../code_samples/Shell/store_products_search/post.sh
tags:
- Product
- Products
responses:
'200':
description: OK
@@ -57,13 +57,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/products_{id}/get.js
$ref: ../code_samples/JavaScript/store_products_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/products_{id}/get.sh
$ref: ../code_samples/Shell/store_products_{id}/get.sh
tags:
- Product
- Products
responses:
'200':
description: OK
@@ -66,13 +66,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/regions/get.js
$ref: ../code_samples/JavaScript/store_regions/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/regions/get.sh
$ref: ../code_samples/Shell/store_regions/get.sh
tags:
- Region
- Regions
responses:
'200':
description: OK
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/regions_{id}/get.js
$ref: ../code_samples/JavaScript/store_regions_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/regions_{id}/get.sh
$ref: ../code_samples/Shell/store_regions_{id}/get.sh
tags:
- Region
- Regions
responses:
'200':
description: OK
@@ -8,13 +8,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/return-reasons/get.js
$ref: ../code_samples/JavaScript/store_return-reasons/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/return-reasons/get.sh
$ref: ../code_samples/Shell/store_return-reasons/get.sh
tags:
- Return Reason
- Return Reasons
responses:
'200':
description: OK
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/return-reasons_{id}/get.js
$ref: ../code_samples/JavaScript/store_return-reasons_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/return-reasons_{id}/get.sh
$ref: ../code_samples/Shell/store_return-reasons_{id}/get.sh
tags:
- Return Reason
- Return Reasons
responses:
'200':
description: OK
@@ -13,13 +13,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/returns/post.js
$ref: ../code_samples/JavaScript/store_returns/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/returns/post.sh
$ref: ../code_samples/Shell/store_returns/post.sh
tags:
- Return
- Returns
responses:
'200':
description: OK
@@ -27,13 +27,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/shipping-options/get.js
$ref: ../code_samples/JavaScript/store_shipping-options/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/shipping-options/get.sh
$ref: ../code_samples/Shell/store_shipping-options/get.sh
tags:
- Shipping Option
- Shipping Options
responses:
'200':
description: OK
@@ -15,20 +15,20 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/shipping-options_{cart_id}/get.js
$ref: ../code_samples/JavaScript/store_shipping-options_{cart_id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/shipping-options_{cart_id}/get.sh
$ref: ../code_samples/Shell/store_shipping-options_{cart_id}/get.sh
tags:
- Shipping Option
- Shipping Options
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreShippingOptionsListRes.yaml
$ref: ../components/schemas/StoreCartShippingOptionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
@@ -15,13 +15,13 @@ post:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/swaps/post.js
$ref: ../code_samples/JavaScript/store_swaps/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/swaps/post.sh
$ref: ../code_samples/Shell/store_swaps/post.sh
tags:
- Swap
- Swaps
responses:
'200':
description: OK
@@ -15,13 +15,13 @@ get:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/swaps_{cart_id}/get.js
$ref: ../code_samples/JavaScript/store_swaps_{cart_id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/swaps_{cart_id}/get.sh
$ref: ../code_samples/Shell/store_swaps_{cart_id}/get.sh
tags:
- Swap
- Swaps
responses:
'200':
description: OK
@@ -89,9 +89,9 @@ get:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/variants/get.sh
$ref: ../code_samples/Shell/store_variants/get.sh
tags:
- Product Variant
- Variants
responses:
'200':
description: OK
@@ -41,9 +41,9 @@ get:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/variants_{variant_id}/get.sh
$ref: ../code_samples/Shell/store_variants_{variant_id}/get.sh
tags:
- Product Variant
- Variants
responses:
'200':
description: OK