> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shipping

> Outbound shipping: rate quotes and label purchases.

## Queries

* [`pickSession`](/docs/api-reference/v3/reference/shipping/queries/pick-session) — Fetch a single pick session by its id, or by the legacy Mongo ObjectId shown in the Redo app.
* [`pickSessions`](/docs/api-reference/v3/reference/shipping/queries/pick-sessions) — 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`](/docs/api-reference/v3/reference/shipping/queries/warehouse-team-member-productivity) — Warehouse team member productivity: fulfillment, scan verification, and picking metrics per person. Data refreshes hourly from the analytics warehouse.

## Mutations

* [`getShippingLabelQuotes`](/docs/api-reference/v3/reference/shipping/mutations/get-shipping-label-quotes) — Quote shipping rates for a shipment. Rates are ephemeral.
* [`purchaseCarrierShipment`](/docs/api-reference/v3/reference/shipping/mutations/purchase-carrier-shipment) — Buy the selected carrier/service/account rate. Returns the single carrier shipment bought, or throws if the purchase failed.
* [`voidCarrierShipment`](/docs/api-reference/v3/reference/shipping/mutations/void-carrier-shipment) — 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`](/docs/api-reference/v3/reference/shipping/carrier-shipment) — A purchased carrier shipment and its package labels.
* [`OutboundRateMessage`](/docs/api-reference/v3/reference/shipping/outbound-rate-message) — A carrier message from a rate quote (e.g. why a carrier account returned no rate).
* [`OutboundRateQuote`](/docs/api-reference/v3/reference/shipping/outbound-rate-quote) — A purchasable shipping rate quoted for a shipment.
* [`OutboundShipmentPackage`](/docs/api-reference/v3/reference/shipping/outbound-shipment-package) — One package (label) within a purchased carrier shipment.
* [`PickSession`](/docs/api-reference/v3/reference/shipping/pick-session) — A batch of orders a warehouse picker collects in one trip, with the lines to pick.
* [`PickSessionItem`](/docs/api-reference/v3/reference/shipping/pick-session-item) — One order line on a pick session.
* [`WarehouseTeamMember`](/docs/api-reference/v3/reference/shipping/warehouse-team-member) — A member of the warehouse team, identified the same way as in `warehouseTeamMemberProductivity`.
* [`WarehouseTeamMemberProductivity`](/docs/api-reference/v3/reference/shipping/warehouse-team-member-productivity) — Per-team-member fulfillment, scan verification, and warehouse picking productivity for a date range.

## Input objects

* [`ContentsSummaryInput`](/docs/api-reference/v3/reference/shipping/contents-summary-input) — 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`](/docs/api-reference/v3/reference/shipping/customs-manufacturer-input) — Who manufactured a customs line, for carriers that ask for it.
* [`OutboundAddressInput`](/docs/api-reference/v3/reference/shipping/outbound-address-input) —
* [`OutboundCustomsInput`](/docs/api-reference/v3/reference/shipping/outbound-customs-input) — 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`](/docs/api-reference/v3/reference/shipping/outbound-customs-item-input) — One declared line on the customs form.
* [`OutboundParcelInput`](/docs/api-reference/v3/reference/shipping/outbound-parcel-input) —
* [`OutboundShipmentRequestInput`](/docs/api-reference/v3/reference/shipping/outbound-shipment-request-input) — A shipment to quote or buy rates for: addresses, parcels, and — when the shipment crosses a customs border — its customs declaration.
* [`PurchaseCarrierShipmentInput`](/docs/api-reference/v3/reference/shipping/purchase-carrier-shipment-input) — A shipment to buy: the rate request plus the selected carrier/service/account.
* [`TaxIdentifierInput`](/docs/api-reference/v3/reference/shipping/tax-identifier-input) — A tax identifier declared for customs clearance, e.g. an IOSS or EORI number.

## Enums

* [`AesExemptionCode`](/docs/api-reference/v3/reference/shipping/aes-exemption-code) — An AES (Automated Export System) exemption citation printed on the customs form when no ITN is filed.
* [`CustomsContentsType`](/docs/api-reference/v3/reference/shipping/customs-contents-type) — What a shipment holds, as declared to customs.
* [`CustomsNonDeliveryOption`](/docs/api-reference/v3/reference/shipping/customs-non-delivery-option) — What the carrier should do with a shipment customs will not release.
* [`PickSessionInventorySource`](/docs/api-reference/v3/reference/shipping/pick-session-inventory-source) — Which stock a pick session draws from.
* [`PickSessionScanType`](/docs/api-reference/v3/reference/shipping/pick-session-scan-type) — Where picked items are scanned and sorted into orders.
* [`PickSessionSortKey`](/docs/api-reference/v3/reference/shipping/pick-session-sort-key) — A field this list can be ordered by; pass to the list's `orderBy` argument and pair with `reverse` to flip direction.
* [`PickSessionStatus`](/docs/api-reference/v3/reference/shipping/pick-session-status) — Where a pick session is in its lifecycle.
* [`PickSessionStrategy`](/docs/api-reference/v3/reference/shipping/pick-session-strategy) — How orders are grouped into a pick session.
* [`ShipmentRefundStatus`](/docs/api-reference/v3/reference/shipping/shipment-refund-status) — Final status of the refund for a voided shipment.
* [`TaxIdentifierEntity`](/docs/api-reference/v3/reference/shipping/tax-identifier-entity) — Which party on the shipment a tax identifier belongs to.
* [`TaxIdentifierType`](/docs/api-reference/v3/reference/shipping/tax-identifier-type) — The kind of tax identifier being declared.
* [`WarehouseTeamMemberProductivitySortDirection`](/docs/api-reference/v3/reference/shipping/warehouse-team-member-productivity-sort-direction) — Sort direction for warehouse team member productivity rows.
* [`WarehouseTeamMemberProductivitySortKey`](/docs/api-reference/v3/reference/shipping/warehouse-team-member-productivity-sort-key) — A column to sort warehouse team member productivity rows by.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.