chore(docs): Updated API Reference (automated) (#13794)
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]
committed by
GitHub
GitHub
parent
1d63ed8ce9
commit
3d0f4086b4
@@ -51,6 +51,7 @@ properties:
|
||||
- currency_code
|
||||
- limit
|
||||
- used
|
||||
- attribute
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -82,6 +83,13 @@ properties:
|
||||
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
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
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: ./AdminCreateShippingOptionType.yaml
|
||||
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: ./AdminCreateShippingOptionRule.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The shipping option's metadata, can hold custom key-value pairs.
|
||||
@@ -1,18 +1,18 @@
|
||||
type: object
|
||||
description: The shipping option's details.
|
||||
x-schemaName: AdminCreateShippingOption
|
||||
description: The flat rate shipping option's details.
|
||||
x-schemaName: AdminCreateFlatRateShippingOption
|
||||
required:
|
||||
- price_type
|
||||
- prices
|
||||
- name
|
||||
- service_zone_id
|
||||
- shipping_profile_id
|
||||
- price_type
|
||||
- provider_id
|
||||
- prices
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The shipping option's name.
|
||||
description: The flat-rate shipping option's name.
|
||||
service_zone_id:
|
||||
type: string
|
||||
title: service_zone_id
|
||||
@@ -24,8 +24,8 @@ properties:
|
||||
data:
|
||||
type: object
|
||||
description: >-
|
||||
The shipping option's data, useful for the fulfillment provider handling
|
||||
its processing.
|
||||
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
|
||||
@@ -65,6 +65,35 @@ properties:
|
||||
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
|
||||
@@ -80,12 +109,44 @@ properties:
|
||||
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: ./AdminCreateShippingOptionRule.yaml
|
||||
type_id:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The ID of the shipping option type that this shipping option belongs to.
|
||||
metadata:
|
||||
type: object
|
||||
description: The shipping option's metadata.
|
||||
@@ -3,6 +3,7 @@ description: The refund reason's details.
|
||||
x-schemaName: AdminCreateRefundReason
|
||||
required:
|
||||
- label
|
||||
- code
|
||||
properties:
|
||||
label:
|
||||
type: string
|
||||
@@ -12,3 +13,10 @@ properties:
|
||||
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.
|
||||
|
||||
@@ -35,4 +35,4 @@ properties:
|
||||
payment:
|
||||
$ref: ./BasePayment.yaml
|
||||
refund_reason:
|
||||
$ref: ./RefundReason.yaml
|
||||
$ref: ./BaseRefundReason.yaml
|
||||
|
||||
@@ -4,7 +4,7 @@ x-schemaName: AdminRefundReason
|
||||
required:
|
||||
- id
|
||||
- label
|
||||
- metadata
|
||||
- code
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
@@ -36,3 +36,7 @@ properties:
|
||||
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.
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
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
|
||||
@@ -9,4 +9,8 @@ properties:
|
||||
type: string
|
||||
title: description
|
||||
description: The refund reason's description.
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The refund reason's code.
|
||||
x-schemaName: AdminUpdatePaymentRefundReason
|
||||
|
||||
@@ -11,17 +11,6 @@ required:
|
||||
- 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
|
||||
|
||||
@@ -9,14 +9,6 @@ required:
|
||||
- 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
|
||||
|
||||
@@ -35,4 +35,4 @@ properties:
|
||||
payment:
|
||||
type: object
|
||||
refund_reason:
|
||||
$ref: ./RefundReason.yaml
|
||||
$ref: ./BaseRefundReason.yaml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
type: object
|
||||
description: The refund reason's details.
|
||||
x-schemaName: RefundReason
|
||||
x-schemaName: BaseRefundReason
|
||||
required:
|
||||
- id
|
||||
- label
|
||||
- metadata
|
||||
- code
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
@@ -36,3 +36,7 @@ properties:
|
||||
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.
|
||||
@@ -1,11 +1,137 @@
|
||||
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: ./StoreCartShippingOption.yaml
|
||||
allOf:
|
||||
- $ref: ./StoreCartShippingOption.yaml
|
||||
- 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.
|
||||
|
||||
Reference in New Issue
Block a user