Skip to main content

Queries

  • carrierShipmentTracker — Fetch tracking for one purchased package by its carrier shipment tracker id. Redo checks the carrier about every 4 hours, and every hour once the package is out for delivery, until the package is delivered, returned, or cancelled, or 21 days after purchase. There are no tracking webhooks yet, so poll. Labels from carriers that only push updates (Sendcloud, WeGrow, NZ Post) keep the status they had at purchase.
  • carrierShipmentTrackers — List tracking for purchased packages, by shipment, tracking number, status, or recent change. Redo checks the carrier about every 4 hours, and every hour once the package is out for delivery, until the package is delivered, returned, or cancelled, or 21 days after purchase. There are no tracking webhooks yet, so poll. Labels from carriers that only push updates (Sendcloud, WeGrow, NZ Post) keep the status they had at purchase. Selecting scans multiplies each tracker’s query cost by the scan page size, so a large page with scans can exceed the query cost limit: poll without scans, then fetch scans only for trackers that changed.
  • fulfillmentAutomation (Experimental) — An order fulfillment automation by id, at its live version. Null if it doesn’t exist.
  • fulfillmentAutomationCatalog (Experimental) — Read fulfillment automation docs by path: one entry per path, in order, null for an unknown path. "" is the index; start with guide/, then workspaceCreate(resourceType: FULFILLMENT_AUTOMATION). context/<kind> pages list the store’s own records, such as parcels and carrier services, that configs name by id. At most 50 paths.
  • fulfillmentAutomationCheck (Experimental) — Check a fulfillment automation as saving would, without saving it. For an editor that changes FulfillmentAutomation.definition and saves it with fulfillmentAutomationDefinitionUpdate.
  • fulfillmentAutomationKinds (Experimental) — Every condition and action a fulfillment automation step can be, with the JSON Schema of its config.
  • fulfillmentAutomations (Experimental) — The store’s order fulfillment automations by position, top first, as the Automations page lists them. Automations run from the bottom of the list up, and what a higher one sets wins over those below it.
  • fulfillmentBatch (Experimental) — Fetch a fulfillment batch by its id.
  • fulfillmentBatches (Experimental) — List the store’s fulfillment batches, newest first. Filter by status for batches still printing, and by creation time for a day’s batches.
  • fulfillmentGroup (Experimental) — Fetch a fulfillment group by its id. The store that owns the group and the 3PL that ships it can both read it.
  • fulfillmentGroupCustomFields (Experimental) — The custom fields set up for fulfillment groups: the store’s own and, for a 3PL, each client store’s. Filter search results on them with FulfillmentGroupFilter.customFields.
  • fulfillmentGroups (Experimental) — List fulfillment groups, newest first: the store’s own groups and, for a 3PL, the groups it ships for its clients. Every status is included; filter by status for open work, and by updatedAtAfter to sync changes.
  • fulfillmentGroupsSearch (Experimental) — Search fulfillment groups by text and filters, with the same matching as the Redo fulfillment app’s search box and filters: the store’s own groups and, for a 3PL, the groups it ships for its clients. Results come from a search index and can trail writes by a few seconds; to sync changes, use fulfillmentGroups with updatedAtAfter instead.
  • overboxServices — The consolidators your account can buy overbox labels for, and the first-mile carriers available for each. Empty when overboxing is not enabled for your account.
  • overboxShipment — Fetch one overbox shipment by its id.
  • overboxShipments — List overbox shipments, newest first, by status, consolidator, or tracking number.
  • 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, picking, return restocking, putaway, and replenishment metrics per person. Data refreshes hourly from the analytics warehouse.

