chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
efdea04963
commit
658339767b
@@ -1,5 +1,8 @@
|
||||
title: Address
|
||||
description: An address.
|
||||
description: >-
|
||||
An address is used across the Medusa backend within other schemas and object
|
||||
types. For example, a customer's billing and shipping addresses both use the
|
||||
Address entity.
|
||||
type: object
|
||||
required:
|
||||
- address_1
|
||||
@@ -72,7 +75,8 @@ properties:
|
||||
description: See a list of codes.
|
||||
example: st
|
||||
country:
|
||||
description: A country object. Available if the relation `country` is expanded.
|
||||
description: A country object.
|
||||
x-expandable: country
|
||||
nullable: true
|
||||
$ref: ./Country.yaml
|
||||
province:
|
||||
@@ -109,3 +113,7 @@ properties:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -4,5 +4,6 @@ required:
|
||||
properties:
|
||||
apps:
|
||||
type: array
|
||||
description: An array of app details.
|
||||
items:
|
||||
$ref: ./OAuth.yaml
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- apps
|
||||
properties:
|
||||
apps:
|
||||
description: App details.
|
||||
$ref: ./OAuth.yaml
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- user
|
||||
properties:
|
||||
user:
|
||||
description: User details.
|
||||
$ref: ./User.yaml
|
||||
|
||||
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
batch_jobs:
|
||||
type: array
|
||||
description: An array of batch job details.
|
||||
items:
|
||||
$ref: ./BatchJob.yaml
|
||||
count:
|
||||
@@ -14,7 +15,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of batch jobs skipped when retrieving the batch jobs.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- batch_job
|
||||
properties:
|
||||
batch_job:
|
||||
description: Batch job details.
|
||||
$ref: ./BatchJob.yaml
|
||||
|
||||
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
collections:
|
||||
type: array
|
||||
description: an array of collection details
|
||||
items:
|
||||
$ref: ./ProductCollection.yaml
|
||||
count:
|
||||
@@ -14,7 +15,9 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: >-
|
||||
The number of product collections skipped when retrieving the product
|
||||
collections.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -7,4 +7,5 @@ required:
|
||||
- collection
|
||||
properties:
|
||||
collection:
|
||||
type: Product Collection details.
|
||||
$ref: ./ProductCollection.yaml
|
||||
|
||||
@@ -4,23 +4,25 @@ required:
|
||||
- password
|
||||
properties:
|
||||
email:
|
||||
description: The Users email.
|
||||
description: The User's email.
|
||||
type: string
|
||||
format: email
|
||||
first_name:
|
||||
description: The name of the User.
|
||||
description: The first name of the User.
|
||||
type: string
|
||||
last_name:
|
||||
description: The name of the User.
|
||||
description: The last name of the User.
|
||||
type: string
|
||||
role:
|
||||
description: Userrole assigned to the user.
|
||||
description: >-
|
||||
The role assigned to the user. These roles don't provide any different
|
||||
privileges.
|
||||
type: string
|
||||
enum:
|
||||
- admin
|
||||
- member
|
||||
- developer
|
||||
password:
|
||||
description: The Users password.
|
||||
description: The User's password.
|
||||
type: string
|
||||
format: password
|
||||
|
||||
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
currencies:
|
||||
type: array
|
||||
description: An array of currency details.
|
||||
items:
|
||||
$ref: ./Currency.yaml
|
||||
count:
|
||||
@@ -14,7 +15,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of currencies skipped when retrieving the currencies.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- currency
|
||||
properties:
|
||||
currency:
|
||||
description: Currency details.
|
||||
$ref: ./Currency.yaml
|
||||
|
||||
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
customer_groups:
|
||||
type: array
|
||||
description: An array of customer group details.
|
||||
items:
|
||||
$ref: ./CustomerGroup.yaml
|
||||
count:
|
||||
@@ -14,7 +15,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of customer groups skipped when retrieving the customer groups.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- customer_group
|
||||
properties:
|
||||
customer_group:
|
||||
description: Customer group details.
|
||||
$ref: ./CustomerGroup.yaml
|
||||
|
||||
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
customers:
|
||||
type: array
|
||||
description: An array of customer details.
|
||||
items:
|
||||
$ref: ./Customer.yaml
|
||||
count:
|
||||
@@ -14,7 +15,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of customers skipped when retrieving the customers.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -8,4 +8,5 @@ required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
description: Customer details.
|
||||
$ref: ./Customer.yaml
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ required:
|
||||
- resources
|
||||
properties:
|
||||
resources:
|
||||
description: The resources to be deleted from the discount condition
|
||||
description: The resources to be removed from the discount condition
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
type: object
|
||||
properties:
|
||||
price_ids:
|
||||
description: The price id's of the Money Amounts to delete.
|
||||
description: The price IDs of the Money Amounts to delete.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
|
||||
@@ -15,5 +15,5 @@ properties:
|
||||
description: The IDs of the products removed from the collection
|
||||
type: array
|
||||
items:
|
||||
description: The ID of a Product to add to the Product Collection.
|
||||
description: The ID of the Product removed from the Product Collection.
|
||||
type: string
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ required:
|
||||
- sales_channel_ids
|
||||
properties:
|
||||
sales_channel_ids:
|
||||
description: The IDs of the sales channels to delete from the publishable api key
|
||||
description: The IDs of the sales channels to remove from the publishable API key
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ required:
|
||||
- product_ids
|
||||
properties:
|
||||
product_ids:
|
||||
description: The IDs of the products to delete from the Sales Channel.
|
||||
description: The IDs of the products to remove from the Sales Channel.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
|
||||
@@ -4,6 +4,8 @@ required:
|
||||
properties:
|
||||
product_types:
|
||||
type: array
|
||||
description: The IDs of the types of products to remove association with this tax rate
|
||||
description: >-
|
||||
The IDs of the product types to remove their association with this tax
|
||||
rate.
|
||||
items:
|
||||
type: string
|
||||
|
||||
@@ -4,6 +4,6 @@ required:
|
||||
properties:
|
||||
products:
|
||||
type: array
|
||||
description: The IDs of the products to remove association with this tax rate
|
||||
description: The IDs of the products to remove their association with this tax rate.
|
||||
items:
|
||||
type: string
|
||||
|
||||
@@ -4,6 +4,8 @@ required:
|
||||
properties:
|
||||
shipping_options:
|
||||
type: array
|
||||
description: The IDs of the shipping options to remove association with this tax rate
|
||||
description: >-
|
||||
The IDs of the shipping options to remove their association with this tax
|
||||
rate.
|
||||
items:
|
||||
type: string
|
||||
|
||||
@@ -7,15 +7,15 @@ required:
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The ID of the deleted DiscountCondition
|
||||
description: The ID of the deleted Discount Condition
|
||||
object:
|
||||
type: string
|
||||
description: The type of the object that was deleted.
|
||||
default: discount-condition
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether the discount condition was deleted successfully or not.
|
||||
description: Whether the discount condition was deleted successfully.
|
||||
default: true
|
||||
discount:
|
||||
description: The Discount to which the condition used to belong
|
||||
description: The Discount to which the condition used to belong to.
|
||||
$ref: ./Discount.yaml
|
||||
|
||||
@@ -7,4 +7,5 @@ required:
|
||||
- discount_condition
|
||||
properties:
|
||||
discount_condition:
|
||||
description: Discount condition details.
|
||||
$ref: ./DiscountCondition.yaml
|
||||
|
||||
@@ -13,5 +13,5 @@ properties:
|
||||
default: discount
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether the discount was deleted successfully or not.
|
||||
description: Whether the discount was deleted successfully.
|
||||
default: true
|
||||
|
||||
@@ -21,7 +21,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of discounts skipped when retrieving the discounts.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -13,4 +13,5 @@ required:
|
||||
- discount
|
||||
properties:
|
||||
discount:
|
||||
description: Discount details.
|
||||
$ref: ./Discount.yaml
|
||||
|
||||
@@ -13,5 +13,5 @@ properties:
|
||||
default: draft-order
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether the draft order was deleted successfully or not.
|
||||
description: Whether the draft order was deleted successfully.
|
||||
default: true
|
||||
|
||||
@@ -14,6 +14,7 @@ required:
|
||||
properties:
|
||||
draft_orders:
|
||||
type: array
|
||||
description: An array of draft order's details.
|
||||
items:
|
||||
$ref: ./DraftOrder.yaml
|
||||
count:
|
||||
@@ -21,7 +22,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of draft orders skipped when retrieving the draft orders.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -32,6 +32,7 @@ x-expanded-relations:
|
||||
- cart.items.tax_lines
|
||||
- cart.items.variant
|
||||
- cart.items.variant.product
|
||||
- cart.items.variant.product.profiles
|
||||
- cart.region
|
||||
- cart.region.tax_rates
|
||||
- cart.shipping_address
|
||||
@@ -61,4 +62,5 @@ required:
|
||||
- draft_order
|
||||
properties:
|
||||
draft_order:
|
||||
description: Draft order's details.
|
||||
$ref: ./DraftOrder.yaml
|
||||
|
||||
@@ -8,4 +8,5 @@ required:
|
||||
- store
|
||||
properties:
|
||||
store:
|
||||
description: Store details.
|
||||
$ref: ./ExtendedStoreDTO.yaml
|
||||
|
||||
@@ -4,6 +4,7 @@ required:
|
||||
properties:
|
||||
fulfillment_options:
|
||||
type: array
|
||||
description: Fulfillment providers details.
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
|
||||
@@ -2,4 +2,5 @@ type: object
|
||||
properties:
|
||||
variant:
|
||||
type: object
|
||||
description: The product variant's.
|
||||
$ref: ./VariantInventory.yaml
|
||||
|
||||
@@ -13,5 +13,5 @@ properties:
|
||||
default: gift-card
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether the gift card was deleted successfully or not.
|
||||
description: Whether the gift card was deleted successfully.
|
||||
default: true
|
||||
|
||||
@@ -22,7 +22,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of gift cards skipped when retrieving the gift cards.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -11,4 +11,5 @@ required:
|
||||
- gift_card
|
||||
properties:
|
||||
gift_card:
|
||||
description: A gift card's details.
|
||||
$ref: ./GiftCard.yaml
|
||||
|
||||
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
inventory_items:
|
||||
type: array
|
||||
description: an array of Inventory Item details
|
||||
items:
|
||||
$ref: ./InventoryItemDTO.yaml
|
||||
count:
|
||||
@@ -14,7 +15,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of inventory items skipped when retrieving the inventory items.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
+2
-1
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
inventory_items:
|
||||
type: array
|
||||
description: an array of Inventory Item details
|
||||
items:
|
||||
$ref: ./DecoratedInventoryItemDTO.yaml
|
||||
count:
|
||||
@@ -14,7 +15,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of inventory items skipped when retrieving the inventory items.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- inventory_item
|
||||
properties:
|
||||
inventory_item:
|
||||
description: Inventory Item details
|
||||
$ref: ./InventoryItemDTO.yaml
|
||||
|
||||
@@ -13,5 +13,5 @@ properties:
|
||||
default: invite
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether or not the Invite was deleted.
|
||||
description: Whether or not the invite was deleted.
|
||||
default: true
|
||||
|
||||
@@ -4,5 +4,6 @@ required:
|
||||
properties:
|
||||
invites:
|
||||
type: array
|
||||
description: An array of invites
|
||||
items:
|
||||
$ref: ./Invite.yaml
|
||||
|
||||
@@ -7,6 +7,7 @@ required:
|
||||
properties:
|
||||
notes:
|
||||
type: array
|
||||
description: An array of notes
|
||||
items:
|
||||
$ref: ./Note.yaml
|
||||
count:
|
||||
@@ -14,7 +15,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of notes skipped when retrieving the notes.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- note
|
||||
properties:
|
||||
note:
|
||||
description: Note details.
|
||||
$ref: ./Note.yaml
|
||||
|
||||
@@ -8,6 +8,7 @@ required:
|
||||
properties:
|
||||
notifications:
|
||||
type: array
|
||||
description: an array of notifications
|
||||
items:
|
||||
$ref: ./Notification.yaml
|
||||
count:
|
||||
@@ -15,7 +16,7 @@ properties:
|
||||
description: The total number of notifications
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of notifications skipped before these notifications
|
||||
description: The number of notifications skipped when retrieving the notifications.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of notifications per page
|
||||
|
||||
@@ -7,4 +7,5 @@ required:
|
||||
- notification
|
||||
properties:
|
||||
notification:
|
||||
description: Notification details
|
||||
$ref: ./Notification.yaml
|
||||
|
||||
@@ -42,6 +42,7 @@ required:
|
||||
properties:
|
||||
order_edits:
|
||||
type: array
|
||||
description: An array of order edit details
|
||||
items:
|
||||
$ref: ./OrderEdit.yaml
|
||||
count:
|
||||
@@ -49,7 +50,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of order edits skipped when retrieving the order edits.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -38,4 +38,5 @@ required:
|
||||
- order_edit
|
||||
properties:
|
||||
order_edit:
|
||||
description: Order edit details
|
||||
$ref: ./OrderEdit.yaml
|
||||
|
||||
@@ -58,6 +58,7 @@ x-expanded-relations:
|
||||
- items.tax_lines
|
||||
- items.variant
|
||||
- items.variant.product
|
||||
- items.variant.product.profiles
|
||||
- refunds
|
||||
- region
|
||||
- shipping_methods
|
||||
@@ -110,6 +111,7 @@ required:
|
||||
properties:
|
||||
orders:
|
||||
type: array
|
||||
description: An array of order details.
|
||||
items:
|
||||
$ref: ./Order.yaml
|
||||
count:
|
||||
@@ -117,7 +119,7 @@ properties:
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
description: The number of orders skipped when retrieving the orders.
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
|
||||
@@ -3,7 +3,7 @@ required:
|
||||
- location_id
|
||||
properties:
|
||||
location_id:
|
||||
description: The id of the location of the reservation
|
||||
description: The ID of the location of the reservation
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity to reserve
|
||||
|
||||
@@ -58,6 +58,7 @@ x-expanded-relations:
|
||||
- items.tax_lines
|
||||
- items.variant
|
||||
- items.variant.product
|
||||
- items.variant.product.profiles
|
||||
- refunds
|
||||
- region
|
||||
- shipping_methods
|
||||
@@ -106,4 +107,5 @@ required:
|
||||
- order
|
||||
properties:
|
||||
order:
|
||||
description: Order details.
|
||||
$ref: ./Order.yaml
|
||||
|
||||
@@ -12,4 +12,5 @@ required:
|
||||
- payment_collection
|
||||
properties:
|
||||
payment_collection:
|
||||
description: Payment Collection details.
|
||||
$ref: ./PaymentCollection.yaml
|
||||
|
||||
@@ -4,5 +4,6 @@ required:
|
||||
properties:
|
||||
payment_providers:
|
||||
type: array
|
||||
description: An array of payment providers details.
|
||||
items:
|
||||
$ref: ./PaymentProvider.yaml
|
||||
|
||||
@@ -3,4 +3,5 @@ required:
|
||||
- payment
|
||||
properties:
|
||||
payment:
|
||||
description: Payment details
|
||||
$ref: ./Payment.yaml
|
||||
|
||||
@@ -6,7 +6,7 @@ required:
|
||||
properties:
|
||||
application_name:
|
||||
type: string
|
||||
description: Name of the application for the token to be generated for.
|
||||
description: Name of the application for to generate the token for.
|
||||
state:
|
||||
type: string
|
||||
description: State of the application.
|
||||
|
||||
@@ -5,9 +5,9 @@ required:
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
description: The User's email.
|
||||
description: The user's email.
|
||||
format: email
|
||||
password:
|
||||
type: string
|
||||
description: The User's password.
|
||||
description: The user's password.
|
||||
format: password
|
||||
|
||||
@@ -5,7 +5,9 @@ required:
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: The type of batch job to start.
|
||||
description: >-
|
||||
The type of batch job to start, which is defined by the `batchType`
|
||||
property of the associated batch job strategy.
|
||||
example: product-export
|
||||
context:
|
||||
type: object
|
||||
@@ -29,6 +31,6 @@ properties:
|
||||
dry_run:
|
||||
type: boolean
|
||||
description: >-
|
||||
Set a batch job in dry_run mode to get some information on what will be
|
||||
done without applying any modifications.
|
||||
Set a batch job in dry_run mode, which would delay executing the batch job
|
||||
until it's confirmed.
|
||||
default: false
|
||||
|
||||
@@ -2,12 +2,16 @@ type: object
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
description: The title to identify the Collection by.
|
||||
description: The title of the collection.
|
||||
handle:
|
||||
type: string
|
||||
description: >-
|
||||
An optional handle to be used in slugs, if none is provided we will
|
||||
kebab-case the title.
|
||||
An optional handle to be used in slugs. If none is provided, the
|
||||
kebab-case version of the title will be used.
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -4,12 +4,16 @@ required:
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
description: The title to identify the Collection by.
|
||||
description: The title of the collection.
|
||||
handle:
|
||||
type: string
|
||||
description: >-
|
||||
An optional handle to be used in slugs, if none is provided we will
|
||||
kebab-case the title.
|
||||
An optional handle to be used in slugs. If none is provided, the
|
||||
kebab-case version of the title will be used.
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -2,4 +2,5 @@ type: object
|
||||
properties:
|
||||
includes_tax:
|
||||
type: boolean
|
||||
description: '[EXPERIMENTAL] Tax included in prices of currency.'
|
||||
x-featureFlag: tax_inclusive_pricing
|
||||
description: Tax included in prices of currency.
|
||||
|
||||
@@ -4,5 +4,9 @@ properties:
|
||||
description: Name of the customer group
|
||||
type: string
|
||||
metadata:
|
||||
description: Metadata for the customer.
|
||||
description: Metadata of the customer group.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -7,4 +7,8 @@ properties:
|
||||
description: Name of the customer group
|
||||
metadata:
|
||||
type: object
|
||||
description: Metadata for the customer.
|
||||
description: Metadata of the customer group.
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -19,6 +19,7 @@ properties:
|
||||
format: password
|
||||
groups:
|
||||
type: array
|
||||
description: A list of customer groups to which the customer belongs.
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
@@ -27,7 +28,10 @@ properties:
|
||||
id:
|
||||
description: The ID of a customer group
|
||||
type: string
|
||||
description: A list of customer groups to which the customer belongs.
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -25,3 +25,7 @@ properties:
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -3,35 +3,38 @@ required:
|
||||
- operator
|
||||
properties:
|
||||
operator:
|
||||
description: Operator of the condition
|
||||
description: >-
|
||||
Operator of the condition. `in` indicates that discountable resources are
|
||||
within the specified resources. `not_in` indicates that discountable
|
||||
resources are everything but the specified resources.
|
||||
type: string
|
||||
enum:
|
||||
- in
|
||||
- not_in
|
||||
products:
|
||||
type: array
|
||||
description: list of product IDs if the condition is applied on products.
|
||||
description: list of product IDs if the condition's type is `products`.
|
||||
items:
|
||||
type: string
|
||||
product_types:
|
||||
type: array
|
||||
description: list of product type IDs if the condition is applied on product types.
|
||||
description: list of product type IDs if the condition's type is `product_types`.
|
||||
items:
|
||||
type: string
|
||||
product_collections:
|
||||
type: array
|
||||
description: >-
|
||||
list of product collection IDs if the condition is applied on product
|
||||
collections.
|
||||
list of product collection IDs if the condition's type is
|
||||
`product_collections`.
|
||||
items:
|
||||
type: string
|
||||
product_tags:
|
||||
type: array
|
||||
description: list of product tag IDs if the condition is applied on product tags.
|
||||
description: list of product tag IDs if the condition's type is `product_tags`.
|
||||
items:
|
||||
type: string
|
||||
customer_groups:
|
||||
type: array
|
||||
description: list of customer group IDs if the condition is applied on customer groups.
|
||||
description: list of customer group IDs if the condition's type is `customer_groups`.
|
||||
items:
|
||||
type: string
|
||||
|
||||
+6
-6
@@ -2,28 +2,28 @@ type: object
|
||||
properties:
|
||||
products:
|
||||
type: array
|
||||
description: list of product IDs if the condition is applied on products.
|
||||
description: list of product IDs if the condition's type is `products`.
|
||||
items:
|
||||
type: string
|
||||
product_types:
|
||||
type: array
|
||||
description: list of product type IDs if the condition is applied on product types.
|
||||
description: list of product type IDs if the condition's type is `product_types`.
|
||||
items:
|
||||
type: string
|
||||
product_collections:
|
||||
type: array
|
||||
description: >-
|
||||
list of product collection IDs if the condition is applied on product
|
||||
collections.
|
||||
list of product collection IDs if the condition's type is
|
||||
`product_collections`.
|
||||
items:
|
||||
type: string
|
||||
product_tags:
|
||||
type: array
|
||||
description: list of product tag IDs if the condition is applied on product tags.
|
||||
description: list of product tag IDs if the condition's type is `product_tags`
|
||||
items:
|
||||
type: string
|
||||
customer_groups:
|
||||
type: array
|
||||
description: list of customer group IDs if the condition is applied on customer groups.
|
||||
description: list of customer group IDs if the condition's type is `customer_groups`.
|
||||
items:
|
||||
type: string
|
||||
|
||||
@@ -7,8 +7,12 @@ properties:
|
||||
description: A unique code that will be used to redeem the Discount
|
||||
usage_limit:
|
||||
type: number
|
||||
description: Maximum times the discount can be used
|
||||
description: Maximum number of times the discount code can be used
|
||||
default: 1
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -2,9 +2,9 @@ type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
description: A unique code that will be used to redeem the Discount
|
||||
description: A unique code that will be used to redeem the discount
|
||||
rule:
|
||||
description: The Discount Rule that defines how Discounts are calculated
|
||||
description: The discount rule that defines how discounts are calculated
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
@@ -18,11 +18,15 @@ properties:
|
||||
value:
|
||||
type: number
|
||||
description: >-
|
||||
The value that the discount represents; this will depend on the type
|
||||
of the discount
|
||||
The value that the discount represents. This will depend on the type
|
||||
of the discount.
|
||||
allocation:
|
||||
type: string
|
||||
description: The scope that the discount should apply to.
|
||||
description: >-
|
||||
The scope that the discount should apply to. `total` indicates that
|
||||
the discount should be applied on the cart total, and `item` indicates
|
||||
that the discount should be applied to each discountable item in the
|
||||
cart.
|
||||
enum:
|
||||
- total
|
||||
- item
|
||||
@@ -31,7 +35,8 @@ properties:
|
||||
description: >-
|
||||
A set of conditions that can be used to limit when the discount can be
|
||||
used. Only one of `products`, `product_types`, `product_collections`,
|
||||
`product_tags`, and `customer_groups` should be provided.
|
||||
`product_tags`, and `customer_groups` should be provided based on the
|
||||
discount condition's type.
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
@@ -39,69 +44,73 @@ properties:
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The ID of the Rule
|
||||
description: The ID of the condition
|
||||
operator:
|
||||
type: string
|
||||
description: Operator of the condition
|
||||
description: >-
|
||||
Operator of the condition. `in` indicates that discountable
|
||||
resources are within the specified resources. `not_in` indicates
|
||||
that discountable resources are everything but the specified
|
||||
resources.
|
||||
enum:
|
||||
- in
|
||||
- not_in
|
||||
products:
|
||||
type: array
|
||||
description: list of product IDs if the condition is applied on products.
|
||||
description: list of product IDs if the condition's type is `products`.
|
||||
items:
|
||||
type: string
|
||||
product_types:
|
||||
type: array
|
||||
description: >-
|
||||
list of product type IDs if the condition is applied on product
|
||||
types.
|
||||
list of product type IDs if the condition's type is
|
||||
`product_types`.
|
||||
items:
|
||||
type: string
|
||||
product_collections:
|
||||
type: array
|
||||
description: >-
|
||||
list of product collection IDs if the condition is applied on
|
||||
product collections.
|
||||
list of product collection IDs if the condition's type is
|
||||
`product_collections`.
|
||||
items:
|
||||
type: string
|
||||
product_tags:
|
||||
type: array
|
||||
description: >-
|
||||
list of product tag IDs if the condition is applied on product
|
||||
tags.
|
||||
list of product tag IDs if the condition's type is
|
||||
`product_tags`.
|
||||
items:
|
||||
type: string
|
||||
customer_groups:
|
||||
type: array
|
||||
description: >-
|
||||
list of customer group IDs if the condition is applied on
|
||||
customer groups.
|
||||
list of customer group IDs if the condition's type is
|
||||
`customer_groups`.
|
||||
items:
|
||||
type: string
|
||||
is_disabled:
|
||||
type: boolean
|
||||
description: >-
|
||||
Whether the Discount code is disabled on creation. You will have to enable
|
||||
it later to make it available to Customers.
|
||||
Whether the discount code is disabled on creation. If set to `true`, it
|
||||
will not be available for customers.
|
||||
starts_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The time at which the Discount should be available.
|
||||
description: The date and time at which the discount should be available.
|
||||
ends_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The time at which the Discount should no longer be available.
|
||||
description: The date and time at which the discount should no longer be available.
|
||||
valid_duration:
|
||||
type: string
|
||||
description: Duration the discount runs between
|
||||
description: The duration the discount runs between
|
||||
example: P3Y6M4DT12H30M5S
|
||||
usage_limit:
|
||||
type: number
|
||||
description: Maximum times the discount can be used
|
||||
description: Maximum number of times the discount can be used
|
||||
regions:
|
||||
description: >-
|
||||
A list of Region ids representing the Regions in which the Discount can be
|
||||
A list of region IDs representing the Regions in which the Discount can be
|
||||
used.
|
||||
type: array
|
||||
items:
|
||||
@@ -109,3 +118,7 @@ properties:
|
||||
metadata:
|
||||
description: An object containing metadata of the discount
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -6,16 +6,16 @@ required:
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
description: A unique code that will be used to redeem the Discount
|
||||
description: A unique code that will be used to redeem the discount
|
||||
is_dynamic:
|
||||
type: boolean
|
||||
description: >-
|
||||
Whether the Discount should have multiple instances of itself, each with a
|
||||
different code. This can be useful for automatically generated codes that
|
||||
all have to follow a common set of rules.
|
||||
Whether the discount should have multiple instances of itself, each with a
|
||||
different code. This can be useful for automatically generated discount
|
||||
codes that all have to follow a common set of rules.
|
||||
default: false
|
||||
rule:
|
||||
description: The Discount Rule that defines how Discounts are calculated
|
||||
description: The discount rule that defines how discounts are calculated
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
@@ -28,7 +28,7 @@ properties:
|
||||
type:
|
||||
type: string
|
||||
description: >-
|
||||
The type of the Discount, can be `fixed` for discounts that reduce the
|
||||
The type of the discount, can be `fixed` for discounts that reduce the
|
||||
price by a fixed amount, `percentage` for percentage reductions or
|
||||
`free_shipping` for shipping vouchers.
|
||||
enum:
|
||||
@@ -38,21 +38,25 @@ properties:
|
||||
value:
|
||||
type: number
|
||||
description: >-
|
||||
The value that the discount represents; this will depend on the type
|
||||
of the discount
|
||||
The value that the discount represents. This will depend on the type
|
||||
of the discount.
|
||||
allocation:
|
||||
type: string
|
||||
description: The scope that the discount should apply to.
|
||||
description: >-
|
||||
The scope that the discount should apply to. `total` indicates that
|
||||
the discount should be applied on the cart total, and `item` indicates
|
||||
that the discount should be applied to each discountable item in the
|
||||
cart.
|
||||
enum:
|
||||
- total
|
||||
- item
|
||||
conditions:
|
||||
type: array
|
||||
description: >-
|
||||
A set of conditions that can be used to limit when the discount can
|
||||
be used. Only one of `products`, `product_types`,
|
||||
`product_collections`, `product_tags`, and `customer_groups` should be
|
||||
provided.
|
||||
A set of conditions that can be used to limit when the discount can be
|
||||
used. Only one of `products`, `product_types`, `product_collections`,
|
||||
`product_tags`, and `customer_groups` should be provided based on the
|
||||
discount condition's type.
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
@@ -60,71 +64,79 @@ properties:
|
||||
properties:
|
||||
operator:
|
||||
type: string
|
||||
description: Operator of the condition
|
||||
description: >-
|
||||
Operator of the condition. `in` indicates that discountable
|
||||
resources are within the specified resources. `not_in` indicates
|
||||
that discountable resources are everything but the specified
|
||||
resources.
|
||||
enum:
|
||||
- in
|
||||
- not_in
|
||||
products:
|
||||
type: array
|
||||
description: list of product IDs if the condition is applied on products.
|
||||
description: list of product IDs if the condition's type is `products`.
|
||||
items:
|
||||
type: string
|
||||
product_types:
|
||||
type: array
|
||||
description: >-
|
||||
list of product type IDs if the condition is applied on product
|
||||
types.
|
||||
list of product type IDs if the condition's type is
|
||||
`product_types`.
|
||||
items:
|
||||
type: string
|
||||
product_collections:
|
||||
type: array
|
||||
description: >-
|
||||
list of product collection IDs if the condition is applied on
|
||||
product collections.
|
||||
list of product collection IDs if the condition's type is
|
||||
`product_collections`.
|
||||
items:
|
||||
type: string
|
||||
product_tags:
|
||||
type: array
|
||||
description: >-
|
||||
list of product tag IDs if the condition is applied on product
|
||||
tags.
|
||||
list of product tag IDs if the condition's type is
|
||||
`product_tags`.
|
||||
items:
|
||||
type: string
|
||||
customer_groups:
|
||||
type: array
|
||||
description: >-
|
||||
list of customer group IDs if the condition is applied on
|
||||
customer groups.
|
||||
list of customer group IDs if the condition's type is
|
||||
`customer_groups`.
|
||||
items:
|
||||
type: string
|
||||
is_disabled:
|
||||
type: boolean
|
||||
description: >-
|
||||
Whether the Discount code is disabled on creation. You will have to enable
|
||||
it later to make it available to Customers.
|
||||
Whether the discount code is disabled on creation. If set to `true`, it
|
||||
will not be available for customers.
|
||||
default: false
|
||||
starts_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The time at which the Discount should be available.
|
||||
description: The date and time at which the discount should be available.
|
||||
ends_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The time at which the Discount should no longer be available.
|
||||
description: The date and time at which the discount should no longer be available.
|
||||
valid_duration:
|
||||
type: string
|
||||
description: Duration the discount runs between
|
||||
description: The duration the discount runs between
|
||||
example: P3Y6M4DT12H30M5S
|
||||
regions:
|
||||
description: >-
|
||||
A list of Region ids representing the Regions in which the Discount can be
|
||||
A list of region IDs representing the Regions in which the Discount can be
|
||||
used.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
usage_limit:
|
||||
type: number
|
||||
description: Maximum times the discount can be used
|
||||
description: Maximum number of times the discount can be used
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
+9
-3
@@ -1,14 +1,20 @@
|
||||
type: object
|
||||
properties:
|
||||
unit_price:
|
||||
description: The potential custom price of the item.
|
||||
description: >-
|
||||
The custom price of the line item. If a `variant_id` is supplied, the
|
||||
price provided here will override the variant's price.
|
||||
type: integer
|
||||
title:
|
||||
description: The potential custom title of the item.
|
||||
description: The title of the line item if `variant_id` is not provided.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Line Item.
|
||||
description: The quantity of the line item.
|
||||
type: integer
|
||||
metadata:
|
||||
description: The optional key-value map with additional details about the Line Item.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -3,18 +3,26 @@ required:
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The ID of the Product Variant to generate the Line Item from.
|
||||
description: >-
|
||||
The ID of the Product Variant associated with the line item. If the line
|
||||
item is custom, the `variant_id` should be omitted.
|
||||
type: string
|
||||
unit_price:
|
||||
description: The potential custom price of the item.
|
||||
description: >-
|
||||
The custom price of the line item. If a `variant_id` is supplied, the
|
||||
price provided here will override the variant's price.
|
||||
type: integer
|
||||
title:
|
||||
description: The potential custom title of the item.
|
||||
description: The title of the line item if `variant_id` is not provided.
|
||||
type: string
|
||||
default: Custom item
|
||||
quantity:
|
||||
description: The quantity of the Line Item.
|
||||
description: The quantity of the line item.
|
||||
type: integer
|
||||
metadata:
|
||||
description: The optional key-value map with additional details about the Line Item.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
+1
@@ -3,4 +3,5 @@ required:
|
||||
- order
|
||||
properties:
|
||||
order:
|
||||
description: Order's details.
|
||||
$ref: ./Order.yaml
|
||||
|
||||
@@ -12,7 +12,7 @@ properties:
|
||||
description: See a list of codes.
|
||||
email:
|
||||
type: string
|
||||
description: An email to be used on the Draft Order.
|
||||
description: An email to be used in the Draft Order.
|
||||
format: email
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
@@ -20,7 +20,7 @@ properties:
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
shipping_address:
|
||||
description: The Address to be used for shipping.
|
||||
description: The Address to be used for shipping purposes.
|
||||
anyOf:
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
@@ -37,9 +37,9 @@ properties:
|
||||
type: string
|
||||
no_notification_order:
|
||||
description: >-
|
||||
An optional flag passed to the resulting order to determine use of
|
||||
notifications.
|
||||
An optional flag passed to the resulting order that indicates whether the
|
||||
customer should receive notifications about order updates.
|
||||
type: boolean
|
||||
customer_id:
|
||||
description: The ID of the Customer to associate the Draft Order with.
|
||||
description: The ID of the customer this draft order is associated with.
|
||||
type: string
|
||||
|
||||
@@ -5,7 +5,9 @@ required:
|
||||
- shipping_methods
|
||||
properties:
|
||||
status:
|
||||
description: The status of the draft order
|
||||
description: >-
|
||||
The status of the draft order. The draft order's default status is `open`.
|
||||
It's changed to `completed` when its payment is marked as paid.
|
||||
type: string
|
||||
enum:
|
||||
- open
|
||||
@@ -20,12 +22,12 @@ properties:
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
shipping_address:
|
||||
description: The Address to be used for shipping.
|
||||
description: The Address to be used for shipping purposes.
|
||||
anyOf:
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
items:
|
||||
description: The Line Items that have been received.
|
||||
description: The draft order's line items.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -33,27 +35,37 @@ properties:
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The ID of the Product Variant to generate the Line Item from.
|
||||
description: >-
|
||||
The ID of the Product Variant associated with the line item. If the
|
||||
line item is custom, the `variant_id` should be omitted.
|
||||
type: string
|
||||
unit_price:
|
||||
description: The potential custom price of the item.
|
||||
description: >-
|
||||
The custom price of the line item. If a `variant_id` is supplied,
|
||||
the price provided here will override the variant's price.
|
||||
type: integer
|
||||
title:
|
||||
description: The potential custom title of the item.
|
||||
description: The title of the line item if `variant_id` is not provided.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Line Item.
|
||||
description: The quantity of the line item.
|
||||
type: integer
|
||||
metadata:
|
||||
description: >-
|
||||
The optional key-value map with additional details about the Line
|
||||
Item.
|
||||
The optional key-value map with additional details about the line
|
||||
item.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: >-
|
||||
Learn about the metadata attribute, and how to delete and update
|
||||
it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
region_id:
|
||||
description: The ID of the region for the draft order
|
||||
type: string
|
||||
discounts:
|
||||
description: The discounts to add on the draft order
|
||||
description: The discounts to add to the draft order
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -64,12 +76,12 @@ properties:
|
||||
description: The code of the discount to apply
|
||||
type: string
|
||||
customer_id:
|
||||
description: The ID of the customer to add on the draft order
|
||||
description: The ID of the customer this draft order is associated with.
|
||||
type: string
|
||||
no_notification_order:
|
||||
description: >-
|
||||
An optional flag passed to the resulting order to determine use of
|
||||
notifications.
|
||||
An optional flag passed to the resulting order that indicates whether the
|
||||
customer should receive notifications about order updates.
|
||||
type: boolean
|
||||
shipping_methods:
|
||||
description: The shipping methods for the draft order
|
||||
@@ -86,8 +98,12 @@ properties:
|
||||
description: The optional additional data needed for the shipping method
|
||||
type: object
|
||||
price:
|
||||
description: The potential custom price of the shipping
|
||||
description: The price of the shipping method.
|
||||
type: integer
|
||||
metadata:
|
||||
description: The optional key-value map with additional details about the Draft Order.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -6,15 +6,19 @@ properties:
|
||||
is_disabled:
|
||||
type: boolean
|
||||
description: >-
|
||||
Whether the Gift Card is disabled on creation. You will have to enable it
|
||||
later to make it available to Customers.
|
||||
Whether the Gift Card is disabled on creation. If set to `true`, the gift
|
||||
card will not be available for customers.
|
||||
ends_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The time at which the Gift Card should no longer be available.
|
||||
description: The date and time at which the Gift Card should no longer be available.
|
||||
region_id:
|
||||
description: The ID of the Region in which the Gift Card can be used.
|
||||
type: string
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -8,15 +8,19 @@ properties:
|
||||
is_disabled:
|
||||
type: boolean
|
||||
description: >-
|
||||
Whether the Gift Card is disabled on creation. You will have to enable it
|
||||
later to make it available to Customers.
|
||||
Whether the Gift Card is disabled on creation. If set to `true`, the gift
|
||||
card will not be available for customers.
|
||||
ends_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The time at which the Gift Card should no longer be available.
|
||||
description: The date and time at which the Gift Card should no longer be available.
|
||||
region_id:
|
||||
description: The ID of the Region in which the Gift Card can be used.
|
||||
type: string
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -4,11 +4,11 @@ required:
|
||||
- stocked_quantity
|
||||
properties:
|
||||
location_id:
|
||||
description: the item location ID
|
||||
description: the ID of the stock location
|
||||
type: string
|
||||
stocked_quantity:
|
||||
description: the stock quantity of an inventory item at the given location ID
|
||||
description: the stock quantity of the inventory item at this location
|
||||
type: number
|
||||
incoming_quantity:
|
||||
description: the incoming stock quantity of an inventory item at the given location ID
|
||||
description: the incoming stock quantity of the inventory item at this location
|
||||
type: number
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
type: object
|
||||
properties:
|
||||
sku:
|
||||
description: The unique SKU for the Product Variant.
|
||||
description: The unique SKU of the associated Product Variant.
|
||||
type: string
|
||||
ean:
|
||||
description: The EAN number of the item.
|
||||
@@ -13,42 +13,64 @@ properties:
|
||||
description: A generic GTIN field for the Product Variant.
|
||||
type: string
|
||||
hs_code:
|
||||
description: The Harmonized System code for the Product Variant.
|
||||
description: >-
|
||||
The Harmonized System code of the Inventory Item. May be used by
|
||||
Fulfillment Providers to pass customs information to shipping carriers.
|
||||
type: string
|
||||
inventory_quantity:
|
||||
description: The amount of stock kept for the Product Variant.
|
||||
description: The amount of stock kept of the associated Product Variant.
|
||||
type: integer
|
||||
default: 0
|
||||
allow_backorder:
|
||||
description: Whether the Product Variant can be purchased when out of stock.
|
||||
description: Whether the associated Product Variant can be purchased when out of stock.
|
||||
type: boolean
|
||||
manage_inventory:
|
||||
description: >-
|
||||
Whether Medusa should keep track of the inventory for this Product
|
||||
Variant.
|
||||
Whether Medusa should keep track of the inventory for the associated
|
||||
Product Variant.
|
||||
type: boolean
|
||||
default: true
|
||||
weight:
|
||||
description: The wieght of the Product Variant.
|
||||
description: >-
|
||||
The weight of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
length:
|
||||
description: The length of the Product Variant.
|
||||
description: >-
|
||||
The length of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
height:
|
||||
description: The height of the Product Variant.
|
||||
description: >-
|
||||
The height of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
width:
|
||||
description: The width of the Product Variant.
|
||||
description: >-
|
||||
The width of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
origin_country:
|
||||
description: The country of origin of the Product Variant.
|
||||
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 Manufacturer Identification code for the Product Variant.
|
||||
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 composition of the Product Variant.
|
||||
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
|
||||
metadata:
|
||||
description: An optional set of key-value pairs with additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -4,10 +4,12 @@ required:
|
||||
- user
|
||||
properties:
|
||||
token:
|
||||
description: The invite token provided by the admin.
|
||||
description: >-
|
||||
The token of the invite to accept. This is a unique token generated when
|
||||
the invite was created or resent.
|
||||
type: string
|
||||
user:
|
||||
description: The User to create.
|
||||
description: The details of the user to create.
|
||||
type: object
|
||||
required:
|
||||
- first_name
|
||||
@@ -21,6 +23,6 @@ properties:
|
||||
type: string
|
||||
description: the last name of the User
|
||||
password:
|
||||
description: The desired password for the User
|
||||
description: The password for the User
|
||||
type: string
|
||||
format: password
|
||||
|
||||
@@ -4,11 +4,15 @@ required:
|
||||
- role
|
||||
properties:
|
||||
user:
|
||||
description: The email for the user to be created.
|
||||
description: >-
|
||||
The email associated with the invite. Once the invite is accepted, the
|
||||
email will be associated with the created user.
|
||||
type: string
|
||||
format: email
|
||||
role:
|
||||
description: The role of the user to be created.
|
||||
description: >-
|
||||
The role of the user to be created. This does not actually change the
|
||||
privileges of the user that is eventually created.
|
||||
type: string
|
||||
enum:
|
||||
- admin
|
||||
|
||||
@@ -4,4 +4,4 @@ required:
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
description: The updated description of the Note.
|
||||
description: The description of the Note.
|
||||
|
||||
@@ -6,10 +6,12 @@ required:
|
||||
properties:
|
||||
resource_id:
|
||||
type: string
|
||||
description: The ID of the resource which the Note relates to.
|
||||
description: >-
|
||||
The ID of the resource which the Note relates to. For example, an order
|
||||
ID.
|
||||
resource_type:
|
||||
type: string
|
||||
description: The type of resource which the Note relates to.
|
||||
description: The type of resource which the Note relates to. For example, `order`.
|
||||
value:
|
||||
type: string
|
||||
description: The content of the Note to create.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
type: object
|
||||
properties:
|
||||
to:
|
||||
description: A new address or user identifier that the Notification should be sent to
|
||||
description: >-
|
||||
A new address or user identifier that the Notification should be sent to.
|
||||
If not provided, the previous `to` field of the notification will be used.
|
||||
type: string
|
||||
|
||||
@@ -4,11 +4,15 @@ required:
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The ID of the variant ID to add
|
||||
description: The ID of the product variant associated with the item.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity to add
|
||||
description: The quantity of the item.
|
||||
type: number
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
type: object
|
||||
properties:
|
||||
internal_note:
|
||||
description: An optional note to create or update for the order edit.
|
||||
description: An optional note to create or update in the order edit.
|
||||
type: string
|
||||
|
||||
@@ -6,5 +6,5 @@ properties:
|
||||
description: The ID of the order to create the edit for.
|
||||
type: string
|
||||
internal_note:
|
||||
description: An optional note to create for the order edit.
|
||||
description: An optional note to associate with the order edit.
|
||||
type: string
|
||||
|
||||
+7
-1
@@ -3,6 +3,12 @@ properties:
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
no_notification:
|
||||
description: If set to true no notification will be send related to this Claim.
|
||||
description: >-
|
||||
If set to `true`, no notification will be sent to the customer related to
|
||||
this Claim.
|
||||
type: boolean
|
||||
|
||||
@@ -57,6 +57,12 @@ properties:
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: >-
|
||||
Learn about the metadata attribute, and how to delete and update
|
||||
it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
shipping_methods:
|
||||
description: The Shipping Methods to send the additional Line Items with.
|
||||
type: array
|
||||
@@ -81,3 +87,7 @@ properties:
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -6,7 +6,7 @@ properties:
|
||||
description: The ID of the Fulfillment.
|
||||
type: string
|
||||
tracking_numbers:
|
||||
description: The tracking numbers for the shipment.
|
||||
description: An array of tracking numbers for the shipment.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
|
||||
@@ -40,7 +40,7 @@ properties:
|
||||
- production_failure
|
||||
- other
|
||||
tags:
|
||||
description: A list o tags to add to the Claim Item
|
||||
description: A list of tags to add to the Claim Item
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
@@ -51,7 +51,8 @@ properties:
|
||||
return_shipping:
|
||||
description: >-
|
||||
Optional details for the Return Shipping Method, if the items are to be
|
||||
sent back.
|
||||
sent back. Providing this field will result in a return being created and
|
||||
associated with the claim.
|
||||
type: object
|
||||
properties:
|
||||
option_id:
|
||||
@@ -61,7 +62,9 @@ properties:
|
||||
type: integer
|
||||
description: The price to charge for the Shipping Method.
|
||||
additional_items:
|
||||
description: The new items to send to the Customer when the Claim type is Replace.
|
||||
description: >-
|
||||
The new items to send to the Customer. This is only used if the claim's
|
||||
type is `replace`.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -70,13 +73,15 @@ properties:
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The ID of the Product Variant to ship.
|
||||
description: The ID of the Product Variant.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Product Variant to ship.
|
||||
description: The quantity of the Product Variant.
|
||||
type: integer
|
||||
shipping_methods:
|
||||
description: The Shipping Methods to send the additional Line Items with.
|
||||
description: >-
|
||||
The Shipping Methods to send the additional Line Items with. This is only
|
||||
used if the claim's type is `replace`.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -95,11 +100,13 @@ properties:
|
||||
type: object
|
||||
shipping_address:
|
||||
description: >-
|
||||
An optional shipping address to send the claim to. Defaults to the parent
|
||||
order's shipping address
|
||||
An optional shipping address to send the claimed items to. If not
|
||||
provided, the parent order's shipping address will be used.
|
||||
$ref: ./AddressPayload.yaml
|
||||
refund_amount:
|
||||
description: The amount to refund the Customer when the Claim type is `refund`.
|
||||
description: >-
|
||||
The amount to refund the customer. This is used when the claim's type is
|
||||
`refund`.
|
||||
type: integer
|
||||
no_notification:
|
||||
description: If set to true no notification will be send related to this Claim.
|
||||
@@ -107,3 +114,7 @@ properties:
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -12,14 +12,20 @@ properties:
|
||||
- quantity
|
||||
properties:
|
||||
item_id:
|
||||
description: The ID of Line Item to fulfill.
|
||||
description: The ID of the Line Item to fulfill.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Line Item to fulfill.
|
||||
type: integer
|
||||
no_notification:
|
||||
description: If set to true no notification will be send related to this Swap.
|
||||
description: >-
|
||||
If set to `true`, no notification will be sent to the customer related to
|
||||
this fulfillment.
|
||||
type: boolean
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
@@ -4,7 +4,9 @@ required:
|
||||
- reason
|
||||
properties:
|
||||
amount:
|
||||
description: The amount to refund.
|
||||
description: >-
|
||||
The amount to refund. It should be less than or equal the
|
||||
`refundable_amount` of the order.
|
||||
type: integer
|
||||
reason:
|
||||
description: The reason for the Refund.
|
||||
@@ -13,5 +15,7 @@ properties:
|
||||
description: A note with additional details about the Refund.
|
||||
type: string
|
||||
no_notification:
|
||||
description: If set to true no notification will be send related to this Refund.
|
||||
description: >-
|
||||
If set to `true`, no notification will be sent to the customer related to
|
||||
this Refund.
|
||||
type: boolean
|
||||
|
||||
@@ -1,39 +1,39 @@
|
||||
type: object
|
||||
properties:
|
||||
email:
|
||||
description: the email for the order
|
||||
description: the email associated with the order
|
||||
type: string
|
||||
billing_address:
|
||||
description: Billing address
|
||||
description: The order's billing address
|
||||
$ref: ./AddressPayload.yaml
|
||||
shipping_address:
|
||||
description: Shipping address
|
||||
description: The order's shipping address
|
||||
$ref: ./AddressPayload.yaml
|
||||
items:
|
||||
description: The Line Items for the order
|
||||
description: The line items of the order
|
||||
type: array
|
||||
items:
|
||||
$ref: ./LineItem.yaml
|
||||
region:
|
||||
description: ID of the region where the order belongs
|
||||
description: ID of the region that the order is associated with.
|
||||
type: string
|
||||
discounts:
|
||||
description: Discounts applied to the order
|
||||
description: The discounts applied to the order
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Discount.yaml
|
||||
customer_id:
|
||||
description: ID of the customer
|
||||
description: The ID of the customer associated with the order.
|
||||
type: string
|
||||
payment_method:
|
||||
description: payment method chosen for the order
|
||||
description: The payment method chosen for the order.
|
||||
type: object
|
||||
properties:
|
||||
provider_id:
|
||||
type: string
|
||||
description: ID of the payment provider
|
||||
description: The ID of the payment provider.
|
||||
data:
|
||||
description: Data relevant for the given payment method
|
||||
description: Any data relevant for the given payment method.
|
||||
type: object
|
||||
shipping_method:
|
||||
description: The Shipping Method used for shipping the order.
|
||||
@@ -50,7 +50,7 @@ properties:
|
||||
description: The price of the shipping.
|
||||
data:
|
||||
type: object
|
||||
description: Data relevant to the specific shipping method.
|
||||
description: Any data relevant to the specific shipping method.
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
@@ -58,6 +58,6 @@ properties:
|
||||
description: Items to ship
|
||||
no_notification:
|
||||
description: >-
|
||||
A flag to indicate if no notifications should be emitted related to the
|
||||
updated order.
|
||||
If set to `true`, no notification will be sent to the customer related to
|
||||
this order.
|
||||
type: boolean
|
||||
|
||||
@@ -3,7 +3,7 @@ required:
|
||||
- items
|
||||
properties:
|
||||
items:
|
||||
description: The Line Items that will be returned.
|
||||
description: The line items that will be returned.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -44,8 +44,8 @@ properties:
|
||||
default: false
|
||||
no_notification:
|
||||
description: >-
|
||||
A flag to indicate if no notifications should be emitted related to the
|
||||
requested Return.
|
||||
If set to `true`, no notification will be sent to the customer related to
|
||||
this Return.
|
||||
type: boolean
|
||||
refund:
|
||||
description: The amount to refund.
|
||||
|
||||
@@ -13,4 +13,4 @@ properties:
|
||||
type: object
|
||||
description: >-
|
||||
The data required for the Shipping Option to create a Shipping Method.
|
||||
This will depend on the Fulfillment Provider.
|
||||
This depends on the Fulfillment Provider.
|
||||
|
||||
@@ -3,7 +3,7 @@ required:
|
||||
- return_items
|
||||
properties:
|
||||
return_items:
|
||||
description: The Line Items to return as part of the Swap.
|
||||
description: The Line Items to associate with the swap's return.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -12,7 +12,7 @@ properties:
|
||||
- quantity
|
||||
properties:
|
||||
item_id:
|
||||
description: The ID of the Line Item that will be claimed.
|
||||
description: The ID of the Line Item that will be returned.
|
||||
type: string
|
||||
quantity:
|
||||
description: The number of items that will be returned
|
||||
@@ -24,7 +24,7 @@ properties:
|
||||
description: An optional note with information about the Return.
|
||||
type: string
|
||||
return_shipping:
|
||||
description: How the Swap will be returned.
|
||||
description: The shipping method associated with the swap's return.
|
||||
type: object
|
||||
required:
|
||||
- option_id
|
||||
@@ -45,13 +45,15 @@ properties:
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The ID of the Product Variant to ship.
|
||||
description: The ID of the Product Variant.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Product Variant to ship.
|
||||
description: The quantity of the Product Variant.
|
||||
type: integer
|
||||
custom_shipping_options:
|
||||
description: The custom shipping options to potentially create a Shipping Method from.
|
||||
description: >-
|
||||
An array of custom shipping options to potentially create a Shipping
|
||||
Method from to send the additional items.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -60,15 +62,17 @@ properties:
|
||||
- price
|
||||
properties:
|
||||
option_id:
|
||||
description: The ID of the Shipping Option to override with a custom price.
|
||||
description: The ID of the Shipping Option.
|
||||
type: string
|
||||
price:
|
||||
description: The custom price of the Shipping Option.
|
||||
type: integer
|
||||
no_notification:
|
||||
description: If set to true no notification will be send related to this Swap.
|
||||
description: >-
|
||||
If set to `true`, no notification will be sent to the customer related to
|
||||
this Swap.
|
||||
type: boolean
|
||||
allow_backorder:
|
||||
description: If true, swaps can be completed with items out of stock
|
||||
description: If set to `true`, swaps can be completed with items out of stock
|
||||
type: boolean
|
||||
default: true
|
||||
|
||||
@@ -3,6 +3,12 @@ properties:
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
no_notification:
|
||||
description: If set to true no notification will be send related to this Claim.
|
||||
description: >-
|
||||
If set to `true`, no notification will be sent to the customer related to
|
||||
this swap.
|
||||
type: boolean
|
||||
|
||||
@@ -14,13 +14,13 @@ properties:
|
||||
type: string
|
||||
region_id:
|
||||
description: >-
|
||||
The ID of the Region for which the price is used. Only required if
|
||||
currecny_code is not provided.
|
||||
The ID of the Region for which the price is used. This is only
|
||||
required if `currecny_code` is not provided.
|
||||
type: string
|
||||
currency_code:
|
||||
description: >-
|
||||
The 3 character ISO currency code for which the price will be used.
|
||||
Only required if region_id is not provided.
|
||||
This is only required if `region_id` is not provided.
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||
@@ -39,6 +39,6 @@ properties:
|
||||
type: integer
|
||||
override:
|
||||
description: >-
|
||||
If true the prices will replace all existing prices associated with the
|
||||
Price List.
|
||||
If set to `true`, the prices will replace all existing prices associated
|
||||
with the Price List.
|
||||
type: boolean
|
||||
|
||||
@@ -4,7 +4,7 @@ properties:
|
||||
description: The name of the Price List
|
||||
type: string
|
||||
description:
|
||||
description: A description of the Price List.
|
||||
description: The description of the Price List.
|
||||
type: string
|
||||
starts_at:
|
||||
description: The date with timezone that the Price List starts being valid.
|
||||
@@ -21,7 +21,9 @@ properties:
|
||||
- sale
|
||||
- override
|
||||
status:
|
||||
description: The status of the Price List.
|
||||
description: >-
|
||||
The status of the Price List. If the status is set to `draft`, the prices
|
||||
created in the price list will not be available of the customer.
|
||||
type: string
|
||||
enum:
|
||||
- active
|
||||
@@ -40,13 +42,13 @@ properties:
|
||||
type: string
|
||||
region_id:
|
||||
description: >-
|
||||
The ID of the Region for which the price is used. Only required if
|
||||
currecny_code is not provided.
|
||||
The ID of the Region for which the price is used. This is only
|
||||
required if `currecny_code` is not provided.
|
||||
type: string
|
||||
currency_code:
|
||||
description: >-
|
||||
The 3 character ISO currency code for which the price will be used.
|
||||
Only required if region_id is not provided.
|
||||
This is only required if `region_id` is not provided.
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||
@@ -65,7 +67,7 @@ properties:
|
||||
type: integer
|
||||
customer_groups:
|
||||
type: array
|
||||
description: A list of customer groups that the Price List applies to.
|
||||
description: An array of customer groups that the Price List applies to.
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
@@ -75,5 +77,6 @@ properties:
|
||||
description: The ID of a customer group
|
||||
type: string
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Tax included in prices of price list'
|
||||
description: Tax included in prices of price list
|
||||
x-featureFlag: tax_inclusive_pricing
|
||||
type: boolean
|
||||
|
||||
@@ -6,10 +6,10 @@ required:
|
||||
- prices
|
||||
properties:
|
||||
name:
|
||||
description: The name of the Price List
|
||||
description: The name of the Price List.
|
||||
type: string
|
||||
description:
|
||||
description: A description of the Price List.
|
||||
description: The description of the Price List.
|
||||
type: string
|
||||
starts_at:
|
||||
description: The date with timezone that the Price List starts being valid.
|
||||
@@ -26,7 +26,9 @@ properties:
|
||||
- sale
|
||||
- override
|
||||
status:
|
||||
description: The status of the Price List.
|
||||
description: >-
|
||||
The status of the Price List. If the status is set to `draft`, the prices
|
||||
created in the price list will not be available of the customer.
|
||||
type: string
|
||||
enum:
|
||||
- active
|
||||
@@ -42,13 +44,13 @@ properties:
|
||||
properties:
|
||||
region_id:
|
||||
description: >-
|
||||
The ID of the Region for which the price is used. Only required if
|
||||
currecny_code is not provided.
|
||||
The ID of the Region for which the price is used. This is only
|
||||
required if `currecny_code` is not provided.
|
||||
type: string
|
||||
currency_code:
|
||||
description: >-
|
||||
The 3 character ISO currency code for which the price will be used.
|
||||
Only required if region_id is not provided.
|
||||
This is only required if `region_id` is not provided.
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||
@@ -67,7 +69,7 @@ properties:
|
||||
type: integer
|
||||
customer_groups:
|
||||
type: array
|
||||
description: A list of customer groups that the Price List applies to.
|
||||
description: An array of customer groups that the Price List applies to.
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
@@ -77,5 +79,6 @@ properties:
|
||||
description: The ID of a customer group
|
||||
type: string
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Tax included in prices of price list'
|
||||
description: Tax included in prices of price list
|
||||
x-featureFlag: tax_inclusive_pricing
|
||||
type: boolean
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user