Active Outlets

The notifications webhook will be the primary way to identify outlets adding / disabling configuration for your provider but for a moment in time snapshot of the currently active outlets you can use the Active Outlets endpoint.

GET /remoteorders/activeoutlets/{providerId}

Headers

Authorisation: Bearer <ros token for organisation>

Response

  • HTTP 200 - JSON Encoded ActiveOutletsResponse
  • HTTP 503 on service is starting up or is not yet ready to process your request, please wait 30 seconds and retry.
  • HTTP 5XX on an error internal to ROS. This would typically only occur due to an internal transient connection issue, please retry for a limited number of attempts after a short delay.

Please note that the organisationCode property will always be set to an empty string for this response type.