Channels

List channels

Create an Amazon channel connection invitation

Show a channel

Get a single channel by its ID. Used to populate the channel edit page.

Delete a channel

Delete a channel and its associated listings, listing-product links, and Amazon feeds.

Activate a channel

Mark a channel as active. Used on the channel edit page.

Deactivate a channel

Deactivate a channel, setting its connection status to `unauthorized`. Used on the channel edit page.

Create an Amazon channel

Create a new Amazon channel for the current merchant. The channel is created in an unauthorized state; use the authorize-url endpoint to begin the OAuth flow.

Update an Amazon channel

Update an Amazon channel's nickname and marketplace. Changing the marketplace disconnects the channel and sets its connection status to `unauthorized`, requiring re-authorization.

Get the Amazon channel authorize URL

Return the Amazon OAuth URL to redirect the merchant to in order to authorize the channel. This is the real "authorize" step of connecting an Amazon channel.

List Amazon marketplaces

Return the list of Amazon marketplaces that a channel can be connected to.

Show a Amazon catalog item's landed-price analytics

Summarises daily UTC landed-price observations of the Amazon New featured offer for one Amazon catalog item into calendar buckets over [start, end). Catalog prices are global per platform, so no listing, channel or merchant link is needed; the caller needs listings:view on the narrated account. A uuid that is not an existing Amazon catalog item returns 404. Days are UTC calendar days, weeks start on Monday and months on the first. Edge buckets are clipped to the range. Each observed currency is its own series; an item with no observations in the range returns an empty series array. Averages are per observation, not time-weighted, and the current UTC day may still gain observations.

Index an Amazon channel's listing inventory levels

Returns one entry per stored AFN or MFN level, so one listing can have two entries. Listings without inventory are omitted and `total` counts levels. Values are retained until replaced: `synced_at` is the source-request time and exposes staleness, while nullable `reported_at` is a legacy vendor timestamp and is not freshness. AFN and MFN may have different ages. This read-only request does not fetch Amazon, inactive channels remain readable, and replica reads may lag recent writes slightly.

Create a custom channel

Create a new custom channel for the current merchant. Custom channels are created in an active state.

Update a custom channel

Update a custom channel's nickname.

Create a Walmart channel

Create a new Walmart channel for the current merchant. The channel is created in an unauthorized state; use the authorize-url endpoint to begin the OAuth flow.

Get the Walmart channel authorize URL

Return the Walmart OAuth URL to redirect the merchant to in order to authorize the channel. This is the real "authorize" step of connecting a Walmart channel.

Index a Walmart channel's feeds

The feeds submitted to Walmart for this channel, newest first, with their processing status.

Index a Walmart channel's listing inventory levels

One entry per listing of the channel, with the last WFS and ship-node levels stored for it. Listings with no stored level are included with `wfs: null` and an empty `ship_nodes`; missing levels are not zero. Every quantity Walmart did not report is null, and zero is only returned when Walmart reported zero. WFS and ship-node levels are synced from separate Walmart requests, so each carries its own `synced_at` (the time of that request) and they can be of different ages. Levels are retained until a later sync replaces them, so an old `synced_at` means the level may no longer be current; the levels are not a guarantee of current stock or a complete catalogue. WFS and ship-node quantities may describe the same units and must not be added together. Nothing is fetched from Walmart by this request. Reads may lag recent writes slightly. Inactive channels remain readable.

Refresh a Walmart listing's stored inventory levels

Requires listings:update. Fetches fresh WFS inventory and inventory across all ship nodes for the listing's Walmart SKU (channel_identifier), then saves the reported levels together and returns the stored values. Both Walmart lookups must succeed before either source is saved. An inactive or disconnected channel is rejected. Quantities Walmart omits remain null; zero is stored only when Walmart reports zero. Previously stored WFS or ship-node levels omitted from a successful response are retained with their original synced_at. Newer stored observations are not overwritten. Each source carries the time its lookup began. WFS and ship-node quantities may describe the same units and must not be added together. The response is read from the primary database.

Refresh a Walmart listing's stored seller price

Requires listings:update. Fetches the item for the listing's Walmart SKU (channel_identifier) and saves its reported price and item facts. Returns the stored price from the primary database. The price is the seller's own offer price. An inactive or disconnected channel is rejected. Empty responses and missing or unparseable prices retain the previous observation, including synced_at; without stored details, price and synced_at are null. Zero is stored only when Walmart reports zero. Newer stored details are not overwritten. synced_at is the time the lookup began. Catalogue links and WFS enrolment are preserved.

