21badd069d
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>
80 lines
2.0 KiB
YAML
80 lines
2.0 KiB
YAML
type: object
|
|
description: The item's detail.
|
|
x-schemaName: BaseOrderItemDetail
|
|
required:
|
|
- id
|
|
- item_id
|
|
- item
|
|
- quantity
|
|
- fulfilled_quantity
|
|
- delivered_quantity
|
|
- shipped_quantity
|
|
- return_requested_quantity
|
|
- return_received_quantity
|
|
- return_dismissed_quantity
|
|
- written_off_quantity
|
|
- metadata
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id
|
|
description: the detail's ID.
|
|
item_id:
|
|
type: string
|
|
title: id
|
|
description: the ID of the associated line item.
|
|
item:
|
|
type: object
|
|
quantity:
|
|
type: number
|
|
title: quantity
|
|
description: The item's quantity.
|
|
fulfilled_quantity:
|
|
type: number
|
|
title: fulfilled_quantity
|
|
description: The item's fulfilled quantity.
|
|
delivered_quantity:
|
|
type: number
|
|
title: fulfilled_quantity
|
|
description: The item's delivered quantity.
|
|
shipped_quantity:
|
|
type: number
|
|
title: shipped_quantity
|
|
description: The item's shipped quantity.
|
|
return_requested_quantity:
|
|
type: number
|
|
title: return_requested_quantity
|
|
description: The item's quantity that's requested to be returned.
|
|
return_received_quantity:
|
|
type: number
|
|
title: return_received_quantity
|
|
description: >-
|
|
The item's quantity that's returned and added to the underlying variant's
|
|
stocked quantity.
|
|
return_dismissed_quantity:
|
|
type: number
|
|
title: return_dismissed_quantity
|
|
description: >-
|
|
The item's quantity that's returned but damaged. So, it's not added to the
|
|
underlying variant's stocked quantity.
|
|
written_off_quantity:
|
|
type: number
|
|
title: written_off_quantity
|
|
description: The item's quantity that's removed from the order.
|
|
metadata:
|
|
type: object
|
|
title: metadata
|
|
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 detail was created.
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
title: updated_at
|
|
description: The date the detail was updated.
|