shipping_read
Store must have one of: OMS, WMS
Arguments
Which fulfillment groups to include.
Show fields
Show fields
Every one of these filters matches.
The carrier of the group’s selected rate, by carrier code (for example
USPS, UPS, FedEx, DHLExpress). USPS, UPS and FedEx include their sub-services. A code that names no carrier matches nothing.Custom fields the store set up, by key, as
fulfillmentGroupCustomFields lists them. Every one must match.Show fields
Show fields
For a DATE field.
The metafield’s
namespace.key, or the attribute’s name, as fulfillmentGroupCustomFields lists it.For a NUMBER field.
Where the field reads its value.
For a TEXT field.
How the group’s orders are delivered.
Show fields
Show fields
Every one of these values.
One of these values.
None of these values.
This filter does not match.
At least one of these filters matches.
The names of the group’s orders, as the sales channel shows them (for example
#1001).Show fields
Show fields
The shipping option the customer chose at checkout, by name (for example
Standard Shipping).Show fields
Show fields
The SKUs of the group’s items.
Show fields
Show fields
The group’s status.
Show fields
Show fields
One of these values.
None of these values.
Forward pagination: returns the first N fulfillment groups (max 100, default 25). Use with
after; mutually exclusive with last/before.Backward pagination: returns the last N fulfillment groups (max 100, default 25). Use with
before; mutually exclusive with first/after.Defaults to RELEVANCE with
text, CREATED_AT without. Relevance order can shift as groups change; use a date sort to page through every match stably.What to search for: order number or name, customer name, email, SKU, item title, tracking number and more, at most 200 characters. Omit to page through the filter’s matches.
Returns
A paginated list of FulfillmentGroup items.
Show fields
Show fields
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
The item at this edge.
Show fields
Show fields
The team member the group is assigned to. Null when unassigned, or the member isn’t on the caller’s team.Requires:
shipping_readThe 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.
The customer the group ships to, if known.
The customs details. Null when the group ships within one country.
How the customer chose to receive the order.
Where the group ships to.
When 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.
The group this one was merged into, was replaced by, or was copied from. Null when there is none.Requires:
shipping_readWhen the group’s order was placed.
Where the group ships from.
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
Arguments
Forward pagination: returns the first N packages (max 100, default 25). Use with
after; mutually exclusive with last/before.The shipping method the customer chose, from the group’s first fulfillment order.
The rate chosen for the label. Null when none is chosen, and for the store when its 3PL ships the group.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.
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.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.
The corrected origin address the validation service returned, if any.
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_manageThe 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.
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.
When 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
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_readThe 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 parcels the group ships in. Empty for pickup, or before packaging is chosen.
Show fields
Show fields
The outside dimensions. Null for carrier packaging, which the carrier defines.
The weight of dry ice in the parcel, if any.
The dangerous goods class, when the parcel has one.
The amount the parcel is insured for. Null when uninsured.
What’s packed in the parcel. Empty when the items haven’t been assigned to parcels, which means everything ships in one box.
The weight of the empty packaging.
The weight the parcel is rated and labeled at: packaging plus contents.
The rates quoted for the group. The store gets no quotes when its 3PL ships the group.
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.
The price of the rate, from the group’s current quote for the same carrier, service and account. Null when no quote matches.
What chose the rate, when recorded.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.
Total price charged for the whole shipment. Carriage only — duties, import taxes, and customs fees are not included.
Options 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.
Example
query {
fulfillmentGroupsSearch(after: "...", before: "...", filter: { ... }, first: 10, last: 10, reverse: true, sort: CREATED_AT, text: "...") {
nodes {
createdAt
deliveryMethod
fulfillBy
fulfillerAccountId
id
merchantAccountId
orderCreatedAt
status
# ...
}
pageInfo { hasNextPage endCursor }
}
}