API Reference

Create Sponsored Brands Profile for Campaign

post
https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile

Create a new Sponsored Brands profile, for a campaign, that is relevant to the products in the respective campaign. This defines the look and click behavior of your Sponsored Brands placement. Successfully created profiles will be assigned a unique Sponsored Brands Profile ID.

Body Params

Details about SBA profile

int32
required

The ID of the campaign.

int32
required

The ID of the ad group.

string
required

The name of the Brand. It should be of maximum 35 characters, all of which are NOT recommended to be special characters. This field should not be left empty.

string
required

Custom headline text showcasing why customers should buy your products.
Piece of text that explains your brand value within following constraints:

  • It should be of maximum 45 characters.
  • It is recommended to NOT use all special characters in this field.
string
required

The destination URL or landing page URL. It is the website address that a visitor lands on when he/she clicks on the ad. Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand.
It can be either of:

  • Search Page
  • Browse Page
  • Brand Shop
  • Brand Shelf
Headers
string
required

Auth signature as an API key.

string
required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

integer
required

We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.

integer
required

Timestamp for which the auth signature is generated. Use Unix epoch format.

string
required

The token will provide you the access to the API. It is same for all advertisers you access through the API.

Response

Updated 24 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 24 days ago