shipping_read
Store must have one of: OMS, WMS
Arguments
Returns
Items from one or more orders that ship together in one box or set of boxes, with what’s needed to ship them.
Show fields
Show fields
Whether the group’s addresses were verified.
Show fields
Show fields
The corrected destination address the validation service returned, if any.
Show fields
Show fields
The country.
The state or province code, e.g. CA. Null when the address stores a full name rather than a code.
The corrected origin address the validation service returned, if any.
Show fields
Show fields
The country.
The state or province code, e.g. CA. Null when the address stores a full name rather than a code.
The team member the group is assigned to. Null when unassigned, or the member isn’t on the caller’s team.Requires:
shipping_readShow fields
Show fields
The agent’s live shift status, worked out when the request runs.Requires:
support_config_readThe agent’s support working hours. An agent with no saved schedule returns enabled false.Requires:
team_members_manageShow fields
Show fields
Channels the agent takes auto-assigned tickets on. Null means every channel.
Dates whose hours replace that day’s weekly hours, earliest first.
IANA time zone the hours are in, such as America/New_York. The store’s time zone when the agent has never saved a schedule.
The batch the group’s label was bought in. Null before a label is bought, or when the batch isn’t the caller’s.Requires:
shipping_readThe order’s billing address, if any.
Show fields
Show fields
The country.
The state or province code, e.g. CA. Null when the address stores a full name rather than a code.
The customer the group ships to, if known.
The customs details. Null when the group ships within one country.
Show fields
Show fields
What kind of contents the shipment holds.
The declared items.
Show fields
Show fields
Where the item was made.
The declared value of one unit.
The weight of one unit.
The US export filing, when one applies.
Show fields
Show fields
Why no export filing is needed, e.g. NOEEI 30.37(a).
What happens to the shipment if it can’t be delivered.
How the customer chose to receive the order.
Where the group ships to.
Show fields
Show fields
The country.
The state or province code, e.g. CA. Null when the address stores a full name rather than a code.
What happened to the group, newest first.
Show fields
Show fields
The team member who did it. Null for system events, and when the member isn’t on the caller’s team.
Show fields
Show fields
The agent’s live shift status, worked out when the request runs.Requires:
support_config_readThe agent’s support working hours. An agent with no saved schedule returns enabled false.Requires:
team_members_manageWhen the group must ship by: the merchant’s override, else the service-level date.
The account that ships the group: a 3PL, or the merchant itself, when it equals
merchantAccountId.The fulfillment orders the group ships. A merged group spans several orders.
Show fields
Show fields
This group’s share of the fulfillment order’s items.
Show fields
Show fields
How the item is built from components. Empty unless it is built from components.
What a fulfillment partner needs to identify and ship this item: identity only, no pricing. Readable by the store and the 3PL that ships the group. Null when it never matched a catalog product.
The store’s catalog product for this item, when it matched one. Null when it never matched, the product was deleted, or the caller can’t read the store’s products (e.g. a 3PL). Requires
products_read.The tax on every unit in the group, if known.
The Redo order. Null when there is no Redo order, or the caller can’t read it, e.g. a 3PL reading its client’s group.Requires:
orders_readShow fields
Show fields
When the order was placed (the ecommerce provider’s creation time, falling back to Redo’s ingestion time).
The customer who placed the order, if known.
The order’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The order’s shipping method, cost, and destination.
The order subtotal, excluding tax and shipping, if known.
The order total, including tax and shipping, if known.
The total tax charged on the order, if known.
The order as it was when it came in, whether or not a Redo order exists. Null when the sales channel sent no order.
The platform the order came from.
The group this one was merged into, was replaced by, or was copied from. Null when there is none.Requires:
shipping_readShow fields
Show fields
The related group. Null when the caller can’t read it.Requires:
shipping_readWhen the group’s order was placed.
Where the group ships from.
Show fields
Show fields
The country.
The state or province code, e.g. CA. Null when the address stores a full name rather than a code.
The labels bought for the group, each with its tracking number and tracker. Readable by the store and by the 3PL that ships the group, without pricing.Requires:
shipping_readShow fields
Show fields
ArgumentsFields
Forward pagination: returns the first N packages (max 100, default 25). Use with
after; mutually exclusive with last/before.Backward pagination: returns the last N packages (max 100, default 25). Use with
before; mutually exclusive with first/after.The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
The tracker following this package. Readable by the store and by the 3PL that ships the group. Null until tracking starts.Requires:
shipping_readThe parcels the group ships in. Empty for pickup, or before packaging is chosen.
Show fields
Show fields
The dangerous goods class, when the parcel has one.
The rates quoted for the group. The store gets no quotes when its 3PL ships the group.
Show fields
Show fields
When the rates were last calculated.
The purchasable rates. Select or buy one by sending back its carrier, service and
carrierAccountId.Show fields
Show fields
Carrier’s estimated delivery date, when provided.
Guaranteed duties, taxes and fees, when the quote asked for
landedCost. Billed with the label, on top of rate.Whether the rate is on the merchant’s own carrier account rather than Redo’s. Null when it wasn’t recorded.
The rate chosen for the label. Null when none is chosen, and for the store when its 3PL ships the group.Requires:
shipping_readShow fields
Show fields
Whether the rate is on the merchant’s own carrier account rather than Redo’s, from the group’s current quote for it. Null when no quote matches.
What chose the rate, when recorded.Requires:
shipping_readShow fields
Show fields
The team member who picked the rate, when
source is USER and they’re on the caller’s team.Requires: shipping_readThe carrier shipments bought for the group. Usually one; a group of several parcels on a carrier that labels each parcel separately (e.g. USPS) has one per parcel. Each caller sees the shipments its own team bought, so the store sees none on a group its 3PL ships.
Show fields
Show fields
Guaranteed duties, taxes and fees locked for this shipment when it was bought with
landedCost. Charged with the label, on top of rate.Whether the label was bought on the merchant’s own carrier account rather than Redo’s. Null when it wasn’t recorded.
The packages and their labels.
Show fields
Show fields
The tracker following this package. Readable by the store and by the 3PL that ships the group. Null until tracking starts.Requires:
shipping_readOptions on buying and delivering the label.
Show fields
Show fields
Whether the sales channel is sent tracking when the label is bought. Null uses the store’s setting.
Forces the destination to be rated as residential (true) or commercial (false). Null uses the address’s classification.
What the group’s items cost the customer.
Show fields
Show fields
Example
query {
fulfillmentGroup(id: "...") {
createdAt
deliveryMethod
fulfillBy
fulfillerAccountId
id
merchantAccountId
orderCreatedAt
packages {
nodes {
labelUrl
trackingNumber
}
pageInfo { hasNextPage endCursor }
}
# ...
}
}