chore(docs): Generated API Reference (#3718)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
olivermrbl
olivermrbl
parent
51d0b88404
commit
70435d5631
@@ -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
|
||||
+17
-20
@@ -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
|
||||
@@ -174,6 +174,10 @@ properties:
|
||||
type: integer
|
||||
example: 1000
|
||||
discount_total:
|
||||
description: The total of discount rounded
|
||||
type: integer
|
||||
example: 800
|
||||
raw_discount_total:
|
||||
description: The total of discount
|
||||
type: integer
|
||||
example: 800
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
allOf:
|
||||
- $ref: ./Store.yaml
|
||||
- type: object
|
||||
required:
|
||||
- payment_providers
|
||||
- fulfillment_providers
|
||||
- feature_flags
|
||||
- modules
|
||||
properties:
|
||||
payment_providers:
|
||||
$ref: ./PaymentProvider.yaml
|
||||
fulfillment_providers:
|
||||
$ref: ./FulfillmentProvider.yaml
|
||||
feature_flags:
|
||||
$ref: ./FeatureFlagsResponse.yaml
|
||||
modules:
|
||||
$ref: ./ModulesResponse.yaml
|
||||
@@ -0,0 +1,13 @@
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- key
|
||||
- value
|
||||
properties:
|
||||
key:
|
||||
description: The key of the feature flag.
|
||||
type: string
|
||||
value:
|
||||
description: The value of the feature flag.
|
||||
type: boolean
|
||||
@@ -199,6 +199,10 @@ properties:
|
||||
type: integer
|
||||
example: 0
|
||||
discount_total:
|
||||
description: The total of discount of the line item rounded
|
||||
type: integer
|
||||
example: 0
|
||||
raw_discount_total:
|
||||
description: The total of discount of the line item
|
||||
type: integer
|
||||
example: 0
|
||||
|
||||
@@ -36,7 +36,7 @@ properties:
|
||||
$ref: ./Discount.yaml
|
||||
amount:
|
||||
description: The adjustment amount
|
||||
type: integer
|
||||
type: number
|
||||
example: 1000
|
||||
metadata:
|
||||
description: An optional key-value map with additional details
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- module
|
||||
- resolution
|
||||
properties:
|
||||
module:
|
||||
description: The key of the module.
|
||||
type: string
|
||||
resolution:
|
||||
description: The resolution path of the module or false if module is not installed.
|
||||
type: string
|
||||
@@ -267,10 +267,14 @@ properties:
|
||||
type: integer
|
||||
description: The total of shipping
|
||||
example: 1000
|
||||
discount_total:
|
||||
raw_discount_total:
|
||||
description: The total of discount
|
||||
type: integer
|
||||
example: 800
|
||||
discount_total:
|
||||
description: The total of discount rounded
|
||||
type: integer
|
||||
example: 800
|
||||
tax_total:
|
||||
description: The total of tax
|
||||
type: integer
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
title: Priced Shipping Option
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: ./ShippingOption.yaml
|
||||
- type: object
|
||||
properties:
|
||||
price_incl_tax:
|
||||
type: number
|
||||
description: Price including taxes
|
||||
tax_rates:
|
||||
type: array
|
||||
description: An array of applied tax rates
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
rate:
|
||||
type: number
|
||||
description: The tax rate value
|
||||
name:
|
||||
type: string
|
||||
description: The name of the tax rate
|
||||
code:
|
||||
type: string
|
||||
description: The code of the tax rate
|
||||
tax_amount:
|
||||
type: number
|
||||
description: The taxes applied.
|
||||
@@ -5,7 +5,6 @@ type: object
|
||||
required:
|
||||
- category_children
|
||||
- created_at
|
||||
- deleted_at
|
||||
- handle
|
||||
- id
|
||||
- is_active
|
||||
@@ -44,6 +43,10 @@ properties:
|
||||
type: boolean
|
||||
description: A flag to make product category visible/hidden in the store front
|
||||
default: false
|
||||
rank:
|
||||
type: integer
|
||||
description: An integer that depicts the rank of category in a tree node
|
||||
default: 0
|
||||
category_children:
|
||||
description: Available if the relation `category_children` are expanded.
|
||||
type: array
|
||||
@@ -75,8 +78,3 @@ properties:
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
allOf:
|
||||
- $ref: ./StockLocationDTO.yaml
|
||||
- type: object
|
||||
properties:
|
||||
sales_channels:
|
||||
$ref: ./SalesChannel.yaml
|
||||
@@ -1,4 +1,12 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: customer
|
||||
relations:
|
||||
- orders
|
||||
- orders.items
|
||||
- shipping_addresses
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ./Customer.yaml
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: shipping_options
|
||||
implicit:
|
||||
- profile
|
||||
- requirements
|
||||
required:
|
||||
- shipping_options
|
||||
properties:
|
||||
shipping_options:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./PricedShippingOption.yaml
|
||||
@@ -1,4 +1,61 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: cart
|
||||
relations:
|
||||
- billing_address
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- gift_cards
|
||||
- items
|
||||
- items.adjustments
|
||||
- items.variant
|
||||
- payment
|
||||
- payment_sessions
|
||||
- region
|
||||
- region.countries
|
||||
- region.payment_providers
|
||||
- shipping_address
|
||||
- shipping_methods
|
||||
eager:
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
- shipping_methods.shipping_option
|
||||
implicit:
|
||||
- items
|
||||
- items.variant
|
||||
- items.variant.product
|
||||
- items.tax_lines
|
||||
- items.adjustments
|
||||
- gift_cards
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- shipping_methods
|
||||
- shipping_methods.tax_lines
|
||||
- shipping_address
|
||||
- region
|
||||
- region.tax_rates
|
||||
totals:
|
||||
- discount_total
|
||||
- gift_card_tax_total
|
||||
- gift_card_total
|
||||
- item_tax_total
|
||||
- refundable_amount
|
||||
- refunded_total
|
||||
- shipping_tax_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:
|
||||
- cart
|
||||
properties:
|
||||
cart:
|
||||
$ref: ./Cart.yaml
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- collections
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
collections:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- collection
|
||||
properties:
|
||||
collection:
|
||||
$ref: ./ProductCollection.yaml
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
- data
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
|
||||
@@ -1,15 +1,101 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: orders
|
||||
relations:
|
||||
- customer
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- fulfillments
|
||||
- fulfillments.tracking_links
|
||||
- items
|
||||
- items.variant
|
||||
- payments
|
||||
- region
|
||||
- shipping_address
|
||||
- shipping_methods
|
||||
eager:
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
- shipping_methods.shipping_option
|
||||
implicit:
|
||||
- claims
|
||||
- claims.additional_items
|
||||
- claims.additional_items.adjustments
|
||||
- claims.additional_items.refundable
|
||||
- claims.additional_items.tax_lines
|
||||
- customer
|
||||
- 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_address
|
||||
- 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
|
||||
items:
|
||||
$ref: ./Order.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
type: integer
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
limit:
|
||||
type: integer
|
||||
limit:
|
||||
description: The number of items per page
|
||||
type: integer
|
||||
|
||||
@@ -1,15 +1,20 @@
|
||||
type: object
|
||||
required:
|
||||
- payment_methods
|
||||
properties:
|
||||
payment_methods:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- provider_id
|
||||
- data
|
||||
properties:
|
||||
provider_id:
|
||||
type: string
|
||||
description: The id of the Payment Provider where the payment method is saved.
|
||||
type: string
|
||||
data:
|
||||
type: object
|
||||
description: >-
|
||||
The data needed for the Payment Provider to use the saved payment
|
||||
method.
|
||||
type: object
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: customer
|
||||
relations:
|
||||
- billing_address
|
||||
- shipping_addresses
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ./Customer.yaml
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- customer
|
||||
properties:
|
||||
customer:
|
||||
$ref: ./Customer.yaml
|
||||
@@ -1,5 +1,7 @@
|
||||
type: object
|
||||
required:
|
||||
- exists
|
||||
properties:
|
||||
exists:
|
||||
type: boolean
|
||||
description: Whether email exists or not.
|
||||
type: boolean
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: product_categories
|
||||
relations:
|
||||
- category_children
|
||||
- parent_category
|
||||
required:
|
||||
- product_categories
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
product_categories:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./ProductCategory.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
@@ -1,4 +1,6 @@
|
||||
type: object
|
||||
required:
|
||||
- gift_card
|
||||
properties:
|
||||
gift_card:
|
||||
$ref: ./GiftCard.yaml
|
||||
|
||||
@@ -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,86 @@
|
||||
type: object
|
||||
required:
|
||||
- order
|
||||
x-expanded-relations:
|
||||
field: order
|
||||
relations:
|
||||
- customer
|
||||
- discounts
|
||||
- discounts.rule
|
||||
- fulfillments
|
||||
- fulfillments.tracking_links
|
||||
- items
|
||||
- items.variant
|
||||
- payments
|
||||
- region
|
||||
- shipping_address
|
||||
- shipping_methods
|
||||
eager:
|
||||
- fulfillments.items
|
||||
- region.fulfillment_providers
|
||||
- region.payment_providers
|
||||
- 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
|
||||
properties:
|
||||
order:
|
||||
$ref: ./Order.yaml
|
||||
|
||||
@@ -1,4 +1,14 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: payment_collection
|
||||
relations:
|
||||
- payment_sessions
|
||||
- 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_session
|
||||
properties:
|
||||
payment_session:
|
||||
$ref: ./PaymentSession.yaml
|
||||
|
||||
@@ -20,14 +20,14 @@ properties:
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
anyOf:
|
||||
- $ref: ./Address.yaml
|
||||
- $ref: ./AddressPayload.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
|
||||
- $ref: ./AddressPayload.yaml
|
||||
description: A full shipping address object.
|
||||
- type: string
|
||||
description: The shipping address ID
|
||||
|
||||
+1
-1
@@ -1,2 +1,2 @@
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
- $ref: ./AddressPayload.yaml
|
||||
|
||||
@@ -4,13 +4,4 @@ required:
|
||||
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
|
||||
$ref: ./AddressCreatePayload.yaml
|
||||
|
||||
@@ -9,7 +9,7 @@ properties:
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
anyOf:
|
||||
- $ref: ./AddressFields.yaml
|
||||
- $ref: ./AddressPayload.yaml
|
||||
description: The full billing address object
|
||||
- type: string
|
||||
description: The ID of an existing billing address
|
||||
|
||||
@@ -1,7 +1,11 @@
|
||||
type: object
|
||||
properties:
|
||||
hits:
|
||||
type: array
|
||||
description: >-
|
||||
Array of results. The format of the items depends on the search engine
|
||||
installed on the server.
|
||||
allOf:
|
||||
- type: object
|
||||
required:
|
||||
- hits
|
||||
properties:
|
||||
hits:
|
||||
description: >-
|
||||
Array of results. The format of the items depends on the search engine
|
||||
installed on the server.
|
||||
type: array
|
||||
- type: object
|
||||
|
||||
+7
-2
@@ -1,9 +1,14 @@
|
||||
type: object
|
||||
required:
|
||||
- product_tags
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
product_categories:
|
||||
product_tags:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./ProductCategory.yaml
|
||||
$ref: ./ProductTag.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
@@ -1,4 +1,9 @@
|
||||
type: object
|
||||
required:
|
||||
- product_types
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
product_types:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,21 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: products
|
||||
relations:
|
||||
- collection
|
||||
- images
|
||||
- options
|
||||
- options.values
|
||||
- tags
|
||||
- type
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
required:
|
||||
- products
|
||||
- count
|
||||
- offset
|
||||
- limit
|
||||
properties:
|
||||
products:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,18 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: product
|
||||
relations:
|
||||
- collection
|
||||
- images
|
||||
- options
|
||||
- options.values
|
||||
- tags
|
||||
- type
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
required:
|
||||
- product
|
||||
properties:
|
||||
product:
|
||||
$ref: ./PricedProduct.yaml
|
||||
|
||||
@@ -1,4 +1,15 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: regions
|
||||
relations:
|
||||
- countries
|
||||
- payment_providers
|
||||
- fulfillment_providers
|
||||
eager:
|
||||
- payment_providers
|
||||
- fulfillment_providers
|
||||
required:
|
||||
- regions
|
||||
properties:
|
||||
regions:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,15 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: region
|
||||
relations:
|
||||
- countries
|
||||
- payment_providers
|
||||
- fulfillment_providers
|
||||
eager:
|
||||
- payment_providers
|
||||
- fulfillment_providers
|
||||
required:
|
||||
- region
|
||||
properties:
|
||||
region:
|
||||
$ref: ./Region.yaml
|
||||
|
||||
@@ -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,13 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: return
|
||||
relations:
|
||||
- items
|
||||
- items.reason
|
||||
eager:
|
||||
- items
|
||||
required:
|
||||
- return
|
||||
properties:
|
||||
return:
|
||||
$ref: ./Return.yaml
|
||||
|
||||
@@ -1,6 +1,12 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: shipping_options
|
||||
relations:
|
||||
- requirements
|
||||
required:
|
||||
- shipping_options
|
||||
properties:
|
||||
shipping_options:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./ShippingOption.yaml
|
||||
$ref: ./PricedShippingOption.yaml
|
||||
|
||||
@@ -1,4 +1,21 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: swap
|
||||
relations:
|
||||
- additional_items
|
||||
- additional_items.variant
|
||||
- cart
|
||||
- fulfillments
|
||||
- order
|
||||
- payment
|
||||
- return_order
|
||||
- return_order.shipping_method
|
||||
- shipping_address
|
||||
- shipping_methods
|
||||
eager:
|
||||
- fulfillments.items
|
||||
required:
|
||||
- swap
|
||||
properties:
|
||||
swap:
|
||||
$ref: ./Swap.yaml
|
||||
|
||||
@@ -1,4 +1,12 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: variants
|
||||
relations:
|
||||
- prices
|
||||
- options
|
||||
- product
|
||||
required:
|
||||
- variants
|
||||
properties:
|
||||
variants:
|
||||
type: array
|
||||
|
||||
@@ -1,4 +1,12 @@
|
||||
type: object
|
||||
x-expanded-relations:
|
||||
field: variant
|
||||
relations:
|
||||
- prices
|
||||
- options
|
||||
- product
|
||||
required:
|
||||
- variant
|
||||
properties:
|
||||
variant:
|
||||
$ref: ./PricedVariant.yaml
|
||||
|
||||
Reference in New Issue
Block a user