Emits : CONSOLIDATION_STATUS_UPDATED
Required scopes: consolidations_read
The merchant’s cartons, in carton-number order. The carton’s number within the consolidation, as printed on its label. Unique per consolidation, and the reference to quote when receiving.
The carton’s measured dimensions. The unit all three measurements are expressed in.
The carton’s measured weight. The unit the value is expressed in.
The numeric magnitude of the weight.
When the consolidation reached its destination. Reserved: not yet reported.
The facility the consolidation is headed to. The facility’s postal address. The first line of the address (street and number).
The second line of the address (apartment, suite, unit, etc.).
The city, town, or village.
The province, state, or region.
The facility’s name, when it has one.
The id of this consolidation.
How many tracked units the consolidation holds for the merchant. Counts units, not physical pieces — a RETURN unit expands through its return’s declared lines.
The merchant’s units in the consolidation. Each carries the number of the carton it is packed in. Requires: consolidations_readArguments Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Fields The list of edges (each a node plus its pagination cursor). Opaque cursor for this item; pass to after/before to page from here.
The nodes in this page, without the edge/cursor wrapper — a convenience over edges. The number of the carton this unit is packed in.
A human-readable label for the unit. Display only — match on sku and return instead.
The condition grade the warehouse assigned. Merchant-defined; null when ungraded.
What this unit represents.
How many tracked units this line covers. A RETURN line is one unit holding the whole return’s pieces.
The catalog SKU this unit resolved to. Null when no product was identified, and always null for a RETURN unit.
Pagination metadata for the current page. Cursor of the last edge in this page; pass to after to page forward.
Whether more items exist after this page (drives forward pagination with first/after).
Whether more items exist before this page (drives backward pagination with last/before).
Cursor of the first edge in this page; pass to before to page backward.
The label printed on the cartons, e.g. CON-42. Display only — never parse it.
The facility the consolidation left from. The facility’s postal address. The first line of the address (street and number).
The second line of the address (apartment, suite, unit, etc.).
The city, town, or village.
The province, state, or region.
The facility’s name, when it has one.
When the consolidation was packed and its contents became final.
When the consolidation left the returns center.
Where the consolidation is in its journey.
Carrier tracking once the consolidation is moving; null when unavailable. Reserved: not yet populated. The carrier moving the consolidation.
When the carrier expects to deliver the consolidation.
The carrier’s tracking number for the consolidation.
A page where the consolidation can be tracked.