chore(docs): Generated API Reference (#2882)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
233d6904f8
commit
4814045036
-1
@@ -1,6 +1,5 @@
|
||||
title: Address
|
||||
description: An address.
|
||||
x-resourceId: address
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Address Fields
|
||||
description: Address fields used when creating/updating an address.
|
||||
x-resourceId: address
|
||||
type: object
|
||||
properties:
|
||||
company:
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Batch Job
|
||||
description: A Batch Job.
|
||||
x-resourceId: batch_job
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
+7
-8
@@ -1,6 +1,5 @@
|
||||
title: Cart
|
||||
description: Represents a user cart
|
||||
x-resourceId: cart
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@@ -17,19 +16,19 @@ properties:
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
billing_address:
|
||||
description: Available if the relation `billing_address` is expanded.
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
shipping_address_id:
|
||||
type: string
|
||||
description: The shipping address's ID
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
shipping_address:
|
||||
description: Available if the relation `shipping_address` is expanded.
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
items:
|
||||
description: Available if the relation `items` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
region_id:
|
||||
type: string
|
||||
description: The region's ID
|
||||
@@ -58,24 +57,24 @@ properties:
|
||||
type: object
|
||||
payment_session:
|
||||
description: The selected payment session in the cart.
|
||||
$ref: ./payment_session.yaml
|
||||
$ref: ./PaymentSession.yaml
|
||||
payment_sessions:
|
||||
type: array
|
||||
description: The payment sessions created on the cart.
|
||||
items:
|
||||
$ref: ./payment_session.yaml
|
||||
$ref: ./PaymentSession.yaml
|
||||
payment_id:
|
||||
type: string
|
||||
description: The payment's ID if available
|
||||
example: pay_01G8ZCC5W42ZNY842124G7P5R9
|
||||
payment:
|
||||
description: Available if the relation `payment` is expanded.
|
||||
$ref: ./payment.yaml
|
||||
$ref: ./Payment.yaml
|
||||
shipping_methods:
|
||||
type: array
|
||||
description: The shipping methods added to the cart.
|
||||
items:
|
||||
$ref: ./shipping_method.yaml
|
||||
$ref: ./ShippingMethod.yaml
|
||||
type:
|
||||
type: string
|
||||
description: The cart's type.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Claim Image
|
||||
description: Represents photo documentation of a claim.
|
||||
x-resourceId: claim_image
|
||||
type: object
|
||||
required:
|
||||
- claim_item_id
|
||||
+3
-4
@@ -2,7 +2,6 @@ title: Claim Item
|
||||
description: >-
|
||||
Represents a claimed item along with information about the reasons for the
|
||||
claim.
|
||||
x-resourceId: claim_item
|
||||
type: object
|
||||
required:
|
||||
- claim_order_id
|
||||
@@ -19,7 +18,7 @@ properties:
|
||||
type: array
|
||||
description: Available if the relation `images` is expanded.
|
||||
items:
|
||||
$ref: ./claim_image.yaml
|
||||
$ref: ./ClaimImage.yaml
|
||||
claim_order_id:
|
||||
description: The ID of the claim this item is associated with.
|
||||
type: string
|
||||
@@ -32,7 +31,7 @@ properties:
|
||||
example: item_01G8ZM25TN49YV9EQBE2NC27KC
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
variant_id:
|
||||
description: The ID of the product variant that is claimed.
|
||||
type: string
|
||||
@@ -64,7 +63,7 @@ properties:
|
||||
relation 'tags' is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./claim_tag.yaml
|
||||
$ref: ./ClaimTag.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+5
-6
@@ -3,7 +3,6 @@ description: >-
|
||||
Claim Orders represent a group of faulty or missing items. Each claim order
|
||||
consists of a subset of items associated with an original order, and can
|
||||
contain additional information about fulfillments and returns.
|
||||
x-resourceId: claim_order
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
@@ -43,14 +42,14 @@ properties:
|
||||
description: The items that have been claimed
|
||||
type: array
|
||||
items:
|
||||
$ref: ./claim_item.yaml
|
||||
$ref: ./ClaimItem.yaml
|
||||
additional_items:
|
||||
description: >-
|
||||
Refers to the new items to be shipped when the claim order has the type
|
||||
`replace`
|
||||
type: array
|
||||
items:
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
order_id:
|
||||
description: The ID of the order that the claim comes from.
|
||||
type: string
|
||||
@@ -69,17 +68,17 @@ properties:
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
shipping_address:
|
||||
description: Available if the relation `shipping_address` is expanded.
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
shipping_methods:
|
||||
description: The shipping methods that the claim order will be shipped with.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./shipping_method.yaml
|
||||
$ref: ./ShippingMethod.yaml
|
||||
fulfillments:
|
||||
description: The fulfillments of the new items to be shipped
|
||||
type: array
|
||||
items:
|
||||
$ref: ./fulfillment.yaml
|
||||
$ref: ./Fulfillment.yaml
|
||||
refund_amount:
|
||||
description: The amount that will be refunded in conjunction with the claim
|
||||
type: integer
|
||||
-1
@@ -2,7 +2,6 @@ title: Claim Tag
|
||||
description: >-
|
||||
Claim Tags are user defined tags that can be assigned to claim items for easy
|
||||
filtering and grouping.
|
||||
x-resourceId: claim_tag
|
||||
type: object
|
||||
required:
|
||||
- value
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Country
|
||||
description: Country details
|
||||
x-resourceId: country
|
||||
type: object
|
||||
required:
|
||||
- iso_2
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Currency
|
||||
description: Currency
|
||||
x-resourceId: currency
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
-1
@@ -3,7 +3,6 @@ description: >-
|
||||
Custom Shipping Options are 'overriden' Shipping Options. Store managers can
|
||||
attach a Custom Shipping Option to a cart in order to set a custom price for a
|
||||
particular Shipping Option
|
||||
x-resourceId: custom_shipping_option
|
||||
type: object
|
||||
required:
|
||||
- price
|
||||
+3
-4
@@ -1,6 +1,5 @@
|
||||
title: Customer
|
||||
description: Represents a customer
|
||||
x-resourceId: customer
|
||||
type: object
|
||||
required:
|
||||
- email
|
||||
@@ -27,12 +26,12 @@ properties:
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
billing_address:
|
||||
description: Available if the relation `billing_address` is expanded.
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
shipping_addresses:
|
||||
description: Available if the relation `shipping_addresses` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
phone:
|
||||
type: string
|
||||
description: The customer's phone number
|
||||
@@ -53,7 +52,7 @@ properties:
|
||||
`groups` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./customer_group.yaml
|
||||
$ref: ./CustomerGroup.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+1
-2
@@ -1,6 +1,5 @@
|
||||
title: Customer Group
|
||||
description: Represents a customer group
|
||||
x-resourceId: customer_group
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
@@ -27,7 +26,7 @@ properties:
|
||||
The price lists that are associated with the customer group. Available if
|
||||
the relation `price_lists` is expanded.
|
||||
items:
|
||||
$ref: ./price_list.yaml
|
||||
$ref: ./PriceList.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Discount
|
||||
description: Represents a discount that can be applied to a cart for promotional purposes.
|
||||
x-resourceId: discount
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
@@ -28,7 +27,7 @@ properties:
|
||||
example: dru_01F0YESMVK96HVX7N419E3CJ7C
|
||||
rule:
|
||||
description: Available if the relation `rule` is expanded.
|
||||
$ref: ./discount_rule.yaml
|
||||
$ref: ./DiscountRule.yaml
|
||||
is_disabled:
|
||||
description: >-
|
||||
Whether the Discount has been disabled. Disabled discounts cannot be
|
||||
@@ -43,7 +42,7 @@ properties:
|
||||
example: disc_01G8ZH853YPY9B94857DY91YGW
|
||||
parent_discount:
|
||||
description: Available if the relation `parent_discount` is expanded.
|
||||
$ref: ./discount.yaml
|
||||
$ref: ./Discount.yaml
|
||||
starts_at:
|
||||
description: The time at which the discount can be used.
|
||||
type: string
|
||||
+1
-2
@@ -1,6 +1,5 @@
|
||||
title: Discount Condition
|
||||
description: Holds rule conditions for when a discount is applicable
|
||||
x-resourceId: discount_condition
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
@@ -32,7 +31,7 @@ properties:
|
||||
example: dru_01F0YESMVK96HVX7N419E3CJ7C
|
||||
discount_rule:
|
||||
description: Available if the relation `discount_rule` is expanded.
|
||||
$ref: ./discount_rule.yaml
|
||||
$ref: ./DiscountRule.yaml
|
||||
products:
|
||||
description: >-
|
||||
products associated with this condition if type = products. Available if
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Product Tag Discount Condition
|
||||
description: Associates a discount condition with a customer group
|
||||
x-resourceId: discount_condition_customer_group
|
||||
type: object
|
||||
required:
|
||||
- customer_group_id
|
||||
@@ -16,10 +15,10 @@ properties:
|
||||
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
customer_group:
|
||||
description: Available if the relation `customer_group` is expanded.
|
||||
$ref: ./customer_group.yaml
|
||||
$ref: ./CustomerGroup.yaml
|
||||
discount_condition:
|
||||
description: Available if the relation `discount_condition` is expanded.
|
||||
$ref: ./discount_condition.yaml
|
||||
$ref: ./DiscountCondition.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Product Discount Condition
|
||||
description: Associates a discount condition with a product
|
||||
x-resourceId: discount_condition_product
|
||||
type: object
|
||||
required:
|
||||
- product_id
|
||||
@@ -16,10 +15,10 @@ properties:
|
||||
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
product:
|
||||
description: Available if the relation `product` is expanded.
|
||||
$ref: ./product.yaml
|
||||
$ref: ./Product.yaml
|
||||
discount_condition:
|
||||
description: Available if the relation `discount_condition` is expanded.
|
||||
$ref: ./discount_condition.yaml
|
||||
$ref: ./DiscountCondition.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Product Collection Discount Condition
|
||||
description: Associates a discount condition with a product collection
|
||||
x-resourceId: discount_condition_product_collection
|
||||
type: object
|
||||
required:
|
||||
- product_collection_id
|
||||
@@ -16,10 +15,10 @@ properties:
|
||||
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
product_collection:
|
||||
description: Available if the relation `product_collection` is expanded.
|
||||
$ref: ./product_collection.yaml
|
||||
$ref: ./ProductCollection.yaml
|
||||
discount_condition:
|
||||
description: Available if the relation `discount_condition` is expanded.
|
||||
$ref: ./discount_condition.yaml
|
||||
$ref: ./DiscountCondition.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Product Tag Discount Condition
|
||||
description: Associates a discount condition with a product tag
|
||||
x-resourceId: discount_condition_product_tag
|
||||
type: object
|
||||
required:
|
||||
- product_tag_id
|
||||
@@ -16,10 +15,10 @@ properties:
|
||||
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
product_tag:
|
||||
description: Available if the relation `product_tag` is expanded.
|
||||
$ref: ./product_tag.yaml
|
||||
$ref: ./ProductTag.yaml
|
||||
discount_condition:
|
||||
description: Available if the relation `discount_condition` is expanded.
|
||||
$ref: ./discount_condition.yaml
|
||||
$ref: ./DiscountCondition.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Product Type Discount Condition
|
||||
description: Associates a discount condition with a product type
|
||||
x-resourceId: discount_condition_product
|
||||
type: object
|
||||
required:
|
||||
- product_type_id
|
||||
@@ -16,10 +15,10 @@ properties:
|
||||
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
product_type:
|
||||
description: Available if the relation `product_type` is expanded.
|
||||
$ref: ./product_type.yaml
|
||||
$ref: ./ProductType.yaml
|
||||
discount_condition:
|
||||
description: Available if the relation `discount_condition` is expanded.
|
||||
$ref: ./discount_condition.yaml
|
||||
$ref: ./DiscountCondition.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -2,7 +2,6 @@ title: Discount Rule
|
||||
description: >-
|
||||
Holds the rules that governs how a Discount is calculated when applied to a
|
||||
Cart.
|
||||
x-resourceId: discount_rule
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: DraftOrder
|
||||
description: Represents a draft order
|
||||
x-resourceId: draft-order
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
-1
@@ -1,5 +1,4 @@
|
||||
title: Response Error
|
||||
x-resourceId: error
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
+3
-4
@@ -7,7 +7,6 @@ description: >-
|
||||
plugins will have asynchronous communications with these providers through
|
||||
webhooks in order to automatically update and synchronize the state of
|
||||
Fulfillments.
|
||||
x-resourceId: fulfillment
|
||||
type: object
|
||||
required:
|
||||
- provider_id
|
||||
@@ -45,7 +44,7 @@ properties:
|
||||
example: manual
|
||||
provider:
|
||||
description: Available if the relation `provider` is expanded.
|
||||
$ref: ./fulfillment_provider.yaml
|
||||
$ref: ./FulfillmentProvider.yaml
|
||||
items:
|
||||
description: >-
|
||||
The Fulfillment Items in the Fulfillment - these hold information about
|
||||
@@ -53,7 +52,7 @@ properties:
|
||||
`items` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./fulfillment_item.yaml
|
||||
$ref: ./FulfillmentItem.yaml
|
||||
tracking_links:
|
||||
description: >-
|
||||
The Tracking Links that can be used to track the status of the
|
||||
@@ -61,7 +60,7 @@ properties:
|
||||
Available if the relation `tracking_links` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./tracking_link.yaml
|
||||
$ref: ./TrackingLink.yaml
|
||||
tracking_numbers:
|
||||
deprecated: true
|
||||
description: >-
|
||||
+1
-2
@@ -2,7 +2,6 @@ title: Fulfillment Item
|
||||
description: >-
|
||||
Correlates a Line Item with a Fulfillment, keeping track of the quantity of
|
||||
the Line Item.
|
||||
x-resourceId: fulfillment_item
|
||||
type: object
|
||||
required:
|
||||
- fulfillment_id
|
||||
@@ -22,7 +21,7 @@ properties:
|
||||
type: object
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
quantity:
|
||||
description: The quantity of the Line Item that is included in the Fulfillment.
|
||||
type: integer
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Fulfillment Provider
|
||||
description: Represents a fulfillment provider plugin and holds its installation status.
|
||||
x-resourceId: fulfillment_provider
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
+4
-1
@@ -2,7 +2,6 @@ title: Gift Card
|
||||
description: >-
|
||||
Gift Cards are redeemable and represent a value that can be used towards the
|
||||
payment of an Order.
|
||||
x-resourceId: gift_card
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
@@ -52,6 +51,10 @@ properties:
|
||||
description: The time at which the Gift Card can no longer be used.
|
||||
type: string
|
||||
format: date-time
|
||||
tax_rate:
|
||||
description: The gift cards's tax rate that will be applied on calculating totals
|
||||
type: number
|
||||
example: 0
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -2,7 +2,6 @@ title: Gift Card Transaction
|
||||
description: >-
|
||||
Gift Card Transactions are created once a Customer uses a Gift Card to pay for
|
||||
their Order
|
||||
x-resourceId: gift_card_transaction
|
||||
type: object
|
||||
required:
|
||||
- gift_card_id
|
||||
-1
@@ -2,7 +2,6 @@ title: Idempotency Key
|
||||
description: >-
|
||||
Idempotency Key is used to continue a process in case of any failure that
|
||||
might occur.
|
||||
x-resourceId: idempotency_key
|
||||
type: object
|
||||
required:
|
||||
- idempotency_key
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Image
|
||||
description: Images holds a reference to a URL at which the image file can be found.
|
||||
x-resourceId: image
|
||||
type: object
|
||||
required:
|
||||
- url
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Invite
|
||||
description: Represents an invite
|
||||
x-resourceId: invite
|
||||
type: object
|
||||
required:
|
||||
- user_email
|
||||
+2
-3
@@ -4,7 +4,6 @@ description: >-
|
||||
checkout. When Line Items are purchased they will get copied to the resulting
|
||||
order and can eventually be referenced in Fulfillments and Returns. Line Items
|
||||
may also be created when processing Swaps and Claims.
|
||||
x-resourceId: line_item
|
||||
type: object
|
||||
required:
|
||||
- title
|
||||
@@ -47,12 +46,12 @@ properties:
|
||||
description: Available if the relation `tax_lines` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./line_item_tax_line.yaml
|
||||
$ref: ./LineItemTaxLine.yaml
|
||||
adjustments:
|
||||
description: Available if the relation `adjustments` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./line_item_adjustment.yaml
|
||||
$ref: ./LineItemAdjustment.yaml
|
||||
title:
|
||||
description: >-
|
||||
The title of the Line Item, this should be easily identifiable by the
|
||||
+3
-4
@@ -1,6 +1,5 @@
|
||||
title: Line Item Adjustment
|
||||
description: Represents an Line Item Adjustment
|
||||
x-resourceId: line_item_adjustment
|
||||
description: Represents a Line Item Adjustment
|
||||
type: object
|
||||
required:
|
||||
- item_id
|
||||
@@ -17,7 +16,7 @@ properties:
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
description:
|
||||
type: string
|
||||
description: The line item's adjustment description
|
||||
@@ -28,7 +27,7 @@ properties:
|
||||
example: disc_01F0YESMW10MGHWJKZSDDMN0VN
|
||||
discount:
|
||||
description: Available if the relation `discount` is expanded.
|
||||
$ref: ./discount.yaml
|
||||
$ref: ./Discount.yaml
|
||||
amount:
|
||||
type: number
|
||||
description: The adjustment amount
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Line Item Tax Line
|
||||
description: Represents an Line Item Tax Line
|
||||
x-resourceId: line_item_tax_line
|
||||
description: Represents a Line Item Tax Line
|
||||
type: object
|
||||
required:
|
||||
- item_id
|
||||
@@ -17,7 +16,7 @@ properties:
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
code:
|
||||
description: A code to identify the tax type by
|
||||
type: string
|
||||
+2
-3
@@ -5,7 +5,6 @@ description: >-
|
||||
with it to indicate the pricing in a given Currency or, for fully region-based
|
||||
pricing, the given price in a specific Region. If region-based pricing is used
|
||||
the amount will be in the currency defined for the Reigon.
|
||||
x-resourceId: money_amount
|
||||
type: object
|
||||
required:
|
||||
- currency_code
|
||||
@@ -24,7 +23,7 @@ properties:
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
$ref: ./currency.yaml
|
||||
$ref: ./Currency.yaml
|
||||
amount:
|
||||
description: >-
|
||||
The amount in the smallest currecny unit (e.g. cents 100 cents to charge
|
||||
@@ -49,7 +48,7 @@ properties:
|
||||
example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
|
||||
price_list:
|
||||
description: Available if the relation `price_list` is expanded.
|
||||
$ref: ./price_list.yaml
|
||||
$ref: ./PriceList.yaml
|
||||
variant_id:
|
||||
description: The id of the Product Variant contained in the Line Item.
|
||||
type: string
|
||||
+1
-2
@@ -1,12 +1,11 @@
|
||||
title: Multiple Errors
|
||||
x-resourceId: multiple_errors
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
description: Array of errors
|
||||
items:
|
||||
$ref: ./error.yaml
|
||||
$ref: ./Error.yaml
|
||||
message:
|
||||
type: string
|
||||
default: >-
|
||||
+1
-2
@@ -2,7 +2,6 @@ title: Note
|
||||
description: >-
|
||||
Notes are elements which we can use in association with different resources to
|
||||
allow users to describe additional information in relation to these.
|
||||
x-resourceId: note
|
||||
type: object
|
||||
required:
|
||||
- value
|
||||
@@ -31,7 +30,7 @@ properties:
|
||||
example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
|
||||
author:
|
||||
description: Available if the relation `author` is expanded.
|
||||
$ref: ./user.yaml
|
||||
$ref: ./User.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -4,7 +4,6 @@ description: >-
|
||||
to internal events such as `order.placed`. Notifications can be used to show a
|
||||
chronological timeline for communications sent to a Customer regarding an
|
||||
Order, and enables resends.
|
||||
x-resourceId: notification
|
||||
type: object
|
||||
required:
|
||||
- resource_type
|
||||
@@ -50,14 +49,14 @@ properties:
|
||||
description: The resends that have been completed after the original Notification.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./notification_resend.yaml
|
||||
$ref: ./NotificationResend.yaml
|
||||
provider_id:
|
||||
description: The id of the Notification Provider that handles the Notification.
|
||||
type: string
|
||||
example: sengrid
|
||||
provider:
|
||||
description: Available if the relation `provider` is expanded.
|
||||
$ref: ./notification_provider.yaml
|
||||
$ref: ./NotificationProvider.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Notification Provider
|
||||
description: Represents a notification provider plugin and holds its installation status.
|
||||
x-resourceId: notification_provider
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Notification Resend
|
||||
description: A resend of a Notification.
|
||||
x-resourceId: notification_resend
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@@ -44,14 +43,14 @@ properties:
|
||||
example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
|
||||
parent_notification:
|
||||
description: Available if the relation `parent_notification` is expanded.
|
||||
$ref: ./notification.yaml
|
||||
$ref: ./Notification.yaml
|
||||
provider_id:
|
||||
description: The ID of the Notification Provider that handles the Notification.
|
||||
type: string
|
||||
example: sengrid
|
||||
provider:
|
||||
description: Available if the relation `provider` is expanded.
|
||||
$ref: ./notification_provider.yaml
|
||||
$ref: ./NotificationProvider.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
@@ -1,6 +1,5 @@
|
||||
title: OAuth
|
||||
description: Represent an OAuth app
|
||||
x-resourceId: OAuth
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
|
||||
+9
-10
@@ -1,6 +1,5 @@
|
||||
title: Order
|
||||
description: Represents an order
|
||||
x-resourceId: order
|
||||
type: object
|
||||
required:
|
||||
- customer_id
|
||||
@@ -76,14 +75,14 @@ properties:
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
billing_address:
|
||||
description: Available if the relation `billing_address` is expanded.
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
shipping_address_id:
|
||||
type: string
|
||||
description: The ID of the shipping address associated with the order
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
shipping_address:
|
||||
description: Available if the relation `shipping_address` is expanded.
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
region_id:
|
||||
type: string
|
||||
description: The region's ID
|
||||
@@ -100,7 +99,7 @@ properties:
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
$ref: ./currency.yaml
|
||||
$ref: ./Currency.yaml
|
||||
tax_rate:
|
||||
description: The order's tax rate
|
||||
type: number
|
||||
@@ -127,21 +126,21 @@ properties:
|
||||
The shipping methods used in the order. Available if the relation
|
||||
`shipping_methods` is expanded.
|
||||
items:
|
||||
$ref: ./shipping_method.yaml
|
||||
$ref: ./ShippingMethod.yaml
|
||||
payments:
|
||||
type: array
|
||||
description: >-
|
||||
The payments used in the order. Available if the relation `payments` is
|
||||
expanded.
|
||||
items:
|
||||
$ref: ./payment.yaml
|
||||
$ref: ./Payment.yaml
|
||||
fulfillments:
|
||||
type: array
|
||||
description: >-
|
||||
The fulfillments used in the order. Available if the relation
|
||||
`fulfillments` is expanded.
|
||||
items:
|
||||
$ref: ./fulfillment.yaml
|
||||
$ref: ./Fulfillment.yaml
|
||||
returns:
|
||||
type: array
|
||||
description: >-
|
||||
@@ -187,21 +186,21 @@ properties:
|
||||
The line items that belong to the order. Available if the relation `items`
|
||||
is expanded.
|
||||
items:
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
edits:
|
||||
type: array
|
||||
description: >-
|
||||
[EXPERIMENTAL] Order edits done on the order. Available if the relation
|
||||
`edits` is expanded.
|
||||
items:
|
||||
$ref: ./order_edit.yaml
|
||||
$ref: ./OrderEdit.yaml
|
||||
gift_card_transactions:
|
||||
type: array
|
||||
description: >-
|
||||
The gift card transactions used in the order. Available if the relation
|
||||
`gift_card_transactions` is expanded.
|
||||
items:
|
||||
$ref: ./gift_card_transaction.yaml
|
||||
$ref: ./GiftCardTransaction.yaml
|
||||
canceled_at:
|
||||
type: string
|
||||
description: The date the order was canceled on.
|
||||
+4
-5
@@ -1,6 +1,5 @@
|
||||
title: Order Edit
|
||||
description: Order edit keeps track of order items changes.
|
||||
x-resourceId: order_edit
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
@@ -18,12 +17,12 @@ properties:
|
||||
example: order_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
order:
|
||||
description: Available if the relation `order` is expanded.
|
||||
$ref: ./order.yaml
|
||||
$ref: ./Order.yaml
|
||||
changes:
|
||||
type: array
|
||||
description: Available if the relation `changes` is expanded.
|
||||
items:
|
||||
$ref: ./order_item_change.yaml
|
||||
$ref: ./OrderItemChange.yaml
|
||||
internal_note:
|
||||
description: An optional note with additional details about the order edit.
|
||||
type: string
|
||||
@@ -106,14 +105,14 @@ properties:
|
||||
type: array
|
||||
description: Available if the relation `items` is expanded.
|
||||
items:
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
payment_collection_id:
|
||||
type: string
|
||||
description: The ID of the payment collection
|
||||
example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
payment_collection:
|
||||
description: Available if the relation `payment_collection` is expanded.
|
||||
$ref: ./payment_collection.yaml
|
||||
$ref: ./PaymentCollection.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+3
-4
@@ -1,6 +1,5 @@
|
||||
title: Order Item Change
|
||||
description: Represents an order edit item change
|
||||
x-resourceId: order_item_change
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
@@ -23,21 +22,21 @@ properties:
|
||||
example: oe_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
order_edit:
|
||||
description: Available if the relation `order_edit` is expanded.
|
||||
$ref: ./order_edit.yaml
|
||||
$ref: ./OrderEdit.yaml
|
||||
original_line_item_id:
|
||||
type: string
|
||||
description: The ID of the original line item in the order
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
original_line_item:
|
||||
description: Available if the relation `original_line_item` is expanded.
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
line_item_id:
|
||||
type: string
|
||||
description: The ID of the cloned line item.
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
line_item:
|
||||
description: Available if the relation `line_item` is expanded.
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+1
-2
@@ -2,7 +2,6 @@ title: Payment
|
||||
description: >-
|
||||
Payments represent an amount authorized with a given payment method, Payments
|
||||
can be captured, canceled or refunded.
|
||||
x-resourceId: payment
|
||||
type: object
|
||||
required:
|
||||
- amount
|
||||
@@ -46,7 +45,7 @@ properties:
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
$ref: ./currency.yaml
|
||||
$ref: ./Currency.yaml
|
||||
amount_refunded:
|
||||
description: >-
|
||||
The amount of the original Payment amount that has been refunded back to
|
||||
+4
-5
@@ -1,6 +1,5 @@
|
||||
title: Payment Collection
|
||||
description: Payment Collection
|
||||
x-resourceId: payment_collection
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
@@ -43,7 +42,7 @@ properties:
|
||||
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
||||
region:
|
||||
description: Available if the relation `region` is expanded.
|
||||
$ref: ./region.yaml
|
||||
$ref: ./Region.yaml
|
||||
currency_code:
|
||||
description: The 3 character ISO code for the currency.
|
||||
type: string
|
||||
@@ -53,17 +52,17 @@ properties:
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
$ref: ./currency.yaml
|
||||
$ref: ./Currency.yaml
|
||||
payment_sessions:
|
||||
type: array
|
||||
description: Available if the relation `payment_sessions` is expanded.
|
||||
items:
|
||||
$ref: ./payment_session.yaml
|
||||
$ref: ./PaymentSession.yaml
|
||||
payments:
|
||||
type: array
|
||||
description: Available if the relation `payments` is expanded.
|
||||
items:
|
||||
$ref: ./payment.yaml
|
||||
$ref: ./Payment.yaml
|
||||
created_by:
|
||||
type: string
|
||||
description: The ID of the user that created the payment collection.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Payment Provider
|
||||
description: Represents a Payment Provider plugin and holds its installation status.
|
||||
x-resourceId: payment_provider
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
-1
@@ -6,7 +6,6 @@ description: >-
|
||||
with external payment services. Authorized Payment Sessions will eventually
|
||||
get promoted to Payments to indicate that they are authorized for
|
||||
capture/refunds/etc.
|
||||
x-resourceId: payment_session
|
||||
type: object
|
||||
required:
|
||||
- cart_id
|
||||
+2
-3
@@ -2,7 +2,6 @@ title: Price List
|
||||
description: >-
|
||||
Price Lists represents a set of prices that overrides the default price for
|
||||
one or more product variants.
|
||||
x-resourceId: price_list
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
@@ -57,8 +56,8 @@ properties:
|
||||
type: array
|
||||
items:
|
||||
oneOf:
|
||||
- $ref: ./money_amount.yaml
|
||||
- $ref: ./customer_group.yaml
|
||||
- $ref: ./MoneyAmount.yaml
|
||||
- $ref: ./CustomerGroup.yaml
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Does the price list prices include tax'
|
||||
type: boolean
|
||||
+6
-7
@@ -3,7 +3,6 @@ description: >-
|
||||
Products are a grouping of Product Variants that have common properties such
|
||||
as images and descriptions. Products can have multiple options which define
|
||||
the properties that Product Variants differ by.
|
||||
x-resourceId: product
|
||||
type: object
|
||||
required:
|
||||
- title
|
||||
@@ -48,7 +47,7 @@ properties:
|
||||
description: Images of the Product. Available if the relation `images` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./image.yaml
|
||||
$ref: ./Image.yaml
|
||||
thumbnail:
|
||||
description: A URL to an image file that can be used to identify the Product.
|
||||
type: string
|
||||
@@ -60,7 +59,7 @@ properties:
|
||||
Available if the relation `options` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./product_option.yaml
|
||||
$ref: ./ProductOption.yaml
|
||||
variants:
|
||||
description: >-
|
||||
The Product Variants that belong to the Product. Each will have a unique
|
||||
@@ -68,7 +67,7 @@ properties:
|
||||
is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./product_variant.yaml
|
||||
$ref: ./ProductVariant.yaml
|
||||
profile_id:
|
||||
description: >-
|
||||
The ID of the Shipping Profile that the Product belongs to. Shipping
|
||||
@@ -78,7 +77,7 @@ properties:
|
||||
example: sp_01G1G5V239ENSZ5MV4JAR737BM
|
||||
profile:
|
||||
description: Available if the relation `profile` is expanded.
|
||||
$ref: ./shipping_profile.yaml
|
||||
$ref: ./ShippingProfile.yaml
|
||||
weight:
|
||||
description: >-
|
||||
The weight of the Product Variant. May be used in shipping rate
|
||||
@@ -144,14 +143,14 @@ properties:
|
||||
example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
type:
|
||||
description: Available if the relation `type` is expanded.
|
||||
$ref: ./product_type.yaml
|
||||
$ref: ./ProductType.yaml
|
||||
tags:
|
||||
description: >-
|
||||
The Product Tags assigned to the Product. Available if the relation `tags`
|
||||
is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./product_tag.yaml
|
||||
$ref: ./ProductTag.yaml
|
||||
discountable:
|
||||
description: >-
|
||||
Whether the Product can be discounted. Discounts will not apply to Line
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Product Collection
|
||||
description: Product Collections represents a group of Products that are related.
|
||||
x-resourceId: product_collection
|
||||
type: object
|
||||
required:
|
||||
- title
|
||||
+1
-2
@@ -3,7 +3,6 @@ description: >-
|
||||
Product Options define properties that may vary between different variants of
|
||||
a Product. Common Product Options are "Size" and "Color", but Medusa doesn't
|
||||
limit what Product Options that can be defined.
|
||||
x-resourceId: product_option
|
||||
type: object
|
||||
required:
|
||||
- title
|
||||
@@ -23,7 +22,7 @@ properties:
|
||||
Available if the relation `values` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./product_option_value.yaml
|
||||
$ref: ./ProductOptionValue.yaml
|
||||
product_id:
|
||||
description: The ID of the Product that the Product Option is defined for.
|
||||
type: string
|
||||
+2
-3
@@ -2,7 +2,6 @@ title: Product Option Value
|
||||
description: >-
|
||||
A value given to a Product Variant's option set. Product Variant have a
|
||||
Product Option Value for each of the Product Options defined on the Product.
|
||||
x-resourceId: product_option_value
|
||||
type: object
|
||||
required:
|
||||
- value
|
||||
@@ -26,7 +25,7 @@ properties:
|
||||
example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
|
||||
option:
|
||||
description: Available if the relation `option` is expanded.
|
||||
$ref: ./product_option.yaml
|
||||
$ref: ./ProductOption.yaml
|
||||
variant_id:
|
||||
description: >-
|
||||
The ID of the Product Variant that the Product Option Value is defined
|
||||
@@ -35,7 +34,7 @@ properties:
|
||||
example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
|
||||
variant:
|
||||
description: Available if the relation `variant` is expanded.
|
||||
$ref: ./product_variant.yaml
|
||||
$ref: ./ProductVariant.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Product Tag
|
||||
description: Product Tags can be added to Products for easy filtering and grouping.
|
||||
x-resourceId: product_tag
|
||||
type: object
|
||||
required:
|
||||
- value
|
||||
+2
-3
@@ -2,7 +2,6 @@ title: Product Tax Rate
|
||||
description: >-
|
||||
Associates a tax rate with a product to indicate that the product is taxed in
|
||||
a certain way
|
||||
x-resourceId: product_tax_rate
|
||||
type: object
|
||||
required:
|
||||
- product_id
|
||||
@@ -14,14 +13,14 @@ properties:
|
||||
example: prod_01G1G5V2MBA328390B5AXJ610F
|
||||
product:
|
||||
description: Available if the relation `product` is expanded.
|
||||
$ref: ./product.yaml
|
||||
$ref: ./Product.yaml
|
||||
rate_id:
|
||||
description: The ID of the Tax Rate
|
||||
type: string
|
||||
example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
|
||||
tax_rate:
|
||||
description: Available if the relation `tax_rate` is expanded.
|
||||
$ref: ./tax_rate.yaml
|
||||
$ref: ./TaxRate.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Product Type
|
||||
description: Product Type can be added to Products for filtering and reporting purposes.
|
||||
x-resourceId: product_type
|
||||
type: object
|
||||
required:
|
||||
- value
|
||||
+2
-3
@@ -2,7 +2,6 @@ title: Product Type Tax Rate
|
||||
description: >-
|
||||
Associates a tax rate with a product type to indicate that the product type is
|
||||
taxed in a certain way
|
||||
x-resourceId: product_type_tax_rate
|
||||
type: object
|
||||
required:
|
||||
- product_type_id
|
||||
@@ -14,14 +13,14 @@ properties:
|
||||
example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
product_type:
|
||||
description: Available if the relation `product_type` is expanded.
|
||||
$ref: ./product_type.yaml
|
||||
$ref: ./ProductType.yaml
|
||||
rate_id:
|
||||
description: The id of the Tax Rate
|
||||
type: string
|
||||
example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
|
||||
tax_rate:
|
||||
description: Available if the relation `tax_rate` is expanded.
|
||||
$ref: ./tax_rate.yaml
|
||||
$ref: ./TaxRate.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -3,7 +3,6 @@ description: >-
|
||||
Product Variants represent a Product with a specific set of Product Option
|
||||
configurations. The maximum number of Product Variants that a Product can have
|
||||
is given by the number of available Product Option combinations.
|
||||
x-resourceId: product_variant
|
||||
type: object
|
||||
required:
|
||||
- title
|
||||
@@ -34,7 +33,7 @@ properties:
|
||||
Available if the relation `prices` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./money_amount.yaml
|
||||
$ref: ./MoneyAmount.yaml
|
||||
sku:
|
||||
description: >-
|
||||
The unique stock keeping unit used to identify the Product Variant. This
|
||||
@@ -130,7 +129,7 @@ properties:
|
||||
the relation `options` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./product_option_value.yaml
|
||||
$ref: ./ProductOptionValue.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Product Variant Prices Fields
|
||||
description: Product Variants Prices Fields that are only available in some requests.
|
||||
x-resourceId: product_variant_prices_fields
|
||||
type: object
|
||||
properties:
|
||||
original_price:
|
||||
-1
@@ -2,7 +2,6 @@ title: Publishable API key
|
||||
description: >-
|
||||
Publishable API key defines scopes (i.e. resources) that are available within
|
||||
a request.
|
||||
x-resourceId: publishable_api_key
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Publishable API key sales channel
|
||||
description: Holds mapping between Publishable API keys and Sales Channels
|
||||
x-resourceId: publishable_api_key_sales_channel
|
||||
type: object
|
||||
properties:
|
||||
sales_channel_id:
|
||||
-1
@@ -3,7 +3,6 @@ description: >-
|
||||
Refund represent an amount of money transfered back to the Customer for a
|
||||
given reason. Refunds may occur in relation to Returns, Swaps and Claims, but
|
||||
can also be initiated by a store operator.
|
||||
x-resourceId: refund
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
+6
-7
@@ -4,7 +4,6 @@ description: >-
|
||||
The is, for example, where currencies and tax rates are defined. A Region can
|
||||
consist of multiple countries to accomodate common shopping settings across
|
||||
countries.
|
||||
x-resourceId: region
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
@@ -30,7 +29,7 @@ properties:
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
$ref: ./currency.yaml
|
||||
$ref: ./Currency.yaml
|
||||
tax_rate:
|
||||
description: The tax rate that should be charged on purchases in the Region.
|
||||
type: number
|
||||
@@ -41,7 +40,7 @@ properties:
|
||||
`tax_rates` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./tax_rate.yaml
|
||||
$ref: ./TaxRate.yaml
|
||||
tax_code:
|
||||
description: >-
|
||||
The tax code used on purchases in the Region. This may be used by other
|
||||
@@ -62,28 +61,28 @@ properties:
|
||||
`countries` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./country.yaml
|
||||
$ref: ./Country.yaml
|
||||
tax_provider_id:
|
||||
type: string
|
||||
description: The ID of the tax provider used in this region
|
||||
example: null
|
||||
tax_provider:
|
||||
description: Available if the relation `tax_provider` is expanded.
|
||||
$ref: ./tax_provider.yaml
|
||||
$ref: ./TaxProvider.yaml
|
||||
payment_providers:
|
||||
description: >-
|
||||
The Payment Providers that can be used to process Payments in the Region.
|
||||
Available if the relation `payment_providers` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./payment_provider.yaml
|
||||
$ref: ./PaymentProvider.yaml
|
||||
fulfillment_providers:
|
||||
description: >-
|
||||
The Fulfillment Providers that can be used to fulfill orders in the
|
||||
Region. Available if the relation `payment_providers` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./fulfillment_provider.yaml
|
||||
$ref: ./FulfillmentProvider.yaml
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Does the prices for the region include tax'
|
||||
type: boolean
|
||||
+2
-3
@@ -3,7 +3,6 @@ description: >-
|
||||
Return orders hold information about Line Items that a Customer wishes to send
|
||||
back, along with how the items will be returned. Returns can be used as part
|
||||
of a Swap.
|
||||
x-resourceId: return
|
||||
type: object
|
||||
required:
|
||||
- refund_amount
|
||||
@@ -27,7 +26,7 @@ properties:
|
||||
the relation `items` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./return_item.yaml
|
||||
$ref: ./ReturnItem.yaml
|
||||
swap_id:
|
||||
description: The ID of the Swap that the Return is a part of.
|
||||
type: string
|
||||
@@ -56,7 +55,7 @@ properties:
|
||||
the relation `shipping_method` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./shipping_method.yaml
|
||||
$ref: ./ShippingMethod.yaml
|
||||
shipping_data:
|
||||
description: >-
|
||||
Data about the return shipment as provided by the Fulfilment Provider that
|
||||
+3
-4
@@ -2,7 +2,6 @@ title: Return Item
|
||||
description: >-
|
||||
Correlates a Line Item with a Return, keeping track of the quantity of the
|
||||
Line Item that will be returned.
|
||||
x-resourceId: return_item
|
||||
type: object
|
||||
required:
|
||||
- return_id
|
||||
@@ -14,14 +13,14 @@ properties:
|
||||
example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
|
||||
return_order:
|
||||
description: Available if the relation `return_order` is expanded.
|
||||
$ref: ./return.yaml
|
||||
$ref: ./Return.yaml
|
||||
item_id:
|
||||
description: The id of the Line Item that the Return Item references.
|
||||
type: string
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
quantity:
|
||||
description: The quantity of the Line Item that is included in the Return.
|
||||
type: integer
|
||||
@@ -46,7 +45,7 @@ properties:
|
||||
example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
|
||||
reason:
|
||||
description: Available if the relation `reason` is expanded.
|
||||
$ref: ./return_reason.yaml
|
||||
$ref: ./ReturnReason.yaml
|
||||
note:
|
||||
description: An optional note with additional details about the Return.
|
||||
type: string
|
||||
+2
-3
@@ -2,7 +2,6 @@ title: Return Reason
|
||||
description: >-
|
||||
A Reason for why a given product is returned. A Return Reason can be used on
|
||||
Return Items in order to indicate why a Line Item was returned.
|
||||
x-resourceId: return_reason
|
||||
type: object
|
||||
required:
|
||||
- value
|
||||
@@ -30,10 +29,10 @@ properties:
|
||||
example: null
|
||||
parent_return_reason:
|
||||
description: Available if the relation `parent_return_reason` is expanded.
|
||||
$ref: ./return_reason.yaml
|
||||
$ref: ./ReturnReason.yaml
|
||||
return_reason_children:
|
||||
description: Available if the relation `return_reason_children` is expanded.
|
||||
$ref: ./return_reason.yaml
|
||||
$ref: ./ReturnReason.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Sales Channel
|
||||
description: A Sales Channel
|
||||
x-resourceId: sales_channel
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
+2
-3
@@ -4,7 +4,6 @@ description: >-
|
||||
Shipping Methods are built from a Shipping Option, but may contain additional
|
||||
details, that can be necessary for the Fulfillment Provider to handle the
|
||||
shipment.
|
||||
x-resourceId: shipping_method
|
||||
type: object
|
||||
required:
|
||||
- shipping_option_id
|
||||
@@ -20,7 +19,7 @@ properties:
|
||||
example: so_01G1G5V27GYX4QXNARRQCW1N8T
|
||||
shipping_option:
|
||||
description: Available if the relation `shipping_option` is expanded.
|
||||
$ref: ./shipping_option.yaml
|
||||
$ref: ./ShippingOption.yaml
|
||||
order_id:
|
||||
description: The id of the Order that the Shipping Method is used on.
|
||||
type: string
|
||||
@@ -60,7 +59,7 @@ properties:
|
||||
type: array
|
||||
description: Available if the relation `tax_lines` is expanded.
|
||||
items:
|
||||
$ref: ./shipping_method_tax_line.yaml
|
||||
$ref: ./ShippingMethodTaxLine.yaml
|
||||
price:
|
||||
description: >-
|
||||
The amount to charge for the Shipping Method. The currency of the price is
|
||||
+1
-2
@@ -1,6 +1,5 @@
|
||||
title: Shipping Method Tax Line
|
||||
description: Shipping Method Tax Line
|
||||
x-resourceId: shipping_method_tax_line
|
||||
type: object
|
||||
required:
|
||||
- shipping_method_id
|
||||
@@ -17,7 +16,7 @@ properties:
|
||||
example: sm_01F0YET7DR2E7CYVSDHM593QG2
|
||||
shipping_method:
|
||||
description: Available if the relation `shipping_method` is expanded.
|
||||
$ref: ./shipping_method.yaml
|
||||
$ref: ./ShippingMethod.yaml
|
||||
code:
|
||||
description: A code to identify the tax type by
|
||||
type: string
|
||||
+3
-4
@@ -6,7 +6,6 @@ description: >-
|
||||
cannot be added to Carts, but serve as a template for Shipping Methods. This
|
||||
distinction makes it possible to customize individual Shipping Methods with
|
||||
additional information.
|
||||
x-resourceId: shipping_option
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
@@ -41,7 +40,7 @@ properties:
|
||||
example: sp_01G1G5V239ENSZ5MV4JAR737BM
|
||||
profile:
|
||||
description: Available if the relation `profile` is expanded.
|
||||
$ref: ./shipping_profile.yaml
|
||||
$ref: ./ShippingProfile.yaml
|
||||
provider_id:
|
||||
description: >-
|
||||
The id of the Fulfillment Provider, that will be used to process
|
||||
@@ -50,7 +49,7 @@ properties:
|
||||
example: manual
|
||||
provider:
|
||||
description: Available if the relation `provider` is expanded.
|
||||
$ref: ./fulfillment_provider.yaml
|
||||
$ref: ./FulfillmentProvider.yaml
|
||||
price_type:
|
||||
description: >-
|
||||
The type of pricing calculation that is used when creatin Shipping Methods
|
||||
@@ -78,7 +77,7 @@ properties:
|
||||
expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./shipping_option_requirement.yaml
|
||||
$ref: ./ShippingOptionRequirement.yaml
|
||||
data:
|
||||
description: >-
|
||||
The data needed for the Fulfillment Provider to identify the Shipping
|
||||
+1
-2
@@ -2,7 +2,6 @@ title: Shipping Option Requirement
|
||||
description: >-
|
||||
A requirement that a Cart must satisfy for the Shipping Option to be available
|
||||
to the Cart.
|
||||
x-resourceId: shipping_option_requirement
|
||||
type: object
|
||||
required:
|
||||
- shipping_option_id
|
||||
@@ -21,7 +20,7 @@ properties:
|
||||
example: so_01G1G5V27GYX4QXNARRQCW1N8T
|
||||
shipping_option:
|
||||
description: Available if the relation `shipping_option` is expanded.
|
||||
$ref: ./shipping_option.yaml
|
||||
$ref: ./ShippingOption.yaml
|
||||
type:
|
||||
description: >-
|
||||
The type of the requirement, this defines how the value will be compared
|
||||
+1
-2
@@ -2,7 +2,6 @@ title: Shipping Profile
|
||||
description: >-
|
||||
Shipping Profiles have a set of defined Shipping Options that can be used to
|
||||
fulfill a given set of Products.
|
||||
x-resourceId: shipping_profile
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
@@ -43,7 +42,7 @@ properties:
|
||||
expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./shipping_option.yaml
|
||||
$ref: ./ShippingOption.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
+2
-3
@@ -2,7 +2,6 @@ title: Shipping Tax Rate
|
||||
description: >-
|
||||
Associates a tax rate with a shipping option to indicate that the shipping
|
||||
option is taxed in a certain way
|
||||
x-resourceId: shipping_tax_rate
|
||||
type: object
|
||||
required:
|
||||
- shipping_option_id
|
||||
@@ -14,14 +13,14 @@ properties:
|
||||
example: so_01G1G5V27GYX4QXNARRQCW1N8T
|
||||
shipping_option:
|
||||
description: Available if the relation `shipping_option` is expanded.
|
||||
$ref: ./shipping_option.yaml
|
||||
$ref: ./ShippingOption.yaml
|
||||
rate_id:
|
||||
description: The ID of the Tax Rate
|
||||
type: string
|
||||
example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
|
||||
tax_rate:
|
||||
description: Available if the relation `tax_rate` is expanded.
|
||||
$ref: ./tax_rate.yaml
|
||||
$ref: ./TaxRate.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Staged Job
|
||||
description: A staged job resource
|
||||
x-resourceId: staged_job
|
||||
type: object
|
||||
required:
|
||||
- event_name
|
||||
+2
-3
@@ -1,6 +1,5 @@
|
||||
title: Store
|
||||
description: Holds settings for the Store, such as name, currencies, etc.
|
||||
x-resourceId: store
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@@ -20,14 +19,14 @@ properties:
|
||||
description: See a list of codes.
|
||||
default_currency:
|
||||
description: Available if the relation `default_currency` is expanded.
|
||||
$ref: ./currency.yaml
|
||||
$ref: ./Currency.yaml
|
||||
currencies:
|
||||
description: >-
|
||||
The currencies that are enabled for the Store. Available if the relation
|
||||
`currencies` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./currency.yaml
|
||||
$ref: ./Currency.yaml
|
||||
swap_link_template:
|
||||
description: >-
|
||||
A template to generate Swap links from. Use {{cart_id}} to include the
|
||||
@@ -0,0 +1,7 @@
|
||||
type: object
|
||||
required:
|
||||
- provider_id
|
||||
properties:
|
||||
provider_id:
|
||||
type: string
|
||||
description: The ID of the Payment Provider.
|
||||
@@ -0,0 +1,39 @@
|
||||
type: object
|
||||
properties:
|
||||
region_id:
|
||||
type: string
|
||||
description: The ID of the Region to create the Cart in.
|
||||
sales_channel_id:
|
||||
type: string
|
||||
description: '[EXPERIMENTAL] The ID of the Sales channel to create the Cart in.'
|
||||
country_code:
|
||||
type: string
|
||||
description: The 2 character ISO country code to create the Cart in.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
||||
description: See a list of codes.
|
||||
items:
|
||||
description: >-
|
||||
An optional array of `variant_id`, `quantity` pairs to generate Line Items
|
||||
from.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- variant_id
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The id of the Product Variant to generate a Line Item from.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Product Variant to add
|
||||
type: integer
|
||||
context:
|
||||
description: >-
|
||||
An optional object to provide context to the Cart. The `context` field is
|
||||
automatically populated with `ip` and `user_agent`
|
||||
type: object
|
||||
example:
|
||||
ip: '::1'
|
||||
user_agent: Chrome
|
||||
@@ -0,0 +1,62 @@
|
||||
type: object
|
||||
properties:
|
||||
region_id:
|
||||
type: string
|
||||
description: The id of the Region to create the Cart in.
|
||||
country_code:
|
||||
type: string
|
||||
description: The 2 character ISO country code to create the Cart in.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
||||
description: See a list of codes.
|
||||
email:
|
||||
type: string
|
||||
description: An email to be used on the Cart.
|
||||
format: email
|
||||
sales_channel_id:
|
||||
type: string
|
||||
description: The ID of the Sales channel to update the Cart with.
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
anyOf:
|
||||
- $ref: ./Address.yaml
|
||||
description: A full billing address object.
|
||||
- type: string
|
||||
description: The billing address ID
|
||||
shipping_address:
|
||||
description: The Address to be used for shipping.
|
||||
anyOf:
|
||||
- $ref: ./Address.yaml
|
||||
description: A full shipping address object.
|
||||
- type: string
|
||||
description: The shipping address ID
|
||||
gift_cards:
|
||||
description: An array of Gift Card codes to add to the Cart.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- code
|
||||
properties:
|
||||
code:
|
||||
description: The code that a Gift Card is identified by.
|
||||
type: string
|
||||
discounts:
|
||||
description: An array of Discount codes to add to the Cart.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- code
|
||||
properties:
|
||||
code:
|
||||
description: The code that a Discount is identifed by.
|
||||
type: string
|
||||
customer_id:
|
||||
description: The ID of the Customer to associate the Cart with.
|
||||
type: string
|
||||
context:
|
||||
description: An optional object to provide context to the Cart.
|
||||
type: object
|
||||
example:
|
||||
ip: '::1'
|
||||
user_agent: Chrome
|
||||
@@ -0,0 +1,7 @@
|
||||
type: object
|
||||
required:
|
||||
- token
|
||||
properties:
|
||||
token:
|
||||
description: The invite token provided by the admin.
|
||||
type: string
|
||||
@@ -0,0 +1,2 @@
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
@@ -0,0 +1,16 @@
|
||||
type: object
|
||||
required:
|
||||
- address
|
||||
properties:
|
||||
address:
|
||||
description: The Address to add to the Customer.
|
||||
allOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
- type: object
|
||||
required:
|
||||
- first_name
|
||||
- last_name
|
||||
- address_1
|
||||
- city
|
||||
- country_code
|
||||
- postal_code
|
||||
@@ -0,0 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- order_ids
|
||||
properties:
|
||||
order_ids:
|
||||
description: The ids of the orders to claim
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- email
|
||||
properties:
|
||||
email:
|
||||
description: The email of the customer.
|
||||
type: string
|
||||
format: email
|
||||
@@ -0,0 +1,27 @@
|
||||
type: object
|
||||
properties:
|
||||
first_name:
|
||||
description: The Customer's first name.
|
||||
type: string
|
||||
last_name:
|
||||
description: The Customer's last name.
|
||||
type: string
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
description: The full billing address object
|
||||
- type: string
|
||||
description: The ID of an existing billing address
|
||||
password:
|
||||
description: The Customer's password.
|
||||
type: string
|
||||
phone:
|
||||
description: The Customer's phone number.
|
||||
type: string
|
||||
email:
|
||||
description: The email of the customer.
|
||||
type: string
|
||||
metadata:
|
||||
description: Metadata about the customer.
|
||||
type: object
|
||||
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
required:
|
||||
- first_name
|
||||
- last_name
|
||||
- email
|
||||
- password
|
||||
properties:
|
||||
first_name:
|
||||
description: The Customer's first name.
|
||||
type: string
|
||||
last_name:
|
||||
description: The Customer's last name.
|
||||
type: string
|
||||
email:
|
||||
description: The email of the customer.
|
||||
type: string
|
||||
format: email
|
||||
password:
|
||||
description: The Customer's password.
|
||||
type: string
|
||||
format: password
|
||||
phone:
|
||||
description: The Customer's phone number.
|
||||
type: string
|
||||
@@ -0,0 +1,17 @@
|
||||
type: object
|
||||
required:
|
||||
- email
|
||||
- password
|
||||
- token
|
||||
properties:
|
||||
email:
|
||||
description: The email of the customer.
|
||||
type: string
|
||||
format: email
|
||||
password:
|
||||
description: The Customer's password.
|
||||
type: string
|
||||
format: password
|
||||
token:
|
||||
description: The reset password token
|
||||
type: string
|
||||
@@ -0,0 +1,5 @@
|
||||
type: object
|
||||
properties:
|
||||
declined_reason:
|
||||
type: string
|
||||
description: The reason for declining the OrderEdit.
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- session_ids
|
||||
properties:
|
||||
session_ids:
|
||||
description: List of Payment Session IDs to authorize.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
required:
|
||||
- sessions
|
||||
properties:
|
||||
sessions:
|
||||
description: >-
|
||||
An array of payment sessions related to the Payment Collection. If the
|
||||
session_id is not provided, existing sessions not present will be deleted
|
||||
and the provided ones will be created.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- provider_id
|
||||
- amount
|
||||
properties:
|
||||
provider_id:
|
||||
type: string
|
||||
description: The ID of the Payment Provider.
|
||||
amount:
|
||||
type: integer
|
||||
description: The amount .
|
||||
session_id:
|
||||
type: string
|
||||
description: The ID of the Payment Session to be updated.
|
||||
@@ -0,0 +1,40 @@
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
- items
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: The ID of the Order to create the Return from.
|
||||
items:
|
||||
description: The items to include in the Return.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- item_id
|
||||
- quantity
|
||||
properties:
|
||||
item_id:
|
||||
description: The ID of the Line Item from the Order.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity to return.
|
||||
type: integer
|
||||
reason_id:
|
||||
description: The ID of the return reason.
|
||||
type: string
|
||||
note:
|
||||
description: A note to add to the item returned.
|
||||
type: string
|
||||
return_shipping:
|
||||
description: >-
|
||||
If the Return is to be handled by the store operator the Customer can
|
||||
choose a Return Shipping Method. Alternatvely the Customer can handle the
|
||||
Return themselves.
|
||||
type: object
|
||||
required:
|
||||
- option_id
|
||||
properties:
|
||||
option_id:
|
||||
type: string
|
||||
description: The ID of the Shipping Option to create the Shipping Method from.
|
||||
@@ -0,0 +1,46 @@
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
- return_items
|
||||
- additional_items
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: The ID of the Order to create the Swap for.
|
||||
return_items:
|
||||
description: The items to include in the Return.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- item_id
|
||||
- quantity
|
||||
properties:
|
||||
item_id:
|
||||
description: The ID of the Line Item from the Order.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity to swap.
|
||||
type: integer
|
||||
reason_id:
|
||||
description: The ID of the reason of this return.
|
||||
type: string
|
||||
note:
|
||||
description: The note to add to the item being swapped.
|
||||
type: string
|
||||
return_shipping_option:
|
||||
type: string
|
||||
description: The ID of the Shipping Option to create the Shipping Method from.
|
||||
additional_items:
|
||||
description: The items to exchange the returned items to.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- variant_id
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The ID of the Product Variant to send.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity to send of the variant.
|
||||
type: integer
|
||||
+5
-6
@@ -7,7 +7,6 @@ description: >-
|
||||
the case where the amount paid for the the Products being returned exceed the
|
||||
amount to be paid for the new Products, a Refund will be issued for the
|
||||
difference.
|
||||
x-resourceId: swap
|
||||
type: object
|
||||
required:
|
||||
- fulfillment_status
|
||||
@@ -57,7 +56,7 @@ properties:
|
||||
`additional_items` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./line_item.yaml
|
||||
$ref: ./LineItem.yaml
|
||||
return_order:
|
||||
description: >-
|
||||
A return order object. The Return that is issued for the return part of
|
||||
@@ -69,13 +68,13 @@ properties:
|
||||
relation `fulfillments` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./fulfillment.yaml
|
||||
$ref: ./Fulfillment.yaml
|
||||
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
|
||||
$ref: ./Payment.yaml
|
||||
difference_due:
|
||||
description: >-
|
||||
The difference that is paid or refunded as a result of the Swap. May be
|
||||
@@ -91,14 +90,14 @@ properties:
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
shipping_address:
|
||||
description: Available if the relation `shipping_address` is expanded.
|
||||
$ref: ./address.yaml
|
||||
$ref: ./Address.yaml
|
||||
shipping_methods:
|
||||
description: >-
|
||||
The Shipping Methods used to fulfill the additional items purchased.
|
||||
Available if the relation `shipping_methods` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./shipping_method.yaml
|
||||
$ref: ./ShippingMethod.yaml
|
||||
cart_id:
|
||||
description: The id of the Cart that the Customer will use to confirm the Swap.
|
||||
type: string
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Tax Line
|
||||
description: Line item that specifies an amount of tax to add to a line item.
|
||||
x-resourceId: tax_line
|
||||
type: object
|
||||
required:
|
||||
- rate
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: Tax Provider
|
||||
description: The tax service used to calculate taxes
|
||||
x-resourceId: tax_provider
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
-1
@@ -2,7 +2,6 @@ title: Tax Rate
|
||||
description: >-
|
||||
A Tax Rate can be used to associate a certain rate to charge on products
|
||||
within a given Region
|
||||
x-resourceId: line_item
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
+1
-2
@@ -3,7 +3,6 @@ description: >-
|
||||
Tracking Link holds information about tracking numbers for a Fulfillment.
|
||||
Tracking Links can optionally contain a URL that can be visited to see the
|
||||
status of the shipment.
|
||||
x-resourceId: tracking_link
|
||||
type: object
|
||||
required:
|
||||
- tracking_number
|
||||
@@ -27,7 +26,7 @@ properties:
|
||||
example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
|
||||
fulfillment:
|
||||
description: Available if the relation `fulfillment` is expanded.
|
||||
$ref: ./fulfillment.yaml
|
||||
$ref: ./Fulfillment.yaml
|
||||
idempotency_key:
|
||||
type: string
|
||||
description: >-
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
title: User
|
||||
description: Represents a User who can manage store settings.
|
||||
x-resourceId: user
|
||||
type: object
|
||||
required:
|
||||
- email
|
||||
Reference in New Issue
Block a user