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

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]andShahed Nasser authored and GitHub committed 2024-10-03 07:48:54 +00:00
1 parent 97c193be1b
commit 21badd069d
894 files changed
+35649 -28168

No files matched your search

@@ -71,7 +71,7 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: "line-item"
* default: line-item
* deleted:
* type: boolean
* title: deleted
@@ -69,7 +69,7 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: "address"
* default: address
* deleted:
* type: boolean
* title: deleted
@@ -883,14 +883,6 @@
* 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 country code the products are 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 country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
* - name: province
* in: query
* description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
@@ -899,14 +891,6 @@
* type: string
* title: province
* description: The province the products are 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 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 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.
* - name: sales_channel_id
* in: query
* required: false
@@ -935,6 +919,38 @@
* type: string
* title: category_id
* description: A product category's ID.
* - name: currency_code
* in: query
* description: The currency code to retrieve prices in.
* required: false
* schema:
* type: string
* title: currency_code
* description: The currency code to retrieve prices in.
* - name: variants
* in: query
* description: Filter the products' variants.
* required: false
* schema:
* type: object
* description: Filter the products' variants.
* x-schemaName: StoreProductVariantParams
* properties:
* options:
* type: object
* description: Filter by the variants' options.
* required:
* - value
* - option_id
* properties:
* option_id:
* type: string
* title: option_id
* description: The ID of the option to filter by.
* value:
* type: string
* title: value
* description: Filter by a value of the option.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -34,8 +34,7 @@
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/store/regions/{id}'
* source: curl '{backend_url}/store/regions/{id}'
* tags:
* - Regions
* responses:
@@ -2,10 +2,9 @@
* @oas [get] /store/shipping-options
* operationId: GetShippingOptions
* summary: List Shipping Options for Cart
* description: >
* 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
@@ -96,8 +96,8 @@
* type: string
* title: type
* 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.
* 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"
* "401":
@@ -70,6 +70,9 @@
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: createCustomerAccountWorkflow
* security:
* - cookie_auth: []
* - jwt_token: []
*
*/
@@ -3,7 +3,8 @@
* operationId: PostPaymentCollectionsIdPaymentSessions
* 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.
* 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."