chore(docs): Updated API Reference (v2) (#8619)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
2024-08-16 06:46:04 +00:00
committed by GitHub
parent 9bdcdc76a8
commit 0f67345308
122 changed files with 10621 additions and 6839 deletions
@@ -1,214 +0,0 @@
type: object
description: The shipping method's shipping methods.
x-schemaName: OrderShippingMethod
required:
- id
- order_id
- name
- amount
- raw_amount
- is_tax_inclusive
- created_at
- updated_at
- original_total
- original_subtotal
- original_tax_total
- total
- subtotal
- tax_total
- discount_total
- discount_tax_total
- raw_original_total
- raw_original_subtotal
- raw_original_tax_total
- raw_total
- raw_subtotal
- raw_tax_total
- raw_discount_total
- raw_discount_tax_total
properties:
id:
type: string
title: id
description: The shipping method's ID.
order_id:
type: string
title: order_id
description: The shipping method's order id.
name:
type: string
title: name
description: The shipping method's name.
description:
type: string
title: description
description: The shipping method's description.
amount:
oneOf:
- type: string
title: amount
description: The shipping method's amount.
- type: number
title: amount
description: The shipping method's amount.
- type: string
title: amount
description: The shipping method's amount.
- $ref: ./IBigNumber.yaml
raw_amount:
type: object
description: The shipping method's raw amount.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The shipping method's is tax inclusive.
shipping_option_id:
type: string
title: shipping_option_id
description: The shipping method's shipping option id.
data:
type: object
description: The shipping method's data.
metadata:
type: object
description: The shipping method's metadata.
tax_lines:
type: array
description: The shipping method's tax lines.
items:
$ref: ./OrderShippingMethodTaxLine.yaml
adjustments:
type: array
description: The shipping method's adjustments.
items:
$ref: ./OrderShippingMethodAdjustment.yaml
created_at:
type: string
format: date-time
title: created_at
description: The shipping method's created at.
updated_at:
type: string
format: date-time
title: updated_at
description: The shipping method's updated at.
original_total:
oneOf:
- type: string
title: original_total
description: The shipping method's original total.
- type: number
title: original_total
description: The shipping method's original total.
- type: string
title: original_total
description: The shipping method's original total.
- $ref: ./IBigNumber.yaml
original_subtotal:
oneOf:
- type: string
title: original_subtotal
description: The shipping method's original subtotal.
- type: number
title: original_subtotal
description: The shipping method's original subtotal.
- type: string
title: original_subtotal
description: The shipping method's original subtotal.
- $ref: ./IBigNumber.yaml
original_tax_total:
oneOf:
- type: string
title: original_tax_total
description: The shipping method's original tax total.
- type: number
title: original_tax_total
description: The shipping method's original tax total.
- type: string
title: original_tax_total
description: The shipping method's original tax total.
- $ref: ./IBigNumber.yaml
total:
oneOf:
- type: string
title: total
description: The shipping method's total.
- type: number
title: total
description: The shipping method's total.
- type: string
title: total
description: The shipping method's total.
- $ref: ./IBigNumber.yaml
subtotal:
oneOf:
- type: string
title: subtotal
description: The shipping method's subtotal.
- type: number
title: subtotal
description: The shipping method's subtotal.
- type: string
title: subtotal
description: The shipping method's subtotal.
- $ref: ./IBigNumber.yaml
tax_total:
oneOf:
- type: string
title: tax_total
description: The shipping method's tax total.
- type: number
title: tax_total
description: The shipping method's tax total.
- type: string
title: tax_total
description: The shipping method's tax total.
- $ref: ./IBigNumber.yaml
discount_total:
oneOf:
- type: string
title: discount_total
description: The shipping method's discount total.
- type: number
title: discount_total
description: The shipping method's discount total.
- type: string
title: discount_total
description: The shipping method's discount total.
- $ref: ./IBigNumber.yaml
discount_tax_total:
oneOf:
- type: string
title: discount_tax_total
description: The shipping method's discount tax total.
- type: number
title: discount_tax_total
description: The shipping method's discount tax total.
- type: string
title: discount_tax_total
description: The shipping method's discount tax total.
- $ref: ./IBigNumber.yaml
raw_original_total:
type: object
description: The shipping method's raw original total.
raw_original_subtotal:
type: object
description: The shipping method's raw original subtotal.
raw_original_tax_total:
type: object
description: The shipping method's raw original tax total.
raw_total:
type: object
description: The shipping method's raw total.
raw_subtotal:
type: object
description: The shipping method's raw subtotal.
raw_tax_total:
type: object
description: The shipping method's raw tax total.
raw_discount_total:
type: object
description: The shipping method's raw discount total.
raw_discount_tax_total:
type: object
description: The shipping method's raw discount tax total.