consolidations_read
Arguments
ID!
required
The id of the consolidation to fetch.
Returns
A batch of a merchant’s returned inventory, packed into cartons at a returns center and sent to the merchant’s destination.
Show fields
Show fields
required
The merchant’s cartons, in carton-number order.
Show fields
Show fields
Int!
required
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.
Show fields
Show fields
Float
The height, in
unit.Float
The length, in
unit.required
The unit all three measurements are expressed in.
Float
The width, in
unit.The carton’s measured weight.
Show fields
Show fields
required
The unit the value is expressed in.
Float!
required
The numeric magnitude of the weight.
required
The facility the consolidation is headed to.
Show fields
Show fields
required
String
The facility’s name, when it has one.
ID!
required
The id of this consolidation.
Int!
required
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.required
The merchant’s units in the consolidation. Each carries the number of the carton it is packed in.Requires:
consolidations_readShow fields
Show fields
ArgumentsFields
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
Int!
required
The number of the carton this unit is packed in.
String!
required
A human-readable label for the unit. Display only — match on
sku and return instead.String
The condition grade the warehouse assigned. Merchant-defined; null when ungraded.
required
What this unit represents.
Int!
required
How many tracked units this line covers. A
RETURN line is one unit holding the whole return’s pieces.String
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.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.String!
required
The label printed on the cartons, e.g.
CON-42. Display only — never parse it.required
The facility the consolidation left from.
Show fields
Show fields
required
String
The facility’s name, when it has one.
required
Where the consolidation is in its journey.
Carrier tracking once the consolidation is moving; null when unavailable. Reserved: not yet populated.
Example
query {
consolidation(id: "...") {
deliveredAt
id
itemCount
items {
nodes {
cartonNumber
description
grade
kind
quantity
sku
}
pageInfo { hasNextPage endCursor }
}
name
packedAt
shippedAt
status
# ...
}
}