chore(docs): Generated API Reference (#2218)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
7c6521101e
commit
9ead8aedd1
@@ -2141,9 +2141,14 @@ paths:
|
||||
type: string
|
||||
- in: query
|
||||
name: currency_code
|
||||
description: to search for.
|
||||
style: form
|
||||
explode: false
|
||||
description: The 3 character ISO currency code to set prices based on.
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: 'https://en.wikipedia.org/wiki/ISO_4217#Active_codes'
|
||||
description: See a list of codes.
|
||||
- in: query
|
||||
name: tax_rate
|
||||
description: to search for.
|
||||
@@ -2693,6 +2698,30 @@ paths:
|
||||
description: The id of the Product.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: cart_id
|
||||
description: The ID of the customer's cart.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: region_id
|
||||
description: >-
|
||||
The ID of the region the customer is using. This is helpful to
|
||||
ensure correct prices are retrieved for a region.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: currency_code
|
||||
style: form
|
||||
explode: false
|
||||
description: >-
|
||||
The 3 character ISO currency code to set prices based on. This is
|
||||
helpful to ensure correct prices are retrieved for a currency.
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: 'https://en.wikipedia.org/wiki/ISO_4217#Active_codes'
|
||||
description: See a list of codes.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
@@ -4779,6 +4808,9 @@ components:
|
||||
description: The written name of the currency
|
||||
type: string
|
||||
example: US Dollar
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Does the currency prices include tax'
|
||||
type: boolean
|
||||
custom_shipping_option:
|
||||
title: Custom Shipping Option
|
||||
description: >-
|
||||
@@ -4835,6 +4867,11 @@ components:
|
||||
description: An optional key-value map with additional details
|
||||
example:
|
||||
car: white
|
||||
includes_tax:
|
||||
description: >-
|
||||
[EXPERIMENTAL] Indicates if the custom shipping option price include
|
||||
tax
|
||||
type: boolean
|
||||
customer_group:
|
||||
title: Customer Group
|
||||
description: Represents a customer group
|
||||
@@ -6134,6 +6171,9 @@ components:
|
||||
type: integer
|
||||
description: The total of the gift card of the line item
|
||||
example: 0
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax'
|
||||
type: boolean
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
@@ -6472,6 +6512,138 @@ components:
|
||||
type: object
|
||||
description: Any data necessary to the app.
|
||||
example: {}
|
||||
order_edit:
|
||||
title: Order Edit
|
||||
description: Order edit keeps track of order items changes.
|
||||
x-resourceId: order_edit
|
||||
required:
|
||||
- order_id
|
||||
- order
|
||||
- changes
|
||||
- created_by
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The order edit's ID
|
||||
example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
order_id:
|
||||
type: string
|
||||
description: The ID of the order that is edited
|
||||
example: order_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
order:
|
||||
description: Order object
|
||||
$ref: '#/components/schemas/order'
|
||||
changes:
|
||||
type: array
|
||||
description: Line item changes array.
|
||||
items:
|
||||
$ref: '#/components/schemas/order_item_change'
|
||||
internal_note:
|
||||
description: An optional note with additional details about the order edit.
|
||||
type: string
|
||||
example: Included two more items B to the order.
|
||||
created_by:
|
||||
type: string
|
||||
description: >-
|
||||
The unique identifier of the user or customer who created the order
|
||||
edit.
|
||||
requested_by:
|
||||
type: string
|
||||
description: >-
|
||||
The unique identifier of the user or customer who requested the
|
||||
order edit.
|
||||
requested_at:
|
||||
type: string
|
||||
description: The date with timezone at which the edit was requested.
|
||||
format: date-time
|
||||
confirmed_by:
|
||||
type: string
|
||||
description: >-
|
||||
The unique identifier of the user or customer who confirmed the
|
||||
order edit.
|
||||
confirmed_at:
|
||||
type: string
|
||||
description: The date with timezone at which the edit was confirmed.
|
||||
format: date-time
|
||||
declined_by:
|
||||
type: string
|
||||
description: >-
|
||||
The unique identifier of the user or customer who declined the order
|
||||
edit.
|
||||
declined_at:
|
||||
type: string
|
||||
description: The date with timezone at which the edit was declined.
|
||||
format: date-time
|
||||
declined_reason:
|
||||
description: An optional note why the order edit is declined.
|
||||
type: string
|
||||
subtotal:
|
||||
type: integer
|
||||
description: The subtotal for line items computed from changes.
|
||||
example: 8000
|
||||
discount_total:
|
||||
type: integer
|
||||
description: The total of discount
|
||||
example: 800
|
||||
tax_total:
|
||||
type: integer
|
||||
description: The total of tax
|
||||
example: 0
|
||||
total:
|
||||
type: integer
|
||||
description: The total amount of the edited order.
|
||||
example: 8200
|
||||
difference_due:
|
||||
type: integer
|
||||
description: >-
|
||||
The difference between the total amount of the order and total
|
||||
amount of edited order.
|
||||
example: 8200
|
||||
items:
|
||||
type: array
|
||||
description: Computed line items from the changes.
|
||||
items:
|
||||
$ref: '#/components/schemas/line_item'
|
||||
order_item_change:
|
||||
title: Order Item Change
|
||||
description: Represents an order edit item change
|
||||
x-resourceId: order_item_change
|
||||
required:
|
||||
- type
|
||||
- order_edit_id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The order item change's ID
|
||||
example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
type:
|
||||
type: string
|
||||
description: The order's status
|
||||
enum:
|
||||
- item_add
|
||||
- item_remove
|
||||
- item_update
|
||||
order_edit_id:
|
||||
type: string
|
||||
description: The ID of the order edit
|
||||
example: oe_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
order_edit:
|
||||
description: Order edit object
|
||||
$ref: '#/components/schemas/order_edit'
|
||||
original_line_item_id:
|
||||
type: string
|
||||
description: The ID of the original line item in the order
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
original_line_item:
|
||||
description: Original line item object.
|
||||
$ref: '#/components/schemas/line_item'
|
||||
line_item_id:
|
||||
type: string
|
||||
description: The ID of the cloned line item.
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
line_item:
|
||||
description: Line item object.
|
||||
$ref: '#/components/schemas/line_item'
|
||||
order:
|
||||
title: Order
|
||||
description: Represents an order
|
||||
@@ -6664,6 +6836,13 @@ components:
|
||||
`items` is expanded.
|
||||
items:
|
||||
$ref: '#/components/schemas/line_item'
|
||||
edits:
|
||||
type: array
|
||||
description: >-
|
||||
[EXPERIMENTAL] Order edits done on the order. Available if the
|
||||
relation `edits` is expanded.
|
||||
items:
|
||||
$ref: '#/components/schemas/order_edit'
|
||||
gift_card_transactions:
|
||||
type: array
|
||||
description: >-
|
||||
@@ -6995,7 +7174,12 @@ components:
|
||||
if the relation `prices` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/money_amount'
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/money_amount'
|
||||
- $ref: '#/components/schemas/customer_group'
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Does the price list prices include tax'
|
||||
type: boolean
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
@@ -7807,6 +7991,9 @@ components:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/fulfillment_provider'
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Does the prices for the region include tax'
|
||||
type: boolean
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
@@ -8201,6 +8388,9 @@ components:
|
||||
data, and may contain information such as a drop point id.
|
||||
type: object
|
||||
example: {}
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Indicates if the shipping method price include tax'
|
||||
type: boolean
|
||||
shipping_option_requirement:
|
||||
title: Shipping Option Requirement
|
||||
description: >-
|
||||
@@ -8335,6 +8525,9 @@ components:
|
||||
Shipping Option.
|
||||
type: object
|
||||
example: {}
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Does the shipping option price include tax'
|
||||
type: boolean
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
Reference in New Issue
Block a user