chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
97c193be1b
commit
21badd069d
894 files changed
+35649
-28168
No files matched your search
@@ -1,3 +1,106 @@
|
||||
type: object
|
||||
description: The item's detail.
|
||||
description: The order item's detail.
|
||||
x-schemaName: OrderItem
|
||||
required:
|
||||
- id
|
||||
- item_id
|
||||
- item
|
||||
- quantity
|
||||
- raw_quantity
|
||||
- fulfilled_quantity
|
||||
- raw_fulfilled_quantity
|
||||
- delivered_quantity
|
||||
- raw_delivered_quantity
|
||||
- shipped_quantity
|
||||
- raw_shipped_quantity
|
||||
- return_requested_quantity
|
||||
- raw_return_requested_quantity
|
||||
- return_received_quantity
|
||||
- raw_return_received_quantity
|
||||
- return_dismissed_quantity
|
||||
- raw_return_dismissed_quantity
|
||||
- written_off_quantity
|
||||
- raw_written_off_quantity
|
||||
- metadata
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
item_id:
|
||||
type: string
|
||||
title: item_id
|
||||
description: The ID of the associated line item.
|
||||
item:
|
||||
type: object
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
raw_quantity:
|
||||
type: object
|
||||
description: The item's raw quantity.
|
||||
fulfilled_quantity:
|
||||
type: number
|
||||
title: fulfilled_quantity
|
||||
description: The item's fulfilled quantity.
|
||||
raw_fulfilled_quantity:
|
||||
type: object
|
||||
description: The item's raw fulfilled quantity.
|
||||
delivered_quantity:
|
||||
type: number
|
||||
title: delivered_quantity
|
||||
description: The item's delivered quantity.
|
||||
raw_delivered_quantity:
|
||||
type: object
|
||||
description: The item's raw delivered quantity.
|
||||
shipped_quantity:
|
||||
type: number
|
||||
title: shipped_quantity
|
||||
description: The item's shipped quantity.
|
||||
raw_shipped_quantity:
|
||||
type: object
|
||||
description: The item's raw shipped quantity.
|
||||
return_requested_quantity:
|
||||
type: number
|
||||
title: return_requested_quantity
|
||||
description: The item's quantity that's requested to be returned.
|
||||
raw_return_requested_quantity:
|
||||
type: object
|
||||
description: The item's raw return requested quantity.
|
||||
return_received_quantity:
|
||||
type: number
|
||||
title: return_received_quantity
|
||||
description: The item's quantity that's received through a return.
|
||||
raw_return_received_quantity:
|
||||
type: object
|
||||
description: The item's raw return received quantity.
|
||||
return_dismissed_quantity:
|
||||
type: number
|
||||
title: return_dismissed_quantity
|
||||
description: The item's quantity that's returned but dismissed because it's damaged.
|
||||
raw_return_dismissed_quantity:
|
||||
type: object
|
||||
description: The item's raw return dismissed quantity.
|
||||
written_off_quantity:
|
||||
type: number
|
||||
title: written_off_quantity
|
||||
description: The item's quantity that's removed due to an order change.
|
||||
raw_written_off_quantity:
|
||||
type: object
|
||||
description: The item's raw written off quantity.
|
||||
metadata:
|
||||
type: object
|
||||
description: The item's metadata, can hold custom key-value pairs.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date the item was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the item was updated.
|
||||
Reference in new issue
Block a user