Skip to main content

Queries

  • node — Refetch any object by its globally unique ID. Returns null if no such object exists or the caller is not allowed to read it.

Mutations

  • cartonManifestExport (Experimental) — Generate a manifest for a warehouse-owned carton and its live descendants, with each line identifying its directly assigned carton. Currently requires a consolidation-backed carton. The file uses current packed data, and its generation time is not an atomic contents snapshot time. Null for an absent, foreign, deleted or voided carton.
  • consolidationManifestExport (Experimental) — Generate a complete consolidation manifest from current packed items. Requires a shipment eligible for a manifest. The file uses current packed data, and its generation time is not an atomic contents snapshot time. Null for an absent or foreign consolidation.
  • inventoryContainerLabelExport (Experimental) — Generate a PDF label for an owned container in the requested warehouse. Returns null for a missing or foreign container or warehouse.
  • shopperSessionCreate — Delegate short-lived shopper access to one order or one email, without staff overrides. Null for a missing or unowned order.

Objects

  • ApiToken (Experimental) — An API token of the store, shown where a change records the token that made it. Revoked tokens still appear.
  • GeneratedDocument (Experimental) — A generated file. The download URL has no promised expiry.
  • GeoCoordinates — A point on the globe.
  • JobError (Experimental) — Why a job failed.
  • MailingAddress — A postal address, e.g. a shipping or billing destination.
  • Money — An amount of money in a specific currency.
  • ShopperCredentials — Short-lived bearer credentials. Keep the access token private.
  • ShopperSession — A store-scoped shopper session. Resource scope remains authoritative.
  • TeamMember (Experimental) — A person on the store’s team. Shared across areas: support assignees now, and later ticket assignees and other people fields.
  • TimeBlock (Experimental) — A span of local time. Both ends are inclusive.

Interfaces

  • Job (Experimental) — Work that can outlast a request. Start it with a mutation, which returns the job at once, and poll it by id with its own query or node(id:).
  • Node — An object that can be refetched by its globally-unique id through the node query.

Input objects

  • ContainsStringListFilter — Matches a list of text values, ignoring case, by whole value or by text anywhere in a value. Set fields are combined with AND.
  • CycleCountStatusFilter — Matches CycleCountStatus values. Set fields are combined with AND.
  • DateTimeFilter — Matches an instant against ISO-8601 bounds. Set fields are combined with AND.
  • DeliveryMethodKindFilter — Matches DeliveryMethodKind values. Set fields are combined with AND.
  • FloatFilter — Matches a number against bounds. Set fields are combined with AND.
  • FulfillmentGroupStatusFilter — Matches FulfillmentGroupStatus values. Set fields are combined with AND.
  • IdFilter — Matches a reference by id. An id that names nothing matches nothing. Set fields are combined with AND.
  • MoneyInput — A monetary amount to set: an exact decimal plus an ISO 4217 currency.
  • PrefixStringListFilter — Matches a list of text values, ignoring case, by whole value or by prefix. Set fields are combined with AND.
  • ShopperSessionCreateInput — Exactly one of orderId or email is required. The authenticated account determines the store.
  • StringListFilter — Matches a list of text values, ignoring case. Set fields are combined with AND.

Enums

  • Conjunction — How a group of conditions, or a group of groups, combines.
  • DayOfWeek — A day of the week.
  • JobStatus (Experimental) — Where a job stands.
  • ListMatch — How a list of values is matched against the condition’s list.
  • NumberOperator — How a value is compared with the condition’s number.
  • ShopperAuthenticationMethod — How the session was established.
  • ShopperEmailAssurance — Whether the shopper proved control of the email address.
  • ShopperScope — Resources this session may access within one store.
  • TagMode — How supplied tags reconcile with a return’s existing tags.
  • TextOperator — How a text is matched against the condition’s values.
  • TrackerScanStatus — The normalized carrier status reported by a single scan.

Scalars

  • CountryCode — An ISO 3166-1 alpha-2 country code (e.g. “US”). Lowercase input is normalized to uppercase.
  • Date — A calendar date in YYYY-MM-DD form (e.g. 2026-01-15).
  • DateTime — An ISO-8601 / RFC-3339 instant in UTC (e.g. 2026-01-15T00:00:00.000Z).
  • Decimal — An exact decimal number serialized as a string (e.g. “19.99”), avoiding floating-point precision loss.
  • JSON — An arbitrary JSON value (object, array, or scalar).