List Walmart product types

Walmart's product type taxonomy for a feed type, flattened to one row per product type, for a product type picker. Read from Walmart's `GET /v3/items/taxonomy` (https://developer.walmart.com/us-marketplace/reference/gettaxonomyresponse) and cached for 24 hours per marketplace and feed type. For an existing Walmart item, the product type it is listed under is authoritative; see `walmart.live_item.product_type` on the listing.

Show a Walmart feed

One feed with Walmart's result for each item in it. Items are empty until the feed is processed.

Show a Walmart catalog item's landed-price analytics

Summarises daily UTC landed-price observations of the Walmart buy box for one Walmart catalog item into calendar buckets over [start, end). Catalog prices are global per platform, so no listing, channel or merchant link is needed; the caller needs listings:view on the narrated account. A uuid that is not an existing Walmart catalog item returns 404. Days are UTC calendar days, weeks start on Monday and months on the first. Edge buckets are clipped to the range. Each observed currency is its own series; an item with no observations in the range returns an empty series array. Averages are per observation, not time-weighted, and the current UTC day may still gain observations.

Set up a listing on Walmart

Set up the listing's SKU as an offer on an item already in Walmart's catalogue ("setup by match", the `MP_ITEM_MATCH` feed). Walmart processes the feed asynchronously: the listing is marked submitted, and the returned feed reports the outcome through the Walmart feeds endpoints. When the feed finishes, the listing becomes synced (with its WPID) or unsynced.

Update listing attributes on Walmart

Requests partial product content and offer attribute updates for an existing United States Walmart listing through an MP_MAINTENANCE feed. Include only attributes to update, using Walmart attribute names inside orderable and visible. The listing SKU is supplied automatically; gtin defaults to the linked catalogue item. Walmart validates category-specific attributes asynchronously. The returned feed tracks submission and item-level errors. The local listing status and content are not changed by this request. WFS trade item and supply chain fields require WFS item setup instead. For dedicated SKU-based price and MSRP updates without a GTIN, use PATCH /channels/walmart/listings/{listing}/price, which submits PRICE_AND_PROMOTION.

Update a Walmart listing price and MSRP

Queues a PRICE_AND_PROMOTION feed for an existing listing on a connected United States Walmart channel. Requires ListingsUpdate permission and the listing must belong to the current merchant and service provider context. The listing SKU is supplied automatically; no GTIN, catalogue link or product type is required. Supply a price and optionally msrp. Uses Walmart pricing specification 2.0.20240126-12_25_52-api with MPItem[].Promo&Discount. A 202 response means queued, not applied: monitor GET /channels/walmart/feeds/{walmart_feed} for submission and item-level ingestion errors. Filter channel feeds with feed_type=PRICE_AND_PROMOTION. The local listing status and content are unchanged. Promotion creation and deletion are not supported by this endpoint. Walmart reference: https://developer.walmart.com/us-marketplace/docs/update-bulk-prices.

Show the content requirements of a Walmart listing

The content (`Visible`) attributes Walmart's item spec defines for the product type Walmart lists the item under, for building a content form. `required` is every attribute a content change must carry: the spec's unconditional `required` list (`spec_required`) united with Walmart's content standards (`content_standards`: `productName`, `shortDescription`, `mainImageUrl`, `keyFeatures`, kept only where the product type has them). The live `MP_MAINTENANCE` spec marks none of the content standards required (for many product types it has no unconditional `required` list at all), yet Walmart's ingestion refuses a content change without them (`EXT_DATA_ERROR_05045574625354`; https://public.walmart.com/content/ContentStandards/en_us/importance-of-content-standards.html), so they come from that ingestion evidence rather than the spec. `conditional` lists the spec's `allOf` `if`/`then` rules as the attribute that triggers them (`when`) and the attributes they then require (`then`); it is listed as Walmart gives it and not evaluated here, and the value that triggers a rule (e.g. which `has_written_warranty` answer calls for `warrantyText` rather than `warrantyURL`) is not included. A content change on `PATCH /channels/walmart/listings/{listing}` that misses a `required` attribute, misses one a `conditional` rule requires for the value sent, or has a value breaking its spec rules is refused with 422 before any feed is sent. Walmart may still refuse a content change on rules this check leaves to Walmart (such as value formats, or rules outside the spec); those come back as the feed's ingestion errors. Read from Walmart's `POST /v3/items/spec` (https://developer.walmart.com/us-marketplace/reference/getspec) for the `MP_MAINTENANCE` feed type at the version our maintenance feed is sent with, and cached for 24 hours per marketplace, feed type and product type.

Get current Walmart listing content

Fetches fresh content directly from Walmart for a listing on a connected Walmart channel. Resolves the exact seller SKU with GET /v3/items/{sku}, then searches GET /v3/items/walmart/search using the live item ID, or its normalized GTIN/UPC when Walmart omits the item ID. Returns only an unambiguous matching catalog item, with a matching condition when both responses include one. No local catalog link is required. Requires ListingsView permission and the listing must belong to the current merchant and service provider context. This is a partial read of Walmart's published catalog, not a complete maintenance feed or saved draft. Unpublished items may not appear in catalog search. Missing text fields are null and missing images are an empty array; never use those missing values to overwrite a draft. Key features and category-specific attributes are not exposed by this endpoint, so use GET /channels/walmart/listings/{listing}/content-requirements to determine what else an update needs. For PATCH /channels/walmart/listings/{listing}, map title to visible.productName, description to visible.shortDescription and brand to visible.brand; image URLs can prefill visible.mainImageUrl and visible.productSecondaryImageURL after review. The response is not guaranteed to satisfy Walmart's maintenance requirements. Text and HTML are preserved as Walmart returns them. Walmart API reference: https://developer.walmart.com/us-marketplace/reference/getsearchresult.

Show WFS conversion requirements

Resolves the listing live by SKU on its connected US Walmart channel and returns the OMNI_WFS conversion JSON schemas at 5.0.20260803-17_50_56-api, also used by conversion validation and feed generation. No local catalog link is needed. Each schema retains Walmart properties, required, additionalProperties, types, bounds, enums and full if/then/else conditions; clients must evaluate value conditions rather than treating every then field as unconditionally required. visible_schema applies inside Visible[product_type], orderable_schema to Orderable and trade_item_schema to TradeItem. feed_schema is the complete envelope restricted to the live product type. See the conversion endpoint for snake_case input mappings. These are conversion requirements, distinct from content-requirements (MP_MAINTENANCE). Requirements are cached for 24 hours by marketplace, OMNI_WFS, exact version and product type.

Convert a Walmart listing to WFS

Requests conversion of an existing United States Walmart Marketplace listing through an OMNI_WFS feed at specification 5.0.20260803-17_50_56-api. The live SKU lookup supplies the product type and GTIN/UPC; a local catalog link is not required. GET /channels/walmart/listings/{listing}/wfs-conversion-requirements returns the exact conversion schemas, including field placement, types, enums and value-dependent requirements. The content-requirements endpoint describes MP_MAINTENANCE and is not a conversion schema. The generated feed is validated before submission. A 202 means queued for asynchronous processing, not converted; monitor the returned feed for ingestion errors.

Index a Walmart channel's WFS inbound orders

The channel's Walmart Fulfillment Services inbound orders, newest first.

Draft a WFS inbound order

Create a draft inbound order on a Walmart channel with its return address and items. Nothing is sent to Walmart until the order is submitted.

Search a GTIN's WFS hazmat compliance holds

Asks Walmart whether an item is on a WFS hazmat compliance hold. `in_review` clears within about 72 business hours; `action_needed` means the item data must be fixed and converted to WFS again; `prohibited` means the item cannot be sold through WFS. An item with several errors is one row per error. Nothing is stored. Walmart: https://developer.walmart.com/us-marketplace/reference/wercsfeedback

Show a WFS inbound order

One inbound order with its items, its shipments (with their items and carrier bookings) and its timeline.

Replace the items of a WFS inbound order

Replace the item set of a draft or rejected inbound order before it is submitted again. A rejected order keeps its `inbound_order_id`: Walmart expects the corrected order to be resubmitted under the same id. Nothing is sent to Walmart until the order is submitted.

Preview the destinations and ITS fees of a WFS inbound order

Asks Walmart where the order's units would go, both with Inventory Transfer Service (ITS) and with self-distribution, and what ITS would cost. Walmart's figures are estimates: routing and fees are fixed when the order is submitted. Only Draft and Rejected orders can be previewed. Nothing is stored except a `preview_fetched` timeline entry. Walmart: https://developer.walmart.com/us-marketplace/reference/inboundpreview

Submit a WFS inbound order to Walmart

Queue a draft or rejected inbound order for submission to Walmart. Submission happens in the background, so the returned order is still in its previous status (`draft` or `rejected`); poll the order to see it become `submitted` (with its shipments) or `rejected` (with `errors`). Submitting again while a submission is queued queues nothing more.

Request cancellation of a WFS inbound order

Ask Walmart to cancel a submitted inbound order. Walmart's answer is recorded on the order rather than returned as an error: `timeline[0].event_type` is `cancellation_requested` when Walmart accepted (and `cancellation_requested_at` is set), `cancellation_rejected` when it refused, or `api_error_occurred` when the call failed (see `errors`). The order becomes `cancelled` once Walmart reports it cancelled.

Update a WFS shipment's quantities

Change how many units of each SKU a shipment will carry. Walmart allows an increase of at most six units per SKU after submission, and a SKU is removed by setting it to 0, but not every SKU on the shipment (that would cancel the whole inbound order); a request outside those rules is refused with 422 before Walmart is called (Walmart remains the authority and may still refuse). The outcome is recorded on the order: `timeline[0].event_type` is `shipment_quantities_updated` when Walmart accepted, `shipment_quantities_rejected` when it refused (also answered 422), or `shipment_quantities_update_unconfirmed` when the call failed (answered 200; the outcome will be learned when the shipment is next refreshed).

Submit tracking for a WFS shipment

Tell Walmart which carrier and tracking numbers a shipment is travelling with. The outcome is recorded on the order: `timeline[0].event_type` is `tracking_submitted` when Walmart accepted (and the shipment shows the carrier and tracking numbers), `tracking_rejected` when it refused, or `api_error_occurred` when the call failed. A Walmart refusal answers 422 and a call Walmart did not answer answers 502.

Create a WFS shipment box label

Have Walmart create the box labels for a shipment and download them. The file is returned as Walmart produced it and is not stored.

List the rate quotes of a WFS shipment

The Walmart preferred-carrier quotes requested for a shipment, newest first, at most 200.

Request rate quotes for a WFS shipment

Ask Walmart's preferred-carrier programme for quotes. The fields besides `quote_type` and `ship_from` depend on the quote type. The returned quotes are kept and can be booked with the carrier booking endpoint.

Book a carrier for a WFS shipment

Book one of the shipment's rate quotes. The quote's type decides which fields are required. Walmart's answer is recorded on the order: `timeline[0].event_type` is `carrier_booked`, `carrier_booking_rejected`, `carrier_booking_unconfirmed` or `api_error_occurred`. A Walmart refusal answers 422 and a call Walmart did not answer answers 502; an unconfirmed booking answers 200 with `carrier_booking.state` `unconfirmed`.

Cancel the carrier booking of a WFS shipment

Cancel the shipment's live booking. Walmart's answer is recorded on the order: `timeline[0].event_type` is `carrier_booking_cancelled`, `carrier_booking_cancellation_rejected` or `api_error_occurred`. A Walmart refusal answers 422 and a call Walmart did not answer answers 502.

Download the carrier label of a WFS shipment

Download the carrier label of the shipment's live Parcel booking. The file is returned as Walmart produced it and is not stored.

Generate the carrier label of a WFS shipment

Ask Walmart to generate the carrier label for a Parcel booking. Walmart generates it asynchronously; fetch it with `GET` on the same path. The outcome is recorded on the order: `timeline[0].event_type` is `carrier_label_generated`, `carrier_label_rejected` or `api_error_occurred`. A Walmart refusal answers 422 and a call Walmart did not answer answers 502.

Print the bill of lading of a WFS shipment

Download the bill of lading of the shipment's live LTL booking. The file is returned as Walmart produced it and is not stored.

Read the carrier tracking of a WFS shipment

Walmart's carrier tracking for the shipment's live booking, read in the booking's mode. Nothing is stored.

Reschedule the pickup of a WFS shipment

Ask Walmart to move the pickup of the shipment's live LTL booking. The booked quote is used. The outcome is recorded on the order: `timeline[0].event_type` is `pickup_rescheduled`, `pickup_reschedule_rejected` or `api_error_occurred`. A Walmart refusal answers 422 and a call Walmart did not answer answers 502.

Refresh the pickup of a WFS shipment

Read the pickup Walmart scheduled for the shipment's live LTL booking and record it on the order when it changed.