Skip to main content

Queries

  • carton (Experimental) — Get a warehouse-owned carton by ID. Foreign, absent, deleted and voided IDs all return null.
  • cartons (Experimental) — List warehouse-owned cartons, including unassigned cartons, in descending opaque ID order. Removed cartons are excluded.
  • consolidation — Fetch a single consolidation by its id.
  • consolidationDocuments (Experimental) — Documents available for a consolidation owned by the authenticated warehouse. Null for an absent or foreign consolidation.
  • consolidations — List the consolidations you operate or participate in at any lifecycle state, newest created first. PACKED_AT ordering includes only consolidations with a packing timestamp.

Mutations

  • consolidationCommercialInvoiceExport (Experimental) — Generate a cross-border invoice using current packed items. Returns completeness warnings. Null for an absent or foreign consolidation.

Objects

  • Carton (Experimental) — An identified physical box operated by the authenticated warehouse. It can exist before assignment to a shipment.
  • CommercialInvoiceExport (Experimental) — A commercial invoice and its completeness information.
  • CommercialInvoiceWarning (Experimental) — An invoice completeness warning.
  • Consolidation — A batch of returned inventory, packed into cartons at a returns center and sent to the merchant’s destination. The account that operates the returns center and each merchant taking part can read it.
  • ConsolidationCarton — A physical carton in the consolidation, holding units for one or more merchants.
  • ConsolidationEndpoint — One end of a consolidation’s journey: a facility and where it is.
  • ConsolidationItem — A merchant’s unit packed in the consolidation.
  • ConsolidationTracking — Carrier tracking for a consolidation in transit.
  • DocumentOption (Experimental) — A document available now. Generation rechecks its eligibility.

Enums

  • CartonSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
  • CommercialInvoiceWarningCode (Experimental) — An invoice completeness issue.
  • ConsolidationItemKind — What a unit inside a consolidation represents.
  • ConsolidationSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
  • ConsolidationStatus — Where a consolidation is in its journey back to the merchant.
  • DocumentFormat (Experimental) — The representation of a generated document.
  • DocumentKind (Experimental) — A document that can be generated for a consolidation or carton.