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

chore(docs): Generated API Reference (#3211)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-09 09:50:55 +02:00
committed by GitHub
parent 9997485c55
commit 14b2de94e2
952 changed files with 13745 additions and 9192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
docs/api/store/components/schemas/Address.yaml
View File

@@ -1,48 +1,71 @@
title: Address
description: An address.
type: object
required:
- address_1
- address_2
- city
- company
- country_code
- created_at
- customer_id
- deleted_at
- first_name
- id
- last_name
- metadata
- phone
- postal_code
- province
- updated_at
properties:
id:
type: string
description: ID of the address
example: addr_01G8ZC9VS1XVE149MGH2J7QSSH
customer_id:
type: string
description: ID of the customer this address belongs to
nullable: true
type: string
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
customer:
description: Available if the relation `customer` is expanded.
type: array
items:
type: object
description: A customer object.
nullable: true
type: object
company:
type: string
description: Company name
nullable: true
type: string
example: Acme
first_name:
type: string
description: First name
nullable: true
type: string
example: Arno
last_name:
type: string
description: Last name
nullable: true
type: string
example: Willms
address_1:
type: string
description: Address line 1
nullable: true
type: string
example: 14433 Kemmer Court
address_2:
type: string
description: Address line 2
nullable: true
type: string
example: Suite 369
city:
type: string
description: City
nullable: true
type: string
example: South Geoffreyview
country_code:
type: string
description: The 2 character ISO code of the country in lower case
nullable: true
type: string
externalDocs:
url: >-
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
@@ -50,18 +73,22 @@ properties:
example: st
country:
description: A country object. Available if the relation `country` is expanded.
type: object
nullable: true
$ref: ./Country.yaml
province:
type: string
description: Province
nullable: true
type: string
example: Kentucky
postal_code:
type: string
description: Postal Code
nullable: true
type: string
example: 72093
phone:
type: string
description: Phone Number
nullable: true
type: string
example: 16128234334802
created_at:
type: string
@@ -72,11 +99,13 @@ properties:
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

121
docs/api/store/components/schemas/BatchJob.yaml
View File

@@ -2,21 +2,36 @@ title: Batch Job
description: A Batch Job.
type: object
required:
- canceled_at
- completed_at
- confirmed_at
- context
- created_at
- created_by
- deleted_at
- dry_run
- failed_at
- id
- pre_processed_at
- processing_at
- result
- status
- type
- updated_at
properties:
id:
type: string
description: The unique identifier for the batch job.
type: string
example: batch_01G8T782965PYFG0751G0Z38B4
type:
type: string
description: The type of batch job.
type: string
enum:
- product-import
- product-export
status:
type: string
description: The status of the batch job.
type: string
enum:
- created
- pre_processed
@@ -27,17 +42,20 @@ properties:
- failed
default: created
created_by:
type: string
description: The unique identifier of the user that created the batch job.
nullable: true
type: string
example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
created_by_user:
description: A user object. Available if the relation `created_by_user` is expanded.
type: object
nullable: true
$ref: ./User.yaml
context:
type: object
description: >-
The context of the batch job, the type of the batch job determines what
the context should contain.
nullable: true
type: object
example:
shape:
prices:
@@ -55,43 +73,47 @@ properties:
- variant.prices
- images
dry_run:
type: boolean
description: Specify if the job must apply the modifications or not.
type: boolean
default: false
result:
type: object
description: The result of the batch job.
properties:
count:
type: number
advancement_count:
type: number
progress:
type: number
errors:
type: object
nullable: true
allOf:
- type: object
example: {}
- type: object
properties:
message:
count:
type: number
advancement_count:
type: number
progress:
type: number
errors:
type: object
properties:
message:
type: string
code:
oneOf:
- type: string
- type: number
err:
type: array
stat_descriptors:
type: object
properties:
key:
type: string
name:
type: string
message:
type: string
file_key:
type: string
code:
oneOf:
- type: string
- type: number
err:
type: array
stat_descriptors:
type: object
properties:
key:
type: string
name:
type: string
message:
type: string
file_key:
type: string
file_size:
type: number
file_size:
type: number
example:
errors:
- err: []
@@ -102,38 +124,45 @@ properties:
name: Product count to export
message: There will be 8 products exported by this action
pre_processed_at:
description: The date from which the job has been pre-processed.
nullable: true
type: string
description: The date from which the job has been pre processed.
format: date-time
processing_at:
type: string
description: The date the job is processing at.
nullable: true
type: string
format: date-time
confirmed_at:
type: string
description: The date when the confirmation has been done.
nullable: true
type: string
format: date-time
completed_at:
type: string
description: The date of the completion.
nullable: true
type: string
format: date-time
canceled_at:
type: string
description: The date of the concellation.
nullable: true
type: string
format: date-time
failed_at:
type: string
description: The date when the job failed.
nullable: true
type: string
format: date-time
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was last updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time

123
docs/api/store/components/schemas/Cart.yaml
View File

@@ -1,28 +1,51 @@
title: Cart
description: Represents a user cart
type: object
required:
- billing_address_id
- completed_at
- context
- created_at
- customer_id
- deleted_at
- email
- id
- idempotency_key
- metadata
- payment_authorized_at
- payment_id
- payment_session
- region_id
- shipping_address_id
- type
- updated_at
properties:
id:
type: string
description: The cart's ID
type: string
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
email:
type: string
description: The email associated with the cart
nullable: true
type: string
format: email
billing_address_id:
type: string
description: The billing address's ID
nullable: true
type: string
example: addr_01G8ZH853YPY9B94857DY91YGW
billing_address:
description: Available if the relation `billing_address` is expanded.
nullable: true
$ref: ./Address.yaml
shipping_address_id:
type: string
description: The shipping address's ID
nullable: true
type: string
example: addr_01G8ZH853YPY9B94857DY91YGW
shipping_address:
description: Available if the relation `shipping_address` is expanded.
nullable: true
$ref: ./Address.yaml
items:
description: Available if the relation `items` is expanded.
@@ -30,54 +53,58 @@ properties:
items:
$ref: ./LineItem.yaml
region_id:
type: string
description: The region's ID
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: A region object. Available if the relation `region` is expanded.
type: object
nullable: true
$ref: ./Region.yaml
discounts:
type: array
description: Available if the relation `discounts` is expanded.
items:
type: object
description: A discount object.
gift_cards:
type: array
description: Available if the relation `gift_cards` is expanded.
items:
type: object
description: A gift card object.
$ref: ./Discount.yaml
gift_cards:
description: Available if the relation `gift_cards` is expanded.
type: array
items:
$ref: ./GiftCard.yaml
customer_id:
type: string
description: The customer's ID
nullable: true
type: string
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
customer:
description: A customer object. Available if the relation `customer` is expanded.
nullable: true
type: object
payment_session:
description: The selected payment session in the cart.
nullable: true
$ref: ./PaymentSession.yaml
payment_sessions:
type: array
description: The payment sessions created on the cart.
type: array
items:
$ref: ./PaymentSession.yaml
payment_id:
type: string
description: The payment's ID if available
nullable: true
type: string
example: pay_01G8ZCC5W42ZNY842124G7P5R9
payment:
description: Available if the relation `payment` is expanded.
$ref: ./Payment.yaml
nullable: true
type: object
shipping_methods:
type: array
description: The shipping methods added to the cart.
type: array
items:
$ref: ./ShippingMethod.yaml
type:
type: string
description: The cart's type.
type: string
enum:
- default
- swap
@@ -86,89 +113,105 @@ properties:
- claim
default: default
completed_at:
type: string
description: The date with timezone at which the cart was completed.
nullable: true
type: string
format: date-time
payment_authorized_at:
type: string
description: The date with timezone at which the payment was authorized.
nullable: true
type: string
format: date-time
idempotency_key:
type: string
description: >-
Randomly generated key used to continue the completion of a cart in case
of failure.
nullable: true
type: string
externalDocs:
url: >-
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
description: Learn more how to use the idempotency key.
context:
type: object
description: The context of the cart which can include info like IP or user agent.
nullable: true
type: object
example:
ip: '::1'
user_agent: PostmanRuntime/7.29.2
sales_channel_id:
type: string
description: The sales channel ID the cart is associated with.
nullable: true
type: string
example: null
sales_channel:
description: >-
A sales channel object. Available if the relation `sales_channel` is
expanded.
type: object
nullable: true
$ref: ./SalesChannel.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white
shipping_total:
type: integer
description: The total of shipping
type: integer
example: 1000
discount_total:
type: integer
description: The total of discount
example: 800
tax_total:
type: integer
example: 800
item_tax_total:
description: The total of items with taxes
type: integer
example: 8000
shipping_tax_total:
description: The total of shipping with taxes
type: integer
example: 1000
tax_total:
description: The total of tax
type: integer
example: 0
refunded_total:
type: integer
description: >-
The total amount refunded if the order associated with this cart is
returned.
type: integer
example: 0
total:
type: integer
description: The total amount of the cart
type: integer
example: 8200
subtotal:
type: integer
description: The subtotal of the cart
type: integer
example: 8000
refundable_amount:
type: integer
description: The amount that can be refunded
type: integer
example: 8200
gift_card_total:
type: integer
description: The total of gift cards
type: integer
example: 0
gift_card_tax_total:
type: integer
description: The total of gift cards with taxes
type: integer
example: 0

24
docs/api/store/components/schemas/ClaimImage.yaml
View File

@@ -3,36 +3,44 @@ description: Represents photo documentation of a claim.
type: object
required:
- claim_item_id
- created_at
- deleted_at
- id
- metadata
- updated_at
- url
properties:
id:
type: string
description: The claim image's ID
type: string
example: cimg_01G8ZH853Y6TFXWPG5EYE81X63
claim_item_id:
type: string
description: The ID of the claim item associated with the image
type: string
claim_item:
description: A claim item object. Available if the relation `claim_item` is expanded.
type: object
nullable: true
$ref: ./ClaimItem.yaml
url:
type: string
description: The URL of the image
type: string
format: uri
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

30
docs/api/store/components/schemas/ClaimItem.yaml
View File

@@ -5,18 +5,24 @@ description: >-
type: object
required:
- claim_order_id
- created_at
- deleted_at
- id
- item_id
- variant_id
- reason
- metadata
- note
- quantity
- reason
- updated_at
- variant_id
properties:
id:
type: string
description: The claim item's ID
type: string
example: citm_01G8ZH853Y6TFXWPG5EYE81X63
images:
type: array
description: Available if the relation `images` is expanded.
type: array
items:
$ref: ./ClaimImage.yaml
claim_order_id:
@@ -24,6 +30,7 @@ properties:
type: string
claim_order:
description: A claim order object. Available if the relation `claim_order` is expanded.
nullable: true
type: object
item_id:
description: The ID of the line item that the claim item refers to.
@@ -31,6 +38,7 @@ properties:
example: item_01G8ZM25TN49YV9EQBE2NC27KC
item:
description: Available if the relation `item` is expanded.
nullable: true
$ref: ./LineItem.yaml
variant_id:
description: The ID of the product variant that is claimed.
@@ -38,7 +46,8 @@ properties:
example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
variant:
description: A variant object. Available if the relation `variant` is expanded.
type: object
nullable: true
$ref: ./ProductVariant.yaml
reason:
description: The reason for the claim
type: string
@@ -49,6 +58,7 @@ properties:
- other
note:
description: An optional note about the claim, for additional information
nullable: true
type: string
example: I don't like it.
quantity:
@@ -65,19 +75,21 @@ properties:
items:
$ref: ./ClaimTag.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

42
docs/api/store/components/schemas/ClaimOrder.yaml
View File

@@ -5,27 +5,41 @@ description: >-
contain additional information about fulfillments and returns.
type: object
required:
- type
- canceled_at
- created_at
- deleted_at
- fulfillment_status
- id
- idempotency_key
- metadata
- no_notification
- order_id
- payment_status
- refund_amount
- shipping_address_id
- type
- updated_at
properties:
id:
type: string
description: The claim's ID
type: string
example: claim_01G8ZH853Y6TFXWPG5EYE81X63
type:
description: The claim's type
type: string
enum:
- refund
- replace
payment_status:
type: string
description: The status of the claim's payment
type: string
enum:
- na
- not_refunded
- refunded
default: na
fulfillment_status:
description: The claim's fulfillment status
type: string
enum:
- not_fulfilled
@@ -56,18 +70,22 @@ properties:
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
order:
description: An order object. Available if the relation `order` is expanded.
nullable: true
type: object
return_order:
description: >-
A return object. Holds information about the return if the claim is to be
returned. Available if the relation 'return_order' is expanded
nullable: true
type: object
shipping_address_id:
description: The ID of the address that the new items should be shipped to
nullable: true
type: string
example: addr_01G8ZH853YPY9B94857DY91YGW
shipping_address:
description: Available if the relation `shipping_address` is expanded.
nullable: true
$ref: ./Address.yaml
shipping_methods:
description: The shipping methods that the claim order will be shipped with.
@@ -78,43 +96,49 @@ properties:
description: The fulfillments of the new items to be shipped
type: array
items:
$ref: ./Fulfillment.yaml
type: object
refund_amount:
description: The amount that will be refunded in conjunction with the claim
nullable: true
type: integer
example: 1000
canceled_at:
description: The date with timezone at which the claim was canceled.
nullable: true
type: string
format: date-time
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white
no_notification:
description: >-
Flag for describing whether or not notifications related to this should be
send.
nullable: true
type: boolean
example: false
idempotency_key:
type: string
description: >-
Randomly generated key used to continue the completion of the cart
associated with the claim in case of failure.
nullable: true
type: string
externalDocs:
url: >-
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key

17
docs/api/store/components/schemas/ClaimTag.yaml
View File

@@ -4,30 +4,37 @@ description: >-
filtering and grouping.
type: object
required:
- created_at
- deleted_at
- id
- metadata
- updated_at
- value
properties:
id:
type: string
description: The claim tag's ID
type: string
example: ctag_01G8ZCC5Y63B95V6B5SHBZ91S4
value:
description: The value that the claim tag holds
type: string
example: Damaged
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

18
docs/api/store/components/schemas/Country.yaml
View File

@@ -2,27 +2,29 @@ title: Country
description: Country details
type: object
required:
- display_name
- id
- iso_2
- iso_3
- num_code
- name
- display_name
- num_code
- region_id
properties:
id:
type: string
description: The country's ID
type: string
example: 109
iso_2:
type: string
description: The 2 character ISO code of the country in lower case
type: string
example: it
externalDocs:
url: >-
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
description: See a list of codes.
iso_3:
type: string
description: The 2 character ISO code of the country in lower case
type: string
example: ita
externalDocs:
url: >-
@@ -45,9 +47,11 @@ properties:
type: string
example: Italy
region_id:
type: string
description: The region ID this country is associated with.
nullable: true
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: A region object. Available if the relation `region` is expanded.
type: object
nullable: true
$ref: ./Region.yaml

3
docs/api/store/components/schemas/Currency.yaml
View File

@@ -3,9 +3,9 @@ description: Currency
type: object
required:
- code
- name
- symbol
- symbol_native
- name
properties:
code:
description: The 3 character ISO code for the currency.
@@ -29,3 +29,4 @@ properties:
includes_tax:
description: '[EXPERIMENTAL] Does the currency prices include tax'
type: boolean
default: false

28
docs/api/store/components/schemas/CustomShippingOption.yaml
View File

@@ -5,12 +5,18 @@ description: >-
particular Shipping Option
type: object
required:
- cart_id
- created_at
- deleted_at
- id
- metadata
- price
- shipping_option_id
- updated_at
properties:
id:
type: string
description: The custom shipping option's ID
type: string
example: cso_01G8X99XNB77DMFBJFWX6DN9V9
price:
description: >-
@@ -26,31 +32,33 @@ properties:
description: >-
A shipping option object. Available if the relation `shipping_option` is
expanded.
type: object
nullable: true
$ref: ./ShippingOption.yaml
cart_id:
description: The ID of the Cart that the custom shipping option is attached to
nullable: true
type: string
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
cart:
description: A cart object. Available if the relation `cart` is expanded.
type: object
nullable: true
$ref: ./Cart.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white
includes_tax:
description: '[EXPERIMENTAL] Indicates if the custom shipping option price include tax'
type: boolean

40
docs/api/store/components/schemas/Customer.yaml
View File

@@ -2,30 +2,44 @@ title: Customer
description: Represents a customer
type: object
required:
- billing_address_id
- created_at
- deleted_at
- email
- first_name
- has_account
- id
- last_name
- metadata
- phone
- updated_at
properties:
id:
type: string
description: The customer's ID
type: string
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
email:
type: string
description: The customer's email
type: string
format: email
first_name:
type: string
description: The customer's first name
nullable: true
type: string
example: Arno
last_name:
type: string
description: The customer's last name
nullable: true
type: string
example: Willms
billing_address_id:
type: string
description: The customer's billing address ID
nullable: true
type: string
example: addr_01G8ZH853YPY9B94857DY91YGW
billing_address:
description: Available if the relation `billing_address` is expanded.
nullable: true
$ref: ./Address.yaml
shipping_addresses:
description: Available if the relation `shipping_addresses` is expanded.
@@ -33,19 +47,19 @@ properties:
items:
$ref: ./Address.yaml
phone:
type: string
description: The customer's phone number
nullable: true
type: string
example: 16128234334802
has_account:
type: boolean
description: Whether the customer has an account or not
type: boolean
default: false
orders:
description: Available if the relation `orders` is expanded.
type: array
items:
type: object
description: An order object.
groups:
description: >-
The customer groups the customer belongs to. Available if the relation
@@ -54,19 +68,21 @@ properties:
items:
$ref: ./CustomerGroup.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

28
docs/api/store/components/schemas/CustomerGroup.yaml
View File

@@ -2,45 +2,51 @@ title: Customer Group
description: Represents a customer group
type: object
required:
- created_at
- deleted_at
- id
- metadata
- name
- updated_at
properties:
id:
type: string
description: The customer group's ID
type: string
example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
name:
type: string
description: The name of the customer group
type: string
example: VIP
customers:
type: array
description: >-
The customers that belong to the customer group. Available if the relation
`customers` is expanded.
items:
type: object
description: A customer object.
price_lists:
type: array
items:
$ref: ./Customer.yaml
price_lists:
description: >-
The price lists that are associated with the customer group. Available if
the relation `price_lists` is expanded.
type: array
items:
$ref: ./PriceList.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

41
docs/api/store/components/schemas/Discount.yaml
View File

@@ -3,11 +3,24 @@ description: Represents a discount that can be applied to a cart for promotional
type: object
required:
- code
- created_at
- deleted_at
- ends_at
- id
- is_disabled
- is_dynamic
- metadata
- parent_discount_id
- rule_id
- starts_at
- updated_at
- usage_count
- usage_limit
- valid_duration
properties:
id:
type: string
description: The discount's ID
type: string
example: disc_01F0YESMW10MGHWJKZSDDMN0VN
code:
description: >-
@@ -22,11 +35,13 @@ properties:
type: boolean
example: false
rule_id:
type: string
description: The Discount Rule that governs the behaviour of the Discount
nullable: true
type: string
example: dru_01F0YESMVK96HVX7N419E3CJ7C
rule:
description: Available if the relation `rule` is expanded.
nullable: true
$ref: ./DiscountRule.yaml
is_disabled:
description: >-
@@ -35,13 +50,15 @@ properties:
type: boolean
example: false
parent_discount_id:
type: string
description: >-
The Discount that the discount was created from. This will always be a
dynamic discount
nullable: true
type: string
example: disc_01G8ZH853YPY9B94857DY91YGW
parent_discount:
description: Available if the relation `parent_discount` is expanded.
nullable: true
$ref: ./Discount.yaml
starts_at:
description: The time at which the discount can be used.
@@ -49,11 +66,13 @@ properties:
format: date-time
ends_at:
description: The time at which the discount can no longer be used.
nullable: true
type: string
format: date-time
valid_duration:
type: string
description: Duration the discount runs between
nullable: true
type: string
example: P3Y6M4DT12H30M5S
regions:
description: >-
@@ -61,10 +80,10 @@ properties:
`regions` is expanded.
type: array
items:
type: object
description: A region object.
$ref: ./Region.yaml
usage_limit:
description: The maximum number of times that a discount can be used.
nullable: true
type: integer
example: 100
usage_count:
@@ -73,19 +92,21 @@ properties:
example: 50
default: 0
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

47
docs/api/store/components/schemas/DiscountCondition.yaml
View File

@@ -2,13 +2,18 @@ title: Discount Condition
description: Holds rule conditions for when a discount is applicable
type: object
required:
- type
- operator
- created_at
- deleted_at
- discount_rule_id
- id
- metadata
- operator
- type
- updated_at
properties:
id:
type: string
description: The discount condition's ID
type: string
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
type:
description: The type of the Condition
@@ -26,11 +31,12 @@ properties:
- in
- not_in
discount_rule_id:
type: string
description: The ID of the discount rule associated with the condition
type: string
example: dru_01F0YESMVK96HVX7N419E3CJ7C
discount_rule:
description: Available if the relation `discount_rule` is expanded.
nullable: true
$ref: ./DiscountRule.yaml
products:
description: >-
@@ -38,55 +44,52 @@ properties:
the relation `products` is expanded.
type: array
items:
type: object
description: A product object.
$ref: ./Product.yaml
product_types:
description: >-
product types associated with this condition if type = product_types.
Product types associated with this condition if type = product_types.
Available if the relation `product_types` is expanded.
type: array
items:
type: object
description: A product type object.
$ref: ./ProductType.yaml
product_tags:
description: >-
product tags associated with this condition if type = product_tags.
Product tags associated with this condition if type = product_tags.
Available if the relation `product_tags` is expanded.
type: array
items:
type: object
description: A product tag object.
$ref: ./ProductTag.yaml
product_collections:
description: >-
product collections associated with this condition if type =
Product collections associated with this condition if type =
product_collections. Available if the relation `product_collections` is
expanded.
type: array
items:
type: object
description: A product collection object.
$ref: ./ProductCollection.yaml
customer_groups:
description: >-
customer groups associated with this condition if type = customer_groups.
Customer groups associated with this condition if type = customer_groups.
Available if the relation `customer_groups` is expanded.
type: array
items:
type: object
description: A customer group object.
$ref: ./CustomerGroup.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

14
docs/api/store/components/schemas/DiscountConditionCustomerGroup.yaml
View File

@@ -2,8 +2,11 @@ title: Product Tag Discount Condition
description: Associates a discount condition with a customer group
type: object
required:
- customer_group_id
- condition_id
- created_at
- customer_group_id
- metadata
- updated_at
properties:
customer_group_id:
description: The ID of the Product Tag
@@ -15,20 +18,23 @@ properties:
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
customer_group:
description: Available if the relation `customer_group` is expanded.
nullable: true
$ref: ./CustomerGroup.yaml
discount_condition:
description: Available if the relation `discount_condition` is expanded.
nullable: true
$ref: ./DiscountCondition.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

14
docs/api/store/components/schemas/DiscountConditionProduct.yaml
View File

@@ -2,8 +2,11 @@ title: Product Discount Condition
description: Associates a discount condition with a product
type: object
required:
- product_id
- condition_id
- created_at
- metadata
- product_id
- updated_at
properties:
product_id:
description: The ID of the Product Tag
@@ -15,20 +18,23 @@ properties:
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
product:
description: Available if the relation `product` is expanded.
nullable: true
$ref: ./Product.yaml
discount_condition:
description: Available if the relation `discount_condition` is expanded.
nullable: true
$ref: ./DiscountCondition.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

14
docs/api/store/components/schemas/DiscountConditionProductCollection.yaml
View File

@@ -2,8 +2,11 @@ title: Product Collection Discount Condition
description: Associates a discount condition with a product collection
type: object
required:
- product_collection_id
- condition_id
- created_at
- metadata
- product_collection_id
- updated_at
properties:
product_collection_id:
description: The ID of the Product Collection
@@ -15,20 +18,23 @@ properties:
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
product_collection:
description: Available if the relation `product_collection` is expanded.
nullable: true
$ref: ./ProductCollection.yaml
discount_condition:
description: Available if the relation `discount_condition` is expanded.
nullable: true
$ref: ./DiscountCondition.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

14
docs/api/store/components/schemas/DiscountConditionProductTag.yaml
View File

@@ -2,8 +2,11 @@ title: Product Tag Discount Condition
description: Associates a discount condition with a product tag
type: object
required:
- product_tag_id
- condition_id
- created_at
- metadata
- product_tag_id
- updated_at
properties:
product_tag_id:
description: The ID of the Product Tag
@@ -15,20 +18,23 @@ properties:
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
product_tag:
description: Available if the relation `product_tag` is expanded.
nullable: true
$ref: ./ProductTag.yaml
discount_condition:
description: Available if the relation `discount_condition` is expanded.
nullable: true
$ref: ./DiscountCondition.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

14
docs/api/store/components/schemas/DiscountConditionProductType.yaml
View File

@@ -2,8 +2,11 @@ title: Product Type Discount Condition
description: Associates a discount condition with a product type
type: object
required:
- product_type_id
- condition_id
- created_at
- metadata
- product_type_id
- updated_at
properties:
product_type_id:
description: The ID of the Product Tag
@@ -15,20 +18,23 @@ properties:
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
product_type:
description: Available if the relation `product_type` is expanded.
nullable: true
$ref: ./ProductType.yaml
discount_condition:
description: Available if the relation `discount_condition` is expanded.
nullable: true
$ref: ./DiscountCondition.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

24
docs/api/store/components/schemas/DiscountRule.yaml
View File

@@ -4,12 +4,19 @@ description: >-
Cart.
type: object
required:
- allocation
- created_at
- deleted_at
- description
- id
- metadata
- type
- updated_at
- value
properties:
id:
type: string
description: The discount rule's ID
type: string
example: dru_01F0YESMVK96HVX7N419E3CJ7C
type:
description: >-
@@ -24,6 +31,7 @@ properties:
example: percentage
description:
description: A short description of the discount
nullable: true
type: string
example: 10 Percent
value:
@@ -34,6 +42,7 @@ properties:
example: 10
allocation:
description: The scope that the discount should apply to.
nullable: true
type: string
enum:
- total
@@ -45,22 +54,23 @@ properties:
used. Available if the relation `conditions` is expanded.
type: array
items:
type: object
description: A discount condition object.
$ref: ./DiscountCondition.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

48
docs/api/store/components/schemas/DraftOrder.yaml
View File

@@ -1,71 +1,89 @@
title: DraftOrder
description: Represents a draft order
type: object
required:
- canceled_at
- cart_id
- completed_at
- created_at
- display_id
- id
- idempotency_key
- metadata
- no_notification_order
- order_id
- status
- updated_at
properties:
id:
type: string
description: The draft order's ID
type: string
example: dorder_01G8TJFKBG38YYFQ035MSVG03C
status:
type: string
description: The status of the draft order
type: string
enum:
- open
- completed
default: open
display_id:
type: string
description: The draft order's display ID
type: string
example: 2
cart_id:
type: string
description: The ID of the cart associated with the draft order.
nullable: true
type: string
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
cart:
description: A cart object. Available if the relation `cart` is expanded.
nullable: true
type: object
order_id:
type: string
description: The ID of the order associated with the draft order.
nullable: true
type: string
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
order:
description: An order object. Available if the relation `order` is expanded.
nullable: true
type: object
canceled_at:
type: string
description: The date the draft order was canceled at.
nullable: true
type: string
format: date-time
completed_at:
type: string
description: The date the draft order was completed at.
nullable: true
type: string
format: date-time
no_notification_order:
type: boolean
description: Whether to send the customer notifications regarding order updates.
nullable: true
type: boolean
example: false
idempotency_key:
type: string
description: >-
Randomly generated key used to continue the completion of the cart
associated with the draft order in case of failure.
nullable: true
type: string
externalDocs:
url: >-
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
description: Learn more how to use the idempotency key.
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white

69
docs/api/store/components/schemas/InventoryItemDTO.yaml Normal file
View File

@@ -0,0 +1,69 @@
type: object
required:
- sku
properties:
sku:
description: The Stock Keeping Unit (SKU) code of the Inventory Item.
type: string
hs_code:
description: >-
The Harmonized System code of the Inventory Item. May be used by
Fulfillment Providers to pass customs information to shipping carriers.
type: string
origin_country:
description: >-
The country in which the Inventory Item was produced. May be used by
Fulfillment Providers to pass customs information to shipping carriers.
type: string
mid_code:
description: >-
The Manufacturers Identification code that identifies the manufacturer of
the Inventory Item. May be used by Fulfillment Providers to pass customs
information to shipping carriers.
type: string
material:
description: >-
The material and composition that the Inventory Item is made of, May be
used by Fulfillment Providers to pass customs information to shipping
carriers.
type: string
weight:
description: >-
The weight of the Inventory Item. May be used in shipping rate
calculations.
type: number
height:
description: >-
The height of the Inventory Item. May be used in shipping rate
calculations.
type: number
width:
description: >-
The width of the Inventory Item. May be used in shipping rate
calculations.
type: number
length:
description: >-
The length of the Inventory Item. May be used in shipping rate
calculations.
type: number
requires_shipping:
description: Whether the item requires shipping.
type: boolean
metadata:
type: object
description: An optional key-value map with additional details
example:
car: white
created_at:
type: string
description: The date with timezone at which the resource was created.
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time

37
docs/api/store/components/schemas/InventoryLevelDTO.yaml Normal file
View File

@@ -0,0 +1,37 @@
type: object
required:
- inventory_item_id
- location_id
- stocked_quantity
- reserved_quantity
- incoming_quantity
properties:
location_id:
description: the item location ID
type: string
stocked_quantity:
description: the total stock quantity of an inventory item at the given location ID
type: number
reserved_quantity:
description: the reserved stock quantity of an inventory item at the given location ID
type: number
incoming_quantity:
description: the incoming stock quantity of an inventory item at the given location ID
type: number
metadata:
type: object
description: An optional key-value map with additional details
example:
car: white
created_at:
type: string
description: The date with timezone at which the resource was created.
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time

6
docs/api/store/components/schemas/Order.yaml
View File

@@ -133,14 +133,14 @@ properties:
The payments used in the order. Available if the relation `payments` is
expanded.
items:
$ref: ./Payment.yaml
type: object
fulfillments:
type: array
description: >-
The fulfillments used in the order. Available if the relation
`fulfillments` is expanded.
items:
$ref: ./Fulfillment.yaml
type: object
returns:
type: array
description: >-
@@ -193,7 +193,7 @@ properties:
[EXPERIMENTAL] Order edits done on the order. Available if the relation
`edits` is expanded.
items:
$ref: ./OrderEdit.yaml
type: object
gift_card_transactions:
type: array
description: >-

2
docs/api/store/components/schemas/OrderEdit.yaml
View File

@@ -17,7 +17,7 @@ properties:
example: order_01G2SG30J8C85S4A5CHM2S1NS2
order:
description: Available if the relation `order` is expanded.
$ref: ./Order.yaml
type: object
changes:
type: array
description: Available if the relation `changes` is expanded.

8
docs/api/store/components/schemas/Product.yaml
View File

@@ -169,6 +169,14 @@ properties:
items:
type: object
description: A sales channel object.
categories:
description: >-
The product's associated categories. Available if the relation
`categories` is expanded.
type: array
items:
type: object
description: A category object.
created_at:
type: string
description: The date with timezone at which the resource was created.

8
docs/api/store/components/schemas/ProductCategory.yaml
View File

@@ -46,6 +46,14 @@ properties:
A product category object. Available if the relation `parent_category` is
expanded.
type: object
products:
description: >-
products associated with category. Available if the relation `products` is
expanded.
type: array
items:
type: object
description: A product object.
created_at:
type: string
description: The date with timezone at which the resource was created.

4
docs/api/store/components/schemas/StockLocationAddressDTO.yaml
View File

@@ -19,6 +19,10 @@ properties:
type: string
description: Stock location address' complement
example: apartment 4432
company:
type: string
description: Stock location company' name
example: Medusa
city:
type: string
description: Stock location address' city

0
docs/api/store/components/schemas/StoreGetProductCategoryRes.yaml → docs/api/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml
View File

11
docs/api/store/components/schemas/StorePostAuthReq.yaml Normal file
View File

@@ -0,0 +1,11 @@
type: object
required:
- email
- password
properties:
email:
type: string
description: The Customer's email.
password:
type: string
description: The Customer's password.

1
docs/api/store/components/schemas/StorePostCartReq.yaml
View File

@@ -19,6 +19,7 @@ properties:
from.
type: array
items:
type: object
required:
- variant_id
- quantity

7
docs/api/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml Normal file
View File

@@ -0,0 +1,7 @@
type: object
required:
- quantity
properties:
quantity:
type: number
description: The quantity to set the Line Item to.

14
docs/api/store/components/schemas/StorePostCartsCartLineItemsReq.yaml Normal file
View File

@@ -0,0 +1,14 @@
type: object
required:
- variant_id
- quantity
properties:
variant_id:
type: string
description: The id of the Product Variant to generate the Line Item from.
quantity:
type: number
description: The quantity of the Product Variant to add to the Line Item.
metadata:
type: object
description: An optional key-value map with additional details about the Line Item.

7
docs/api/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml Normal file
View File

@@ -0,0 +1,7 @@
type: object
required:
- provider_id
properties:
provider_id:
type: string
description: The ID of the Payment Provider.

7
docs/api/store/components/schemas/StorePostCartsCartPaymentSessionUpdateReq.yaml Normal file
View File

@@ -0,0 +1,7 @@
type: object
required:
- data
properties:
data:
type: object
description: The data to update the payment session with.

2
docs/api/store/components/schemas/StorePostCartsCartReq.yaml
View File

@@ -35,6 +35,7 @@ properties:
description: An array of Gift Card codes to add to the Cart.
type: array
items:
type: object
required:
- code
properties:
@@ -45,6 +46,7 @@ properties:
description: An array of Discount codes to add to the Cart.
type: array
items:
type: object
required:
- code
properties:

13
docs/api/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml Normal file
View File

@@ -0,0 +1,13 @@
type: object
required:
- option_id
properties:
option_id:
type: string
description: ID of the shipping option to create the method from
data:
type: object
description: >-
Used to hold any data that the shipping method may need to process the
fulfillment of the order. Look at the documentation for your installed
fulfillment providers to find out what to send.

1
docs/api/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml
View File

@@ -9,6 +9,7 @@ properties:
and the provided ones will be created.
type: array
items:
type: object
required:
- provider_id
- amount

1
docs/api/store/components/schemas/StorePostReturnsReq.yaml
View File

@@ -10,6 +10,7 @@ properties:
description: The items to include in the Return.
type: array
items:
type: object
required:
- item_id
- quantity

2
docs/api/store/components/schemas/StorePostSwapsReq.yaml
View File

@@ -11,6 +11,7 @@ properties:
description: The items to include in the Return.
type: array
items:
type: object
required:
- item_id
- quantity
@@ -34,6 +35,7 @@ properties:
description: The items to exchange the returned items to.
type: array
items:
type: object
required:
- variant_id
- quantity

15
docs/api/store/components/schemas/StoreProductCategoriesListRes.yaml Normal file
View File

@@ -0,0 +1,15 @@
type: object
properties:
product_categories:
type: array
items:
$ref: ./ProductCategory.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page

4
docs/api/store/components/schemas/Swap.yaml
View File

@@ -68,13 +68,13 @@ properties:
relation `fulfillments` is expanded.
type: array
items:
$ref: ./Fulfillment.yaml
type: object
payment:
description: >-
The Payment authorized when the Swap requires an additional amount to be
charged from the Customer. Available if the relation `payment` is
expanded.
$ref: ./Payment.yaml
type: object
difference_due:
description: >-
The difference that is paid or refunded as a result of the Swap. May be