Introduction to Walmart Connect - Sponsored Search APIs

• WMC Sponsored Search API - Partner Onboarding.postman_collection.json

• WMC STG Environment.postman_environment.json

{ "id": "1ee5d92b-d239-4b58-8f31-122702e8784c", "name": "WMC STG Environment", "values": [ { "key": "WPA_Consumer_Id", "value": "", "enabled": true }, { "key": "advertiserId", "value": "", "enabled": true }, { "key": "signature", "value": "", "enabled": true }, { "key": "timestamp", "value": "", "enabled": true }, { "key": "correlationId", "value": "{{$guid}}", "enabled": true }, { "key": "key", "value": "", "enabled": true }, { "key": "Authorization", "value": "", "type": "default", "enabled": true } ], "_postman_variable_scope": "environment", "_postman_exported_at": "2025-02-11T20:37:52.524Z", "_postman_exported_using": "Postman/11.31.3"
}

{ "info": { "_postman_id": "6afd9ed3-f98b-4c2e-96dc-cd845629e774", "name": "WMC Sponsored Search API - Partner Onboarding", "description": "Staging URL: [https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/](https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/) \nProduction URL : [https://developer.api.walmart.com/api-proxy/service/WPA/Api/v1/](https://developer.api.walmart.com/api-proxy/service/WPA/Api/v1/)\n\nThe Walmart Sponsored Products API enables programmatic access to campaign management and reporting, allowing you to automate, scale, and optimize your advertising. Our flexible solution will allow you to integrate with Sponsored Search Products in a way that meets your goals and objectives. The API functionalities include campaign and ad group creation, bid and budget adjustments, campaign scheduling, and performance reporting.\n\nNote: POST request to create new entities. PUT request should only include the attribute which needs to be updated and Id for which PUT request is fired for.\n\nFor more information, please refer the Partner Operating Guide (page 9).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "15902700" }, "item": [ { "name": "api/v1", "item": [ { "name": "Campaign", "item": [ { "name": "List all the campaigns", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "strictSSL": false, "disableCookies": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{$guid}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "campaigns" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint makes an HTTP GET request to retrieve a list of campaigns for a specific advertiser. The request should include the advertiserId as a query parameter.\n\n### Response\n\nThe response will be a JSON object representing the list of campaigns for the specified advertiser. To document the response as a JSON schema, you can use a tool like JSON Schema to define the structure of the response object." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/campaigns?advertiserId=&campaignId=&filter[name]=&filter[lastModifiedDate]=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "campaigns" ], "query": [ { "key": "advertiserId", "value": "" }, { "key": "campaignId", "value": "" }, { "key": "filter[name]", "value": "" }, { "key": "filter[lastModifiedDate]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Create new campaign", "protocolProfileBehavior": { "strictSSL": false, "disabledSystemHeaders": {} }, "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"advertiserId\": ,\n \"campaignType\": \"sponsoredProducts/sba/video\",\n \"dailyBudget\": \"value\", \n \"startDate\": \"yyyy-mm-dd\",\n \"endDate\": \"yyyy-mm-dd\",\n \"name\": \"name\",\n \"status\": \"enabled\",\n \"targetingType\": \"manual\",\n \"totalBudget\": \"value\",\n \"budgetType\": \"both\",\n \"rollover\": \"true\"\n// \"biddingStrategy\": {\n// \"strategy\": \"DYNAMIC\" OR \"FIXED\" OR \"TROAS\"\n// },\n// \"campaignOptions\": [\"BRAND_TERM_OPT_OUT\"]\n //NOTE: Note: > All net new automatic campaigns will be opted in to Brand Term Targeting by default.\n// > If no value (null) is specified for campaignOptions: New campaigns are opted in\n// > Existing campaigns are opted out\t\n } \n]\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "campaigns" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Create new campaign\n\nThis endpoint is used to create a new campaign. It is an HTTP POST request to `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?advertiserId={{advertiserId}}`.\n\n#### Request Body\n\n- **advertiserId** (string): The ID of the advertiser.\n \n- **campaignType** (string): The type of campaign, e.g., \"sponsoredProducts/sba/video\".\n \n- **dailyBudget** (string): The daily budget for the campaign.\n \n- **startDate** (string): The start date of the campaign in \"yyyy-mm-dd\" format.\n \n- **endDate** (string): The end date of the campaign in \"yyyy-mm-dd\" format.\n \n- **name** (string): The name of the campaign.\n \n- **status** (string): The status of the campaign, e.g., \"enabled\".\n \n- **targetingType** (string): The targeting type for the campaign, e.g., \"manual\".\n \n- **totalBudget** (string): The total budget for the campaign.\n \n- **budgetType** (string): The type of budget, e.g., \"both\".\n \n- **rollover** (string): Indicates whether the budget should rollover, e.g., \"true\".\n \n\n#### Headers\n\n- **Content-Type** (string): application/json\n \n\n#### Authorization\n\nThe request requires an authorization token to be included in the URL parameter.\n\n#### Response Body\n\nThe response body will contain the details of the newly created campaign.\n\nThis endpoint is used to create a new campaign. It is an HTTP POST request to `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?auth_token={{WPA_Auth_Token}}&advertiserId={{advertiserId}}`.\n\n#### Request Body\n\n- **advertiserId** (string): The ID of the advertiser.\n \n- **campaignType** (string): The type of campaign, e.g., \"sponsoredProducts/sba/video\".\n \n- **dailyBudget** (string): The daily budget for the campaign.\n \n- **startDate** (string): The start date of the campaign in \"yyyy-mm-dd\" format.\n \n- **endDate** (string): The end date of the campaign in \"yyyy-mm-dd\" format.\n \n- **name** (string): The name of the campaign.\n \n- **status** (string): The status of the campaign, e.g., \"enabled\".\n \n- **targetingType** (string): The targeting type for the campaign, e.g., \"manual\".\n \n- **totalBudget** (string): The total budget for the campaign.\n \n- **budgetType** (string): The type of budget, e.g., \"both\".\n \n- **rollover** (string): Indicates whether the budget should rollover, e.g., \"true\".\n \n\n#### Response Body\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"campaignId\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"createdDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n }\n}\n\n ```\n\nThis endpoint is used to create a new campaign. It is an HTTP POST request to `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?advertiserId={{advertiserId}}`.\n\n#### Request Body\n\n- **advertiserId** (string): The ID of the advertiser.\n \n- **campaignType** (string): The type of campaign, e.g., \"sponsoredProducts/sba/video\".\n \n- **dailyBudget** (string): The daily budget for the campaign.\n \n- **startDate** (string): The start date of the campaign in \"yyyy-mm-dd\" format.\n \n- **endDate** (string): The end date of the campaign in \"yyyy-mm-dd\" format.\n \n- **name** (string): The name of the campaign.\n \n- **status** (string): The status of the campaign, e.g., \"enabled\".\n \n- **targetingType** (string): The targeting type for the campaign, e.g., \"manual\".\n \n- **totalBudget** (string): The total budget for the campaign.\n \n- **budgetType** (string): The type of budget, e.g., \"both\".\n \n- **rollover** (string): Indicates whether the budget should rollover, e.g., \"true\".\n \n\n#### Headers\n\n- Content-Type: application/json\n \n\n#### Authorization\n\nThe request requires an authorization token in the header.\n\n#### Response Body\n\nThe response body will contain the details of the newly created campaign." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"advertiserId\": \"\",\n \"campaignType\": \"\",\n \"dailyBudget\": 100,\n \"endDate\": \"\",\n \"name\": \"Campaign name\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"targetingType\": \"\",\n \"totalBudget\": 1000,\n \"budgetType\": \"\",\n \"rollover\": true\n },\n {\n \"advertiserId\": \"\",\n \"campaignType\": \"\",\n \"dailyBudget\": 100,\n \"endDate\": \"\",\n \"name\": \"Campaign name\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"targetingType\": \"\",\n \"totalBudget\": 1000,\n \"budgetType\": \"\",\n \"rollover\": true\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/campaigns", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "campaigns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Update existing campaign", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n // put the campaign value(s) that needs to be updated/edited\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "campaigns" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint allows you to update campaigns for a specific advertiser. The HTTP PUT request should be made to [https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?advertiserId={{advertiserId}}](https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns?advertiserId=%7B%7BadvertiserId%7D%7D).\n\n### Request Body\n\nThe request body should be sent in raw format and should contain a JSON array with the following parameter:\n\n- `campaignId`: The ID of the campaign to be updated.\n \n\n### Response\n\nThe response will include the updated details of the campaign after the PUT request is successfully processed." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"\",\n \"name\": \"Campaign name\",\n \"status\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"budgetType\": \"\",\n \"totalBudget\": 1000,\n \"dailyBudget\": 100,\n \"rollover\": true\n },\n {\n \"campaignId\": \"\",\n \"name\": \"Campaign name\",\n \"status\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"budgetType\": \"\",\n \"totalBudget\": 1000,\n \"dailyBudget\": 100,\n \"rollover\": true\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/campaigns", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "campaigns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Delete existing campaign", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": 1833456311\n }\n]\n\n/*\n\nIt allows you to delete one or more campaigns\nYou will be able to delete any campaign which has never gone Live \nOnce campaigns go live:\nThey cannot be deleted\nItems/Ad Groups/Keywords in the campaign cannot be deleted, but they can be disabled\nCampaign start date and end date cannot be changed\n\n*/", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/campaigns/delete", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "campaigns", "delete" ] }, "description": "### Update Campaigns\n\nThis endpoint is used to delete a specific campaign.\n\n**Request Body**\n\n- `campaignId` (string): The ID of the campaign to be deleted.\n \n\n**Response** \nThe response will indicate the success or failure of the delete operation." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"\"\n },\n {\n \"campaignId\": \"\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/campaigns/delete", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "campaigns", "delete" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "Walmart Developer Portal Link: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-campaigns/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-campaigns/)" }, { "name": "SBA profile API v2", "item": [ { "name": "Get SBA Profile for campaign", "request": { "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile?campaignId=600001&adGroupId=700001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v2", "sba_profile" ], "query": [ { "key": "campaignId", "value": "600001" }, { "key": "adGroupId", "value": "700001" } ] }, "description": "This endpoint makes an HTTP GET request to retrieve the SBA profile information based on the provided campaign ID and ad group ID. The request should include the campaignId and adGroupId as query parameters in the URL.\n\n### Request Parameters\n\n- `campaignId` (number) - The ID of the campaign for which the SBA profile information is requested.\n \n- `adGroupId` (number) - The ID of the ad group for which the SBA profile information is requested.\n \n\n### Response Body\n\nThe response will contain the SBA profile information for the specified campaign and ad group." }, "response": [] }, { "name": "Create SBA profile for campaign", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"searchAmpName\": \"Great Value\",\n \"headlineText\": \"SBA Profile v2 - second profile\",\n \"clickUrl\": \"https://www.walmart.com\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v2", "sba_profile" ], "query": [ { "key": "campaignId", "value": "600001", "disabled": true }, { "key": "adGroupId", "value": "700001", "disabled": true } ] } }, "response": [] }, { "name": "Update SBA profile for campaign", "request": { "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"searchAmpName\": \"Great Value!!!!!!!!\",\n \"sbaProfileId\": 123455,\n \"campaignId\": 600001,\n \"adGroupId\": 70001,\n \"status\": \"enabled\"\n }\n] ", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v2", "sba_profile" ], "query": [ { "key": "campaignId", "value": "600001", "disabled": true }, { "key": "adGroupId", "value": "700001", "disabled": true } ] } }, "response": [] }, { "name": "Upload Logo Image to SBA Profile for Campaign", "request": { "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/Users/d0m0f9u/Downloads/TestBrandLogo.png" }, { "key": "SBABaseProfileRequest", "value": "{\"campaignId\": \"600001\" , \"adGroupId\": \"700001\", \"sbaProfileId\": \"123456\"}", "type": "text" } ] }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile_image_upload", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v2", "sba_profile_image_upload" ], "query": [ { "key": "campaignId", "value": "600001", "disabled": true }, { "key": "adGroupId", "value": "700001", "disabled": true } ] }, "description": "# Walmart API - Upload SBA Profile Image\n\nThis API endpoint allows you to upload a Small Business Administration (SBA) profile image.\n\n## Request\n\n- Method: POST\n \n- Endpoint: `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile_image_upload`\n \n- Body type: form-data\n \n\n### Request Body Parameters\n\n- No request body parameters are required for this request.\n \n\n## Response\n\nThe response for this request is a JSON object conforming to the following schema:\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"description\": \"The status of the image upload process.\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message providing additional information about the upload status.\"\n }\n }\n}\n\n ```" }, "response": [] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sb/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sb/)" }, { "name": "Review", "item": [ { "name": "Fetch Review for Advertisers", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/review?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "review" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint makes an HTTP GET request to retrieve reviews for a specific advertiser. The request should include the advertiserId as a query parameter.\n\n### Request Parameters\n\n- `advertiserId` (string, required): The ID of the advertiser for which reviews are to be retrieved.\n \n\n### Response\n\nThe response will include the details of the reviews for the specified advertiser." }, "response": [] }, { "name": "Submit Review for AdGroup", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/review?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "review" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Add Review\n\nThis endpoint allows you to add a review for a specific advertiser.\n\n#### Request Body\n\n- The request body should be in raw format and should contain a JSON array with the following parameters:\n \n - `campaignId` (Number): The ID of the campaign for which the review is being added.\n \n - `adGroupId` (Number): The ID of the ad group for which the review is being added.\n \n\n#### Response\n\nUpon a successful request, the response will contain the details of the added review." }, "response": [] }, { "name": "Cancel Review for AdGroup", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"reviewId\": 10000\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/review?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "review" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Update Review\n\nThis endpoint is used to update a review with the specified advertiser ID.\n\n#### Request Body\n\n- The request body should be in JSON format and should contain the following parameters:\n \n - `campaignId` (Number): The ID of the campaign.\n \n - `adGroupId` (Number): The ID of the ad group.\n \n - `reviewId` (Number): The ID of the review to be updated.\n \n\n#### Response\n\nThe response will contain the updated review details." }, "response": [] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-review/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-review/)" }, { "name": "Sponsored Videos", "item": [ { "name": "List All Media", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/media?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "media" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [] }, { "name": "Update Media Name", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": 600001,\n \"mediaName\": \"new media\",\n \"mediaId\": 700001\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/media?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "media" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "# Update Media Information\n\nThis endpoint allows the user to update media information for a specific advertiser.\n\n## Request\n\n### Request Body\n\n- `advertiserId` (number) - The ID of the advertiser.\n \n- `mediaName` (string) - The name of the media.\n \n- `mediaId` (number) - The ID of the media to be updated.\n \n\n### Example\n\n``` json\n{\n \"advertiserId\": 600001,\n \"mediaName\": \"new media\",\n \"mediaId\": 700001\n}\n\n ```\n\n## Response\n\nThe response for this request is a JSON object representing the updated media information. The JSON schema for the response can be found below.\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"advertiserId\": {\n \"type\": \"number\"\n },\n \"mediaName\": {\n \"type\": \"string\"\n },\n \"mediaId\": {\n \"type\": \"number\"\n }\n // Additional properties based on the response\n }\n}\n\n ```" }, "response": [] }, { "name": "Upload Media", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": advertiser_id,\n \"mediaType\": \"video\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/media/upload?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "media", "upload" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "advertiserId", "value": "16335089", "disabled": true } ] } }, "response": [] }, { "name": "Video to Upload URL", "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "Content-Type", "value": "video/mp4", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "https://advertising.walmart.com/media/assets/wmt-stg-media/676e1ce6-10a7-4629-bac1-bcf269d44732/video.mp4?sv=2021-08-06&se=2023-01-18T21%3A36%3A21Z&sr=b&sp=rcwl&sig=0uc8WsFEmB%2Bsi0JY1t18cORkI%2F9Z4d0QBKMdUiEMPDI%3D", "protocol": "https", "host": [ "advertising", "walmart", "com" ], "path": [ "media", "assets", "wmt-stg-media", "676e1ce6-10a7-4629-bac1-bcf269d44732", "video.mp4" ], "query": [ { "key": "sv", "value": "2021-08-06" }, { "key": "se", "value": "2023-01-18T21%3A36%3A21Z" }, { "key": "sr", "value": "b" }, { "key": "sp", "value": "rcwl" }, { "key": "sig", "value": "0uc8WsFEmB%2Bsi0JY1t18cORkI%2F9Z4d0QBKMdUiEMPDI%3D" } ] } }, "response": [] }, { "name": "Caption to Upload URL", "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "Content-Type", "value": "application/x-subrip", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "https://advertising.walmart.com/media/assets/wmt-stg-media/991306d0-5871-4d90-becb-95533e65b804/cc.srt?sv=2021-08-06&se=2022-12-05T18%3A19%3A38Z&sr=b&sp=rcwl&sig=oMBlhkARLTJftuenjI8V4tdS2k2QqKjK2asmYrMmyec%3D", "protocol": "https", "host": [ "advertising", "walmart", "com" ], "path": [ "media", "assets", "wmt-stg-media", "991306d0-5871-4d90-becb-95533e65b804", "cc.srt" ], "query": [ { "key": "sv", "value": "2021-08-06" }, { "key": "se", "value": "2022-12-05T18%3A19%3A38Z" }, { "key": "sr", "value": "b" }, { "key": "sp", "value": "rcwl" }, { "key": "sig", "value": "oMBlhkARLTJftuenjI8V4tdS2k2QqKjK2asmYrMmyec%3D" } ] } }, "response": [] }, { "name": "Notify Upload Complete", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{$guid}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": advertiser_id,\n \"mediaUploadRequestId\": 11111,\n \"mediaName\": \"test-video\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/media/complete?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "media", "complete" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [] }, { "name": "Get all Ad Group Media", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroup/media?advertiserId={{advertiserId}}&campaignId=600001&adGroupId=700001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "adGroup", "media" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "campaignId", "value": "600001" }, { "key": "adGroupId", "value": "700001" } ] }, "description": "This endpoint retrieves media information for a specific ad group, identified by the advertiserId, campaignId, and adGroupId parameters.\n\n### Request Parameters\n\n- `advertiserId` (path parameter) : The ID of the advertiser.\n \n- `campaignId` (query parameter) : The ID of the campaign.\n \n- `adGroupId` (query parameter) : The ID of the ad group.\n \n\n### Response Body\n\nThe response contains media information related to the specified ad group." }, "response": [] }, { "name": "Ad Group Media", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"advertiserId\": advertiser_id,\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"mediaId\": 11111\n}\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroup/media?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "adGroup", "media" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [] } ], "description": "**Walmart Developer Portal Links:**\n\nSV Ad Groups: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-adgroups/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-adgroups/)\n\nSV Media: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-media/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-media/)\n\nSV Workflow Guide: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-workflow/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-workflow/)\n\nAdditional Resources: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-additional-resources/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-sv-additional-resources/)" }, { "name": "AdGroup", "item": [ { "name": "List all the ad groups", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroups?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "adGroups" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "# Retrieve Ad Groups\n\nThis endpoint retrieves a list of ad groups for a specific advertiser.\n\n## Request\n\n- Method: GET\n \n- URL: `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroups?advertiserId={{advertiserId}}`\n \n- Description: This endpoint requires a GET request to retrieve ad groups for a specific advertiser. The `advertiserId` path parameter should be replaced with the ID of the advertiser for whom the ad groups are being retrieved.\n \n\n## Response\n\nThe response for this request is a JSON object representing the list of ad groups for the specified advertiser. You can refer to the JSON schema below for the detailed structure of the response.\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"adGroups\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n // ad group properties\n }\n }\n }\n }\n}\n\n ```" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adGroups?advertiserId=&campaignId=&filter[name]=&filter[lastModifiedDate]=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adGroups" ], "query": [ { "key": "advertiserId", "value": "" }, { "key": "campaignId", "value": "" }, { "key": "filter[name]", "value": "" }, { "key": "filter[lastModifiedDate]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Create new adgroup", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n \"name\": \"ad group name\",\n \"status\": \"enabled/disabled/deleted\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroups?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "adGroups" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"\",\n \"dailyBudget\": 100,\n \"name\": \"AdGroup name\",\n \"status\": \"\",\n \"totalBudget\": 1000\n },\n {\n \"campaignId\": \"\",\n \"dailyBudget\": 100,\n \"name\": \"AdGroup name\",\n \"status\": \"\",\n \"totalBudget\": 1000\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adGroups", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adGroups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Update existing ad group", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": \"700001\",\n \"status\": \"enabled/disabled/deleted\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adGroups?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adGroups" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Update Ad Group Status\n\nThis endpoint allows the user to update the status of an ad group.\n\n#### Request\n\n- Method: PUT\n \n- URL: `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adGroups?advertiserId={{advertiserId}}`\n \n- \\[ { \"adGroupId\": \"700001\", \"status\": \"enabled/disabled/deleted\" }\\]\n \n\n#### Response\n\nThe response for this request can be documented as a JSON schema." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": \"\",\n \"name\": \"AdGroup name\",\n \"totalBudget\": 1000,\n \"dailyBudget\": 100,\n \"status\": \"\"\n },\n {\n \"adGroupId\": \"\",\n \"name\": \"AdGroup name\",\n \"totalBudget\": 1000,\n \"dailyBudget\": 100,\n \"status\": \"\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adGroups", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adGroups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:**\n\n[https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-adgroups/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-adgroups/)" }, { "name": "Ad Item", "item": [ { "name": "List all the Items in campaign", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adItems?campaignId=600001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "adItems" ], "query": [ { "key": "campaignId", "value": "600001" } ] }, "description": "This endpoint makes an HTTP GET request to retrieve ad items for a specific campaign. The request should include the campaignId as a query parameter in the URL.\n\n### Request Body\n\nThis request does not require a request body.\n\n### Response Body\n\nThe response will include the ad items for the specified campaign. The structure of the response body will include details such as ad item ID, name, type, and other relevant information." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adItems?campaignId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adItems" ], "query": [ { "key": "campaignId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Add new item(s) to ad group", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"itemId\": \"100000001\",\n \"bid\": 1,\n \"status\": \"enabled/disabled/deleted\"\n },\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"itemId\": \"100000002\",\n \"bid\": 1,\n \"status\": \"enabled/disabled/deleted\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adItems?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adItems" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint makes an HTTP POST request to create ad items for a specific advertiser. The request should include a payload in the raw request body type, containing an array of objects with keys for campaignId, adGroupId, itemId, bid, and status. The status field should have one of the values: enabled, disabled, or deleted.\n\nThe response to this request will include the details of the ad items that were created, along with any relevant metadata." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": \"\",\n \"bid\": \"\",\n \"campaignId\": \"\",\n \"itemId\": \"\",\n \"status\": \"\"\n },\n {\n \"adGroupId\": \"\",\n \"bid\": \"\",\n \"campaignId\": \"\",\n \"itemId\": \"\",\n \"status\": \"\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adItems", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adItems" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Update ad items", "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"itemId\": \"100000001\",\n \"bid\": 1,\n \"status\": \"enabled/disabled/deleted\"\n },\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"itemId\": \"100000001\",\n \"bid\": 1,\n \"status\": \"enabled/disabled/deleted\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adItems?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adItems" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint allows you to update ad items for a specific advertiser. The HTTP PUT request should be made to the given URL with the advertiserId as a query parameter. The request body should be in raw format and should include an array of objects, each containing the campaignId, adGroupId, itemId, bid, and status for the ad item to be updated.\n\n### Request Body\n\n- `campaignId` (number): The ID of the campaign.\n \n- `adGroupId` (number): The ID of the ad group.\n \n- `itemId` (string): The ID of the item.\n \n- `bid` (number): The bid amount.\n \n- `status` (string): The status of the ad item (enabled/disabled/deleted).\n \n\n### Response\n\nThe response to this request will contain the updated information for the ad items." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": \"\",\n \"campaignId\": \"\",\n \"itemId\": \"\",\n \"bid\": \"\",\n \"status\": \"\"\n },\n {\n \"adGroupId\": \"\",\n \"campaignId\": \"\",\n \"itemId\": \"\",\n \"bid\": \"\",\n \"status\": \"\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/adItems", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "adItems" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-aditems/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-aditems/)" }, { "name": "Keywords", "item": [ { "name": "Fetch keyword Analytics", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"itemIds\": [\n \"10000001\"\n ]\n}\n\n// Note: Time period considered for results is last 30 days and 90 days from the same day last year to factor in seasonality.\n\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywordAnalytics", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "keywordAnalytics" ] }, "description": "This API endpoint allows you to retrieve keyword analytics data for a specific advertiser and item IDs.\n\n### Request Body\n\n- **advertiserId** (string, required): The ID of the advertiser for which keyword analytics data is requested.\n \n- **itemIds** (array of strings, required): An array of item IDs for which keyword analytics data is requested.\n \n\n### Response\n\nThe response will contain the keyword analytics data for the specified advertiser and item IDs." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"advertiserId\": \"\",\n \"channel\": \"Walmart.com\",\n \"itemIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"advertiserId\": \"\",\n \"channel\": \"Walmart.com\",\n \"itemIds\": [\n \"\",\n \"\"\n ]\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/keywordAnalytics", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "keywordAnalytics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Suggested keywords based on the item added in the ad group", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keyword_suggestions?advertiserId={{advertiserId}}&adGroupId=700001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "keyword_suggestions" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "adGroupId", "value": "700001" } ] }, "description": "This endpoint makes an HTTP GET request to retrieve keyword suggestions for a specific advertiser and ad group. The request should include the advertiserId as a path parameter and the adGroupId as a query parameter.\n\nThe response will include a list of keyword suggestions based on the provided advertiserId and adGroupId." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/keyword_suggestions?adGroupId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "keyword_suggestions" ], "query": [ { "key": "adGroupId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "List all the keywords in campaign", "event": [ { "listen": "prerequest", "script": { "exec": [ "function formatDate(d) {", " month = '' + (d.getMonth() + 1)", " day = '' + d.getDate()", " year = d.getFullYear()", "", " if (month.length < 2) ", " month = '0' + month;", " if (day.length < 2) ", " day = '0' + day;", "", " return [year, month, day].join('-');", "}", "function deleteCookies(request_id, url) {", " const jar = pm.cookies.jar();", " jar.clear(url, function (error) {", " if (error !== null) {", " console.log(request_id + \".deleteCookies: \" + error)", " }", " else {", " console.log(request_id + \".deleteCookies: successfully deleted for url [\" + url + \"]\")", " }", " });", "}", "function exec() {", " request_id = \"[\" + pm.info.requestName + \".\" + pm.info.requestId + \"]\"", " console.log(request_id + \".exec: starting execution\")", " // Clear all cookies before every request", " deleteCookies(request_id, \"https://developer.api.stg.walmart.com\");", "", " auth_signature_host = pm.environment.get(\"walmart_auth_signature_host\");", " console.log(request_id + \".exec: getting auth_signature from [\" + auth_signature_host + \"]\")", "", " pm.sendRequest(auth_signature_host + \"/walmartAuthSignature\", function (err, response) {", " if (err !== null) {", " console.error(request_id + \".walmartAuthSignature: \" + err);", " }", " if (response !== null) {", " console.log(request_id + \".exec: auth_signature response [\" + response.json().auth_signature + \"]\")", " json_resp = response.json();", " ", " // Set Auth Signature", " pm.environment.set(\"auth_signature\", json_resp.auth_signature);", " pm.environment.set(\"auth_signature_timestamp\", json_resp.in_timestamp);", "", " // Set current date", " var start_date = formatDate(new Date())", " pm.environment.set(\"start_date\", start_date)", "", " // Set 5 years from now", " var end_date = new Date()", " end_date.setFullYear(end_date.getFullYear() + 5)", " end_date = formatDate(end_date)", " pm.environment.set(\"end_date\", end_date)", " }", " });", " console.log(request_id + \".exec: finished execution\")", "}", "", "// Pre-script execution", "exec();" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywords?auth_token={{WPA_Auth_Token}}&campaignId=600001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "keywords" ], "query": [ { "key": "auth_token", "value": "{{WPA_Auth_Token}}" }, { "key": "campaignId", "value": "600001" } ] }, "description": "This endpoint makes an HTTP GET request to retrieve keywords using the provided campaign ID and authentication token. The request should include the 'auth_token' as a query parameter and the 'campaignId' as a query parameter.\n\n### Request\n\n- Method: GET\n \n- URL: `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywords`\n \n- Query Parameters:\n \n - auth_token (string, required): The authentication token for accessing the API.\n \n - campaignId (string, required): The ID of the campaign for which keywords are being retrieved.\n \n\n### Response\n\nThe response for this request will be in JSON format and will include a schema for the response body." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/keywords?campaignId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "keywords" ], "query": [ { "key": "campaignId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Add keywords to existing keyword bidded campaign", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": 600001,\n \"adGroupId\": 700001,\n \"bid\": 5.00,\n \"keywordText\": \"string1\",\n \"matchType\": \"exact/phrase/broad\",\n \"state\": \"enabled/paused/archived\"\n }\n]\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywords?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "keywords" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Add Keyword\n\nThis endpoint allows you to add a keyword for a specific advertiser.\n\n#### Request Body\n\n- `campaignId` (number): The ID of the campaign.\n \n- `adGroupId` (number): The ID of the ad group.\n \n- `bid` (number): The bid amount for the keyword.\n \n- `keywordText` (string): The text of the keyword.\n \n- `matchType` (string): The type of match for the keyword (exact/phrase/broad).\n \n- `state` (string): The state of the keyword (enabled/paused/archived).\n \n\n#### Response\n\nThe response will contain the status of the request to add the keyword." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": \"\",\n \"bid\": \"\",\n \"campaignId\": \"\",\n \"keywordText\": \"\",\n \"matchType\": \"\",\n \"state\": \"\"\n },\n {\n \"adGroupId\": \"\",\n \"bid\": \"\",\n \"campaignId\": \"\",\n \"keywordText\": \"\",\n \"matchType\": \"\",\n \"state\": \"\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/keywords", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "keywords" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Update state and bid of existing keywords", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"keywordId\": \"5555555\",\n \"state\": \"enabled/paused/archived\",\n \"bid\": 2\n }\n]\n\n// Note: You must provide at least one of “bid” or “state” parameters.\n\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywords?campaignId=600001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "keywords" ], "query": [ { "key": "campaignId", "value": "600001" } ] }, "description": "This endpoint makes an HTTP PUT request to update keywords for a specific campaign. The request should include the campaignId as a query parameter, and the payload should be in a JSON format with an array of objects, each containing keywordId, state, and bid.\n\n### Request\n\n- Method: PUT\n \n- URL: `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywords?campaignId=600001`\n \n- Headers:\n \n - Content-Type: application/json\n \n- \\[ { \"keywordId\": \"5555555\", \"state\": \"enabled/paused/archived\", \"bid\": 2 }\\]\n \n\n### Response\n\nThe response for this request will be in JSON format. Below is a JSON schema representing the response:\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\n ```" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"keywordId\": \"\",\n \"bid\": \"\",\n \"state\": \"\"\n },\n {\n \"keywordId\": \"\",\n \"bid\": \"\",\n \"state\": \"\"\n }\n]" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/keywords", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "keywords" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-keywords/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-keywords/)" }, { "name": "Campaign placement", "item": [ { "name": "List all the campaign placements", "request": { "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/placements?advertiserId={{advertiserId}}&campaignId=600001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "placements" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "campaignId", "value": "600001" } ] }, "description": "### Get Placements\n\nThis endpoint retrieves placements based on the provided advertiser ID and campaign ID.\n\n#### Request\n\n- Method: GET\n \n- URL: `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/placements?advertiserId={{advertiserId}}&campaignId=600001`\n \n\n##### Query Parameters\n\n- `advertiserId` (required, string): The ID of the advertiser for which placements are to be retrieved.\n \n- `campaignId` (required, string): The ID of the campaign for which placements are to be retrieved.\n \n\n#### Response\n\nThe response for this request is a JSON schema that represents the structure of the data returned by the API. It includes the properties and their data types that can be expected in the response." }, "response": [] }, { "name": "Add campaign placement to keyword bidded campaign", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n \"placements\": [\n {\n \"placement\": \"Search Carousel\",\n \"status\": \"excluded\"\n },\n {\n \"placement\": \"Item Buybox\",\n \"status\": \"included\"\n },\n {\n \"placement\": \"Item Carousel\",\n \"status\": \"included\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/placements?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "placements" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [] }, { "name": "Update campaign placement to keyword bidded campaign", "request": { "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n \"placements\": [\n {\n \"placement\": \"Search Carousel\",\n \"status\": \"included\"\n }\n ]\n }\n]\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/placements?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "placements" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-placements/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-placements/)" }, { "name": "Multipliers", "item": [ { "name": "placement", "item": [ { "name": "List all the Placement Bid Multipliers", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/placement?campaignId=600001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "placement" ], "query": [ { "key": "campaignId", "value": "600001", "description": "(Required) CampaignId" } ] }, "description": "### Retrieve Multipliers Placement\n\nThis endpoint makes an HTTP GET request to retrieve multipliers placement for a specific campaign.\n\n#### Request\n\n- Method: GET\n \n- Endpoint: `https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/placement`\n \n- Query Parameters:\n \n - `campaignId` (integer, required): The ID of the campaign for which multipliers placement is to be retrieved.\n \n\n#### Response\n\nThe response for this request is a JSON object representing the multipliers placement for the specified campaign. To document the response as a JSON schema, please refer to the response body of the actual API response." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/placement?campaignId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "placement" ], "query": [ { "key": "campaignId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Create Placement Bid Multipliers", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n \"multiplier\": \"value\",\n \"placementType\": \n/* For auto campaigns:\n a) Buy-Box\n b) Search Ingrid \n c) Home Page\n d) Stock Up\n\n For manual campaigns:\n a) Buy-Box\n b) Search Ingrid \n*/ }\n]\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/placement?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "placement" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### POST /api/v1/multipliers/placement\n\nThis endpoint allows the user to submit multipliers for placements associated with a specific advertiser.\n\n#### Request Body\n\n- Type: JSON\n \n- Description: The request should contain an array of objects, each specifying the campaignId and its corresponding multiplier value.\n \n\nExample:\n\n``` json\n[\n {\n \"campaignId\": \"600001\",\n \"multiplier\": \"value\"\n }\n]\n\n ```\n\n#### Response\n\nThe response for this request follows the JSON schema below:\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\n ```" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/placement", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "placement" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Update Placement Bid Multipliers", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n \"multiplier\": \"value\",\n \"placementType\": \n/* For auto campaigns:\n a) Buy-Box\n b) Search Ingrid \n c) Home Page\n d) Stock Up\n\n For manual campaigns:\n a) Buy-Box\n b) Search Ingrid \n*/ }\n]\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/placement?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "placement" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint allows the user to update multipliers for a specific placement. The HTTP PUT request should be made to the specified URL with the advertiserId as a query parameter. The request body should be in raw format and contain an array of objects, where each object includes the campaignId and the multiplier value.\n\n### Request Body\n\n- Type: Raw\n \n- Description: Array of objects containing campaignId and multiplier value.\n \n\n### Response\n\nThe response for this request will be a JSON object conforming to the following schema:\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\n ```\n\nThe response will include a status field indicating the success or failure of the request, along with an optional message field providing additional information." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/placement", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "placement" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ] }, { "name": "platform", "item": [ { "name": "List all the Platform Bid Multipliers", "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/platform?campaignId=600001", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "platform" ], "query": [ { "key": "campaignId", "value": "600001" } ] }, "description": "# Retrieve Multipliers for a Campaign\n\nThis endpoint makes an HTTP GET request to retrieve multipliers for a specific campaign.\n\n## Request\n\n### Query Parameters\n\n- `campaignId` (integer, required): The ID of the campaign for which multipliers are to be retrieved.\n \n\n## Response\n\nThe response for this request is a JSON object containing the multipliers for the specified campaign. Below is an example of the JSON schema for the response:\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"campaignId\": {\n \"type\": \"integer\"\n },\n \"multipliers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"platform\": {\n \"type\": \"string\"\n },\n \"multiplier\": {\n \"type\": \"number\"\n }\n }\n }\n }\n }\n}\n\n ```\n\nThe `campaignId` in the response indicates the ID of the campaign for which multipliers are being returned. The `multipliers` array contains objects with `platform` and `multiplier` properties, representing the platform name and the corresponding multiplier value." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/platform?campaignId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "platform" ], "query": [ { "key": "campaignId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Create Platform Bid Multipliers", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n \"multiplier\": \"110\",\n \"platformType\": \"Desktop/Mobile/App\"\n }\n]\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/platform?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "platform" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This API endpoint allows you to make an HTTP POST request to retrieve multipliers for a specific platform associated with a particular advertiser. The request should include the advertiserId as a query parameter. The payload should be in JSON format with an array containing objects with keys campaignId, multiplier, and platformType.\n\n### Request Body\n\n- campaignId (string): The ID of the campaign.\n \n- multiplier (string): The multiplier value.\n \n- platformType (string): The type of platform (e.g. Desktop, Mobile, App).\n \n\n### Response\n\nThe response of this request is expected to be a JSON object following a specific schema. Please refer to the JSON schema for the response structure." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/platform", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "platform" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Update Platform Bid Multipliers", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"campaignId\": \"600001\",\n \"multiplier\": \"110\",\n \"platformType\": \"Desktop/Mobile/App\"\n }\n]\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/platform?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "platform" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint allows you to update the multipliers for a specific platform associated with a given advertiser ID. The HTTP PUT request should be made to the specified URL with the advertiser ID as a query parameter. The request body should be in raw format and include an array of objects, each containing the campaign ID, multiplier, and platform type.\n\n### Request Body\n\n- `campaignId` (string): The ID of the campaign.\n \n- `multiplier` (string): The multiplier value to be set.\n \n- `platformType` (string): The type of platform (Desktop/Mobile/App) for which the multiplier is being updated.\n \n\n### Response\n\nThe response to the request will contain the relevant information about the updated multipliers for the specified platform." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/multipliers/platform", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "multipliers", "platform" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-bid-multipliers/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-bid-multipliers/)" }, { "name": "Catalog Item", "item": [ { "name": "Search for item for an advertiser (text)", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": ,\n \"searchText\": \"text\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/itemSearch?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "itemSearch" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "This endpoint makes an HTTP POST request to search for items using the provided searchText. The request body should include a JSON object with the key \"searchText\" and the value as the text to be searched. The response will include the results of the item search." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"searchText\": \"\",\n \"searchItemIds\": [\n \"\",\n \"\"\n ],\n \"channel\": \"Walmart.com\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/itemSearch", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "itemSearch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Search for item for an advertiser (itemId)", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": ,\n \"searchItemIds\": [\"44346415\", \"44346416\"]\n}\n\n// Note: Item search operation will yield a maximum of 200 primary variant items (formerly known as base items) for an advertiser. There is no limit on number of variant items that are returned for a primary variant item.\n\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/itemSearch?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "itemSearch" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Item Search API\n\nThis API endpoint allows you to search for items by their IDs.\n\n#### Request Body\n\n- **searchItemIds** (array of strings) - The IDs of the items to search for.\n \n\nExample:\n\n``` json\n{\n \"searchItemIds\": [\"44346415\"]\n}\n\n ```\n\n#### Response\n\nThe response will contain an array of objects, each representing an item with the following properties:\n\n- **itemName** (string) - The name of the item.\n \n- **suggestedBid** (number) - The suggested bid for the item.\n \n- **itemId** (string) - The ID of the item.\n \n- **itemImageUrl** (string) - The URL of the item's image.\n \n- **variantItems** (array of objects) - An array of variant items, each with the following properties:\n \n - **variantItemId** (string) - The ID of the variant item.\n \n - **variantImageUrl** (string) - The URL of the variant item's image.\n \n - **variantItemName** (string) - The name of the variant item.\n \n- **itemPageUrl** (string) - The URL of the item's page.\n \n\nExample Response:\n\n``` json\n[\n {\n \"itemName\": \"\",\n \"suggestedBid\": 0,\n \"itemId\": \"\",\n \"itemImageUrl\": \"\",\n \"variantItems\": [\n {\n \"variantItemId\": \"\",\n \"variantImageUrl\": \"\",\n \"variantItemName\": \"\"\n }\n ],\n \"itemPageUrl\": \"\"\n }\n]\n\n ```" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"searchText\": \"\",\n \"searchItemIds\": [\n \"\",\n \"\"\n ],\n \"channel\": \"Walmart.com\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/itemSearch", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "itemSearch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" }, { "name": "Search for item for an advertiser (itemId)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": 16274575,\n \"searchItemIds\": [45098873]\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/itemSearch?auth_token={{WPA_Auth_Token}}&advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "itemSearch" ], "query": [ { "key": "auth_token", "value": "{{WPA_Auth_Token}}" }, { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "advertiserId", "value": "2572611", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Ct", "value": "Optional.empty" }, { "key": "Date", "value": "Tue, 17 Jan 2023 19:12:44 GMT" }, { "key": "X-Tb", "value": "1" }, { "key": "Trace-Id", "value": "7b8d65c70f55d133" }, { "key": "Wm_svc.env", "value": "stg" }, { "key": "Wm_svc.name", "value": "WPA-Api" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Ranges", "value": "bytes" }, { "key": "Last-Modified", "value": "Tue, 17 Jan 2023 19:12:44 GMT" }, { "key": "Wm_svc.version", "value": "1.0.0" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Proxy-Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Strict-Transport-Security", "value": "max-age=86400" }, { "key": "X-Lua-Strict-Transport-Security", "value": "max-age=86400" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "X-Tb-Optimization-Total-Bytes-Saved", "value": "0" } ], "cookie": [], "body": "[\n {\n \"itemName\": \"Women\\u0000s Ruffled Crossover Dress\",\n \"suggestedBid\": 0.25,\n \"itemId\": \"45098873\",\n \"itemImageUrl\": \"https://i5.walmartimages.com/asr/448d7ac8-c12b-431d-9cbe-6346d3f4c8ee_1.4a8ff17d2e3f1be9413426ded69b1c25.jpeg?odnHeight=450&odnWidth=450&odnBg=ffffff\",\n \"variantItems\": [\n {\n \"variantItemId\": \"45098873\",\n \"variantImageUrl\": \"https://i5.walmartimages.com/asr/448d7ac8-c12b-431d-9cbe-6346d3f4c8ee_1.4a8ff17d2e3f1be9413426ded69b1c25.jpeg?odnHeight=450&odnWidth=450&odnBg=ffffff\",\n \"variantItemName\": \"Women\\u0000s Ruffled Crossover Dress\"\n }\n ],\n \"itemPageUrl\": \"https://www.walmart.com/ip/45098873\"\n }\n]" } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-catalog-item-search/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-catalog-item-search/)" }, { "name": "Snapshot v1", "item": [ { "name": "Get the snapshot by Snapshot Id", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?snapshotId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "snapshot" ], "query": [ { "key": "snapshotId", "value": "", "description": "(Required) Snapshot Id" }, { "key": "advertiserId", "value": "", "disabled": true } ] }, "description": "### Snapshot API\n\nThis API endpoint makes an HTTP GET request to retrieve a snapshot using the provided snapshot ID.\n\n#### Request\n\nThe request should be made to the following endpoint:\n\n```\nGET https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?snapshotId=\n\n ```\n\n##### Request Parameters\n\n- `snapshotId`: (string) The ID of the snapshot to be retrieved.\n \n\n#### Response\n\nThe response for this request is a JSON object representing the snapshot data. The JSON schema for the response is as follows:\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n // Define the properties of the response JSON schema here\n }\n}\n\n ```" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot?advertiserId=&snapshotId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot" ], "query": [ { "key": "advertiserId", "value": "" }, { "key": "snapshotId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Submit Report Snapshot Request", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "// API Documentation: https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-snapshot-reportsv1/ > Sample Requests for Create Snapshot Reports\n\n\n{\n \"advertiserId\": \"advertiser_id\",\n \"startDate\": \"2023-05-09\",\n \"endDate\": \"2023-05-12\",\n \"attributionWindow\": \"days14\",\n \"reportType\": \n \"itemHealthV2\",\n \"format\": \"gzip\"\n}\n\n//Possible reportType values: \"itemHealthv2\" and \"itemKeyword\"" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/report?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "report" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Submit Report Snapshot Request\n\n#### Request Body\n\n- **Type**: Raw\n \n- **Description**: JSON payload containing the following parameters:\n \n - `advertiserId`: The ID of the advertiser.\n \n - `startDate`: The start date for the report.\n \n - `endDate`: The end date for the report.\n \n - `attributionWindow`: The attribution window for the report.\n \n - `reportType`: The type of report.\n \n - `format`: The format of the report.\n \n\n#### Headers\n\n- `Content-Type`: application/json\n \n\n#### Use Case\n\nThis API endpoint is used to submit a request for a report snapshot with specific parameters such as advertiser ID, start date, end date, attribution window, report type, and format." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"attributionWindow\": \"\",\n \"endDate\": \"2019-01-02\",\n \"reportType\": \"\",\n \"startDate\": \"2019-01-01\",\n \"extraFields\": [\n \"\",\n \"\"\n ],\n \"format\": \"\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/report", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "report" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Create Entity Snapshot", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "//API documentation: https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-campaign-entity/ \n\n{\n \"advertiserId\": \"advertiser_id\",\n \"entityStatus\": \"all\",\n \"entityTypes\": [\n \"campaign\",\n \"adGroup\",\n \"keyword\",\n \"adItem\",\n \"bidMultiplier\",\n \"placement\",\n \"sbaProfile\",\n \"category\",\n \"adGroupMedia\"\n ],\n \"format\": \"zip\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/entity?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "entity" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Submit Entity Snapshot Request\n\nThis API endpoint is used to submit a request for an entity snapshot.\n\n#### Request Body\n\n- **advertiserId** (string) - The ID of the advertiser.\n \n- **entityStatus** (string) - The status of the entity (e.g., \"all\").\n \n- **entityTypes** (array) - An array of entity types (e.g., \\[\"campaign\"\\]).\n \n- **format** (string) - The format of the snapshot (e.g., \"zip\").\n \n\n#### Example\n\n``` json\n{\n \"advertiserId\": \"advertiser_id\",\n \"entityStatus\": \"all\",\n \"entityTypes\": [\"campaign\"],\n \"format\": \"zip\"\n}\n\n ```\n\n#### Use Case\n\nThis request can be used to retrieve a snapshot of entities for a specific advertiser, with the option to specify the entity status, types, and format of the snapshot.\n\n#### Response\n\nThe response structure will include the status of the snapshot request and any relevant data associated with the snapshot." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"entityStatus\": \"\",\n \"entityTypes\": [\n \"\",\n \"\"\n ],\n \"format\": \"\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/entity", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "entity" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Create Audit Snapshot", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "//API documentation: https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-audit/ \n{\n \"advertiserId\": \"advertiser_id\",\n \"auditRequests\": [\n {\n \"entityType\": \"campaign\",\n \"entityIds\": [\n 600001\n ],\n \"fromDate\": \"2023-05-01\",\n \"toDate\": \"2023-05-12\"\n }\n ],\n \"format\": \"gzip\"\n}\n/*\n-- entityType (possible values):\n1. campaign\n2. adGroup\n3. keyword\n4. adItem\n5. bidMultiplier\n6. placement\n7. sbaProfile\n8. adGroupMedia\n9. category\n*/" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/audit?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "audit" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"16274575\",\n \"auditRequests\": [\n {\n \"entityType\": \"adItem\",\n \"entityIds\": [\n 629162604\n ],\n \"fromDate\": \"2022-01-01\",\n \"toDate\": \"2022-01-11\"\n }\n ],\n \"format\": \"gzip\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/audit?advertiserId={{advertiserId}}&auth_token={{WPA_Auth_Token}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "audit" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "auth_token", "value": "{{WPA_Auth_Token}}" } ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:**\n\n- Snapshot Reports: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-snapshot-reportsv1/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-snapshot-reportsv1/)\n \n- Entity Snapshot Report: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-campaign-entity/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-campaign-entity/)\n \n- Audit Snapshot Report: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-audit/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-audit/)" }, { "name": "Snapshot v2", "item": [ { "name": "Get the snapshot by Snapshot Id", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot?snapshotId=&advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot" ], "query": [ { "key": "snapshotId", "value": "", "description": "(Required) Snapshot Id" }, { "key": "advertiserId", "value": "{{advertiserId}}" } ] } }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot?advertiserId=&snapshotId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot" ], "query": [ { "key": "advertiserId", "value": "" }, { "key": "snapshotId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Submit Report Snapshot Request", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "// Example Report Request \n\n\n{\n \"advertiserId\": advertiser_id,\n \"startDate\": \"2023-08-16\",\n \"endDate\": \"2023-08-17\",\n \"reportType\": \"videoKeywords\",\n \"attributionWindow\": \"days30\",\n \"format\": \"zip\",\n \"reportMetrics\": [\n \"date\",\n \"campaignId\",\n \"adGroupId\",\n \"numAdsShown\",\n \"numAdsClicks\",\n \"adSpend\",\n \"attributedUnits3days\",\n \"attributedUnits14days\",\n \"attributedUnits30days\",\n \"attributedOrders3days\",\n \"attributedOrders14days\",\n \"attributedOrders30days\",\n \"viewableImpressions\",\n \"videoFirstQuartileViews\",\n \"videoMidpointViews\",\n \"videoThirdQuartileViews\",\n \"videoCompleteViews\",\n \"videoUnmutes\",\n \"video5SecondViews\",\n \"attributedSales3days\",\n \"attributedSales14days\",\n \"attributedSales30days\",\n \"videoImpressions\",\n \"viewThroughSales3days\",\n \"viewThroughSales14days\",\n \"viewThroughSales30days\",\n \"viewThroughOrders3days\",\n \"viewThroughOrders14days\",\n \"viewThroughOrders30days\",\n \"viewThroughUnitsSold3days\",\n \"viewThroughUnitsSold14days\",\n \"viewThroughUnitsSold30days\",\n \"completeViewRevenue3days\",\n \"completeViewRevenue14days\",\n \"completeViewRevenue30days\",\n \"haloCompleteViewRevenue3days\",\n \"haloCompleteViewRevenue14days\",\n \"haloCompleteViewRevenue30days\",\n \"totalCompleteViewOrders3days\",\n \"totalCompleteViewOrders14days\",\n \"totalCompleteViewOrders30days\",\n \"totalCompleteViewUnits3days\",\n \"totalCompleteViewUnits14days\",\n \"totalCompleteViewUnits30days\"\n ]\n}\n\n/* \nFor more information, please refer: https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-snapshot-reportsv2/ > \"Sample Requests for Create Report Snapshot\".\n\nFor reportType to reportMetrics mapping, please refer \"Definition of Various Parameters Generated Across the Snapshot Reports\".\n\n*/\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v2", "snapshot", "report" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Submit Report Snapshot Request\n\n#### Request Body\n\n- Type: Raw\n \n- Description: JSON payload containing the following parameters:\n \n - startDate (string): The start date for the report.\n \n - endDate (string): The end date for the report.\n \n - reportType (string): Type of report to be generated.\n \n - attributionWindow (string): Attribution window for the report.\n \n - format (string): Format of the report.\n \n - reportMetrics (array): Array of metrics to be included in the report.\n \n\n#### Response Body\n\n- The response body contains the data for the report snapshot.\n \n\n#### Headers\n\n- Content-Type: application/json\n \n\n#### Example\n\n``` json\n{\n \"startDate\": \"2023-08-16\",\n \"endDate\": \"2023-08-17\",\n \"reportType\": \"videoKeywords\",\n \"attributionWindow\": \"days30\",\n \"format\": \"zip\",\n \"reportMetrics\": [\"date\"]\n}\n\n ```" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"attributionWindow\": \"\",\n \"endDate\": \"2019-01-02\",\n \"reportType\": \"\",\n \"startDate\": \"2019-01-01\",\n \"extraFields\": [\n \"\",\n \"\"\n ],\n \"format\": \"\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/report", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "report" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-snapshot-reportsv2/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-snapshot-reportsv2/)" }, { "name": "Recommendations Reports (Item & Keyword)", "item": [ { "name": "Get recommendations", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "\n {\n \"advertiserId\": \"advertiser_id\",\n \"recommendationType\": \"matchTypeKeywordRecommendations\",\n \"format\": \"gzip\"\n }\n\n//Possible values for recommendationType: matchTypeKeywordRecommendations AND itemRecommendations" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/recommendations?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "recommendations" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "## Snapshot Recommendations API\n\nThis API endpoint is used to retrieve snapshot recommendations for a given advertiser.\n\n### Request Body\n\n- **advertiserId** (string) - The ID of the advertiser for which recommendations are requested.\n \n- **recommendationType** (string) - The type of recommendation being requested.\n \n- **format** (string) - The format in which the response should be compressed, e.g., gzip.\n \n\n### Request Headers\n\n- Content-Type: application/json\n \n\n### Path Parameters\n\n- advertiserId (query parameter) - The ID of the advertiser for which recommendations are requested.\n \n\n### Response\n\nThe response will contain the snapshot recommendations based on the provided parameters." }, "response": [ { "name": "(getItems) successful operation", "originalRequest": { "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "\n {\n \"advertiserId\": \"16274575\",\n \"recommendationType\": \"itemRecommendations\",\n \"format\": \"zip\"\n }\n ", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/recommendations?advertiserId={{advertiserId}}&auth_token={{WPA_Auth_Token}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "recommendations" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "auth_token", "value": "{{WPA_Auth_Token}}" }, { "key": "recommendationType", "value": "itemRecommendation", "disabled": true }, { "key": "format", "value": "zip", "disabled": true } ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "(getKeywords) successful operation", "originalRequest": { "method": "POST", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "\n {\n \"advertiserId\": \"16274575\",\n \"recommendationType\": \"keywordRecommendations\",\n \"format\": \"zip\"\n }\n ", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/recommendations?advertiserId={{advertiserId}}&auth_token={{WPA_Auth_Token}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "recommendations" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" }, { "key": "auth_token", "value": "{{WPA_Auth_Token}}" }, { "key": "recommendationType", "value": "itemRecommendation", "disabled": true }, { "key": "format", "value": "zip", "disabled": true } ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Links**\n\n- Item Recommendations: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-item-recommendations/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-item-recommendations/)\n \n- Keyword Recommendations: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-keyword-recommendations/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-keyword-recommendations/)" }, { "name": "Insights Report", "item": [ { "name": "Create Advertiser Attributes Report", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "\n {\n \"insightType\": \"advertiserAttributes\",\n \"format\": \"zip\"\n }\n" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/insight", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "snapshot", "insight" ] }, "description": "Submit Report Snapshot Request" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"attributionWindow\": \"\",\n \"endDate\": \"2019-01-02\",\n \"reportType\": \"\",\n \"startDate\": \"2019-01-01\",\n \"extraFields\": [\n \"\",\n \"\"\n ],\n \"format\": \"\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/report", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "report" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] }, { "name": "Create Advanced Insights Report", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": 16274575,\n \"insightType\": \"advancedInsights\",\n \"reportMetrics\": [\n \"reportDate\",\n \"catalogItemId\",\n \"price\",\n \"buyboxWinnerPrice\",\n \"publishedStatus\",\n \"inventoryCount\"\n ],\n \"format\": \"gzip\"\n}\n/*\n-- Possible reportMetrics values:\navailabilityStatus\naverageRating  \nbaseItemId\nbaseVariantIdentifier\nbrandName\nbuyboxWinnerPrice\ncatalogItemId\ncatalogItemName\ncategory\nGTIN\ninventoryCount  \nitemCreationDate\nitemImageUrl\nitemLastUpdatedDate\nitemPageUrl\npageViewBasedAvailabilityRate \npageViewBasedBuyboxWinRate \nprice\npublishedStatus\nreplenishmentStatus\nreportDate    \nreviewCount\nUPC\nwalmartItemNumber\nwalmartProductId \n*/" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/insight?advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "snapshot", "insight" ], "query": [ { "key": "advertiserId", "value": "{{advertiserId}}" } ] }, "description": "### Submit Report Snapshot Request\n\n#### Description\n\nThis API endpoint is used to submit a report snapshot request for advanced insights.\n\n#### Request Body\n\n- **advertiserId** (number) - The ID of the advertiser.\n \n- **insightType** (string) - The type of insight, in this case \"advancedInsights\".\n \n- **reportMetrics** (array) - An array of metrics to be included in the report snapshot.\n \n- **format** (string) - The format of the report snapshot, in this case \"gzip\".\n \n\n#### Example\n\n``` json\n{\n \"advertiserId\": 16274575,\n \"insightType\": \"advancedInsights\",\n \"reportMetrics\": [\"reportDate\"],\n \"format\": \"gzip\"\n}\n\n ```\n\n#### Response\n\n- **Status** - 200\n \n- **Content-Type** - application/json\n \n- **code** (string) - The code related to the response.\n \n- **details** (string) - Details related to the response.\n \n- **snapshotId** (string) - The ID of the generated snapshot.\n \n- **jobStatus** (string) - The status of the job related to the snapshot request.\n \n\n#### Example\n\n``` json\n{\n \"code\": \"\",\n \"details\": \"\",\n \"snapshotId\": \"\",\n \"jobStatus\": \"\"\n}\n\n ```" }, "response": [ { "name": "successful operation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": \"\",\n \"attributionWindow\": \"\",\n \"endDate\": \"2019-01-02\",\n \"reportType\": \"\",\n \"startDate\": \"2019-01-01\",\n \"extraFields\": [\n \"\",\n \"\"\n ],\n \"format\": \"\"\n}" }, "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/snapshot/report", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "snapshot", "report" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Links**\n\nAdvertiser Attributes: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-advertiser-attributes/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-advertiser-attributes/)\n\nAdvanced Insights: [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-advanced-insights/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-advanced-insights/)" }, { "name": "Insights - Top Search Trends", "item": [ { "name": "Get Top Perfoming Keywords", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{$guid}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/insights?insightsType=searchTrends&format=zip/gzip", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "insights" ], "query": [ { "key": "insightsType", "value": "searchTrends" }, { "key": "format", "value": "zip/gzip" } ] }, "description": "This API endpoint makes an HTTP GET request to retrieve insights of a specific type, such as search trends, in a compressed zip/gzip format. The request does not include a request body, as it only requires query parameters for insightsType and format.\n\nThe response will include the insights data in a compressed zip/gzip format, as specified in the request. The response body will contain the insights data related to the specified type, allowing the consumer to analyze and utilize the trend information." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/latestReportDate", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "latestReportDate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-search-trends/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-search-trends/)" }, { "name": "Stats", "item": [ { "name": "List of Stats", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{$guid}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/stats?campaignId=600001&advertiserId={{advertiserId}}", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "stats" ], "query": [ { "key": "campaignId", "value": "600001", "description": "Campaign Id" }, { "key": "advertiserId", "value": "{{advertiserId}}", "description": "(Required) Advertiser Id" } ] }, "description": "This endpoint makes an HTTP GET request to retrieve statistics for a specific campaign and advertiser. The request should include the campaignId as a query parameter and the advertiserId as a path variable.\n\n### Request Parameters\n\n- `campaignId` (query parameter) - The ID of the campaign for which statistics are to be retrieved.\n \n- `advertiserId` (path variable) - The ID of the advertiser for which statistics are to be retrieved.\n \n\n### Response Body\n\nThe response will include the statistics data for the specified campaign and advertiser." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/stats?advertiserId=&campaignId=", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "stats" ], "query": [ { "key": "advertiserId", "value": "" }, { "key": "campaignId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-stats/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-stats/)", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Latest Report Date", "item": [ { "name": "Get Latest Report Date", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{$guid}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/latestReportDate", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "latestReportDate" ] }, "description": "This endpoint makes an HTTP GET request to retrieve the latest report date from the Walmart API.\n\n### Request\n\nNo request body is required for this endpoint.\n\n### Response\n\n- `latestReportDate`: (string) The latest report date from the Walmart API." }, "response": [ { "name": "successful operation", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1//api/v1/latestReportDate", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "", "api", "v1", "latestReportDate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "body": "" } ] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-report-date/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-report-date/)" }, { "name": "API usage analyze", "item": [ { "name": "Api Usage Analyze", "request": { "method": "GET", "header": [ { "key": "WM_CONSUMER.ID", "value": "{{WPA_Consumer_Id}}", "type": "text" }, { "key": "WM_SEC.KEY_VERSION", "value": "1", "type": "text" }, { "key": "WM_QOS.CORRELATION_ID", "value": "{{correlationId}}", "type": "text" }, { "key": "WM_SEC.AUTH_SIGNATURE", "value": "{{signature}}", "type": "text" }, { "key": "WM_CONSUMER.INTIMESTAMP", "value": "{{timestamp}}", "type": "text" }, { "key": "Authorization", "value": "{{Authorization}}", "type": "text" } ], "url": { "raw": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/api_usage_analyze", "protocol": "https", "host": [ "developer", "api", "stg", "walmart", "com" ], "path": [ "api-proxy", "service", "WPA", "Api", "v1", "api", "v1", "api_usage_analyze" ] }, "description": "Get last hour api usage" }, "response": [] } ], "description": "**Walmart Developer Portal Link:** [https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-api-usage/](https://developer.walmart.com/doc/us/us-wmc-ads/us-wmc-ads-api-usage/)" } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const jar = pm.cookies.jar();", "jar.clear(pm.request.url, function (error) {", " // error - ", "});", "", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/" } ]
}