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

chore(docs): Updated API Reference (v2) (#8609)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-15 14:31:35 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 4bd0917aed
commit b23ddcdde8
1211 changed files with 92070 additions and 5062 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/paths/store_carts.yaml
+65 -1
View File
@@ -63,7 +63,64 @@ post:
content:
application/json:
schema:
$ref: ../components/schemas/CreateCartWorkflowInput.yaml
description: SUMMARY
properties:
region_id:
type: string
title: region_id
description: The cart's region id.
customer_id:
type: string
title: customer_id
description: The cart's customer id.
sales_channel_id:
type: string
title: sales_channel_id
description: The cart's sales channel id.
email:
type: string
title: email
description: The cart's email.
format: email
currency_code:
type: string
title: currency_code
description: The cart's currency code.
shipping_address_id:
type: string
title: shipping_address_id
description: The cart's shipping address id.
billing_address_id:
type: string
title: billing_address_id
description: The cart's billing address id.
shipping_address:
oneOf:
- type: string
title: shipping_address
description: The cart's shipping address.
- $ref: ../components/schemas/CreateCartAddress.yaml
billing_address:
oneOf:
- type: string
title: billing_address
description: The cart's billing address.
- $ref: ../components/schemas/CreateCartAddress.yaml
metadata:
type: object
description: The cart's metadata.
items:
type: array
description: The cart's items.
items:
$ref: ../components/schemas/CreateCartCreateLineItem.yaml
promo_codes:
type: array
description: The cart's promo codes.
items:
type: string
title: promo_codes
description: The promo code's promo codes.
x-codeSamples:
- lang: Shell
label: cURL
@@ -72,6 +129,12 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -84,3 +147,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCartWorkflow
www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
+60 -1
View File
@@ -75,6 +75,12 @@ get:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -158,7 +164,48 @@ post:
content:
application/json:
schema:
$ref: ../components/schemas/UpdateCartData.yaml
description: SUMMARY
properties:
region_id:
type: string
title: region_id
description: The cart's region id.
customer_id:
type: string
title: customer_id
description: The cart's customer id.
sales_channel_id:
type: string
title: sales_channel_id
description: The cart's sales channel id.
email:
type: string
title: email
description: The cart's email.
format: email
currency_code:
type: string
title: currency_code
description: The cart's currency code.
shipping_address_id:
type: string
title: shipping_address_id
description: The cart's shipping address id.
billing_address_id:
type: string
title: billing_address_id
description: The cart's billing address id.
billing_address:
oneOf:
- $ref: ../components/schemas/CreateAddress.yaml
- $ref: ../components/schemas/UpdateAddress.yaml
shipping_address:
oneOf:
- $ref: ../components/schemas/CreateAddress.yaml
- $ref: ../components/schemas/UpdateAddress.yaml
metadata:
type: object
description: The cart's metadata.
x-codeSamples:
- lang: Shell
label: cURL
@@ -167,6 +214,18 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
description: SUMMARY
required:
- cart
properties:
cart:
$ref: ../components/schemas/StoreCart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+52
View File
@@ -84,6 +84,57 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- type: object
description: SUMMARY
required:
- type
- cart
- error
properties:
type:
type: string
title: type
description: The cart's type.
cart:
$ref: ../components/schemas/StoreCart.yaml
error:
type: object
description: The cart's error.
required:
- message
- name
- type
properties:
message:
type: string
title: message
description: The error's message.
name:
type: string
title: name
description: The error's name.
type:
type: string
title: type
description: The error's type.
- type: object
description: SUMMARY
required:
- type
- order
properties:
type:
type: string
title: type
description: The cart's type.
order:
$ref: ../components/schemas/StoreOrder.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -96,3 +147,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: completeCartWorkflow
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+6
View File
@@ -78,6 +78,12 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+6
View File
@@ -84,6 +84,12 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml
+18
View File
@@ -89,6 +89,12 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -178,6 +184,18 @@ delete:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
description: SUMMARY
required:
- cart
properties:
cart:
$ref: ../components/schemas/StoreCart.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+6
View File
@@ -89,6 +89,12 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml
+6
View File
@@ -78,6 +78,12 @@ post:
tags:
- Carts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCartResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_collections.yaml
+35
View File
@@ -69,6 +69,41 @@ get:
tags:
- Collections
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- limit
- offset
- count
properties:
limit:
type: number
title: limit
description: The collection's limit.
offset:
type: number
title: offset
description: The collection's offset.
count:
type: number
title: count
description: The collection's count.
- type: object
description: SUMMARY
required:
- collections
properties:
collections:
type: array
description: The collection's collections.
items:
$ref: ../components/schemas/StoreCollection.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+6
View File
@@ -75,6 +75,12 @@ get:
tags:
- Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCollectionResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_currencies.yaml
+6
View File
@@ -69,6 +69,12 @@ get:
tags:
- Currencies
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCurrencyListResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml
+6
View File
@@ -75,6 +75,12 @@ get:
tags:
- Currencies
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCurrencyResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_customers.yaml
+6
View File
@@ -72,6 +72,12 @@ post:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomerResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+12
View File
@@ -72,6 +72,12 @@ get:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomerResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -161,6 +167,12 @@ post:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomerResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
+12
View File
@@ -183,6 +183,12 @@ get:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomerAddressListResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -342,6 +348,12 @@ post:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomerResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
+39
View File
@@ -78,6 +78,12 @@ get:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomerAddressResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -244,6 +250,12 @@ post:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreCustomerResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -337,6 +349,33 @@ delete:
tags:
- Customers
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
description: SUMMARY
required:
- id
- object
- deleted
properties:
id:
type: string
title: id
description: The customer's ID.
object:
type: string
title: object
description: The customer's object.
deleted:
type: boolean
title: deleted
description: The customer's deleted.
parent:
type: object
description: The customer's parent.
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_orders.yaml
+47 -2
View File
@@ -92,11 +92,21 @@ get:
- name: $and
in: query
required: false
schema: {}
schema:
type: array
description: The order's $and.
items:
type: object
title: $and
- name: $or
in: query
required: false
schema: {}
schema:
type: array
description: The order's $or.
items:
type: object
title: $or
x-codeSamples:
- lang: Shell
label: cURL
@@ -105,6 +115,41 @@ get:
tags:
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- limit
- offset
- count
properties:
limit:
type: number
title: limit
description: The order's limit.
offset:
type: number
title: offset
description: The order's offset.
count:
type: number
title: count
description: The order's count.
- type: object
description: SUMMARY
required:
- orders
properties:
orders:
type: array
description: The order's orders.
items:
$ref: ../components/schemas/StoreOrder.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
+18 -2
View File
@@ -98,11 +98,21 @@ get:
- name: $and
in: query
required: false
schema: {}
schema:
type: array
description: The order's $and.
items:
type: object
title: $and
- name: $or
in: query
required: false
schema: {}
schema:
type: array
description: The order's $or.
items:
type: object
title: $or
x-codeSamples:
- lang: Shell
label: cURL
@@ -111,6 +121,12 @@ get:
tags:
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreOrderResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_payment-collections.yaml
+6 -15
View File
@@ -67,26 +67,11 @@ post:
description: SUMMARY
required:
- cart_id
- region_id
- currency_code
- amount
properties:
cart_id:
type: string
title: cart_id
description: The payment collection's cart id.
region_id:
type: string
title: region_id
description: The payment collection's region id.
currency_code:
type: string
title: currency_code
description: The payment collection's currency code.
amount:
type: number
title: amount
description: The payment collection's amount.
x-codeSamples:
- lang: Shell
label: cURL
@@ -95,6 +80,12 @@ post:
tags:
- Payment Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StorePaymentCollectionResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml
+6
View File
@@ -93,6 +93,12 @@ post:
tags:
- Payment Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StorePaymentCollectionResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_payment-providers.yaml
+47 -2
View File
@@ -95,11 +95,21 @@ get:
- name: $and
in: query
required: false
schema: {}
schema:
type: array
description: The payment provider's $and.
items:
type: object
title: $and
- name: $or
in: query
required: false
schema: {}
schema:
type: array
description: The payment provider's $or.
items:
type: object
title: $or
x-codeSamples:
- lang: Shell
label: cURL
@@ -108,6 +118,41 @@ get:
tags:
- Payment Providers
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- limit
- offset
- count
properties:
limit:
type: number
title: limit
description: The payment provider's limit.
offset:
type: number
title: offset
description: The payment provider's offset.
count:
type: number
title: count
description: The payment provider's count.
- type: object
description: SUMMARY
required:
- payment_providers
properties:
payment_providers:
type: array
description: The payment provider's payment providers.
items:
$ref: ../components/schemas/StorePaymentProvider.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+12 -2
View File
@@ -247,11 +247,21 @@ get:
- name: $and
in: query
required: false
schema: {}
schema:
type: array
description: The product category's $and.
items:
type: object
title: $and
- name: $or
in: query
required: false
schema: {}
schema:
type: array
description: The product category's $or.
items:
type: object
title: $or
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_products.yaml
+6288 -155
View File
File diff suppressed because it is too large Load Diff
www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+6
View File
@@ -107,6 +107,12 @@ get:
tags:
- Products
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreProductResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_regions.yaml
+35
View File
@@ -69,6 +69,41 @@ get:
tags:
- Regions
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- limit
- offset
- count
properties:
limit:
type: number
title: limit
description: The region's limit.
offset:
type: number
title: offset
description: The region's offset.
count:
type: number
title: count
description: The region's count.
- type: object
description: SUMMARY
required:
- regions
properties:
regions:
type: array
description: The region's regions.
items:
$ref: ../components/schemas/StoreRegion.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
+12
View File
@@ -75,6 +75,18 @@ get:
tags:
- Regions
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
description: SUMMARY
required:
- region
properties:
region:
$ref: ../components/schemas/StoreRegion.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
+35
View File
@@ -69,6 +69,41 @@ get:
tags:
- Return Reasons
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
description: SUMMARY
required:
- limit
- offset
- count
properties:
limit:
type: number
title: limit
description: The return reason's limit.
offset:
type: number
title: offset
description: The return reason's offset.
count:
type: number
title: count
description: The return reason's count.
- type: object
description: SUMMARY
required:
- return_reasons
properties:
return_reasons:
type: array
description: The return reason's return reasons.
items:
$ref: ../components/schemas/StoreReturnReason.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
+6
View File
@@ -75,6 +75,12 @@ get:
tags:
- Return Reasons
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreReturnReasonResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_return.yaml
+6
View File
@@ -72,6 +72,12 @@ post:
tags:
- Return
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreReturnResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+7
View File
@@ -69,6 +69,12 @@ get:
tags:
- Shipping Options
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreShippingOptionListResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -81,3 +87,4 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: listShippingOptionsForCartWorkflow