Mutations

  • fulfillmentAutomationCreate (Experimental) — Create an order fulfillment automation from a whole typed definition. It joins the bottom of the list, so it runs first and the automations above it win, and it’s turned off: turn it on with fulfillmentAutomationUpdate. Check it first with fulfillmentAutomationCheck. FULFILLMENT_AUTOMATION_DEFINITION_INVALID, with diagnostics, while an error blocks saving.
  • fulfillmentAutomationDefinitionUpdate (Experimental) — Save a whole typed definition as an order fulfillment automation’s new live version. It keeps its place in the order and whether it’s on. FULFILLMENT_AUTOMATION_REVISION_STALE when it was saved since expectedRevision; FULFILLMENT_AUTOMATION_DEFINITION_INVALID, with diagnostics, while an error blocks saving. Null if it doesn’t exist.
  • fulfillmentAutomationsReorder (Experimental) — Set the order of the store’s fulfillment automations, top first, as the Automations page lists them. Automations run from the bottom of the list up, and what a higher one sets wins over those below it. Pass every id from fulfillmentAutomations once. FULFILLMENT_AUTOMATION_ORDER_STALE when the order changed meanwhile.
  • fulfillmentAutomationUpdate (Experimental) — Rename an order fulfillment automation, or turn it on or off. It takes effect the next time its trigger fires. Null if it doesn’t exist.
  • fulfillmentGroupAddressVerify (Experimental) — Mark a fulfillment group’s destination address as verified or unverified by hand, as the app’s Mark address as verified does. Marking an on-hold group verified also releases holds placed because the address failed verification. Rates are refreshed in the background. Setting the value it already has returns the group unchanged. Returns the group, or null if it doesn’t exist or isn’t visible to the caller.
  • fulfillmentGroupCancel (Experimental) — Cancel a fulfillment group’s whole order, or cancel and refund some units of its items. The store that owns the group and the 3PL that ships it can both cancel it. Cancelling an already cancelled group returns it. Returns the group, or null if it doesn’t exist or isn’t visible to the caller. FULFILLMENT_GROUP_NOT_CANCELLABLE (409) when its status or marketplace can’t be cancelled, MARKETPLACE_ORDER_CANCEL_FAILED (409) when the marketplace refuses, ITEM_CANCEL_NOT_SUPPORTED (409), REFUND_REQUIRED, ITEM_NOT_ON_GROUP and INVALID_QUANTITY (400), ITEM_CANCEL_INCOMPLETE (503) when an item cancel stopped partway.
  • fulfillmentGroupCreate (Experimental) — Create a manual order from your products or custom items and ship it as a new fulfillment group. Send an idempotencyKey so a retry returns the first group instead of creating another. Rates are fetched in the background, so the group’s rates may be empty at first. PRODUCT_NOT_FOUND, LOCATION_NOT_FOUND, INVALID_ITEM, INVALID_SHIP_FROM, PRICE_REQUIRED, CURRENCY_MISMATCH, INVALID_CURRENCY, INVALID_COUNTRY, INVALID_AMOUNT, INVALID_QUANTITY, INVALID_WEIGHT and UNKNOWN_TAG reject the input; the shipping options are checked as in fulfillmentGroupUpdate. A countryCode that isn’t ISO 3166-1 alpha-2 is rejected as a 400 before the mutation runs.
  • fulfillmentGroupHold (Experimental) — Put a fulfillment group on hold so it isn’t shipped, in Redo and on its sales channel. The store that owns the group and the 3PL that ships it can both hold it. Holding a group already on hold with the same reason, notes and releaseAt returns it unchanged. The sales channel can take a few seconds to confirm, so the group may not show ON_HOLD yet when this returns. Returns the group, or null if it doesn’t exist or isn’t visible to the caller. FULFILLMENT_GROUP_ALREADY_ON_HOLD (409) when it’s held with a different reason, notes or releaseAt, FULFILLMENT_GROUP_NOT_HOLDABLE (409) when its status or sales channel can’t be held, HOLD_IN_PROGRESS (409) while another hold is still being placed (retry in a few seconds), HOLD_FAILED (409) when the sales channel refuses.
  • fulfillmentGroupMarkFulfilled (Experimental) — Mark a fulfillment group fulfilled when it shipped outside Redo, like Mark as fulfilled in the app. The group closes right away and the fulfillment is recorded on its sales channel in the background, so it can take a few seconds to appear there. The store that owns the group and the 3PL that ships it can both mark it. Marking a closed group fulfilled returns it unchanged. Returns the group, or null if it doesn’t exist or isn’t visible to the caller. FULFILLMENT_GROUP_NOT_FULFILLABLE (409) when its status can’t be marked fulfilled, such as on hold, pending or cancelled; MARK_FULFILLED_IN_PROGRESS (409) while another call for the group is still starting (retry in a few seconds); TRACKING_REQUIRED (400) when notifyMarketplace is true for a sales channel that needs a carrier and trackingNumber; CARRIER_NOT_SUPPORTED (400) when that channel only accepts known carriers.
  • fulfillmentGroupMerge (Experimental) — Merge fulfillment groups into one so they ship together, as the app’s Merge orders does. Redo creates a new merged group with every input’s items and marks the inputs MERGED, each linking to it through linkedGroup. It returns once the merge is done; rates for the new group are fetched in the background, so they may be empty at first. The groups must share a store, fulfiller, sales channel and origin, be in statuses that can merge, and not be in a pick session. Groups whose packing slips were already printed can be merged, as the app allows after a warning, but the printed slips belong to the old groups, so print the merged group’s packing slip again. Retrying a merge that already happened returns the group it made. Returns the merged group, or null if any group doesn’t exist or isn’t visible to the caller. FULFILLMENT_GROUPS_NOT_MERGEABLE (409) says why the app’s rules refuse the merge; MERGE_IN_PROGRESS (409) while another merge with the same primaryId is running.
  • fulfillmentGroupReleaseHold (Experimental) — Release every hold on a fulfillment group, in Redo and on its sales channel, and cancel any scheduled release. The store that owns the group and the 3PL that ships it can both release it. Releasing a group that isn’t on hold returns it unchanged. HOLD_RELEASE_IN_PROGRESS (409) while another release is starting (retry in a few seconds). The sales channel can take a few seconds to confirm, so the group may still show ON_HOLD when this returns. Returns the group, or null if it doesn’t exist or isn’t visible to the caller. HOLD_RELEASE_FAILED (409) when the sales channel refuses.
  • fulfillmentGroupUpdate (Experimental) — Change a fulfillment group: notes, assignee, fulfiller, tags, rate, parcels, shipping options and customs. The store that owns the group and the 3PL that ships it can both update it. Returns the updated group, or null if the group does not exist or is not visible to the caller.
  • getShippingLabelQuotes — Quote shipping rates for a shipment. Rates are ephemeral.
  • overboxShipmentPurchase — Buy an overbox label: one first-mile label for an outer box that carries your labeled parcels to a consolidator. Seals into the box the parcels labeled for that consolidator from the same ship-from location since its previous overbox. Retry with the same idempotencyKey to get the first overbox back instead of buying another. The label is billed to the consolidator’s carrier account, not your Redo balance.
  • 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

  • AddressVerification — The result of checking a fulfillment group’s addresses with an address validation service.
  • CarrierShipment — A purchased carrier shipment and its package labels.
  • CarrierShipmentTracker — Tracking for one package of a label bought with purchaseCarrierShipment. Redo checks the carrier about every 4 hours, and every hour once the package is out for delivery, until the package is delivered, returned, or cancelled, or 21 days after purchase. There are no tracking webhooks yet, so poll. Labels from carriers that only push updates (Sendcloud, WeGrow, NZ Post) keep the status they had at purchase.
  • CarrierShipmentTrackerScan — A carrier scan for a purchased label’s package.
  • CustomsDeclaration — One line of a fulfillment group’s customs declaration.
  • ExportFiling — The US export filing for an international shipment: an exemption, or the filing number.
  • FulfillmentAutomation (Experimental) — An order fulfillment automation (Settings › Order fulfillment › Automations): a rule that runs when its trigger fires for a fulfillment, such as when it’s created, and sets its shipping service, parcel, tags, holds and more. They’re listed by position, as on the Automations page. Automations run from the bottom of the list up, and what a higher one sets wins over those below it. Agents edit one as script in a workspace (workspaceCreate; read guide/ in fulfillmentAutomationCatalog first). Apps send typed definitions to fulfillmentAutomationCreate and fulfillmentAutomationDefinitionUpdate.
  • FulfillmentAutomationCatalogEntry (Experimental) — A page of the fulfillment automation catalog.
  • FulfillmentAutomationCatalogListing (Experimental) — A page under a catalog page.
  • FulfillmentAutomationDefinition (Experimental) — A fulfillment automation’s content as typed data: its steps and the edges between them. The same content as script.
  • FulfillmentAutomationDiagnostic (Experimental) — A problem found checking a fulfillment automation. diagnostics/<code> in fulfillmentAutomationCatalog explains it.
  • FulfillmentAutomationKind (Experimental) — A condition, action or code step, and the config it takes.
  • FulfillmentAutomationStep (Experimental) — One step of a fulfillment automation.
  • FulfillmentBatch (Experimental) — A set of fulfillment groups whose labels were bought together.
  • FulfillmentGroup (Experimental) — Items from one or more orders that ship together in one box or set of boxes, with what’s needed to ship them.
  • FulfillmentGroupCustomField (Experimental) — A custom field a store set up for its fulfillment groups, from an order metafield, an order attribute or a variant metafield.
  • FulfillmentGroupCustoms — The customs details for an international fulfillment group.
  • FulfillmentGroupEvent — Something that happened to a fulfillment group.
  • FulfillmentGroupFulfillmentOrder — A sales channel’s fulfillment order, or the part of one, that a fulfillment group ships.
  • FulfillmentGroupLabelPurchase — Where buying a fulfillment group’s label stands.
  • FulfillmentGroupLink — A pointer from a fulfillment group to a related group.
  • FulfillmentGroupNotes — Notes on a fulfillment group.
  • FulfillmentGroupParcel — A box or other package a fulfillment group ships in.
  • FulfillmentGroupParcelLineItem — Units of one line item packed in a parcel.
  • FulfillmentGroupRates — The rates quoted for a fulfillment group. Quotes and messages are empty for the store when its 3PL ships the group.
  • FulfillmentGroupRequestedShipping — The shipping method the customer chose at checkout.
  • FulfillmentGroupSelectedRate — The rate chosen for a fulfillment group’s label.
  • FulfillmentGroupShippingOptions — Options on buying and delivering a fulfillment group’s label.
  • FulfillmentGroupTag — A tag on a fulfillment group.
  • FulfillmentGroupTotals — What a fulfillment group’s items cost the customer.
  • FulfillmentHold — A hold on a fulfillment order, placed in Redo or by the sales channel.
  • FulfillmentOrderLineItem — An item on a fulfillment order, as it was ordered. Titles, options and prices are frozen when the order comes in.
  • FulfillmentOrderLineItemBillOfMaterials — How a line item is built from components.
  • FulfillmentOrderLineItemComponent — One component a line item is built from.
  • FulfillmentOrderLineItemComponentBillOfMaterials — How a line item’s component is built from components.
  • FulfillmentOrderLineItemLeftover — A remainder piece a cut-to-size build produces, to put back into stock.
  • FulfillmentOrderLineItemSubcomponent — One component a line item’s component is built from.
  • FulfillmentOrderOrderSummary — The order a fulfillment order came from, as the sales channel sent it. Frozen when the order came in.
  • LabelPurchaseError — Why buying a fulfillment group’s label failed.
  • LandedCostQuote — Guaranteed duties, import taxes and fees for a rate, billed with the label. Separate from the rate’s carriage price and may be in a different currency.
  • LineItemAttribute — A custom key and value attached to a line item, e.g. an engraving.
  • LineItemOption — A product option the customer chose, e.g. Size: Large.
  • 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.
  • OutboundShipmentPackageTracking — Where a package is in the carrier’s network, read from the tracker following its tracking number.
  • OverboxServiceOption — A consolidator your account can buy overbox labels for, with the first-mile carriers available to reach it.
  • OverboxShipment — An overbox: one outer box, with its own first-mile label, that carries many labeled parcels to a consolidator (APC or ePost Global) in one shipment.
  • OverboxShipmentParcel — A labeled parcel sealed inside an overbox. The consolidator delivers it on its own label after unpacking the box.
  • 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.
  • RateSelection — What chose a fulfillment group’s rate.
  • ShipmentBilling — Who pays the carrier for a label. Carrier account numbers are never exposed.
  • ShippingAddress — A shipping address with the recipient’s contact details, as it appears on a label.
  • WarehouseTeamMember — A member of the warehouse team, identified the same way as in warehouseTeamMemberProductivity.
  • WarehouseTeamMemberProductivity — Per-team-member fulfillment, scan verification, warehouse picking, return restocking, putaway, and replenishment productivity for a date range.

Input objects

Enums