Walmart
Base URL:
https://app.partnerboost.com
All endpoints use POST with Content-Type: application/json unless noted otherwise. Auth: Partner API authentication — pass token in the JSON body (from the publisher portal).
getProducts
This API allows you to filter and search for Walmart products that meet specific criteria, helping to narrow down the selection.
Method: POST
Path: /api/walmart_datafeed/get_products
Request parameters
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
page_size | Page size, Maximum 50 | Yes | integer | 20 |
page | Page | Yes | integer | 1 |
brand_id | Brand ID, Not supported for bulk | No | integer | - |
item_id | Walmart Item IDs, Maximum of 50, separated by comma | No | string | - |
relationship | Relationship, 1 = returns only products with a partnership (default), 0 = returns products without partnership, 2 = returns all products with relationship field indicating partnership status. | No | integer | 1 |
annual_event | Set it to true if you want items that are part of annual event items list | No | boolean | true |
flash_deal | Set it to true if you want items that are part of weekly flash deal items list | No | boolean | true |
daily_deal | Set it to true if you want items that are part of daily deals | No | boolean | true |
limited_time_deal | Set it to true if you want items that are part of limited time deals | No | boolean | true |
rollback | Set it to true if you want items marked with Walmart Rollback pricing | No | boolean | true |
clearance | Set it to true if you want items on clearance sale | No | boolean | true |
extra_savings | Set it to true if you want items that are part of extra savings items list | No | boolean | true |
reduced_price | Set it to true if you want items with direct reduced prices | No | boolean | true |
strikethrough | Set it to true if you want items displaying a strikethrough original price | No | boolean | true |
bundle | Set it to true if you want items offered as bundle packages | No | boolean | true |
fulfilled_by_walmart | Set it to true if you want items fulfilled by Walmart (WFS) | No | boolean | true |
pro_seller_item | Set it to true if you want items that are sold by pro-sellers | No | boolean | true |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 20,
"page": 1,
"brand_id": null,
"relationship": 1,
"annual_event": true,
"flash_deal": true,
"daily_deal": true,
"limited_time_deal": true,
"rollback": true,
"clearance": true,
"extra_savings": true,
"reduced_price": true,
"strikethrough": true,
"bundle": true,
"fulfilled_by_walmart": true,
"pro_seller_item": true
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | - | integer | 0 |
status.msg | - | string | success |
data.list[].product_name | Product name | string | onn. 65" Class 4K UHD LED Roku Smart TV HDR |
data.list[].image | Product image | string | https://i5.walmartimages.com/seo/onn-65-Class-4K-UHD_abc123.jpeg |
data.list[].item_id | Walmart Item ID | string | 587462398 |
data.list[].commission | Commission, Could be a percentage or flat fee | string | 5% |
data.list[].category | Product category | string | Electronics |
data.list[].availability | Product availability status | string | IN_STOCK |
data.list[].rating | Average rating | string | 4.3 |
data.list[].reviews | Number of reviews | string | 2156 |
data.list[].url | Product URL | string | https://www.walmart.com/ip/587462398 |
data.list[].brand_id | Brand ID | integer | 12345 |
data.list[].brand_name | Merchant / PartnerBoost brand name (sitename) | string | onn. |
data.list[].product_brand_name | Product brand name from Walmart catalog | string | onn. |
data.list[].update_time | Updated time, Unix timestamp | integer | 1716192000 |
data.list[].relationship | Relationship, 0 = no partnership, 1 = has partnership | integer | 1 |
data.list[].price | Product price | string | 298.00 |
data.list[].original_price | Original price (strikethrough price) | string | 298.00 |
data.list[].discount | Discount percentage, rounded to 2 decimal places | number | 0 |
data.list[].discount_start_date | Discount start date, millisecond timestamp | integer | 1778987100000 |
data.list[].discount_end_date | Discount end date, millisecond timestamp | integer | 1783906200000 |
data.list[].currency | Currency code | string | USD |
data.list[].annual_event | Indicates whether the item is part of an annual event | boolean | true |
data.list[].flash_deal | Indicates whether the item is currently on a flash deal | boolean | true |
data.list[].daily_deal | Indicates whether the item is part of daily deals | boolean | true |
data.list[].limited_time_deal | Indicates whether the item has a limited-time deal tag | boolean | true |
data.list[].rollback | Indicates whether the item has Walmart's Rollback price tag | boolean | true |
data.list[].clearance | Indicates whether the item is a clearance item | boolean | true |
data.list[].extra_savings | Indicates whether the item offers extra savings or additional instant discounts | boolean | true |
data.list[].reduced_price | Indicates whether the item's price has been reduced | boolean | true |
data.list[].strikethrough | Indicates whether the item shows a strikethrough price comparison | boolean | true |
data.list[].bundle | Indicates whether the item is sold as a bundle package | boolean | true |
data.list[].fulfilled_by_walmart | Indicates whether the item is fulfilled by Walmart (WFS) | boolean | true |
data.list[].pro_seller_item | Indicates whether the item is offered by a Pro Seller | boolean | true |
data.has_more | Is there more data? | boolean | true |
getProductsLink
This API allows you to generate Walmart product tracking links using Walmart Item IDs.
Method: POST
Path: /api/walmart_datafeed/get_products_link
Request parameters
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
item_id | Walmart Item IDs, Maximum of 50, separated by comma | Yes | string | 587462398,234567891 |
uid | PartnerBoost UID, Maximum 5, separated by comma, Maximum length is 128 | No | string | myuid |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"item_id": "587462398,234567891",
"uid": "myuid"
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data[].item_id | Walmart Item ID | string | 587462398 |
data[].link | Walmart Attribution tracking link | string | https://goto.walmart.com/c/5610446/565706/9383?veh=aff&sharedid=... |
data[].partnerboost_link | PartnerBoost short link | string | https://pboost.me/AbCdEfGh?uid=myuid |
error_list[].item_id | Walmart Item ID that failed | string | 234567891 |
error_list[].message | Error message | string | Product not found or no relationship |
getShopsLink
This API allows you to generate Walmart brandshop tracking links using Brand IDs.
Method: POST
Path: /api/walmart_datafeed/get_shops_link
Request parameters
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
brand_id | Brand IDs, Maximum of 50, separated by comma | Yes | string | 12345,67890 |
uid | PartnerBoost UID, Maximum 5, separated by comma, Maximum length is 128 | No | string | myuid |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"brand_id": "12345,67890",
"uid": "myuid"
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data[].brand_id | Brand ID | string | 12345 |
data[].brand_name | Brand name | string | onn. |
data[].brandshop_link | Walmart Attribution brandshop tracking link | string | https://goto.walmart.com/c/5610446/565706/9383?veh=aff&sharedid=... |
data[].partnerboost_link | PartnerBoost short link | string | https://pboost.me/XyZaBcDe?uid=myuid |
error_list[].brand_id | Brand ID that failed | string | 67890 |
error_list[].brand_name | Brand name | string | Example Brand |
error_list[].message | Error message | string | Brand has no brandshop link |
getLatestAffiliateBoostForWalmartItems
This API allows you to retrieve the latest Affiliate Boost for Walmart item list. Only authorized publishers can access this API.
Method: POST
Path: /api/datafeed/get_latest_affiliate_boost_for_walmart_items
Request parameters
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
page_size | Page size, Maximum 50, default at 50 | Yes | integer | 50 |
page | Page | Yes | integer | 1 |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 50,
"page": 1
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.list[].bid | Brand ID (Merchant ID) | integer | 12345 |
data.list[].brand_name | Merchant / PartnerBoost brand name (sitename) | string | onn. |
data.list[].product_brand_name | Product brand name from Walmart catalog | string | onn. |
data.list[].category | Product Category | string | Electronics |
data.list[].item_id | Walmart Item ID | string | 587462398 |
data.list[].sku | SKU | string | SKU587462 |
data.list[].product_name | Product name | string | onn. 65" Class 4K UHD LED Roku Smart TV HDR |
data.list[].url | Product URL | string | https://www.walmart.com/ip/587462398 |
data.list[].rating | Average rating | string | 4.3 |
data.list[].reviews | Number of reviews | integer | 2156 |
data.list[].commission | Commission rate, e.g. 0.15 means 15% | string | 0.15 |
data.list[].start_time | Commission start time, ISO 8601 | string | 2026-05-01T00:00:00-07:00 |
data.list[].end_time | Commission end time, ISO 8601 | string | 2026-05-31T23:59:59-07:00 |
data.has_more | Is there more data? | boolean | true |