Retailer API

The Retailer API is designed to retrieve information about the Retailer linked to the provided application ID.

warning

It is important to handle retailer data securely and ensure that access is restricted to authorized users only.

API Endpoint

Method: GET

URL: https://<PA_RM_END_POINT>/retail-media/retailers

Request Header

Name	Value
Content-Type	application/json
Authorization	Bearer ACCESS_TOKEN

Response Payload

Success Response

• Status Code: 200 OK
• Payload: Returns list retailers associated to the application in JSON format

[
  {
    "id": "xxxxxxxxxxxxxxxxxxxxxxx",
    "organisationId": "xxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Retailer's business unit name",
    "timeZoneUtcOffsetInMin": 0,
    "primaryCurrency": "AUD"
  }
]

Response Parameters

Parameter	Type	Description
id	GUID	System generated unique identifier for the retailer
organisationId	GUID	The unique identifier for the organization the retailer belongs to
name	string	Name of the retailer
primaryCurrency	string	The primary currency used by the retailer

Error Response

If an error occurs, the API will return an appropriate status code along with an error message.

• Sample Error Response (400 Bad Request):

{
  "errors": [
    "Error message 1",
    "Error message 2"
  ],
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "xxxxxxxxxxxxxxxxxxx"
}

Example Usage (JavaScript)

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "BEARER YOUR_ACCESS_TOKEN");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect:'follow'
};

fetch("https://<PA_RM_END_POINT>/retail-media/retailers", requestOptions)
  .then(response => response.json())
  .then(result=> { 
    console.log(result);
  })
  .catch(error => console.log('error', error));