You can use the sales channel management APIs listed in this section to create, retrieve, and update Multichannel Solutions (MCS) sales channel details.

Create MCS sales channel details

Creates one or more MCS sales channels. The API combines mcfDetails and mcsDetails into the channel configuration. Use this endpoint to register test or production sales channels that will be used for order routing, fulfillment, and tracking.

Endpoint

POST https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details

Sample request

curl -X POST "https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "martId: 202" \ -H "buId: 0" \ -d '{ "header": { "headerAttributes": { "martId": "202", "buId": "0" } }, "payload": { "partnerId": "ID", "mcsDetails": [ { "returnAddress": { "firstName": "Alice", "line1": "line 1", "line2": "line 2", "line3": "line 3", "city": "city", "state": "ST", "country": "USA", "zip": "00000", "addressType": "Type" }, "active": true, "orderChannelName": "Sales channel name", "carrierPreference": "Package" } ] } }'

import requests url = "https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details" headers = { "Authorization": "Bearer <ACCESS_TOKEN>", "Content-Type": "application/json", "martId": "202", "buId": "0", "Accept": "application/json",
} body = { "header": { "headerAttributes": { "martId": "202", "buId": "0" } }, "payload": { "partnerId": "ID", "mcsDetails": [ { "returnAddress": { "firstName": "Alice", "line1": "line 1", "line2": "line 2", "line3": "line 3", "city": "city", "state": "ST", "country": "USA", "zip": "00000", "addressType": "Type" }, "active": True, "orderChannelName": "Sales channel name", "carrierPreference": "Package" } ] }
} response = requests.post(url, headers=headers, json=body, timeout=30)
response.raise_for_status()
print(response.json())

Success response (201 created)

On success, this API returns HTTPS 201 status and echoes created mcsDetails.

{ "status": "CREATED", "header": null, "payload": [ { "orderChannelId": "43D99F3319FF464F8B29C8623F639968", "boxCatalogType": "multichannel", "shippping": "FedX 2 Business Days and FedX Ground", "returnAddress": { "firstName": "Jomashop-up1", "line1": "AMT-up", "line2": "140A test-up", "line3": "", "city": "JORDAN", "state": "CA", "country": "US", "zip": "11220-2516", "addressType": "COMMERCIAL" }, "active": "Y", "sellerId": "BECA2C4CBD13464CBEC8A3E5B4CC0E35", "sellerName": "mpcoeewfsseller2", "createdDate": "2024-04-29T15:08:26.240+00:00", "orderChannelName": "new name1", "carrierPreference": "packageB", "martId": "202" } ], "errors": [] }

Error response (400 Bad Request)

If there are validation issues, this API returns 400 with INVALID_MCS_REQUEST.

Get sales channel details

Retrieves details for existing sandbox sales channels. This API looks up sales channels by partnerID.

Endpoint

GET https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details

Sample request

This sample request retrieves the channel configuration and metadata for channels previously created with the Create MCS sales channel endpoint.

curl -X GET "https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-Type: application/json" \ -H "martId: 202" \ -H "buId: 0"

import requests url = "https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details"
params = {"partnerId": "PARTNER_ID"}
headers = { "Authorization": "Bearer <ACCESS_TOKEN>", "martId": "202", "buId": "0", "Accept": "application/json",
} response = requests.get(url, headers=headers, params=params, timeout=30)
response.raise_for_status()
print(response.json())

Success response (200 OK)

On success, the API returns a HTTPS 200 OK status along with the configuration and metadata details for the channel specified by the partnerID.

{ "status": "OK", "header": null, "payload": [ { "orderChannelId": "43D99F3319FF464F8B29C8623F639968", "boxCatalogType": "multichannel", "shippping": "FedX 2 Business Days and FedX Ground", "returnAddress": { "firstName": "Jomashop-up1", "line1": "AMT-up", "line2": "140A test-up", "line3": "", "city": "JORDAN", "state": "CA", "country": "US", "zip": "11220-2516", "addressType": "COMMERCIAL" }, "active": "Y", "sellerId": "BECA2C4CBD13464CBEC8A3E5B4CC0E35", "sellerName": "mpcoeewfsseller2", "createdDate": "2024-04-29T15:08:26.240+00:00", "orderChannelName": "new name1", "carrierPreference": "packageB", "martId": "202" } ], "errors": [] }

Error response (400 Invalid Request)

If there are no channels configured, this API returns HTTPS 400 status with InvalidRequest or INVALID_MCS_REQUEST.

Update MCS sales channel details

Update details for an existing test sales channel. This API updates existing sales channels and merges the provided details.

PUT https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details

Sample request

curl -X PUT "https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "martId: 202" \ -H "buId: 0" \ -d '{ "header": { "headerAttributes": { "martId": "202", "buId": "0" } }, "payload": { "partnerId": "ID", "mcsDetails": [ { "returnAddress": { "firstName": "Alice", "line1": "line 1", "line2": "line 2", "line3": "line 3", "city": "city", "state": "ST", "country": "USA", "zip": "00000", "addressType": "Type" }, "active": true, "orderChannelName": "Sales channel name", "carrierPreference": "Package" } ] } }'

import requests url = "https://sandbox.walmartapis.com/v3/fulfillment/orders-fulfillments/channel-details" headers = { "Authorization": "Bearer <ACCESS_TOKEN>", "Content-Type": "application/json", "martId": "202", "buId": "0", "Accept": "application/json",
} body = { "header": { "headerAttributes": { "martId": "202", "buId": "0" } }, "payload": { "partnerId": "ID", "mcsDetails": [ { "returnAddress": { "firstName": "Alice", "line1": "line 1", "line2": "line 2", "line3": "line 3", "city": "city", "state": "ST", "country": "USA", "zip": "00000", "addressType": "Type" }, "active": True, "orderChannelName": "Sales channel name", "carrierPreference": "Package" } ] }
} response = requests.put(url, headers=headers, json=body, timeout=30)
response.raise_for_status()
print(response.json())

Success response (201 created)

On success, this API returns HTTPS 201 status and echoes updated mcsDetails.

{ "status": "CREATED", "header": null, "payload": [ { "orderChannelId": "43D99F3319FF464F8B29C8623F639968", "boxCatalogType": "multichannel", "shippping": "FedX 2 Business Days and FedX Ground", "returnAddress": { "firstName": "Jomashop-up1", "line1": "AMT-up", "line2": "140A test-up", "line3": "", "city": "JORDAN", "state": "CA", "country": "US", "zip": "11220-2516", "addressType": "COMMERCIAL" }, "active": "Y", "sellerId": "BECA2C4CBD13464CBEC8A3E5B4CC0E35", "sellerName": "mpcoeewfsseller2", "createdDate": "2024-04-29T15:08:26.240+00:00", "orderChannelName": "new name1", "carrierPreference": "packageB", "martId": "202" } ], "errors": [] }

Error response (400 Bad Request)

If there are validation issues, this API returns 400 with INVALID_MCS_REQUEST.