Retailer API

The Retailer API is designed to retrieve information about the Retailer linked with the Application.

• Method: GET

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

• Headers:

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

• Response Codes:

  • 200 OK

    Successful request. The response body will include detailed information about the retailer:

    "payload": [{
        "id": "xxxxxxxxxxxxxxxxxxxxxxx",
        "name": "Retailer's business unit name",
        "organisationId": "xxxxxxxxxxxxxxxxxxxxxxx",
        "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.

    • 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, or retailer not found), 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 is important to handle retailer data securely and ensure that access is restricted to authorized users only.