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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-22 17:09:49 +02:00
committed by GitHub
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/store/paths/auth.yaml
+2 -2
View File
@@ -25,7 +25,7 @@ post:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -109,7 +109,7 @@ get:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/carts.yaml
+2 -44
View File
@@ -10,49 +10,7 @@ post:
content:
application/json:
schema:
type: object
properties:
region_id:
type: string
description: The ID of the Region to create the Cart in.
sales_channel_id:
type: string
description: >-
[EXPERIMENTAL] The ID of the Sales channel to create the Cart
in.
country_code:
type: string
description: The 2 character ISO country code to create the Cart in.
externalDocs:
url: >-
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
description: See a list of codes.
items:
description: >-
An optional array of `variant_id`, `quantity` pairs to generate
Line Items from.
type: array
items:
required:
- variant_id
- quantity
properties:
variant_id:
description: >-
The id of the Product Variant to generate a Line Item
from.
type: string
quantity:
description: The quantity of the Product Variant to add
type: integer
context:
description: >-
An optional object to provide context to the Cart. The `context`
field is automatically populated with `ip` and `user_agent`
type: object
example:
ip: '::1'
user_agent: Chrome
$ref: ../components/schemas/StorePostCartReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -73,7 +31,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}.yaml
+3 -64
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
@@ -55,68 +55,7 @@ post:
content:
application/json:
schema:
type: object
properties:
region_id:
type: string
description: The id of the Region to create the Cart in.
country_code:
type: string
description: The 2 character ISO country code to create the Cart in.
externalDocs:
url: >-
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
description: See a list of codes.
email:
type: string
description: An email to be used on the Cart.
format: email
sales_channel_id:
type: string
description: The ID of the Sales channel to update the Cart with.
billing_address:
description: The Address to be used for billing purposes.
anyOf:
- $ref: ../components/schemas/address.yaml
description: A full billing address object.
- type: string
description: The billing address ID
shipping_address:
description: The Address to be used for shipping.
anyOf:
- $ref: ../components/schemas/address.yaml
description: A full shipping address object.
- type: string
description: The shipping address ID
gift_cards:
description: An array of Gift Card codes to add to the Cart.
type: array
items:
required:
- code
properties:
code:
description: The code that a Gift Card is identified by.
type: string
discounts:
description: An array of Discount codes to add to the Cart.
type: array
items:
required:
- code
properties:
code:
description: The code that a Discount is identifed by.
type: string
customer_id:
description: The ID of the Customer to associate the Cart with.
type: string
context:
description: An optional object to provide context to the Cart.
type: object
example:
ip: '::1'
user_agent: Chrome
$ref: ../components/schemas/StorePostCartsCartReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -137,7 +76,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_complete.yaml
+3 -3
View File
@@ -57,21 +57,21 @@ post:
successfully.
properties:
order:
$ref: ../components/schemas/order.yaml
$ref: ../components/schemas/Order.yaml
- type: object
description: >-
Cart was successfully authorized but requires further
actions.
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
- type: object
description: >-
When cart is used for a swap and it has been completed
successfully.
properties:
cart:
$ref: ../components/schemas/swap.yaml
$ref: ../components/schemas/Swap.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_discounts_{code}.yaml
+1 -1
View File
@@ -35,7 +35,7 @@ delete:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_line-items.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml
+2 -2
View File
@@ -36,7 +36,7 @@ delete:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
@@ -85,7 +85,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_payment-session.yaml
+1 -1
View File
@@ -31,7 +31,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_payment-sessions.yaml
+1 -1
View File
@@ -31,7 +31,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml
+2 -2
View File
@@ -39,7 +39,7 @@ delete:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
@@ -89,7 +89,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
+1 -1
View File
@@ -41,7 +41,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_shipping-methods.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/carts_{id}_taxes.yaml
+1 -1
View File
@@ -27,7 +27,7 @@ post:
type: object
properties:
cart:
$ref: ../components/schemas/cart.yaml
$ref: ../components/schemas/Cart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/collections.yaml
+1 -1
View File
@@ -83,7 +83,7 @@ get:
collections:
type: array
items:
$ref: ../components/schemas/product_collection.yaml
$ref: ../components/schemas/ProductCollection.yaml
count:
type: integer
description: The total number of items available
docs/api/store/paths/collections_{id}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
collection:
$ref: ../components/schemas/product_collection.yaml
$ref: ../components/schemas/ProductCollection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/customers.yaml
+2 -25
View File
@@ -6,30 +6,7 @@ post:
content:
application/json:
schema:
type: object
required:
- first_name
- last_name
- email
- password
properties:
first_name:
description: The Customer's first name.
type: string
last_name:
description: The Customer's last name.
type: string
email:
description: The email of the customer.
type: string
format: email
password:
description: The Customer's password.
type: string
format: password
phone:
description: The Customer's phone number.
type: string
$ref: ../components/schemas/StorePostCustomersReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -50,7 +27,7 @@ post:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/customers_me.yaml
+3 -29
View File
@@ -27,7 +27,7 @@ get:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -49,33 +49,7 @@ post:
content:
application/json:
schema:
type: object
properties:
first_name:
description: The Customer's first name.
type: string
last_name:
description: The Customer's last name.
type: string
billing_address:
description: The Address to be used for billing purposes.
anyOf:
- $ref: ../components/schemas/address_fields.yaml
description: The full billing address object
- type: string
description: The ID of an existing billing address
password:
description: The Customer's password.
type: string
phone:
description: The Customer's phone number.
type: string
email:
description: The email of the customer.
type: string
metadata:
description: Metadata about the customer.
type: object
$ref: ../components/schemas/StorePostCustomersCustomerReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -98,7 +72,7 @@ post:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/customers_me_addresses.yaml
+2 -17
View File
@@ -7,22 +7,7 @@ post:
content:
application/json:
schema:
type: object
required:
- address
properties:
address:
description: The Address to add to the Customer.
allOf:
- $ref: ../components/schemas/address_fields.yaml
- type: object
required:
- first_name
- last_name
- address_1
- city
- country_code
- postal_code
$ref: ../components/schemas/StorePostCustomersCustomerAddressesReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -45,7 +30,7 @@ post:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/customers_me_addresses_{address_id}.yaml
+4 -4
View File
@@ -34,7 +34,7 @@ delete:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -63,8 +63,8 @@ post:
content:
application/json:
schema:
anyOf:
- $ref: ../components/schemas/address_fields.yaml
$ref: >-
../components/schemas/StorePostCustomersCustomerAddressesAddressReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -89,7 +89,7 @@ post:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/customers_me_orders.yaml
+1 -1
View File
@@ -192,7 +192,7 @@ get:
orders:
type: array
items:
$ref: ../components/schemas/order.yaml
$ref: ../components/schemas/Order.yaml
count:
type: integer
description: The total number of items available
docs/api/store/paths/customers_password-reset.yaml
+2 -18
View File
@@ -8,23 +8,7 @@ post:
content:
application/json:
schema:
type: object
required:
- email
- password
- token
properties:
email:
description: The email of the customer.
type: string
format: email
password:
description: The Customer's password.
type: string
format: password
token:
description: The reset password token
type: string
$ref: ../components/schemas/StorePostCustomersResetPasswordReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -45,7 +29,7 @@ post:
type: object
properties:
customer:
$ref: ../components/schemas/customer.yaml
$ref: ../components/schemas/Customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/customers_password-token.yaml
+2 -8
View File
@@ -9,14 +9,8 @@ post:
content:
application/json:
schema:
type: object
required:
- email
properties:
email:
description: The email of the customer.
type: string
format: email
$ref: >-
../components/schemas/StorePostCustomersCustomerPasswordTokenReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/store/paths/gift-cards_{code}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
gift_card:
$ref: ../components/schemas/gift_card.yaml
$ref: ../components/schemas/GiftCard.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/order-edits_{id}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml
$ref: ../components/schemas/OrderEdit.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/order-edits_{id}_complete.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ post:
type: object
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml
$ref: ../components/schemas/OrderEdit.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/order-edits_{id}_decline.yaml
+2 -6
View File
@@ -13,11 +13,7 @@ post:
content:
application/json:
schema:
type: object
properties:
declined_reason:
type: string
description: The reason for declining the OrderEdit.
$ref: ../components/schemas/StorePostOrderEditsOrderEditDecline.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -38,7 +34,7 @@ post:
type: object
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml
$ref: ../components/schemas/OrderEdit.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/orders.yaml
+1 -1
View File
@@ -49,7 +49,7 @@ get:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml
$ref: ../components/schemas/Order.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/orders_batch_customer_token.yaml
+1 -8
View File
@@ -8,14 +8,7 @@ post:
content:
application/json:
schema:
required:
- order_ids
properties:
order_ids:
description: The ids of the orders to claim
type: array
items:
type: string
$ref: ../components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/store/paths/orders_cart_{cart_id}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml
$ref: ../components/schemas/Order.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/orders_customer_confirm.yaml
+1 -6
View File
@@ -8,12 +8,7 @@ post:
content:
application/json:
schema:
required:
- token
properties:
token:
description: The invite token provided by the admin.
type: string
$ref: ../components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
docs/api/store/paths/orders_{id}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml
$ref: ../components/schemas/Order.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/payment-collections_{id}.yaml
+1 -1
View File
@@ -43,7 +43,7 @@ get:
type: object
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
$ref: ../components/schemas/PaymentCollection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/payment-collections_{id}_sessions.yaml
+2 -7
View File
@@ -14,12 +14,7 @@ post:
content:
application/json:
schema:
required:
- provider_id
properties:
provider_id:
type: string
description: The ID of the Payment Provider.
$ref: ../components/schemas/StorePaymentCollectionSessionsReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -43,7 +38,7 @@ post:
schema:
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
$ref: ../components/schemas/PaymentCollection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml
+3 -22
View File
@@ -14,27 +14,8 @@ post:
content:
application/json:
schema:
properties:
sessions:
description: >-
An array of payment sessions related to the Payment Collection.
If the session_id is not provided, existing sessions not present
will be deleted and the provided ones will be created.
type: array
items:
required:
- provider_id
- amount
properties:
provider_id:
type: string
description: The ID of the Payment Provider.
amount:
type: integer
description: The amount .
session_id:
type: string
description: The ID of the Payment Session to be updated.
$ref: >-
../components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -59,7 +40,7 @@ post:
schema:
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
$ref: ../components/schemas/PaymentCollection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml
+3 -7
View File
@@ -14,12 +14,8 @@ post:
content:
application/json:
schema:
properties:
session_ids:
description: List of Payment Session IDs to authorize.
type: array
items:
type: string
$ref: >-
../components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -44,7 +40,7 @@ post:
schema:
properties:
payment_collection:
$ref: ../components/schemas/payment_collection.yaml
$ref: ../components/schemas/PaymentCollection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml
+1 -16
View File
@@ -18,21 +18,6 @@ post:
description: The id of the Payment Session to be refreshed.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- provider_id
- customer_id
properties:
provider_id:
description: The Payment Provider id.
type: string
customer_id:
description: The Customer id.
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -55,7 +40,7 @@ post:
type: object
properties:
payment_session:
$ref: ../components/schemas/payment_session.yaml
$ref: ../components/schemas/PaymentSession.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml
+1 -1
View File
@@ -40,7 +40,7 @@ post:
schema:
properties:
payment_session:
$ref: ../components/schemas/payment_session.yaml
$ref: ../components/schemas/PaymentSession.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
docs/api/store/paths/product-types.yaml
+1 -1
View File
@@ -116,7 +116,7 @@ get:
type: object
properties:
product_types:
$ref: ../components/schemas/product_type.yaml
$ref: ../components/schemas/ProductType.yaml
count:
type: integer
description: The total number of items available
docs/api/store/paths/products.yaml
+8 -3
View File
@@ -147,6 +147,11 @@ get:
result.
schema:
type: string
- in: query
name: order
description: the field used to order the products.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -170,16 +175,16 @@ get:
type: array
items:
allOf:
- $ref: ../components/schemas/product.yaml
- $ref: ../components/schemas/Product.yaml
- type: object
properties:
variants:
type: array
items:
allOf:
- $ref: ../components/schemas/product_variant.yaml
- $ref: ../components/schemas/ProductVariant.yaml
- $ref: >-
../components/schemas/product_variant_prices_fields.yaml
../components/schemas/ProductVariantPricesFields.yaml
count:
type: integer
description: The total number of items available
docs/api/store/paths/products_{id}.yaml
+3 -3
View File
@@ -54,16 +54,16 @@ get:
properties:
product:
allOf:
- $ref: ../components/schemas/product.yaml
- $ref: ../components/schemas/Product.yaml
- type: object
properties:
variants:
type: array
items:
allOf:
- $ref: ../components/schemas/product_variant.yaml
- $ref: ../components/schemas/ProductVariant.yaml
- $ref: >-
../components/schemas/product_variant_prices_fields.yaml
../components/schemas/ProductVariantPricesFields.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/regions.yaml
+1 -1
View File
@@ -81,7 +81,7 @@ get:
regions:
type: array
items:
$ref: ../components/schemas/region.yaml
$ref: ../components/schemas/Region.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/regions_{id}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
region:
$ref: ../components/schemas/region.yaml
$ref: ../components/schemas/Region.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/return-reasons.yaml
+1 -1
View File
@@ -24,7 +24,7 @@ get:
return_reasons:
type: array
items:
$ref: ../components/schemas/return_reason.yaml
$ref: ../components/schemas/ReturnReason.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/return-reasons_{id}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
return_reason:
$ref: ../components/schemas/return_reason.yaml
$ref: ../components/schemas/ReturnReason.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/returns.yaml
+2 -43
View File
@@ -6,48 +6,7 @@ post:
content:
application/json:
schema:
type: object
required:
- order_id
- items
properties:
order_id:
type: string
description: The ID of the Order to create the Return from.
items:
description: The items to include in the Return.
type: array
items:
required:
- item_id
- quantity
properties:
item_id:
description: The ID of the Line Item from the Order.
type: string
quantity:
description: The quantity to return.
type: integer
reason_id:
description: The ID of the return reason.
type: string
note:
description: A note to add to the item returned.
type: string
return_shipping:
description: >-
If the Return is to be handled by the store operator the
Customer can choose a Return Shipping Method. Alternatvely the
Customer can handle the Return themselves.
type: object
required:
- option_id
properties:
option_id:
type: string
description: >-
The ID of the Shipping Option to create the Shipping Method
from.
$ref: ../components/schemas/StorePostReturnsReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -68,7 +27,7 @@ post:
type: object
properties:
return:
$ref: ../components/schemas/return.yaml
$ref: ../components/schemas/Return.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/shipping-options.yaml
+1 -1
View File
@@ -42,7 +42,7 @@ get:
shipping_options:
type: array
items:
$ref: ../components/schemas/shipping_option.yaml
$ref: ../components/schemas/ShippingOption.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/shipping-options_{cart_id}.yaml
+1 -1
View File
@@ -31,7 +31,7 @@ get:
shipping_options:
type: array
items:
$ref: ../components/schemas/shipping_option.yaml
$ref: ../components/schemas/ShippingOption.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/swaps.yaml
+2 -49
View File
@@ -8,54 +8,7 @@ post:
content:
application/json:
schema:
type: object
required:
- order_id
- return_items
- additional_items
properties:
order_id:
type: string
description: The ID of the Order to create the Swap for.
return_items:
description: The items to include in the Return.
type: array
items:
required:
- item_id
- quantity
properties:
item_id:
description: The ID of the Line Item from the Order.
type: string
quantity:
description: The quantity to swap.
type: integer
reason_id:
description: The ID of the reason of this return.
type: string
note:
description: The note to add to the item being swapped.
type: string
return_shipping_option:
type: string
description: >-
The ID of the Shipping Option to create the Shipping Method
from.
additional_items:
description: The items to exchange the returned items to.
type: array
items:
required:
- variant_id
- quantity
properties:
variant_id:
description: The ID of the Product Variant to send.
type: string
quantity:
description: The quantity to send of the variant.
type: integer
$ref: ../components/schemas/StorePostSwapsReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -76,7 +29,7 @@ post:
type: object
properties:
swap:
$ref: ../components/schemas/swap.yaml
$ref: ../components/schemas/Swap.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/swaps_{cart_id}.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ get:
type: object
properties:
swap:
$ref: ../components/schemas/swap.yaml
$ref: ../components/schemas/Swap.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/variants.yaml
+2 -2
View File
@@ -81,8 +81,8 @@ get:
type: array
items:
allOf:
- $ref: ../components/schemas/product_variant.yaml
- $ref: ../components/schemas/product_variant_prices_fields.yaml
- $ref: ../components/schemas/ProductVariant.yaml
- $ref: ../components/schemas/ProductVariantPricesFields.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
docs/api/store/paths/variants_{variant_id}.yaml
+2 -2
View File
@@ -46,8 +46,8 @@ get:
properties:
variant:
allOf:
- $ref: ../components/schemas/product_variant.yaml
- $ref: ../components/schemas/product_variant_prices_fields.yaml
- $ref: ../components/schemas/ProductVariant.yaml
- $ref: ../components/schemas/ProductVariantPricesFields.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':