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

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 20,
"page": 1,
"brand_id": null,
"relationship": 1
}

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_nameBrand namestringonn.
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.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[].brand_nameBrand Namestringonn.
data.list[].item_idWalmart Item IDstring587462398
data.list[].skuSKUstringSKU587462
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