Skip to main content

Location Management

Location Retrieval​

When a merchant connects to Stream, we will fetch all available locations from your platform using the Get Locations endpoint. This allows merchants to select which locations they want to connect to Stream.

Location Properties​

Each location should include essential information:

  • Unique provider_id to identify the location
  • Name and address details
  • Preparation time in minutes prep_time_minutes (optional)

Location Status Management​

Stream provides functionality for merchants to manage their location statuses through our platform. This can effectively disable/enable connected channels for a location.

Status Updates​

When a location's status changes in your POS system (e.g., temporary closure, holiday hours), you should notify Stream by sending a request to the Location Status Update Notification (POS -> Stream via Webhook) endpoint with the updated status information.

Example location status update payload:

{
  "type": "location.status.updated",
  "object": {
    "location_id": "test_location_123",
    "status": "active" | "inactive" ,
    "paused_until": 1707772800000, // Optional: Unix timestamp in milliseconds
  }
}