chore(docs): Generated API Reference (#3718)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
51d0b88404
commit
70435d5631
57
docs/api/admin/components/schemas/AddressCreatePayload.yaml
Normal file
57
docs/api/admin/components/schemas/AddressCreatePayload.yaml
Normal file
@@ -0,0 +1,57 @@
|
||||
type: object
|
||||
description: Address fields used when creating an address.
|
||||
required:
|
||||
- first_name
|
||||
- last_name
|
||||
- address_1
|
||||
- city
|
||||
- country_code
|
||||
- postal_code
|
||||
properties:
|
||||
first_name:
|
||||
description: First name
|
||||
type: string
|
||||
example: Arno
|
||||
last_name:
|
||||
description: Last name
|
||||
type: string
|
||||
example: Willms
|
||||
phone:
|
||||
type: string
|
||||
description: Phone Number
|
||||
example: 16128234334802
|
||||
company:
|
||||
type: string
|
||||
address_1:
|
||||
description: Address line 1
|
||||
type: string
|
||||
example: 14433 Kemmer Court
|
||||
address_2:
|
||||
description: Address line 2
|
||||
type: string
|
||||
example: Suite 369
|
||||
city:
|
||||
description: City
|
||||
type: string
|
||||
example: South Geoffreyview
|
||||
country_code:
|
||||
description: The 2 character ISO code of the country in lower case
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
||||
description: See a list of codes.
|
||||
example: st
|
||||
province:
|
||||
description: Province
|
||||
type: string
|
||||
example: Kentucky
|
||||
postal_code:
|
||||
description: Postal Code
|
||||
type: string
|
||||
example: 72093
|
||||
metadata:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
description: An optional key-value map with additional details
|
||||
@@ -1,53 +1,50 @@
|
||||
title: Address Fields
|
||||
description: Address fields used when creating/updating an address.
|
||||
type: object
|
||||
description: Address fields used when creating/updating an address.
|
||||
properties:
|
||||
company:
|
||||
type: string
|
||||
description: Company name
|
||||
example: Acme
|
||||
first_name:
|
||||
type: string
|
||||
description: First name
|
||||
type: string
|
||||
example: Arno
|
||||
last_name:
|
||||
type: string
|
||||
description: Last name
|
||||
example: Willms
|
||||
address_1:
|
||||
type: string
|
||||
example: Willms
|
||||
phone:
|
||||
type: string
|
||||
description: Phone Number
|
||||
example: 16128234334802
|
||||
company:
|
||||
type: string
|
||||
address_1:
|
||||
description: Address line 1
|
||||
type: string
|
||||
example: 14433 Kemmer Court
|
||||
address_2:
|
||||
type: string
|
||||
description: Address line 2
|
||||
type: string
|
||||
example: Suite 369
|
||||
city:
|
||||
type: string
|
||||
description: City
|
||||
type: string
|
||||
example: South Geoffreyview
|
||||
country_code:
|
||||
type: string
|
||||
description: The 2 character ISO code of the country in lower case
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
||||
description: See a list of codes.
|
||||
example: st
|
||||
province:
|
||||
type: string
|
||||
description: Province
|
||||
type: string
|
||||
example: Kentucky
|
||||
postal_code:
|
||||
type: string
|
||||
description: Postal Code
|
||||
example: 72093
|
||||
phone:
|
||||
type: string
|
||||
description: Phone Number
|
||||
example: 16128234334802
|
||||
example: 72093
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
example:
|
||||
car: white
|
||||
description: An optional key-value map with additional details
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- apps
|
||||
properties:
|
||||
apps:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- apps
|
||||
properties:
|
||||
apps:
|
||||
$ref: ./OAuth.yaml
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- user
|
||||
properties:
|
||||
user:
|
||||
$ref: ./User.yaml
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- batch_jobs
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
batch_jobs:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- batch_job
|
||||
properties:
|
||||
batch_job:
|
||||
$ref: ./BatchJob.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- collections
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
collections:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: collection
|
||||
relations:
|
||||
- products
|
||||
required:
|
||||
- collection
|
||||
properties:
|
||||
collection:
|
||||
$ref: ./ProductCollection.yaml
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- currencies
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
currencies:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- currency
|
||||
properties:
|
||||
currency:
|
||||
$ref: ./Currency.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- customer_groups
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
customer_groups:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- customer_group
|
||||
properties:
|
||||
customer_group:
|
||||
$ref: ./CustomerGroup.yaml
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- customers
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
customers:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: customer
|
||||
relations:
|
||||
- orders
|
||||
- shipping_addresses
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ./Customer.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- removed_products
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
- discount
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: discount_condition
|
||||
relations:
|
||||
- discount_rule
|
||||
required:
|
||||
- discount_condition
|
||||
properties:
|
||||
discount_condition:
|
||||
$ref: ./DiscountCondition.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,16 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: discounts
|
||||
relations:
|
||||
- parent_discount
|
||||
- regions
|
||||
- rule
|
||||
- rule.conditions
|
||||
required:
|
||||
- discounts
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
discounts:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,16 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: discount
|
||||
relations:
|
||||
- parent_discount
|
||||
- regions
|
||||
- rule
|
||||
- rule.conditions
|
||||
eager:
|
||||
- regions.fulfillment_providers
|
||||
- regions.payment_providers
|
||||
required:
|
||||
- discount
|
||||
properties:
|
||||
discount:
|
||||
$ref: ./Discount.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,16 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: draft_orders
|
||||
relations:
|
||||
- order
|
||||
- cart
|
||||
- cart.items
|
||||
- cart.items.adjustments
|
||||
required:
|
||||
- draft_orders
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
draft_orders:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,64 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: draft_order
|
||||
relations:
|
||||
- order
|
||||
- cart
|
||||
- cart.items
|
||||
- cart.items.adjustments
|
||||
- cart.billing_address
|
||||
- cart.customer
|
||||
- cart.discounts
|
||||
- cart.discounts.rule
|
||||
- cart.items
|
||||
- cart.items.adjustments
|
||||
- cart.payment
|
||||
- cart.payment_sessions
|
||||
- cart.region
|
||||
- cart.region.payment_providers
|
||||
- cart.shipping_address
|
||||
- cart.shipping_methods
|
||||
- cart.shipping_methods.shipping_option
|
||||
eager:
|
||||
- cart.region.fulfillment_providers
|
||||
- cart.region.payment_providers
|
||||
- cart.shipping_methods.shipping_option
|
||||
implicit:
|
||||
- cart.discounts
|
||||
- cart.discounts.rule
|
||||
- cart.gift_cards
|
||||
- cart.items
|
||||
- cart.items.adjustments
|
||||
- cart.items.tax_lines
|
||||
- cart.items.variant
|
||||
- cart.items.variant.product
|
||||
- cart.region
|
||||
- cart.region.tax_rates
|
||||
- cart.shipping_address
|
||||
- cart.shipping_methods
|
||||
- cart.shipping_methods.tax_lines
|
||||
totals:
|
||||
- cart.discount_total
|
||||
- cart.gift_card_tax_total
|
||||
- cart.gift_card_total
|
||||
- cart.item_tax_total
|
||||
- cart.refundable_amount
|
||||
- cart.refunded_total
|
||||
- cart.shipping_tax_total
|
||||
- cart.shipping_total
|
||||
- cart.subtotal
|
||||
- cart.tax_total
|
||||
- cart.total
|
||||
- cart.items.discount_total
|
||||
- cart.items.gift_card_total
|
||||
- cart.items.original_tax_total
|
||||
- cart.items.original_total
|
||||
- cart.items.refundable
|
||||
- cart.items.subtotal
|
||||
- cart.items.tax_total
|
||||
- cart.items.total
|
||||
required:
|
||||
- draft_order
|
||||
properties:
|
||||
draft_order:
|
||||
$ref: ./DraftOrder.yaml
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: store
|
||||
relations:
|
||||
- currencies
|
||||
- default_currency
|
||||
required:
|
||||
- store
|
||||
properties:
|
||||
store:
|
||||
$ref: ./ExtendedStoreDTO.yaml
|
||||
@@ -1,17 +1,24 @@
|
||||
type: object
|
||||
required:
|
||||
- fulfillment_options
|
||||
properties:
|
||||
fulfillment_options:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- provider_id
|
||||
- options
|
||||
properties:
|
||||
provider_id:
|
||||
type: string
|
||||
description: ID of the fulfillment provider
|
||||
type: string
|
||||
options:
|
||||
type: array
|
||||
description: fulfillment provider options
|
||||
example:
|
||||
- id: manual-fulfillment
|
||||
- id: manual-fulfillment-return
|
||||
is_return: true
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
example:
|
||||
- id: manual-fulfillment
|
||||
- id: manual-fulfillment-return
|
||||
is_return: true
|
||||
|
||||
@@ -1,21 +1,5 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: the id of the variant
|
||||
type: string
|
||||
inventory:
|
||||
description: the stock location address ID
|
||||
type: string
|
||||
sales_channel_availability:
|
||||
variant:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
properties:
|
||||
channel_name:
|
||||
description: Sales channel name
|
||||
type: string
|
||||
channel_id:
|
||||
description: Sales channel id
|
||||
type: string
|
||||
available_quantity:
|
||||
description: Available quantity in sales channel
|
||||
type: number
|
||||
$ref: ./VariantInventory.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,17 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: gift_cards
|
||||
relations:
|
||||
- order
|
||||
- region
|
||||
eager:
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
required:
|
||||
- gift_cards
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
gift_cards:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,14 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: gift_card
|
||||
relations:
|
||||
- order
|
||||
- region
|
||||
eager:
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
required:
|
||||
- gift_card
|
||||
properties:
|
||||
gift_card:
|
||||
$ref: ./GiftCard.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- inventory_items
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
inventory_items:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- inventory_items
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
inventory_items:
|
||||
type: array
|
||||
|
||||
@@ -1,9 +1,17 @@
|
||||
type: object
|
||||
required:
|
||||
- inventory_item
|
||||
properties:
|
||||
id:
|
||||
description: The id of the location
|
||||
location_levels:
|
||||
description: List of stock levels at a given location
|
||||
type: array
|
||||
items:
|
||||
$ref: ./InventoryLevelDTO.yaml
|
||||
inventory_item:
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- location_levels
|
||||
properties:
|
||||
id:
|
||||
description: The id of the location
|
||||
location_levels:
|
||||
description: List of stock levels at a given location
|
||||
type: array
|
||||
items:
|
||||
$ref: ./InventoryLevelDTO.yaml
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- inventory_item
|
||||
properties:
|
||||
inventory_item:
|
||||
$ref: ./InventoryItemDTO.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- invites
|
||||
properties:
|
||||
invites:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- notes
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
notes:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- note
|
||||
properties:
|
||||
note:
|
||||
$ref: ./Note.yaml
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: notifications
|
||||
relations:
|
||||
- resends
|
||||
required:
|
||||
- notifications
|
||||
properties:
|
||||
notifications:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: notification
|
||||
relations:
|
||||
- resends
|
||||
required:
|
||||
- notification
|
||||
properties:
|
||||
notification:
|
||||
$ref: ./Notification.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,44 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: order_edits
|
||||
relations:
|
||||
- changes
|
||||
- changes.line_item
|
||||
- changes.line_item.variant
|
||||
- changes.original_line_item
|
||||
- changes.original_line_item.variant
|
||||
- items
|
||||
- items.adjustments
|
||||
- items.tax_lines
|
||||
- items.variant
|
||||
- payment_collection
|
||||
implicit:
|
||||
- items
|
||||
- items.tax_lines
|
||||
- items.adjustments
|
||||
- items.variant
|
||||
totals:
|
||||
- difference_due
|
||||
- discount_total
|
||||
- gift_card_tax_total
|
||||
- gift_card_total
|
||||
- shipping_total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- total
|
||||
- items.discount_total
|
||||
- items.gift_card_total
|
||||
- items.original_tax_total
|
||||
- items.original_total
|
||||
- items.refundable
|
||||
- items.subtotal
|
||||
- items.tax_total
|
||||
- items.total
|
||||
required:
|
||||
- order_edits
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
order_edits:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,41 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: order_edit
|
||||
relations:
|
||||
- changes
|
||||
- changes.line_item
|
||||
- changes.line_item.variant
|
||||
- changes.original_line_item
|
||||
- changes.original_line_item.variant
|
||||
- items
|
||||
- items.adjustments
|
||||
- items.tax_lines
|
||||
- items.variant
|
||||
- payment_collection
|
||||
implicit:
|
||||
- items
|
||||
- items.tax_lines
|
||||
- items.adjustments
|
||||
- items.variant
|
||||
totals:
|
||||
- difference_due
|
||||
- discount_total
|
||||
- gift_card_tax_total
|
||||
- gift_card_total
|
||||
- shipping_total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- total
|
||||
- items.discount_total
|
||||
- items.gift_card_total
|
||||
- items.original_tax_total
|
||||
- items.original_total
|
||||
- items.refundable
|
||||
- items.subtotal
|
||||
- items.tax_total
|
||||
- items.total
|
||||
required:
|
||||
- order_edit
|
||||
properties:
|
||||
order_edit:
|
||||
$ref: ./OrderEdit.yaml
|
||||
|
||||
@@ -1,4 +1,112 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: orders
|
||||
relations:
|
||||
- billing_address
|
||||
- claims
|
||||
- claims.additional_items
|
||||
- claims.additional_items.variant
|
||||
- claims.claim_items
|
||||
- claims.claim_items.images
|
||||
- claims.claim_items.item
|
||||
- claims.fulfillments
|
||||
- claims.fulfillments.tracking_links
|
||||
- claims.return_order
|
||||
- claims.return_order.shipping_method
|
||||
- claims.return_order.shipping_method.tax_lines
|
||||
- claims.shipping_address
|
||||
- claims.shipping_methods
|
||||
- customer
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- fulfillments
|
||||
- fulfillments.items
|
||||
- fulfillments.tracking_links
|
||||
- gift_card_transactions
|
||||
- gift_cards
|
||||
- items
|
||||
- payments
|
||||
- refunds
|
||||
- region
|
||||
- returns
|
||||
- returns.items
|
||||
- returns.items.reason
|
||||
- returns.shipping_method
|
||||
- returns.shipping_method.tax_lines
|
||||
- shipping_address
|
||||
- shipping_methods
|
||||
eager:
|
||||
- fulfillments.items
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
- returns.items
|
||||
- shipping_methods.shipping_option
|
||||
implicit:
|
||||
- claims
|
||||
- claims.additional_items
|
||||
- claims.additional_items.adjustments
|
||||
- claims.additional_items.refundable
|
||||
- claims.additional_items.tax_lines
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- gift_card_transactions
|
||||
- gift_card_transactions.gift_card
|
||||
- gift_cards
|
||||
- items
|
||||
- items.adjustments
|
||||
- items.refundable
|
||||
- items.tax_lines
|
||||
- items.variant
|
||||
- items.variant.product
|
||||
- refunds
|
||||
- region
|
||||
- shipping_methods
|
||||
- shipping_methods.tax_lines
|
||||
- swaps
|
||||
- swaps.additional_items
|
||||
- swaps.additional_items.adjustments
|
||||
- swaps.additional_items.refundable
|
||||
- swaps.additional_items.tax_lines
|
||||
totals:
|
||||
- discount_total
|
||||
- gift_card_tax_total
|
||||
- gift_card_total
|
||||
- paid_total
|
||||
- refundable_amount
|
||||
- refunded_total
|
||||
- shipping_total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- total
|
||||
- claims.additional_items.discount_total
|
||||
- claims.additional_items.gift_card_total
|
||||
- claims.additional_items.original_tax_total
|
||||
- claims.additional_items.original_total
|
||||
- claims.additional_items.refundable
|
||||
- claims.additional_items.subtotal
|
||||
- claims.additional_items.tax_total
|
||||
- claims.additional_items.total
|
||||
- items.discount_total
|
||||
- items.gift_card_total
|
||||
- items.original_tax_total
|
||||
- items.original_total
|
||||
- items.refundable
|
||||
- items.subtotal
|
||||
- items.tax_total
|
||||
- items.total
|
||||
- swaps.additional_items.discount_total
|
||||
- swaps.additional_items.gift_card_total
|
||||
- swaps.additional_items.original_tax_total
|
||||
- swaps.additional_items.original_total
|
||||
- swaps.additional_items.refundable
|
||||
- swaps.additional_items.subtotal
|
||||
- swaps.additional_items.tax_total
|
||||
- swaps.additional_items.total
|
||||
required:
|
||||
- orders
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
orders:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,109 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: order
|
||||
relations:
|
||||
- billing_address
|
||||
- claims
|
||||
- claims.additional_items
|
||||
- claims.additional_items.variant
|
||||
- claims.claim_items
|
||||
- claims.claim_items.images
|
||||
- claims.claim_items.item
|
||||
- claims.fulfillments
|
||||
- claims.fulfillments.tracking_links
|
||||
- claims.return_order
|
||||
- claims.return_order.shipping_method
|
||||
- claims.return_order.shipping_method.tax_lines
|
||||
- claims.shipping_address
|
||||
- claims.shipping_methods
|
||||
- customer
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- fulfillments
|
||||
- fulfillments.items
|
||||
- fulfillments.tracking_links
|
||||
- gift_card_transactions
|
||||
- gift_cards
|
||||
- items
|
||||
- payments
|
||||
- refunds
|
||||
- region
|
||||
- returns
|
||||
- returns.items
|
||||
- returns.items.reason
|
||||
- returns.shipping_method
|
||||
- returns.shipping_method.tax_lines
|
||||
- shipping_address
|
||||
- shipping_methods
|
||||
eager:
|
||||
- fulfillments.items
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
- returns.items
|
||||
- shipping_methods.shipping_option
|
||||
implicit:
|
||||
- claims
|
||||
- claims.additional_items
|
||||
- claims.additional_items.adjustments
|
||||
- claims.additional_items.refundable
|
||||
- claims.additional_items.tax_lines
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- gift_card_transactions
|
||||
- gift_card_transactions.gift_card
|
||||
- gift_cards
|
||||
- items
|
||||
- items.adjustments
|
||||
- items.refundable
|
||||
- items.tax_lines
|
||||
- items.variant
|
||||
- items.variant.product
|
||||
- refunds
|
||||
- region
|
||||
- shipping_methods
|
||||
- shipping_methods.tax_lines
|
||||
- swaps
|
||||
- swaps.additional_items
|
||||
- swaps.additional_items.adjustments
|
||||
- swaps.additional_items.refundable
|
||||
- swaps.additional_items.tax_lines
|
||||
totals:
|
||||
- discount_total
|
||||
- gift_card_tax_total
|
||||
- gift_card_total
|
||||
- paid_total
|
||||
- refundable_amount
|
||||
- refunded_total
|
||||
- shipping_total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- total
|
||||
- claims.additional_items.discount_total
|
||||
- claims.additional_items.gift_card_total
|
||||
- claims.additional_items.original_tax_total
|
||||
- claims.additional_items.original_total
|
||||
- claims.additional_items.refundable
|
||||
- claims.additional_items.subtotal
|
||||
- claims.additional_items.tax_total
|
||||
- claims.additional_items.total
|
||||
- items.discount_total
|
||||
- items.gift_card_total
|
||||
- items.original_tax_total
|
||||
- items.original_total
|
||||
- items.refundable
|
||||
- items.subtotal
|
||||
- items.tax_total
|
||||
- items.total
|
||||
- swaps.additional_items.discount_total
|
||||
- swaps.additional_items.gift_card_total
|
||||
- swaps.additional_items.original_tax_total
|
||||
- swaps.additional_items.original_total
|
||||
- swaps.additional_items.refundable
|
||||
- swaps.additional_items.subtotal
|
||||
- swaps.additional_items.tax_total
|
||||
- swaps.additional_items.total
|
||||
required:
|
||||
- order
|
||||
properties:
|
||||
order:
|
||||
$ref: ./Order.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,15 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: payment_collection
|
||||
relations:
|
||||
- payment_sessions
|
||||
- payments
|
||||
- region
|
||||
eager:
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
required:
|
||||
- payment_collection
|
||||
properties:
|
||||
payment_collection:
|
||||
$ref: ./PaymentCollection.yaml
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- payment_providers
|
||||
properties:
|
||||
payment_providers:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- payment
|
||||
properties:
|
||||
payment:
|
||||
$ref: ./Payment.yaml
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- order
|
||||
properties:
|
||||
order:
|
||||
$ref: ./Order.yaml
|
||||
|
||||
@@ -17,12 +17,12 @@ properties:
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
shipping_address:
|
||||
description: The Address to be used for shipping.
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
discounts:
|
||||
description: An array of Discount codes to add to the Draft Order.
|
||||
|
||||
@@ -17,12 +17,12 @@ properties:
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
shipping_address:
|
||||
description: The Address to be used for shipping.
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
- $ref: ./AddressPayload.yaml
|
||||
- type: string
|
||||
items:
|
||||
description: The Line Items that have been received.
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
type: object
|
||||
properties:
|
||||
sku:
|
||||
description: The unique SKU for the Product Variant.
|
||||
type: string
|
||||
ean:
|
||||
description: The EAN number of the item.
|
||||
type: string
|
||||
upc:
|
||||
description: The UPC number of the item.
|
||||
type: string
|
||||
barcode:
|
||||
description: A generic GTIN field for the Product Variant.
|
||||
type: string
|
||||
hs_code:
|
||||
description: The Harmonized System code for the Product Variant.
|
||||
type: string
|
||||
inventory_quantity:
|
||||
description: The amount of stock kept for the Product Variant.
|
||||
type: integer
|
||||
default: 0
|
||||
allow_backorder:
|
||||
description: Whether the 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.
|
||||
type: boolean
|
||||
default: true
|
||||
weight:
|
||||
description: The wieght of the Product Variant.
|
||||
type: number
|
||||
length:
|
||||
description: The length of the Product Variant.
|
||||
type: number
|
||||
height:
|
||||
description: The height of the Product Variant.
|
||||
type: number
|
||||
width:
|
||||
description: The width of the Product Variant.
|
||||
type: number
|
||||
origin_country:
|
||||
description: The country of origin of the Product Variant.
|
||||
type: string
|
||||
mid_code:
|
||||
description: The Manufacturer Identification code for the Product Variant.
|
||||
type: string
|
||||
material:
|
||||
description: The material composition of the Product Variant.
|
||||
type: string
|
||||
metadata:
|
||||
description: An optional set of key-value pairs with additional information.
|
||||
type: object
|
||||
@@ -94,11 +94,10 @@ properties:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
shipping_address:
|
||||
type: object
|
||||
description: >-
|
||||
An optional shipping address to send the claim to. Defaults to the parent
|
||||
order's shipping address
|
||||
$ref: ./Address.yaml
|
||||
$ref: ./AddressPayload.yaml
|
||||
refund_amount:
|
||||
description: The amount to refund the Customer when the Claim type is `refund`.
|
||||
type: integer
|
||||
|
||||
@@ -5,12 +5,10 @@ properties:
|
||||
type: string
|
||||
billing_address:
|
||||
description: Billing address
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
$ref: ./AddressPayload.yaml
|
||||
shipping_address:
|
||||
description: Shipping address
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
$ref: ./AddressPayload.yaml
|
||||
items:
|
||||
description: The Line Items for the order
|
||||
type: array
|
||||
|
||||
@@ -15,3 +15,6 @@ properties:
|
||||
parent_category_id:
|
||||
type: string
|
||||
description: The ID of the parent product category
|
||||
rank:
|
||||
type: number
|
||||
description: The rank of the category in the tree node (starting from 0)
|
||||
|
||||
@@ -1,6 +1,21 @@
|
||||
type: object
|
||||
required:
|
||||
- reservation
|
||||
- location_id
|
||||
- inventory_item_id
|
||||
- quantity
|
||||
properties:
|
||||
reservation:
|
||||
$ref: ./ReservationItemDTO.yaml
|
||||
line_item_id:
|
||||
description: The id of the location of the reservation
|
||||
type: string
|
||||
location_id:
|
||||
description: The id of the location of the reservation
|
||||
type: string
|
||||
inventory_item_id:
|
||||
description: The id of the inventory item the reservation relates to
|
||||
type: string
|
||||
quantity:
|
||||
description: The id of the reservation item
|
||||
type: number
|
||||
metadata:
|
||||
description: An optional set of key-value pairs with additional information.
|
||||
type: object
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: price_list
|
||||
relations:
|
||||
- customer_groups
|
||||
- prices
|
||||
required:
|
||||
- price_list
|
||||
properties:
|
||||
price_list:
|
||||
$ref: ./PriceList.yaml
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- price_lists
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
price_lists:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,20 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: products
|
||||
relations:
|
||||
- categories
|
||||
- collection
|
||||
- images
|
||||
- options
|
||||
- tags
|
||||
- type
|
||||
- variants
|
||||
- variants.options
|
||||
required:
|
||||
- products
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
products:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: product_category
|
||||
relations:
|
||||
- category_children
|
||||
- parent_category
|
||||
required:
|
||||
- product_category
|
||||
properties:
|
||||
product_category:
|
||||
$ref: ./ProductCategory.yaml
|
||||
|
||||
@@ -1,4 +1,14 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: product_categories
|
||||
relations:
|
||||
- category_children
|
||||
- parent_category
|
||||
required:
|
||||
- product_categories
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
product_categories:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- product_tags
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
product_tags:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- product_types
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
product_types:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,20 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: product
|
||||
relations:
|
||||
- collection
|
||||
- images
|
||||
- options
|
||||
- tags
|
||||
- type
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
required:
|
||||
- option_id
|
||||
- object
|
||||
- deleted
|
||||
- product
|
||||
properties:
|
||||
option_id:
|
||||
type: string
|
||||
@@ -12,4 +28,4 @@ properties:
|
||||
description: Whether or not the items were deleted.
|
||||
default: true
|
||||
product:
|
||||
$ref: ./Product.yaml
|
||||
$ref: ./PricedProduct.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,20 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: product
|
||||
relations:
|
||||
- collection
|
||||
- images
|
||||
- options
|
||||
- tags
|
||||
- type
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
required:
|
||||
- variant_id
|
||||
- object
|
||||
- deleted
|
||||
- product
|
||||
properties:
|
||||
variant_id:
|
||||
type: string
|
||||
@@ -12,4 +28,4 @@ properties:
|
||||
description: Whether or not the items were deleted.
|
||||
default: true
|
||||
product:
|
||||
$ref: ./Product.yaml
|
||||
$ref: ./PricedProduct.yaml
|
||||
|
||||
@@ -1,11 +1,25 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: products
|
||||
relations:
|
||||
- collection
|
||||
- images
|
||||
- options
|
||||
- tags
|
||||
- type
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
required:
|
||||
- products
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
products:
|
||||
type: array
|
||||
items:
|
||||
oneOf:
|
||||
- $ref: ./Product.yaml
|
||||
- $ref: ./PricedProduct.yaml
|
||||
$ref: ./PricedProduct.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
type: object
|
||||
required:
|
||||
- tags
|
||||
properties:
|
||||
tags:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- usage_count
|
||||
- value
|
||||
properties:
|
||||
id:
|
||||
description: The ID of the tag.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- types
|
||||
properties:
|
||||
types:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- variants
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
variants:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,17 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: product
|
||||
relations:
|
||||
- collection
|
||||
- images
|
||||
- options
|
||||
- tags
|
||||
- type
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
required:
|
||||
- product
|
||||
properties:
|
||||
product:
|
||||
$ref: ./Product.yaml
|
||||
$ref: ./PricedProduct.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- publishable_api_keys
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
publishable_api_keys:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- sales_channels
|
||||
properties:
|
||||
sales_channels:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- publishable_api_key
|
||||
properties:
|
||||
publishable_api_key:
|
||||
$ref: ./PublishableApiKey.yaml
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- refund
|
||||
properties:
|
||||
refund:
|
||||
$ref: ./Refund.yaml
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,18 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: regions
|
||||
relations:
|
||||
- countries
|
||||
- fulfillment_providers
|
||||
- payment_providers
|
||||
eager:
|
||||
- fulfillment_providers
|
||||
- payment_providers
|
||||
required:
|
||||
- regions
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
regions:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,15 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: region
|
||||
relations:
|
||||
- countries
|
||||
- fulfillment_providers
|
||||
- payment_providers
|
||||
eager:
|
||||
- fulfillment_providers
|
||||
- payment_providers
|
||||
required:
|
||||
- region
|
||||
properties:
|
||||
region:
|
||||
$ref: ./Region.yaml
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The ID of the deleted Reservation.
|
||||
object:
|
||||
type: string
|
||||
description: The type of the object that was deleted.
|
||||
default: reservation
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether or not the Reservation was deleted.
|
||||
default: true
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- reservations
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
reservations:
|
||||
type: array
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- reservation
|
||||
properties:
|
||||
reservation:
|
||||
$ref: ./ReservationItemDTO.yaml
|
||||
@@ -1,4 +1,8 @@
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: return_reasons
|
||||
relations:
|
||||
- parent_return_reason
|
||||
- return_reason_children
|
||||
required:
|
||||
- return_reasons
|
||||
properties:
|
||||
return_reasons:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: return_reason
|
||||
relations:
|
||||
- parent_return_reason
|
||||
- return_reason_children
|
||||
required:
|
||||
- return_reason
|
||||
properties:
|
||||
return_reason:
|
||||
$ref: ./ReturnReason.yaml
|
||||
|
||||
@@ -1,4 +1,54 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: order
|
||||
relations:
|
||||
- billing_address
|
||||
- claims
|
||||
- claims.additional_items
|
||||
- claims.additional_items.variant
|
||||
- claims.claim_items
|
||||
- claims.claim_items.images
|
||||
- claims.claim_items.item
|
||||
- claims.fulfillments
|
||||
- claims.fulfillments.tracking_links
|
||||
- claims.return_order
|
||||
- claims.return_order.shipping_method
|
||||
- claims.return_order.shipping_method.tax_lines
|
||||
- claims.shipping_address
|
||||
- claims.shipping_methods
|
||||
- customer
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- fulfillments
|
||||
- fulfillments.items
|
||||
- fulfillments.tracking_links
|
||||
- gift_card_transactions
|
||||
- gift_cards
|
||||
- items
|
||||
- payments
|
||||
- refunds
|
||||
- region
|
||||
- returns
|
||||
- returns.items
|
||||
- returns.items.reason
|
||||
- returns.shipping_method
|
||||
- returns.shipping_method.tax_lines
|
||||
- shipping_address
|
||||
- shipping_methods
|
||||
- swaps
|
||||
- swaps.additional_items
|
||||
- swaps.additional_items.variant
|
||||
- swaps.fulfillments
|
||||
- swaps.fulfillments.tracking_links
|
||||
- swaps.payment
|
||||
- swaps.return_order
|
||||
- swaps.return_order.shipping_method
|
||||
- swaps.return_order.shipping_method.tax_lines
|
||||
- swaps.shipping_address
|
||||
- swaps.shipping_methods
|
||||
- swaps.shipping_methods.tax_lines
|
||||
required:
|
||||
- order
|
||||
properties:
|
||||
order:
|
||||
$ref: ./Order.yaml
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user