chore: reorganize docs apps (#7228)
* reorganize docs apps * add README * fix directory * add condition for old docs
This commit is contained in:
1 parent
224ebb2154
commit
4fe28f5a95
6187 files changed
+601447
-598226
No files matched your search
@@ -0,0 +1,30 @@
|
||||
post:
|
||||
operationId: PostCarts
|
||||
summary: Create Cart
|
||||
description: Create a cart.
|
||||
x-authenticated: false
|
||||
parameters: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts/post.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,74 @@
|
||||
get:
|
||||
operationId: GetCartsId
|
||||
summary: Get a Cart
|
||||
description: >-
|
||||
Retrieve a cart by its ID. You can expand the cart's relations or select the
|
||||
fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}/get.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
post:
|
||||
operationId: PostCartsId
|
||||
summary: Update a Cart
|
||||
description: Update a cart's details.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}/post.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,36 @@
|
||||
post:
|
||||
operationId: PostCartsIdLineItems
|
||||
summary: Add Line Items to Cart
|
||||
description: Add a list of line items to a cart.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}_line-items/post.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
+86
@@ -0,0 +1,86 @@
|
||||
post:
|
||||
operationId: PostCartsIdLineItemsLine_id
|
||||
summary: Add Line Items to Cart
|
||||
description: Add a list of line items to a cart.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: line_id
|
||||
in: path
|
||||
description: The cart's line id.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
delete:
|
||||
operationId: DeleteCartsIdLineItemsLine_id
|
||||
summary: Remove Line Items from Cart
|
||||
description: >-
|
||||
Remove a list of line items from a cart. This doesn't delete the Line Item,
|
||||
only the association between the Line Item and the cart.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: line_id
|
||||
in: path
|
||||
description: The cart's line id.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}_line-items_{line_id}/delete.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,36 @@
|
||||
post:
|
||||
operationId: PostCartsIdPaymentCollections
|
||||
summary: Add Payment Collections to Cart
|
||||
description: Add a list of payment collections to a cart.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}_payment-collections/post.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,74 @@
|
||||
post:
|
||||
operationId: PostCartsIdPromotions
|
||||
summary: Add Promotions to Cart
|
||||
description: Add a list of promotions to a cart.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}_promotions/post.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
delete:
|
||||
operationId: DeleteCartsIdPromotions
|
||||
summary: Remove Promotions from Cart
|
||||
description: >-
|
||||
Remove a list of promotions from a cart. This doesn't delete the Promotion,
|
||||
only the association between the Promotion and the cart.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}_promotions/delete.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,37 @@
|
||||
post:
|
||||
operationId: PostCartsIdTaxes
|
||||
summary: Add Taxes to Cart
|
||||
description: Add a list of taxes to a cart.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The cart's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/StorePostCartsCartTaxesReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_carts_{id}_taxes/post.sh
|
||||
tags:
|
||||
- Carts
|
||||
responses:
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
@@ -0,0 +1,32 @@
|
||||
get:
|
||||
operationId: GetCurrencies
|
||||
summary: List Currencies
|
||||
description: >-
|
||||
Retrieve a list of currencies. The currencies can be filtered by fields such
|
||||
as `id`. The currencies can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_currencies/get.sh
|
||||
tags:
|
||||
- Currencies
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,38 @@
|
||||
get:
|
||||
operationId: GetCurrenciesCode
|
||||
summary: Get a Currency
|
||||
description: >-
|
||||
Retrieve a currency by its ID. You can expand the currency's relations or
|
||||
select the fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: code
|
||||
in: path
|
||||
description: The currency's code.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_currencies_{code}/get.sh
|
||||
tags:
|
||||
- Currencies
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,30 @@
|
||||
post:
|
||||
operationId: PostCustomers
|
||||
summary: Create Customer
|
||||
description: Create a customer.
|
||||
x-authenticated: false
|
||||
parameters: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_customers/post.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,32 @@
|
||||
get:
|
||||
operationId: GetCustomersMe
|
||||
summary: List Customers
|
||||
description: >-
|
||||
Retrieve a list of customers. The customers can be filtered by fields such
|
||||
as `id`. The customers can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_customers_me/get.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,62 @@
|
||||
get:
|
||||
operationId: GetCustomersMeAddresses
|
||||
summary: List Customers
|
||||
description: >-
|
||||
Retrieve a list of customers. The customers can be filtered by fields such
|
||||
as `id`. The customers can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_customers_me_addresses/get.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
post:
|
||||
operationId: PostCustomersMeAddresses
|
||||
summary: Create Customer
|
||||
description: Create a customer.
|
||||
x-authenticated: false
|
||||
parameters: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_customers_me_addresses/post.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
get:
|
||||
operationId: GetCustomersMeAddressesAddress_id
|
||||
summary: List Addresses
|
||||
description: >-
|
||||
Retrieve a list of addresses in a customer. The addresses can be filtered by
|
||||
fields like FILTER FIELDS. The addresses can also be paginated.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: address_id
|
||||
in: path
|
||||
description: The customer's address id.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_customers_me_addresses_{address_id}/get.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
post:
|
||||
operationId: PostCustomersMeAddressesAddress_id
|
||||
summary: Add Addresses to Customer
|
||||
description: Add a list of addresses to a customer.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: address_id
|
||||
in: path
|
||||
description: The customer's address id.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
delete:
|
||||
operationId: DeleteCustomersMeAddressesAddress_id
|
||||
summary: Remove Addresses from Customer
|
||||
description: >-
|
||||
Remove a list of addresses from a customer. This doesn't delete the Address,
|
||||
only the association between the Address and the customer.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: address_id
|
||||
in: path
|
||||
description: The customer's address id.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
post:
|
||||
operationId: PostPaymentCollectionsIdPaymentSessions
|
||||
summary: Add Payment Sessions to Payment Collection
|
||||
description: Add a list of payment sessions to a payment collection.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The payment collection's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: >-
|
||||
../components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/Shell/store_payment-collections_{id}_payment-sessions/post.sh
|
||||
tags:
|
||||
- Payment Collections
|
||||
responses:
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
@@ -0,0 +1,32 @@
|
||||
get:
|
||||
operationId: GetRegions
|
||||
summary: List Regions
|
||||
description: >-
|
||||
Retrieve a list of regions. The regions can be filtered by fields such as
|
||||
`id`. The regions can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_regions/get.sh
|
||||
tags:
|
||||
- Regions
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,38 @@
|
||||
get:
|
||||
operationId: GetRegionsId
|
||||
summary: Get a Region
|
||||
description: >-
|
||||
Retrieve a region by its ID. You can expand the region's relations or select
|
||||
the fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The region's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_regions_{id}/get.sh
|
||||
tags:
|
||||
- Regions
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,39 @@
|
||||
get:
|
||||
operationId: GetRegionsIdPaymentProviders
|
||||
summary: List Payment Providers
|
||||
description: >-
|
||||
Retrieve a list of payment providers in a region. The payment providers can
|
||||
be filtered by fields like FILTER FIELDS. The payment providers can also be
|
||||
paginated.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The region's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_regions_{id}_payment-providers/get.sh
|
||||
tags:
|
||||
- Regions
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
@@ -0,0 +1,38 @@
|
||||
get:
|
||||
operationId: GetShippingOptionsCart_id
|
||||
summary: Get a Shipping Option
|
||||
description: >-
|
||||
Retrieve a shipping option by its ID. You can expand the shipping option's
|
||||
relations or select the fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: cart_id
|
||||
in: path
|
||||
description: The shipping option's cart id.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_shipping-options_{cart_id}/get.sh
|
||||
tags:
|
||||
- Shipping Options
|
||||
responses:
|
||||
'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
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema: {}
|
||||
Reference in new issue
Block a user