Supplier API

The Supplier API is designed to retrieve a list of suppliers associated with a retailer and activated for the current application. This endpoint enables the application to retrieve the supplier information in order to operate.

warning

It's essential to handle supplier data securely and ensure that access is restricted to authorized users only. Proper handling of sensitive data in compliance with data protection regulations is paramount.

API Endpoint

Method: GET

URL: https://<PA_RM_END_POINT>/retail-media/retailer/{retailerId}/suppliers

Request Header

Name	Value
Content-Type	application/json
Authorization	Bearer ACCESS_TOKEN

Request Parameters

Parameter	Type	Description
retailerId	string	Get the retailer ID from the retailer API

Response Payload

Success Response

• Status Code: 200 OK
• Payload: Returns list of suppliers associated with a retailer in JSON format

[
  {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Supplier business unit name",
    "organisationId": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "timeZoneUtcOffsetInMin": 0,
    "primaryCurrency": "AUD"
  },
  {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Supplier business unit name",
    "organisationId": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "timeZoneUtcOffsetInMin": 0,
    "primaryCurrency": "AUD"
  },
  {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Supplier business unit name",
    "organisationId": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "timeZoneUtcOffsetInMin": 0,
    "primaryCurrency": "AUD"
  }
]

Response Parameters

Parameter	Type	Description
id	GUID	System generated unique identifier for the supplier
organisationId	GUID	The unique identifier for the organization the supplier belongs to
name	string	Name of the supplier
primaryCurrency	string	The primary currency used by the supplier
timeZoneUtcOffsetInMin	int	The time zone offset in minutes for the supplier

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/retailer/{retailerId}/suppliers", requestOptions)
  .then(response => response.json())
  .then(result=> { 
    console.log(result);
  })
  .catch(error => console.log('error', error));

info

If there are multiple suppliers, all of their business units will be listed in the response. However, the organisationId will remain the same for all business units of the same supplier.

For example, if there are two business units for one supplier and one business unit for another supplier, the response will include three business units with two having the same organisationId and one with a different organisationId.