Walmart Marketplace

Any instance where an entry in the below configuration has a leading $ represents a parameter that needs to be replaced with a static value.

Parameters in this document:

• $client_id and $client_secret - The Client ID and Client Secret will be used to authenticate calls to the Walmart Marketplace API. These values are associated wtih an Authenticated User in Walmart, and will be exchanged for the access token that will be used to make API calls. You can find your Client ID and Client Secret here.
• $encoded_auth - In order to utilize the Client ID and Client Secret to access the Walmart API, it must be added to the Refresh Access Token process as a Base64-encoded value. To get this, within your computer's terminal, enter the following string:
  echo -n '$client_id:$client_secret' | base64. The result will be the value to use for this parameter. If you run into any problems running the above string in the terminal, you can also find online resources for generating a Base64-encoded value, or reach out to our Support Team and we'd be happy to assist in generating this value.
• $endpoint - The Endpoint represents the data that you would like to ingest into Panoply from the Walmart Marketplace API. The value that should be used here can be found in the API Resources table below.
• $version - The version of the API can be found in the Walmart documentation for a given resource, and will be given as v# (e.g. v2, v3, etc.).
• $limit - The Limit value represents the number of records returned by the API per page.
• $pagination_key - The Pagination Key represents the column that will be used for paginating results in the API.
• $data_key - The Data Key represents the location of the data in the API response from Walmart Marketplace.
• $incremental_key - The Incremental Key represents the column that will be used to collect only new records in subsequent collections.
• $primary key - Primary keys are used to ensure the uniqueness of the rows in a table. The Primary Key is comprised of one or more columns that can be used to identify the row in the data warehouse. The process guarantees that no two rows have the same value in their primary key.
• $incremental_starting_value - The Incremental Starting Value represents the earliest date that data should be collected for, given in yyyy-mm-DD format. For example, if you would like your historical data to go back to the start of 2021, this value would be set to 2021-01-01.

All resources utilize the limit=$limit URL parameter, however additional parameters can be used in addition to this and can be found in the links above for each resource. For example, if you only want to collect Published Items that are in New condition, the following would be the URL Parameters entry:
limit=$limit&publishedStatus=PUBLISHED&condition=New

To find additional parameters available for a given resource, visit the link for the resource provided above in the API Resources section.

Destination Table naming convention is ultimately up to you as the data owner. One common structure used for this API is concatentating "walmart_" and the resource being ingested. For example, when ingesting the Orders resource, the destination table name would be walmart_orders.

When entering a column value to the incremental key feature, you will need to use the following format: yyyy-mm-DD