Skip to main content

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​

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
page_sizePage size, Maximum 50Yesinteger20
pagePageYesinteger1
brand_idBrand ID, Not supported for bulkNointeger-
item_idWalmart Item IDs, Maximum of 50, separated by commaNostring-
relationshipRelationship, 1 = returns only products with a partnership (default), 0 = returns products without partnership, 2 = returns all products with relationship field indicating partnership status.Nointeger1
annual_eventSet it to true if you want items that are part of annual event items listNobooleantrue
flash_dealSet it to true if you want items that are part of weekly flash deal items listNobooleantrue
daily_dealSet it to true if you want items that are part of daily dealsNobooleantrue
limited_time_dealSet it to true if you want items that are part of limited time dealsNobooleantrue
rollbackSet it to true if you want items marked with Walmart Rollback pricingNobooleantrue
clearanceSet it to true if you want items on clearance saleNobooleantrue
extra_savingsSet it to true if you want items that are part of extra savings items listNobooleantrue
reduced_priceSet it to true if you want items with direct reduced pricesNobooleantrue
strikethroughSet it to true if you want items displaying a strikethrough original priceNobooleantrue
bundleSet it to true if you want items offered as bundle packagesNobooleantrue
fulfilled_by_walmartSet it to true if you want items fulfilled by Walmart (WFS)Nobooleantrue
pro_seller_itemSet it to true if you want items that are sold by pro-sellersNobooleantrue

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​

KeyDescriptionTypeExample
status.code-integer0
status.msg-stringsuccess
data.list[].product_nameProduct namestringonn. 65" Class 4K UHD LED Roku Smart TV HDR
data.list[].imageProduct imagestringhttps://i5.walmartimages.com/seo/onn-65-Class-4K-UHD_abc123.jpeg
data.list[].item_idWalmart Item IDstring587462398
data.list[].commissionCommission, Could be a percentage or flat feestring5%
data.list[].categoryProduct categorystringElectronics
data.list[].availabilityProduct availability statusstringIN_STOCK
data.list[].ratingAverage ratingstring4.3
data.list[].reviewsNumber of reviewsstring2156
data.list[].urlProduct URLstringhttps://www.walmart.com/ip/587462398
data.list[].brand_idBrand IDinteger12345
data.list[].brand_nameMerchant / PartnerBoost brand name (sitename)stringonn.
data.list[].product_brand_nameProduct brand name from Walmart catalogstringonn.
data.list[].update_timeUpdated time, Unix timestampinteger1716192000
data.list[].relationshipRelationship, 0 = no partnership, 1 = has partnershipinteger1
data.list[].priceProduct pricestring298.00
data.list[].original_priceOriginal price (strikethrough price)string298.00
data.list[].discountDiscount percentage, rounded to 2 decimal placesnumber0
data.list[].discount_start_dateDiscount start date, millisecond timestampinteger1778987100000
data.list[].discount_end_dateDiscount end date, millisecond timestampinteger1783906200000
data.list[].currencyCurrency codestringUSD
data.list[].annual_eventIndicates whether the item is part of an annual eventbooleantrue
data.list[].flash_dealIndicates whether the item is currently on a flash dealbooleantrue
data.list[].daily_dealIndicates whether the item is part of daily dealsbooleantrue
data.list[].limited_time_dealIndicates whether the item has a limited-time deal tagbooleantrue
data.list[].rollbackIndicates whether the item has Walmart's Rollback price tagbooleantrue
data.list[].clearanceIndicates whether the item is a clearance itembooleantrue
data.list[].extra_savingsIndicates whether the item offers extra savings or additional instant discountsbooleantrue
data.list[].reduced_priceIndicates whether the item's price has been reducedbooleantrue
data.list[].strikethroughIndicates whether the item shows a strikethrough price comparisonbooleantrue
data.list[].bundleIndicates whether the item is sold as a bundle packagebooleantrue
data.list[].fulfilled_by_walmartIndicates whether the item is fulfilled by Walmart (WFS)booleantrue
data.list[].pro_seller_itemIndicates whether the item is offered by a Pro Sellerbooleantrue
data.has_moreIs there more data?booleantrue

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​

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
item_idWalmart Item IDs, Maximum of 50, separated by commaYesstring587462398,234567891
uidPartnerBoost UID, Maximum 5, separated by comma, Maximum length is 128Nostringmyuid

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"item_id": "587462398,234567891",
"uid": "myuid"
}

Response fields​

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data[].item_idWalmart Item IDstring587462398
data[].linkWalmart Attribution tracking linkstringhttps://goto.walmart.com/c/5610446/565706/9383?veh=aff&sharedid=...
data[].partnerboost_linkPartnerBoost short linkstringhttps://pboost.me/AbCdEfGh?uid=myuid
error_list[].item_idWalmart Item ID that failedstring234567891
error_list[].messageError messagestringProduct not found or no relationship

This API allows you to generate Walmart brandshop tracking links using Brand IDs.

Method: POST
Path: /api/walmart_datafeed/get_shops_link

Request parameters​

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
brand_idBrand IDs, Maximum of 50, separated by commaYesstring12345,67890
uidPartnerBoost UID, Maximum 5, separated by comma, Maximum length is 128Nostringmyuid

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"brand_id": "12345,67890",
"uid": "myuid"
}

Response fields​

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data[].brand_idBrand IDstring12345
data[].brand_nameBrand namestringonn.
data[].brandshop_linkWalmart Attribution brandshop tracking linkstringhttps://goto.walmart.com/c/5610446/565706/9383?veh=aff&sharedid=...
data[].partnerboost_linkPartnerBoost short linkstringhttps://pboost.me/XyZaBcDe?uid=myuid
error_list[].brand_idBrand ID that failedstring67890
error_list[].brand_nameBrand namestringExample Brand
error_list[].messageError messagestringBrand 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​

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
page_sizePage size, Maximum 50, default at 50Yesinteger50
pagePageYesinteger1

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 50,
"page": 1
}

Response fields​

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.list[].bidBrand ID (Merchant ID)integer12345
data.list[].brand_nameMerchant / PartnerBoost brand name (sitename)stringonn.
data.list[].product_brand_nameProduct brand name from Walmart catalogstringonn.
data.list[].categoryProduct CategorystringElectronics
data.list[].item_idWalmart Item IDstring587462398
data.list[].skuSKUstringSKU587462
data.list[].product_nameProduct namestringonn. 65" Class 4K UHD LED Roku Smart TV HDR
data.list[].urlProduct URLstringhttps://www.walmart.com/ip/587462398
data.list[].ratingAverage ratingstring4.3
data.list[].reviewsNumber of reviewsinteger2156
data.list[].commissionCommission rate, e.g. 0.15 means 15%string0.15
data.list[].start_timeCommission start time, ISO 8601string2026-05-01T00:00:00-07:00
data.list[].end_timeCommission end time, ISO 8601string2026-05-31T23:59:59-07:00
data.has_moreIs there more data?booleantrue