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

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

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

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-18 07:13:51 +00:00
committed by GitHub
parent a63f6910d0
commit 56ee4d6aad
254 changed files with 6349 additions and 5461 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}.yaml
+31 -3
View File
@@ -1,9 +1,18 @@
post:
operationId: PostActor_typeAuth_provider
summary: Authenticate Customer
description: >-
description: >
Authenticate a customer and receive the JWT token to be used in the header
of subsequent requests.
When used with a third-party provider, such as Google, the request returns a
`location` property. You redirect to the specified URL in your storefront to
continue authentication with the third-party service.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#types-of-authentication-flows
description: Learn about different authentication flows.
x-authenticated: false
parameters:
- name: auth_provider
@@ -13,9 +22,26 @@ post:
schema:
type: string
example: emailpass
requestBody:
content:
application/json:
schema:
type: object
title: input
description: >-
The input data necessary for authentication. For example, for
email-pass authentication, pass `email` and `password` properties.
x-codeSamples:
- lang: Shell
label: cURL
label: EmailPass Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh
- lang: Shell
label: Google Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh
- lang: Shell
label: GitHub Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh
tags:
@@ -26,7 +52,9 @@ post:
content:
application/json:
schema:
$ref: ../components/schemas/AuthResponse.yaml
oneOf:
- $ref: ../components/schemas/AuthResponse.yaml
- $ref: ../components/schemas/AuthCallbackResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_callback.yaml
+23 -6
View File
@@ -1,11 +1,24 @@
post:
operationId: PostActor_typeAuth_providerCallback
summary: Validate Authentication Callback
description: >-
Third-party authentication providers, such as Google, require an API route
to call once authentication with the third-party provider is finished. This
API route validates callback for customers logged-in with third-party
providers.
description: >
This API route is used by your storefront or frontend application when a
third-party provider redirects to it after authentication.
It validates the authentication with the third-party provider and, if
successful, returns an authentication token.
You can decode the JWT token using libraries like
[react-jwt](https://www.npmjs.com/package/react-jwt) in the storefront. If
the decoded data doesn't have an `actor_id` property, then you must
register the customer using the Create Customer API route passing the token
in the request's Authorization header.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
description: Learn about third-party authentication flow.
x-authenticated: false
parameters:
- name: auth_provider
@@ -17,7 +30,11 @@ post:
example: google
x-codeSamples:
- lang: Shell
label: cURL
label: Google Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh
- lang: Shell
label: GitHub Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh
tags:
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_register.yaml
+16 -3
View File
@@ -2,9 +2,13 @@ post:
operationId: PostActor_typeAuth_provider_register
summary: Retrieve Registration JWT Token
description: >-
A registration JWT token is used in the header of requests that create a
customer. This API route retrieves the JWT token of a customer that hasn't
been registered yet.
This API route retrieves a registration JWT token of a customer that hasn't
been registered yet. The token is used in the header of requests that create
a customer.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#1-basic-authentication-flow
description: Learn about the basic authentication flow.
x-authenticated: false
parameters:
- name: auth_provider
@@ -14,6 +18,15 @@ post:
schema:
type: string
example: emailpass
requestBody:
content:
application/json:
schema:
type: object
title: input
description: >-
The input data necessary for authentication. For example, for
email-pass authentication, pass `email` and `password` properties.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/auth_token_refresh.yaml
+39
View File
@@ -0,0 +1,39 @@
post:
operationId: PostAdminAuthTokenRefresh
summary: Refresh Authentication Token
description: >-
Refresh the authentication token of a customer. This is useful after
authenticating a customer with a third-party service to ensure the token
holds the new user's details, or when you don't want customers to re-login
every day.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
description: Learn about third-party authentication flow.
x-authenticated: true
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth_token_refresh/post.sh
tags:
- Auth
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AuthResponse.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
www/apps/api-reference/specs/store/paths/store_carts.yaml
+3 -3
View File
@@ -35,9 +35,9 @@ post:
application/json:
schema:
allOf:
- $ref: ../components/schemas/CreateCartWorkflowInput.yaml
- $ref: ../components/schemas/StoreCreateCart.yaml
- type: object
description: SUMMARY
description: The cart's details.
properties:
additional_data:
type: object
@@ -45,7 +45,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The cart's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
+6 -4
View File
@@ -67,7 +67,9 @@ get:
post:
operationId: PostCartsId
summary: Update a Cart
description: Update a cart's details.
description: >-
Update a cart's details. This unsets the shipping an payment methods chosen
before, and the customer would have to choose them again.
x-authenticated: false
parameters:
- name: id
@@ -109,7 +111,7 @@ post:
allOf:
- $ref: ../components/schemas/UpdateCartData.yaml
- type: object
description: SUMMARY
description: The properties to update in the cart item.
properties:
additional_data:
type: object
@@ -117,7 +119,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The properties to update in the cart item.
x-codeSamples:
- lang: Shell
label: cURL
@@ -132,7 +134,7 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The updated cart's details.
required:
- cart
properties:
www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+29 -29
View File
@@ -1,8 +1,12 @@
post:
operationId: PostCartsIdComplete
summary: Add Completes to Cart
description: Add a list of completes to a cart.
summary: Complete Cart
description: Complete a cart and place an order.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart
description: 'Storefront guide: How to implement cart completion during checkout.'
parameters:
- name: id
in: path
@@ -36,17 +40,6 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
requestBody:
content:
application/json:
schema:
type: object
description: SUMMARY
properties:
idempotency_key:
type: string
title: idempotency_key
description: The cart's idempotency key.
x-codeSamples:
- lang: Shell
label: cURL
@@ -62,7 +55,20 @@ post:
schema:
oneOf:
- type: object
description: SUMMARY
description: The created order's details.
required:
- type
- order
properties:
type:
type: string
title: type
description: The type of the returned object.
default: order
order:
$ref: ../components/schemas/StoreOrder.yaml
- type: object
description: The details of why the cart completion failed.
required:
- type
- cart
@@ -71,12 +77,13 @@ post:
type:
type: string
title: type
description: The cart's type.
description: The type of the returned object.
default: cart
cart:
$ref: ../components/schemas/StoreCart.yaml
error:
type: object
description: The cart's error.
description: The error's details.
required:
- message
- name
@@ -93,19 +100,12 @@ post:
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
description: >
The error's type. Can be a [MedusaError
type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types)
or `payment_authorization_error` or
`payment_requires_more_error` for payment-related
errors.
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+7 -2
View File
@@ -1,7 +1,12 @@
post:
operationId: PostCartsIdLineItems
summary: Add Line Items to Cart
description: Add a list of line items to a cart.
summary: Add Line Item to Cart
x-sidebar-summary: Add Line Item
description: Add a product variant as a line item in the cart.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#add-product-variant-to-cart
description: 'Storefront guide: How to add a product variant to the cart.'
x-authenticated: false
parameters:
- name: id
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+23 -13
View File
@@ -1,7 +1,12 @@
post:
operationId: PostCartsIdLineItemsLine_id
summary: Add Line Items to Cart
description: Add a list of line items to a cart.
summary: Update a Line Item in a Cart
x-sidebar-summary: Update Line Item
description: Update a line item's details in the cart.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#update-line-item-in-cart
description: 'Storefront guide: How to update a cart''s line item.'
x-authenticated: false
parameters:
- name: id
@@ -12,7 +17,7 @@ post:
type: string
- name: line_id
in: path
description: The cart's line id.
description: The line item's ID.
required: true
schema:
type: string
@@ -76,10 +81,13 @@ post:
x-workflow: updateLineItemInCartWorkflow
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.
summary: Remove Line Item from Cart
x-sidebar-summary: Remove Line Item
description: Remove a line item from a cart.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#remove-line-item-from-cart
description: 'Storefront guide: How to remove line item from cart.'
x-authenticated: false
parameters:
- name: id
@@ -90,7 +98,7 @@ delete:
type: string
- name: line_id
in: path
description: The cart's line id.
description: The line item's ID.
required: true
schema:
type: string
@@ -135,7 +143,7 @@ delete:
schema:
allOf:
- type: object
description: SUMMARY
description: The deletion's details.
required:
- id
- object
@@ -144,21 +152,23 @@ delete:
id:
type: string
title: id
description: The cart's ID.
description: The ID of the deleted line item.
object:
type: string
title: object
description: The name of the deleted object.
default: line-item
deleted:
type: boolean
title: deleted
description: Whether the Cart was deleted.
description: Whether the item was deleted.
- type: object
description: SUMMARY
description: The deletion's details.
properties:
parent:
$ref: ../components/schemas/StoreCart.yaml
description: SUMMARY
description: The cart that the item belonged to.
description: The deletion's details.
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml
+6 -7
View File
@@ -1,6 +1,7 @@
post:
operationId: PostCartsIdPromotions
summary: Add Promotions to Cart
x-sidebar-summary: Add Promotions
description: Add a list of promotions to a cart.
x-authenticated: false
parameters:
@@ -41,17 +42,17 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The promotion's details.
required:
- promo_codes
properties:
promo_codes:
type: array
description: The cart's promo codes.
description: Promotion codes to add to the cart.
items:
type: string
title: promo_codes
description: The promo code's promo codes.
description: A promotion code.
x-codeSamples:
- lang: Shell
label: cURL
@@ -82,9 +83,7 @@ post:
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.
description: Remove a list of promotions from a cart.
x-authenticated: false
parameters:
- name: id
@@ -133,7 +132,7 @@ delete:
application/json:
schema:
type: object
description: SUMMARY
description: The cart's details.
required:
- cart
properties:
www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+18 -5
View File
@@ -1,7 +1,14 @@
post:
operationId: PostCartsIdShippingMethods
summary: Add Shipping Methods to Cart
description: Add a list of shipping methods to a cart.
summary: Add Shipping Method to Cart
x-sidebar-summary: Add Shipping Method
description: >-
Add a shipping method to a cart. Use this API route when the customer
chooses their preferred shipping option.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false
parameters:
- name: id
@@ -41,17 +48,23 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The shipping method's details.
required:
- option_id
properties:
option_id:
type: string
title: option_id
description: The cart's option id.
description: The ID of the shipping option this method is created from.
data:
type: object
description: The cart's data.
description: >-
Any additional data relevant for the third-party fulfillment
provider to process the shipment.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter
description: Learn more about the `data` parameter.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml
+3 -2
View File
@@ -1,7 +1,8 @@
post:
operationId: PostCartsIdTaxes
summary: Add Taxes to Cart
description: Add a list of taxes to a cart.
summary: Calculate Cart Taxes
x-sidebar-summary: Calculate Taxes
description: Calculate the cart's tax lines and amounts.
x-authenticated: false
parameters:
- name: id
www/apps/api-reference/specs/store/paths/store_collections.yaml
+61 -85
View File
@@ -3,8 +3,12 @@ get:
summary: List Collections
description: >-
Retrieve a list of collections. The collections can be filtered by fields
such as `id`. The collections can also be sorted or paginated.
such as `handle`. The collections can also be sorted or paginated.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list
description: 'Storefront guide: How to retrieve a list of collections.'
parameters:
- name: expand
in: query
@@ -63,11 +67,11 @@ get:
with `-`.
- name: deleted_at
in: query
description: The collection's deleted at.
description: Filter by the collection's deletion date.
required: false
schema:
type: object
description: The collection's deleted at.
description: Filter by the collection's deletion date.
properties:
$and:
type: array
@@ -351,20 +355,20 @@ get:
oneOf:
- type: string
title: title
description: The collection's title.
description: Filter by a collection's title.
- type: array
description: The collection's title.
description: Filter by collection titles.
items:
type: string
title: title
description: The title's details.
description: A title.
- name: created_at
in: query
description: The collection's created at.
description: Filter by the collection's creation date.
required: false
schema:
type: object
description: The collection's created at.
description: Filter by the collection's creation date.
properties:
$and:
type: array
@@ -388,11 +392,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -403,21 +407,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -445,50 +447,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -539,9 +537,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -550,16 +546,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -567,15 +561,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -622,32 +612,32 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at
in: query
description: The collection's updated at.
description: Filter by the collection's update date.
required: false
schema:
type: object
description: The collection's updated at.
description: Filter by the collection's update date.
properties:
$and:
type: array
@@ -671,11 +661,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -686,21 +676,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -728,50 +716,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -822,9 +806,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -833,16 +815,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -850,15 +830,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -905,21 +881,21 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -931,21 +907,21 @@ get:
oneOf:
- type: string
title: handle
description: The collection's handle.
description: Filter by a collection's handle.
- type: array
description: The collection's handle.
description: Filter by collection handles.
items:
type: string
title: handle
description: The handle's details.
description: A handle.
- name: q
in: query
description: The collection's q.
description: Search term to filter the collection's searchable properties.
required: false
schema:
type: string
title: q
description: The collection's q.
description: Search term to filter the collection's searchable properties.
- name: $and
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+4
View File
@@ -5,6 +5,10 @@ get:
Retrieve a collection by its ID. You can expand the collection's relations
or select the fields that should be returned.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve
description: 'Storefront guide: How to retrieve a collection.'
parameters:
- name: id
in: path
www/apps/api-reference/specs/store/paths/store_currencies.yaml
+6 -6
View File
@@ -3,7 +3,7 @@ get:
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.
as `code`. The currencies can also be sorted or paginated.
x-authenticated: false
parameters:
- name: expand
@@ -63,12 +63,12 @@ get:
with `-`.
- name: q
in: query
description: The currency's q.
description: Search term to filter the currency's searchable properties.
required: false
schema:
type: string
title: q
description: The currency's q.
description: Search term to filter the currency's searchable properties.
- name: code
in: query
required: false
@@ -76,13 +76,13 @@ get:
oneOf:
- type: string
title: code
description: The currency's code.
description: Filter by a currency code.
- type: array
description: The currency's code.
description: Filter by currency codes.
items:
type: string
title: code
description: The code's details.
description: A currency code.
- name: $and
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml
+1 -1
View File
@@ -2,7 +2,7 @@ get:
operationId: GetCurrenciesCode
summary: Get a Currency
description: >-
Retrieve a currency by its ID. You can expand the currency's relations or
Retrieve a currency by its code. You can expand the currency's relations or
select the fields that should be returned.
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/store_customers.yaml
+10 -3
View File
@@ -1,8 +1,15 @@
post:
operationId: PostCustomers
summary: Create Customer
description: Create a customer.
x-authenticated: false
summary: Register Customer
description: >-
Register a customer. Use the `/auth/customer/emailpass/register` API route
first to retrieve the registration token and pass it in the header of the
request.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/register
description: 'Storefront guide: How to register a customer.'
x-authenticated: true
parameters:
- name: expand
in: query
www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+14 -5
View File
@@ -1,10 +1,15 @@
get:
operationId: GetCustomersMe
summary: List Customers
summary: Get Logged-in Customer
x-sidebar-summary: Get Customer
description: >-
Retrieve a list of customers. The customers can be filtered by fields such
as `id`. The customers can also be sorted or paginated.
Retrieve the logged-in customer. You can expand the customer's relations or
select the fields that should be returned.
x-authenticated: true
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve
description: 'Storefront guide: How to retrieve the logged-in customer.'
parameters:
- name: expand
in: query
@@ -63,8 +68,12 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomersMe
summary: Create Customer
description: Create a customer.
summary: Update Customer
description: Update the logged-in customer's details.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/profile
description: 'Storefront guide: How to edit a customer''s profile.'
x-authenticated: true
parameters:
- name: expand
www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
+55 -61
View File
@@ -1,10 +1,16 @@
get:
operationId: GetCustomersMeAddresses
summary: List Customers
summary: List Customer's Addresses
x-sidebary-summary: List Addresses
description: >-
Retrieve a list of customers. The customers can be filtered by fields such
as `id`. The customers can also be sorted or paginated.
Retrieve the addresses of the logged-in customer. The addresses can be
filtered by fields such as `country_code`. The addresses can also be sorted
or paginated.
x-authenticated: true
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses
description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.'
parameters:
- name: expand
in: query
@@ -63,57 +69,36 @@ get:
with `-`.
- name: city
in: query
description: The customer's city.
required: false
description: Filter by the address's city.
required: true
schema:
oneOf:
- type: string
title: city
description: The customer's city.
- type: array
description: The customer's city.
items:
type: string
title: city
description: The city's details.
- name: country_code
in: query
description: The customer's country code.
required: false
schema:
oneOf:
- type: string
title: country_code
description: The customer's country code.
- type: array
description: The customer's country code.
items:
type: string
title: country_code
description: The country code's details.
type: string
title: city
description: Filter by the address's city.
- name: postal_code
in: query
description: The customer's postal code.
required: false
description: Filter by the address's postal code.
required: true
schema:
oneOf:
- type: string
title: postal_code
description: The customer's postal code.
- type: array
description: The customer's postal code.
items:
type: string
title: postal_code
description: The postal code's details.
type: string
title: postal_code
description: Filter by the address's postal code.
- name: country_code
in: query
description: Filter by the address's country code.
required: true
schema:
type: string
title: country_code
description: Filter by the address's country code.
- name: q
in: query
description: The customer's q.
required: false
description: Search term to filter the address's searchable properties.
required: true
schema:
type: string
title: q
description: The customer's q.
description: Search term to filter the address's searchable properties.
security:
- cookie_auth: []
- jwt_token: []
@@ -145,8 +130,13 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomersMeAddresses
summary: Create Customer
description: Create a customer.
summary: Create Address for Logged-In Customer
x-sidebar-summary: Create Address
description: Create an address for the logged-in customer.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#add-customer-address
description: 'Storefront guide: How to create an address for the logged-in customer.'
x-authenticated: true
parameters:
- name: expand
@@ -183,11 +173,8 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The address's details.
properties:
metadata:
type: object
description: The customer's metadata.
first_name:
type: string
title: first_name
@@ -203,43 +190,50 @@ post:
company:
type: string
title: company
description: The customer's company.
description: The address's company.
address_1:
type: string
title: address_1
description: The customer's address 1.
description: The address's first line.
address_2:
type: string
title: address_2
description: The customer's address 2.
description: The address's second line.
city:
type: string
title: city
description: The customer's city.
description: The address's city.
country_code:
type: string
title: country_code
description: The customer's country code.
description: The address's country code.
province:
type: string
title: province
description: The customer's province.
description: The address's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
description: The address's postal code.
address_name:
type: string
title: address_name
description: The customer's address name.
description: The address's name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: The customer's is default shipping.
description: >-
Whether the address is used by default for shipping during
checkout.
is_default_billing:
type: boolean
title: is_default_billing
description: The customer's is default billing.
description: >-
Whether the address is used by default for billing during
checkout.
metadata:
type: object
description: Holds custom key-value pairs.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
+46 -31
View File
@@ -1,14 +1,15 @@
get:
operationId: GetCustomersMeAddressesAddress_id
summary: List Addresses
summary: Get Customer's Address
x-sidebar-summary: Get Address
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.
Retrieve an address of the logged-in customer. You can expand the address's
relations or select the fields that should be returned.
x-authenticated: true
parameters:
- name: address_id
in: path
description: The customer's address id.
description: The address's ID.
required: true
schema:
type: string
@@ -69,13 +70,18 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostCustomersMeAddressesAddress_id
summary: Add Addresses to Customer
description: Add a list of addresses to a customer.
summary: Update Customer's Address
x-sidebar-summary: Update Address
description: Update the logged-in customer's address.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#edit-an-address
description: 'Storefront guide: How to update an address of the logged-in customer.'
x-authenticated: true
parameters:
- name: address_id
in: path
description: The customer's address id.
description: The address's ID.
required: true
schema:
type: string
@@ -113,11 +119,8 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The properties to update in the address.
properties:
metadata:
type: object
description: The customer's metadata.
first_name:
type: string
title: first_name
@@ -133,43 +136,50 @@ post:
company:
type: string
title: company
description: The customer's company.
description: The address's company.
address_1:
type: string
title: address_1
description: The customer's address 1.
description: The address's first line.
address_2:
type: string
title: address_2
description: The customer's address 2.
description: The address's second line.
city:
type: string
title: city
description: The customer's city.
description: The address's city.
country_code:
type: string
title: country_code
description: The customer's country code.
description: The address's country code.
province:
type: string
title: province
description: The customer's province.
description: The address's province.
postal_code:
type: string
title: postal_code
description: The customer's postal code.
description: The address's postal code.
address_name:
type: string
title: address_name
description: The customer's address name.
description: The address's name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: The customer's is default shipping.
description: >-
Whether the address is used by default for shipping during
checkout.
is_default_billing:
type: boolean
title: is_default_billing
description: The customer's is default billing.
description: >-
Whether the address is used by default for billing during
checkout.
metadata:
type: object
description: Holds custom key-value pairs.
x-codeSamples:
- lang: Shell
label: cURL
@@ -200,15 +210,18 @@ post:
x-workflow: updateCustomerAddressesWorkflow
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.
summary: Remove Customer's Address
x-sidebar-summary: Remove Address
description: Remove an address of the logged-in customer.
x-authenticated: true
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#delete-customer-address
description: 'Storefront guide: How to delete a customer''s address.'
parameters:
- name: address_id
in: path
description: The customer's address id.
description: The address's ID.
required: true
schema:
type: string
@@ -257,7 +270,7 @@ delete:
schema:
allOf:
- type: object
description: SUMMARY
description: The deletion's details.
required:
- id
- object
@@ -266,21 +279,23 @@ delete:
id:
type: string
title: id
description: The customer's ID.
description: The address's ID.
object:
type: string
title: object
description: The name of the deleted object.
default: address
deleted:
type: boolean
title: deleted
description: Whether the Customer was deleted.
description: Whether the address was deleted.
- type: object
description: SUMMARY
description: The deletion's details.
properties:
parent:
$ref: ../components/schemas/StoreCustomer.yaml
description: SUMMARY
description: The details of the customer the address belongs to.
description: The deletion's details.
'400':
$ref: ../components/responses/400_error.yaml
'401':
www/apps/api-reference/specs/store/paths/store_orders.yaml
+7 -6
View File
@@ -1,9 +1,10 @@
get:
operationId: GetOrders
summary: List Orders
summary: List Logged-in Customer's Orders
x-sidebar-summary: List Orders
description: >-
Retrieve a list of orders. The orders can be filtered by fields such as
`id`. The orders can also be sorted or paginated.
Retrieve the orders of the logged-in customer. The orders can be filtered by
fields such as `id`. The orders can also be sorted or paginated.
x-authenticated: true
parameters:
- name: expand
@@ -68,13 +69,13 @@ get:
oneOf:
- type: string
title: id
description: The order's ID.
description: Filter by an order ID.
- type: array
description: The order's ID.
description: Filter by order IDs.
items:
type: string
title: id
description: The id's ID.
description: An order ID.
- name: $and
in: query
required: false
www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
+2 -2
View File
@@ -1,8 +1,8 @@
get:
operationId: GetOrdersId
summary: Get a Order
summary: Get an Order
description: >-
Retrieve a order by its ID. You can expand the order's relations or select
Retrieve an order by its ID. You can expand the order's relations or select
the fields that should be returned.
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/store_payment-collections.yaml
+7 -1
View File
@@ -1,7 +1,13 @@
post:
operationId: PostPaymentCollections
summary: Create Payment Collection
description: Create a payment collection.
description: >-
Create a payment collection for a cart. This is used during checkout, where
the payment collection holds the cart's payment sessions.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false
parameters:
- name: expand
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml
+25 -6
View File
@@ -1,7 +1,16 @@
post:
operationId: PostPaymentCollectionsIdPaymentSessions
summary: Add Payment Sessions to Payment Collection
description: Add a list of payment sessions to a payment collection.
summary: Initialize Payment Session of a Payment Collection
x-sidebar-summary: Initialize Payment Session
description: >-
Initialize and add a payment session to a payment collection. This is used
during checkout, where you create a payment collection for the cart, then
initialize a payment session for the payment provider that the customer
chooses.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false
parameters:
- name: id
@@ -41,20 +50,30 @@ post:
application/json:
schema:
type: object
description: SUMMARY
description: The payment session's details.
required:
- provider_id
properties:
provider_id:
type: string
title: provider_id
description: The payment collection's provider id.
description: The ID of the payment provider the customer chose.
example: pp_stripe_stripe
context:
type: object
description: The payment collection's context.
description: >-
The payment's context, such as the customer or address details.
If the customer is logged-in, the customer `id` is set in the
context under a `customer.id` property.
data:
type: object
description: The payment collection's data.
description: >-
Any data necessary for the payment provider to process the
payment.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
description: Learn more about the payment session's data property
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_payment-providers.yaml
+18 -11
View File
@@ -2,10 +2,13 @@ get:
operationId: GetPaymentProviders
summary: List Payment Providers
description: >-
Retrieve a list of payment providers. The payment providers can be filtered
by fields such as `id`. The payment providers can also be sorted or
paginated.
Retrieve a list of payment providers. You must provide the `region_id` query
parameter to retrieve the payment providers enabled in that region.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.'
parameters:
- name: expand
in: query
@@ -64,12 +67,14 @@ get:
with `-`.
- name: region_id
in: query
description: The payment provider's region id.
description: >-
Filter by a region ID to get the payment providers enabled in that
region.
required: true
schema:
type: string
title: region_id
description: The payment provider's region id.
description: Filter by a region ID.
x-codeSamples:
- lang: Shell
label: cURL
@@ -85,7 +90,7 @@ get:
schema:
allOf:
- type: object
description: SUMMARY
description: The list of payment providers.
required:
- limit
- offset
@@ -94,23 +99,25 @@ get:
limit:
type: number
title: limit
description: The payment provider's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The payment provider's offset.
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The payment provider's count.
description: The total number of items.
- type: object
description: SUMMARY
description: The list of payment providers.
required:
- payment_providers
properties:
payment_providers:
type: array
description: The payment provider's payment providers.
description: The list of payment providers.
items:
$ref: ../components/schemas/StorePaymentProvider.yaml
'400':
www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+111 -133
View File
@@ -6,6 +6,10 @@ get:
filtered by fields such as `id`. The product categories can also be sorted
or paginated.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
description: 'Storefront guide: How to retrieve a list of product categories.'
parameters:
- name: expand
in: query
@@ -64,12 +68,12 @@ get:
with `-`.
- name: q
in: query
description: The product category's q.
description: Search term to filter the product category's properties.
required: false
schema:
type: string
title: q
description: The product category's q.
description: Search term to filter the product category's properties.
- name: id
in: query
required: false
@@ -77,13 +81,13 @@ get:
oneOf:
- type: string
title: id
description: The product category's ID.
description: Filter by a product category's ID.
- type: array
description: The product category's ID.
description: Filter by product category IDs.
items:
type: string
title: id
description: The id's ID.
description: A product category ID.
- name: description
in: query
required: false
@@ -91,13 +95,19 @@ get:
oneOf:
- type: string
title: description
description: The product category's description.
description: >-
Filter by a description. This only matches categories with the
exact description. To search by a term or keyword, use the `q`
query parameter instead.
- type: array
description: The product category's description.
description: >-
Filter by descriptions. This only matches categories that have one
of the provided descriptions. To search by a term or keyword, use
the `q` query parameter instead.
items:
type: string
title: description
description: The description's details.
description: A description.
- name: handle
in: query
required: false
@@ -105,13 +115,13 @@ get:
oneOf:
- type: string
title: handle
description: The product category's handle.
description: Filter by a category's handle.
- type: array
description: The product category's handle.
description: Filter by category handles.
items:
type: string
title: handle
description: The handle's details.
description: A handle.
- name: parent_category_id
in: query
required: false
@@ -119,36 +129,44 @@ get:
oneOf:
- type: string
title: parent_category_id
description: The product category's parent category id.
description: The ID of a category to retrieve its child categories.
- type: array
description: The product category's parent category id.
description: The ID of categories to retrieve their child categories.
items:
type: string
title: parent_category_id
description: The parent category id's details.
description: A product category's ID.
- name: include_ancestors_tree
in: query
description: The product category's include ancestors tree.
description: >-
Whether to retrieve the category's parent. When enabled, the parent
category is set in the `parent_category` property.
required: false
schema:
type: boolean
title: include_ancestors_tree
description: The product category's include ancestors tree.
description: >-
Whether to retrieve the category's parent. When enabled, the parent
category is set in the `parent_category` property.
- name: include_descendants_tree
in: query
description: The product category's include descendants tree.
description: >-
Whether to retrieve a list of child categories. When enabled, the parent
categories are added to the `category_children` property.
required: false
schema:
type: boolean
title: include_descendants_tree
description: The product category's include descendants tree.
description: >-
Whether to retrieve a list of child categories. When enabled, the
parent categories are added to the `category_children` property.
- name: created_at
in: query
description: The product category's created at.
description: Filter by the category's creation date.
required: false
schema:
type: object
description: The product category's created at.
description: Filter by the category's creation date.
properties:
$and:
type: array
@@ -172,11 +190,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -187,21 +205,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -229,50 +245,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -323,9 +335,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -334,16 +344,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -351,15 +359,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -406,32 +410,32 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at
in: query
description: The product category's updated at.
description: Filter by the category's update date.
required: false
schema:
type: object
description: The product category's updated at.
description: Filter by the category's update date.
properties:
$and:
type: array
@@ -455,11 +459,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -470,21 +474,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -512,50 +514,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -606,9 +604,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -617,16 +613,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -634,15 +628,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -689,32 +679,32 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at
in: query
description: The product category's deleted at.
description: Filter by the category's deletion date.
required: false
schema:
type: object
description: The product category's deleted at.
description: Filter by the category's deletion date.
properties:
$and:
type: array
@@ -738,11 +728,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -753,21 +743,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -795,50 +783,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -889,9 +873,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -900,16 +882,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -917,15 +897,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -972,21 +948,21 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -996,7 +972,9 @@ get:
required: false
schema:
type: array
description: The product category's $and.
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
@@ -1016,13 +994,13 @@ get:
oneOf:
- type: string
title: name
description: The product category's name.
description: Filter by a product category name.
- type: array
description: The product category's name.
description: Filter by product category names.
items:
type: string
title: name
description: The name's details.
description: A product category name.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
+16 -4
View File
@@ -5,6 +5,10 @@ get:
Retrieve a product category by its ID. You can expand the product category's
relations or select the fields that should be returned.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve
description: 'Storefront guide: How to retrieve a product category.'
parameters:
- name: id
in: path
@@ -40,20 +44,28 @@ get:
prefix it will replace the entire default fields.
- name: include_ancestors_tree
in: query
description: The product category's include ancestors tree.
description: >-
Whether to retrieve the category's parent. When enabled, the parent
category is set in the `parent_category` property.
required: false
schema:
type: boolean
title: include_ancestors_tree
description: The product category's include ancestors tree.
description: >-
Whether to retrieve the category's parent. When enabled, the parent
category is set in the `parent_category` property.
- name: include_descendants_tree
in: query
description: The product category's include descendants tree.
description: >-
Whether to retrieve a list of child categories. When enabled, the parent
categories are added to the `category_children` property.
required: false
schema:
type: boolean
title: include_descendants_tree
description: The product category's include descendants tree.
description: >-
Whether to retrieve a list of child categories. When enabled, the
parent categories are added to the `category_children` property.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_products.yaml
+298 -209
View File
File diff suppressed because it is too large Load Diff
www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+35 -8
View File
@@ -5,6 +5,10 @@ get:
Retrieve a product by its ID. You can expand the product's relations or
select the fields that should be returned.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters:
- name: id
in: path
@@ -40,36 +44,59 @@ get:
prefix it will replace the entire default fields.
- name: region_id
in: query
description: The product's region id.
description: >-
The ID of the region the product is being viewed from. This is required
if you're retrieving product variant prices with taxes.
required: false
schema:
type: string
title: region_id
description: The product's region id.
description: >-
The ID of the region the product is being viewed from. This is
required if you're retrieving product variant prices with taxes.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: country_code
in: query
description: The product's country code.
description: >-
The country code the product is being viewed from. This is required if
you're retrieving product variant prices with taxes.
required: false
schema:
type: string
title: country_code
description: The product's country code.
description: >-
The country code the product is being viewed from. This is required if
you're retrieving product variant prices with taxes.
- name: province
in: query
description: The product's province.
description: >-
The province the product is being viewed from. This is useful to narrow
down the tax context when calculating product variant prices with taxes.
required: false
schema:
type: string
title: province
description: The product's province.
description: >-
The province the product is being viewed from. This is useful to
narrow down the tax context when calculating product variant prices
with taxes.
- name: cart_id
in: query
description: The product's cart id.
description: >-
The ID of the customer's cart. If set, the cart's region and shipping
address's country code and province are used instead of the `region_id`,
`country_code`, and `province` properties.
required: false
schema:
type: string
title: cart_id
description: The product's cart id.
description: >-
The ID of the customer's cart. If set, the cart's region and shipping
address's country code and province are used instead of the
`region_id`, `country_code`, and `province` properties.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_regions.yaml
+27 -561
View File
@@ -5,6 +5,9 @@ get:
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
externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list
description: 'Storefront guide: How to retrieve a list of regions.'
parameters:
- name: expand
in: query
@@ -63,12 +66,12 @@ get:
with `-`.
- name: q
in: query
description: The region's q.
description: Search term to filter the region's searchable properties.
required: false
schema:
type: string
title: q
description: The region's q.
description: Search term to filter the region's searchable properties.
- name: id
in: query
required: false
@@ -76,552 +79,13 @@ get:
oneOf:
- type: string
title: id
description: The region's ID.
description: Filter by a region's ID.
- type: array
description: The region's ID.
description: Filter by region IDs.
items:
type: string
title: id
description: The id's ID.
- type: object
description: The region's ID.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
oneOf:
- type: string
title: $ne
description: Filter by values not equal to this parameter.
- type: array
description: Filter by values not equal to this parameter.
items:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
oneOf:
- type: string
title: $in
description: Filter by values in this array.
- type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
oneOf:
- type: string
title: $nin
description: Filter by values not in this array.
- type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each
object's content is the same type as the expected
query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each
object's content is the same type as the expected
query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in
this parameter.
- type: object
description: >-
Filter by values not matching the conditions in
this parameter.
- type: array
description: >-
Filter by values not matching the conditions in
this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in
this parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful
for numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for
strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of
this parameter.
$contained:
type: array
description: >-
Filter arrays that contain all values of this
parameter.
items:
type: string
title: $contained
description: >-
Filter arrays that contain all values of this
parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists
(not `null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition.
Each object's content is the same type as the
expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each
object's content is the same type as the
expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions
in this parameter.
- type: object
description: >-
Filter by values not matching the conditions
in this parameter.
- type: array
description: >-
Filter by values not matching the conditions
in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the
conditions in this parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter.
Useful for numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter.
Useful for numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this
parameter. Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful
for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with
this parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values
with this parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of
this parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values
of this parameter.
$contained:
type: array
description: >-
Filter arrays that contain all values of this
parameter.
items:
type: string
title: $contained
description: >-
Filter arrays that contain all values of this
parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter
exists (not `null`).
$gt:
oneOf:
- type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
- type: array
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
items:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
oneOf:
- type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
- type: array
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
items:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
oneOf:
- type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
- type: array
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
items:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
oneOf:
- type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
- type: array
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
items:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
description: A region's ID.
- name: name
in: query
required: false
@@ -629,13 +93,29 @@ get:
oneOf:
- type: string
title: name
description: The region's name.
description: Filter by a region name.
- type: array
description: The region's name.
description: Filter by region names.
items:
type: string
title: name
description: The name's details.
description: A region's name.
- name: currency_code
in: query
required: false
schema:
oneOf:
- type: string
title: currency_code
description: Filter by a currency code to retrieve regions that use that code.
- type: array
description: >-
Filter by currency codes to retrieve regions that use one of these
codes.
items:
type: string
title: currency_code
description: A currency code.
- name: $and
in: query
description: >-
@@ -664,20 +144,6 @@ get:
items:
type: object
title: $or
- name: currency_code
in: query
required: false
schema:
oneOf:
- type: string
title: currency_code
description: The region's currency code.
- type: array
description: The region's currency code.
items:
type: string
title: currency_code
description: The currency code's details.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
+10 -8
View File
@@ -2,8 +2,8 @@ get:
operationId: GetReturnReasons
summary: List Return Reasons
description: >-
Retrieve a list of return reasons. The return reasons can be filtered by
fields such as `id`. The return reasons can also be sorted or paginated.
Retrieve a list of return reasons. The return reasons can be sorted or
paginated.
x-authenticated: false
parameters:
- name: expand
@@ -76,7 +76,7 @@ get:
schema:
allOf:
- type: object
description: SUMMARY
description: The paginated list of return reasons.
required:
- limit
- offset
@@ -85,23 +85,25 @@ get:
limit:
type: number
title: limit
description: The return reason's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The return reason's offset.
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The return reason's count.
description: The total number of items.
- type: object
description: SUMMARY
description: The paginated list of return reasons.
required:
- return_reasons
properties:
return_reasons:
type: array
description: The return reason's return reasons.
description: The list of return reasons.
items:
$ref: ../components/schemas/StoreReturnReason.yaml
'400':
www/apps/api-reference/specs/store/paths/store_return.yaml
+3 -1
View File
@@ -1,7 +1,9 @@
post:
operationId: PostReturn
summary: Create Return
description: Create a return.
description: >-
Create a return for an order's items. The admin receives the return and
process it from their side.
x-authenticated: false
requestBody:
content:
www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+13 -6
View File
@@ -1,9 +1,16 @@
get:
operationId: GetShippingOptions
summary: List Shipping Options
description: >-
Retrieve a list of shipping options. The shipping options can be filtered by
fields such as `id`. The shipping options can also be sorted or paginated.
summary: List Shipping Options for Cart
description: >
Retrieve a list of shipping options for a cart. The cart's ID is set in the
required `cart_id` query parameter.
The shipping options also be sorted or paginated.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false
parameters:
- name: fields
@@ -53,12 +60,12 @@ get:
with `-`.
- name: cart_id
in: query
description: The shipping option's cart id.
description: The ID of the cart to retrieve its shipping options.
required: true
schema:
type: string
title: cart_id
description: The shipping option's cart id.
description: The ID of the cart to retrieve its shipping options.
- name: $and
in: query
description: >-