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

chore(docs): Updated API Reference (automated) (#13794)

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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-10-21 09:14:39 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 1d63ed8ce9
commit 3d0f4086b4
67 changed files with 2475 additions and 525 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/openapi.full.yaml
+445 -163
View File
@@ -1300,6 +1300,19 @@ paths:
description: Comma-separated fields that should be included in the returned data. 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.
externalDocs:
url: '#select-fields-and-relations'
security:
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
type: object
description: Optional additional data to pass to the underlying workflow.
properties:
additional_data:
type: object
description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -1363,19 +1376,6 @@ paths:
description: Emitted when the customer in the cart is transferred.
deprecated: false
since: 2.8.0
security:
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
type: object
description: Optional additional data to pass to the underlying workflow.
properties:
additional_data:
type: object
description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
/store/carts/{id}/gift-cards:
post:
operationId: PostCartsIdGiftCards
@@ -2915,6 +2915,20 @@ paths:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
- name: id
in: query
required: false
schema:
oneOf:
- type: string
title: id
description: Filter by a collection's ID.
- type: array
description: Filter by collection IDs.
items:
type: string
title: id
description: The collection's ID.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -10475,6 +10489,7 @@ components:
- currency_code
- limit
- used
- attribute
properties:
id:
type: string
@@ -10500,6 +10515,12 @@ components:
title: used
description: |
How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds the number of times the campaign's promotions have been used so far.
attribute:
type: string
title: attribute
description: The cart attribute to limit the budget by.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/promotion/campaign#attribute-based-budgets
created_at:
type: string
format: date-time
@@ -10994,6 +11015,59 @@ components:
enum:
- publishable
- secret
AdminCreateCalculatedShippingOption:
type: object
description: The calculated shipping option's details.
x-schemaName: AdminCreateCalculatedShippingOption
required:
- price_type
- name
- service_zone_id
- shipping_profile_id
- provider_id
properties:
price_type:
type: string
title: price_type
description: The calculated shipping option's price type.
enum:
- calculated
- flat
name:
type: string
title: name
description: The calculated shipping option's name.
service_zone_id:
type: string
title: service_zone_id
description: The ID of the associated service zone.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the associated shipping profile.
data:
type: object
description: The calculated shipping option's data.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id:
type: string
title: provider_id
description: The ID of the fulfillment provider handling this calculated shipping option.
type:
$ref: '#/components/schemas/AdminCreateShippingOptionType'
type_id:
type: string
title: type_id
description: The ID of the shipping option type that this shipping option belongs to.
rules:
type: array
description: The calculated shipping option's rules.
items:
$ref: '#/components/schemas/AdminCreateShippingOptionRule'
metadata:
type: object
description: The shipping option's metadata, can hold custom key-value pairs.
AdminCreateCustomerGroup:
type: object
description: The customer group's details.
@@ -11011,6 +11085,153 @@ components:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
AdminCreateFlatRateShippingOption:
type: object
description: The flat rate shipping option's details.
x-schemaName: AdminCreateFlatRateShippingOption
required:
- price_type
- prices
- name
- service_zone_id
- shipping_profile_id
- provider_id
properties:
name:
type: string
title: name
description: The flat-rate shipping option's name.
service_zone_id:
type: string
title: service_zone_id
description: The ID of the associated service zone.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the associated shipping profile.
data:
type: object
description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing.
externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
price_type:
type: string
description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider.
enum:
- flat
- calculated
provider_id:
type: string
title: provider_id
description: The ID of the fulfillment provider handling this shipping option.
type:
$ref: '#/components/schemas/AdminCreateShippingOptionType'
prices:
type: array
description: The shipping option's prices.
items:
oneOf:
- type: object
description: The price's details.
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
required:
- currency_code
- amount
properties:
currency_code:
type: string
title: currency_code
description: The price's currency code.
example: usd
amount:
type: number
title: amount
description: The price's amount.
rules:
type: array
description: The price's rules.
items:
type: object
description: The rule's details.
x-schemaName: PriceRule
required:
- attribute
- operator
- value
properties:
attribute:
type: string
title: attribute
description: The rule's attribute.
operator:
type: string
description: The rule's operator.
enum:
- gt
- lt
- eq
- lte
- gte
value:
type: number
title: value
description: The rule's value.
- type: object
description: The price's details.
x-schemaName: AdminCreateShippingOptionPriceWithRegion
required:
- region_id
- amount
properties:
region_id:
type: string
title: region_id
description: The ID of the region this price is used in.
amount:
type: number
title: amount
description: The price's amount.
rules:
type: array
description: The price's rules.
items:
type: object
description: The rule's details.
x-schemaName: PriceRule
required:
- attribute
- operator
- value
properties:
attribute:
type: string
title: attribute
description: The rule's attribute.
operator:
type: string
description: The rule's operator.
enum:
- gt
- lt
- eq
- lte
- gte
value:
type: number
title: value
description: The rule's value.
type_id:
type: string
title: type_id
description: The ID of the shipping option type that this shipping option belongs to.
rules:
type: array
description: The shipping option's rules.
items:
$ref: '#/components/schemas/AdminCreateShippingOptionRule'
metadata:
type: object
description: The shipping option's metadata.
AdminCreateFulfillment:
type: object
description: The filfillment's details.
@@ -12084,6 +12305,7 @@ components:
x-schemaName: AdminCreateRefundReason
required:
- label
- code
properties:
label:
type: string
@@ -12093,6 +12315,13 @@ components:
type: string
title: description
description: The refund reason's description.
code:
type: string
title: code
description: The refund reason's code.
metadata:
type: object
description: The refund reason's metadata. Can hold custom key-value pairs.
AdminCreateRegion:
type: object
description: The region's details.
@@ -12260,92 +12489,6 @@ components:
type: string
title: label_url
description: The label's URL.
AdminCreateShippingOption:
type: object
description: The shipping option's details.
x-schemaName: AdminCreateShippingOption
required:
- name
- service_zone_id
- shipping_profile_id
- price_type
- provider_id
- prices
properties:
name:
type: string
title: name
description: The shipping option's name.
service_zone_id:
type: string
title: service_zone_id
description: The ID of the associated service zone.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the associated shipping profile.
data:
type: object
description: The shipping option's data, useful for the fulfillment provider handling its processing.
externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
price_type:
type: string
description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider.
enum:
- flat
- calculated
provider_id:
type: string
title: provider_id
description: The ID of the fulfillment provider handling this shipping option.
type:
$ref: '#/components/schemas/AdminCreateShippingOptionType'
prices:
type: array
description: The shipping option's prices.
items:
oneOf:
- type: object
description: The price's details.
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
required:
- currency_code
- amount
properties:
currency_code:
type: string
title: currency_code
description: The price's currency code.
example: usd
amount:
type: number
title: amount
description: The price's amount.
- type: object
description: The price's details.
x-schemaName: AdminCreateShippingOptionPriceWithRegion
required:
- region_id
- amount
properties:
region_id:
type: string
title: region_id
description: The ID of the region this price is used in.
amount:
type: number
title: amount
description: The price's amount.
rules:
type: array
description: The shipping option's rules.
items:
$ref: '#/components/schemas/AdminCreateShippingOptionRule'
type_id:
type: string
title: type_id
description: The ID of the shipping option type that this shipping option belongs to.
AdminCreateShippingOptionRule:
type: object
description: The details of the shipping option rule.
@@ -20507,7 +20650,7 @@ components:
payment:
$ref: '#/components/schemas/BasePayment'
refund_reason:
$ref: '#/components/schemas/RefundReason'
$ref: '#/components/schemas/BaseRefundReason'
AdminRefundReason:
type: object
description: The refund reason's details.
@@ -20515,7 +20658,7 @@ components:
required:
- id
- label
- metadata
- code
- created_at
- updated_at
properties:
@@ -20547,6 +20690,32 @@ components:
format: date-time
title: updated_at
description: The date the refund reason was updated.
code:
type: string
title: code
description: The refund reason's code.
AdminRefundReasonDeleteResponse:
type: object
description: The deletion's details.
required:
- id
- object
- deleted
properties:
id:
type: string
title: id
description: The refund reason's ID.
object:
type: string
title: object
description: The name of the deleted object.
default: refund_reason
deleted:
type: boolean
title: deleted
description: Whether the refund reason was deleted.
x-schemaName: AdminRefundReasonDeleteResponse
AdminRegion:
type: object
description: The region's details.
@@ -23246,6 +23415,10 @@ components:
type: string
title: description
description: The refund reason's description.
code:
type: string
title: code
description: The refund reason's code.
x-schemaName: AdminUpdatePaymentRefundReason
AdminUpdatePriceList:
type: object
@@ -25106,17 +25279,6 @@ components:
- unit_price
- cart
- cart_id
- original_total
- original_subtotal
- original_tax_total
- item_total
- item_subtotal
- item_tax_total
- total
- subtotal
- tax_total
- discount_total
- discount_tax_total
properties:
id:
type: string
@@ -25302,14 +25464,6 @@ components:
- is_tax_inclusive
- created_at
- updated_at
- original_total
- original_subtotal
- original_tax_total
- total
- subtotal
- tax_total
- discount_total
- discount_tax_total
properties:
id:
type: string
@@ -27797,7 +27951,50 @@ components:
payment:
type: object
refund_reason:
$ref: '#/components/schemas/RefundReason'
$ref: '#/components/schemas/BaseRefundReason'
BaseRefundReason:
type: object
description: The refund reason's details.
x-schemaName: BaseRefundReason
required:
- id
- label
- code
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The refund reason's ID.
label:
type: string
title: label
description: The refund reason's label.
description:
type: string
title: description
description: The refund reason's description.
metadata:
type: object
description: The refund reason's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
description: Learn how to manage metadata
created_at:
type: string
format: date-time
title: created_at
description: The date the refund reason was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the refund reason was updated.
code:
type: string
title: code
description: The refund reason's code.
BaseRegion:
type: object
description: The region's details.
@@ -30302,45 +30499,6 @@ components:
type: number
title: version
description: The order version that the transaction belongs to.
RefundReason:
type: object
description: The refund reason's details.
x-schemaName: RefundReason
required:
- id
- label
- metadata
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The refund reason's ID.
label:
type: string
title: label
description: The refund reason's label.
description:
type: string
title: description
description: The refund reason's description.
metadata:
type: object
description: The refund reason's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
description: Learn how to manage metadata
created_at:
type: string
format: date-time
title: created_at
description: The date the refund reason was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the refund reason was updated.
RefundReasonResponse:
type: object
description: The refund reason's details.
@@ -39911,16 +40069,140 @@ components:
description: Learn how to manage metadata
StoreShippingOptionListResponse:
type: object
description: The shipping option's details.
description: The list of shipping options.
x-schemaName: StoreShippingOptionListResponse
required:
- shipping_options
properties:
shipping_options:
type: array
description: The shipping option's shipping options.
description: The list of shipping options.
items:
$ref: '#/components/schemas/StoreCartShippingOption'
allOf:
- $ref: '#/components/schemas/StoreCartShippingOption'
- type: object
description: The shipping option's details.
required:
- service_zone
properties:
service_zone:
type: object
description: The shipping option's service zone.
required:
- id
- fulfillment_set_id
- fulfillment_set
properties:
id:
type: string
title: id
description: The service zone's ID.
fulfillment_set_id:
type: string
title: fulfillment_set_id
description: The ID of the service zone's fulfillment set.
fulfillment_set:
type: object
description: The service zone's fulfillment set.
required:
- id
- type
- location
properties:
id:
type: string
title: id
description: The fulfillment set's ID.
type:
type: string
title: type
description: The fulfillment set's type.
location:
type: object
description: The fulfillment set's location details.
required:
- id
- address
properties:
id:
type: string
title: id
description: The location's ID.
address:
type: object
description: The location's address.
x-schemaName: StoreFulfillmentAddress
required:
- id
- company
- address_1
- address_2
- city
- country_code
- province
- postal_code
- phone
- metadata
- created_at
- updated_at
- deleted_at
properties:
id:
type: string
title: id
description: The address's ID.
company:
type: string
title: company
description: The address's company.
address_1:
type: string
title: address_1
description: The first line of the address.
address_2:
type: string
title: address_2
description: The second line of the address.
city:
type: string
title: city
description: The address's city.
country_code:
type: string
title: country_code
description: The address's country code.
example: us
province:
type: string
title: province
description: The address's province.
postal_code:
type: string
title: postal_code
description: The address's postal code.
phone:
type: string
title: phone
description: The address's phone.
metadata:
type: object
description: The address's metadata. Can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The date the address was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the address was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the address was deleted.
description: The shipping option's details.
StoreShippingOptionResponse:
type: object
description: The shipping option's details.