Shipping

​

Queries

• pickSession — Fetch a single pick session by its id, or by the legacy Mongo ObjectId shown in the Redo app.
• pickSessions — List pick sessions, newest first. Filter by status to find open work, by location for one warehouse, and by creation time for a day’s sessions.
• warehouseTeamMemberProductivity — Warehouse team member productivity: fulfillment, scan verification, and picking metrics per person. Data refreshes hourly from the analytics warehouse.

​

Mutations

• getShippingLabelQuotes — Quote shipping rates for a shipment. Rates are ephemeral.
• purchaseCarrierShipment — Buy the selected carrier/service/account rate. Returns the single carrier shipment bought, or throws if the purchase failed.
• voidCarrierShipment — Void a purchased carrier shipment and refund its label charge. Returns null if the shipment does not exist. Idempotent: voiding an already-voided shipment returns the original result.

​

Objects

• CarrierShipment — A purchased carrier shipment and its package labels.
• OutboundRateMessage — A carrier message from a rate quote (e.g. why a carrier account returned no rate).
• OutboundRateQuote — A purchasable shipping rate quoted for a shipment.
• OutboundShipmentPackage — One package (label) within a purchased carrier shipment.
• PickSession — A batch of orders a warehouse picker collects in one trip, with the lines to pick.
• PickSessionItem — One order line on a pick session.
• WarehouseTeamMember — A member of the warehouse team, identified the same way as in warehouseTeamMemberProductivity.
• WarehouseTeamMemberProductivity — Per-team-member fulfillment, scan verification, and warehouse picking productivity for a date range.

​

Input objects

• ContentsSummaryInput — Total declared contents of the shipment. Some carriers (e.g. Stallion Express) require it on every shipment, including domestic ones with no customs items.
• CustomsManufacturerInput — Who manufactured a customs line, for carriers that ask for it.
• OutboundAddressInput —
• OutboundCustomsInput — The goods declared to customs. Required by carriers whenever the shipment crosses a customs border. The certification, signer, declaration text, and AES citation printed on the form are resolved from your Redo customs settings, not sent here.
• OutboundCustomsItemInput — One declared line on the customs form.
• OutboundParcelInput —
• OutboundShipmentRequestInput — A shipment to quote or buy rates for: addresses, parcels, and — when the shipment crosses a customs border — its customs declaration.
• PurchaseCarrierShipmentInput — A shipment to buy: the rate request plus the selected carrier/service/account.
• TaxIdentifierInput — A tax identifier declared for customs clearance, e.g. an IOSS or EORI number.

​

Enums

• AesExemptionCode — An AES (Automated Export System) exemption citation printed on the customs form when no ITN is filed.
• CustomsContentsType — What a shipment holds, as declared to customs.
• CustomsNonDeliveryOption — What the carrier should do with a shipment customs will not release.
• PickSessionInventorySource — Which stock a pick session draws from.
• PickSessionScanType — Where picked items are scanned and sorted into orders.
• PickSessionSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• PickSessionStatus — Where a pick session is in its lifecycle.
• PickSessionStrategy — How orders are grouped into a pick session.
• ShipmentRefundStatus — Final status of the refund for a voided shipment.
• TaxIdentifierEntity — Which party on the shipment a tax identifier belongs to.
• TaxIdentifierType — The kind of tax identifier being declared.
• WarehouseTeamMemberProductivitySortDirection — Sort direction for warehouse team member productivity rows.
• WarehouseTeamMemberProductivitySortKey — A column to sort warehouse team member productivity rows by.