Supplier API

The Supplier API is designed to retrieve a list of suppliers associated with a specific application. This endpoint enables users to retrieve the supplier information effectively to facilitate operations and integrations across Retail Media campaigns.

• Method: GET

• URL: https://<PA_RM_END_POINT>/rm/1.0/supplier

• Headers:

  • Content-Type: application/json
  • Authorization: Bearer ACCESS_TOKEN

• Response Codes:

  • 200 OK

    Successful request. The response body will include an array of supplier details:

    [
      {
        "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"
      }
    ]

    • id (GUID): The unique identifier for the business unit.

    • name (string): The name of the business unit.

    • organisationId (GUID): The unique identifier for the organization.

      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.

    • timeZoneUtcOffsetInMin (integer): The time zone offset in minutes.

    • primaryCurrency (string): The primary currency used by the business unit.

  • Non-200 Responses

    If an error occurs (e.g., bad request, unauthorized access), the server will respond with an appropriate non-200 status code and include an error message in the response body:

    {
        "error": "Error message"
    }
    note

    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.