object ReturnLineItem

Fields

Field	Type	Description
`id`	`String`	Public API ID for this identifiable.
`legacy_id`	BigInt	Numeric legacy ID for this identifiable; use only where legacy IDs are required.
`account_id`	`String`	Public API account ID that identifies the related record.
`line_item_id`	`String`	Public API line item ID that identifies the related record.
`warehouse_id`	`String`	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`product_id`	`String`	Public API product ID that identifies the related record.
`return_id`	`String`	Public API return ID that identifies the related record.
`quantity`	`Int`	Quantity as a whole-unit count.
`quantity_received`	`Int`	Quantity received as a whole-unit count.
`restock`	`Int`	Restock as a numeric value.
`condition`	`String`	Condition for this return line item.
`is_component`	`Boolean`	Whether this return line item is component.
`type`	`String`	Return type for this return line item.
`reason`	`String`	Human-readable reason for this return line item.
`created_at`	ISODateTime	Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`updated_at`	ISODateTime	Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`line_item`	LineItem	Line item associated with this return line item.
`product`	Product	Product associated with this return line item.
`warehouse`	Warehouse	Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.

Referenced By

Return Type

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "UmV0dXJuTGluZUl0ZW06MTIzNA==",
  "line_item_id": "UmV0dXJuTGluZUl0ZW06MTIzNA==",
  "warehouse_id": "UmV0dXJuTGluZUl0ZW06MTIzNA==",
  "product_id": "UmV0dXJuTGluZUl0ZW06MTIzNA==",
  "return_id": "UmV0dXJuTGluZUl0ZW06MTIzNA==",
  "quantity": 2,
  "quantity_received": 2,
  "restock": 100,
  "condition": "new",
  "is_component": true,
  "type": "refund",
  "reason": "Customer requested expedited handling.",
  "created_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z",
  "line_item": {sku: "BLUE-TEE-M", quantity: 2},
  "product": {sku: "BLUE-TEE-M", quantity: 2},
  "warehouse": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"}
}