Redo

List bin-level inventory: the quantity of each product in each storage location, newest first. Pass `storageLocationId` for one bin's contents, `sku` for every bin holding a product, or both. Add `locationId` to restrict either to one warehouse. Pass `inStock: true` to skip empty and negative rows.

bin_inventory_levels

Fetch a calendar event by id. Returns null when this store has no event with that id.

calendar_event

The calendar's grammar: event types, the agenda item kinds each accepts, the input key that writes each kind, and how the Commerce Agent uses them. Read it before creating or editing calendar events.

calendar_event_catalog

Calendar events on this store, earliest start first unless `orderBy` says otherwise. To list the events overlapping a window, pass its start as `endsAfter` and its end as `startsBefore`. Read `calendarEventCatalog` for what each event type and agenda item kind does.

calendar_events

Fetch a single campaign by its id. Ids from earlier versions of the Redo API are also accepted.

campaign

List campaigns, optionally filtered by name, channel, or when they finished sending.

campaigns

Stop an in-progress campaign. Returns null if no campaign with that id is owned by the caller.

cancel_campaign

Cancel a purchase order, releasing it from incoming stock. Returns null if no purchase order with that id is owned by the caller. Cancelling an already-cancelled order is a no-op. Throws a 409 CONFLICT error (with an extension code of PURCHASE_ORDER_CLOSED or PURCHASE_ORDER_HAS_RECEIVED_ITEMS) if the order can no longer be cancelled.

cancel_purchase_order

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.

carrier_shipment_tracker

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.

carrier_shipment_trackers

Close a return by marking it as complete. This marks all return items as complete and closes the return without performing any processing actions (no refunds, exchanges, etc.). Use this when a merchant wants to close out a return without taking further action. Cannot be used on returns that are already in a closed state (complete, rejected, or deleted). Confirm with the user before closing.

close_return

Close returns that were handled outside Redo: every item is marked complete and nothing is refunded. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.

close_returns

Commerce Agent strategies on this store, newest first, optionally filtered by name. At most 100 are returned; narrow with `query` to reach older ones.

commerce_agent_strategies

Look up a Commerce Agent strategy by id. Returns null when this store has no strategy with that id.

commerce_agent_strategy

Fetch a single consolidation by its id.

consolidation

List the consolidations you participate in, newest packed first.

consolidations

Create a calendar event. The Commerce Agent reads MARKETING events near the current date as context when it answers shoppers and writes outbound marketing messages. Read calendarEventCatalog for the agenda item kinds each type accepts.

create_calendar_event

Create a campaign shell. Email requires `subject` and `previewText`. Set the audience and schedule with `updateCampaign`.

create_campaign

Create an empty checkout experience — a named group of shipping methods Redo can serve at checkout. The new experience has no shipping methods and is not live until the checkout tree points at it; add methods with create_shipping_method and route to it with update_checkout_tree.

create_checkout_experience

Create a Commerce Agent strategy. Set its id as `strategyId` when inserting a Start Agent Conversation step.

create_commerce_agent_strategy

Record a single customer event. The event is queued for asynchronous processing and acknowledged immediately.

create_customer_event

Record up to 100 customer events in one request. Each event is queued for asynchronous processing and acknowledged individually, in order.

create_customer_events

Create a customer tag in this store's Redo catalog. The tag's source is Redo Marketing.

create_customer_tag

Create a discount code on Shopify or BigCommerce. The same input is used for both providers.

create_discount_code

Start a new return for a customer's order. Accepts an internal order ID, Shopify order ID, or Shopify/display order name such as '#1234'. If an order name does not resolve or you need to disambiguate, call list_orders with providerOrderName, then pass the returned order id here. This creates a draft return that must be configured step-by-step before submission. After creating the draft, use manage_draft_return to configure it, then submit_draft_return to finalize.

create_draft_return

Create a dynamic segment from a condition tree. Attach it to a campaign with updateCampaign.segmentIds.

create_dynamic_segment

Create an email template. `trigger` is required and cannot be UNKNOWN. Optional `operations` are applied to the default sections.

create_email_template

Create an OMS fulfillment-group view folder. Folders group related views (for example International Orders or Problem Orders). Use the returned folderId when calling create_views. Confirm the folder name with the merchant before calling. This does not create inventory, returns, claims, or support folders.

create_folder

Create a shipment tag for OMS fulfillment groups. An existing tag with the same name is updated with the supplied color. Tags label shipments and can be used as filter values with the tagName filter. Only create a tag when the merchant explicitly asks for a new one — do not invent tags because a filter value is missing. Confirm the name and color with the merchant before calling.

create_fulfillment_tag

Create an inbound shipment fulfilling a purchase order. Its line items are derived from that order, not supplied: when this is the order's only shipment they mirror the order exactly, but once an order has several shipments new order lines are left unassigned and quantity changes stop propagating. Throws a 409 CONFLICT error (with an extension code of PURCHASE_ORDER_NOT_EDITABLE) if the order is closed or cancelled.

create_inbound_shipment

Create a Commerce Agent knowledge article. Defaults to DRAFT so it is not retrievable until you set status to ACTIVE.

create_knowledge_article

Create an automation for a trigger listed in marketingAutomationCatalog. Returns the new automation. Date and price-drop triggers are not supported.

create_marketing_automation

Start an image upload for a file on disk. PUT the file's raw bytes to the returned `url` before `expiresAt`, then call `uploadMarketingImage` with `source: { uploadId }` to compress and host it. Counts against the image upload quota.

create_marketing_image_upload

Create a packing slip template from the standard layout, or copy an existing template when copyFromTemplateId is provided. Call list_packing_slip_templates first to see existing templates. After creation, use get_packing_slip_block_catalog, get_packing_slip_block_details, and update_packing_slip_template to customize sections. Confirm the desired name and copy source with the merchant before calling.

create_packing_slip_template

Create a new product family.

create_product_family

Save a product filter on this account. The returned `id` is what an email block stores.

create_product_filter

Create a purchase order. Throws a 409 CONFLICT error (with an extension code of PURCHASE_ORDER_NUMBER_TAKEN) if `poNumber` is already used by another order.

create_purchase_order

Add a comment to a return's timeline. If the message follows the format '{product_title} - {variant_title} disposition: {grade}', it will automatically update the matching product's grade (used for 2Boxes-style disposition notes). Use get_return first to verify the return exists and to get product details if writing a disposition note.

create_return_comment

Add a shipping method to a checkout experience. A 'fixed' method is a merchant-set price served by Redo with no carrier involved and needs `rates`. A 'dynamic' method quotes live carrier rates through Redo and needs `carrierServices` (or a `serviceLevel`). A 'custom' method is priced per cart by TypeScript in `code`, which is type-checked before anything is saved; call get_custom_shipping_method_code first for the contract and starter code. Always use 'fixed' or 'dynamic' unless the merchant specifically asks for a custom (script-priced) shipping method or provides their own code. When they do, send merchant-supplied code exactly as given. Only bring up custom methods after the merchant does, or when discussing a method that is already custom. Until then, do not mention, list or suggest them, including when asked which method types exist: describe only 'fixed' and 'dynamic'. Changing a custom method's script requires confirmCustomCode after the merchant approves the script. Shipping discount rules cannot be set through this API. They are configured by Redo and sync to a live storefront-platform function, so they are read-only here and are carried over untouched on update. Optional fields are omitted when they are not configured. An absent field means the option is not set, or is not editable through this tool — it does not mean Redo lacks the capability.

create_shipping_method

Create an SMS template. `trigger` is required and cannot be UNKNOWN.

create_sms_template