Places - linked branches | AurMap Developers

Endpoints and scopes

Request	Scope
`GET /places`	any link to the place
`GET /places/{place_id}`	any link to the place
`PATCH /places/{place_id}/ordering`	`orders:write`

What a place is

A place is what customers find on the map: the merchant’s main place or one of its branches. Every place-level link covers one place, and every link can read its place.

List places

GET /places

bash

aurmap GET '/v1/places?limit=50'

json

{
  "data": [
    { "place_id": "plc_9q3w7e", "merchant_id": "mer_5r8k2d", "name": { "ar": "الريحان - العليا", "en": "Al Rayhan - Olaya" }, "link_id": "lnk_2h6j4n" }
  ],
  "next_cursor": null
}

One place

GET /places/{place_id}

bash

aurmap GET /v1/places/plc_9q3w7e

json

{
  "place_id": "plc_9q3w7e",
  "merchant_id": "mer_5r8k2d",
  "name": { "ar": "الريحان - العليا", "en": "Al Rayhan - Olaya" },
  "timezone": "Asia/Riyadh",
  "country": "SA",
  "location": { "lat": 24.6995, "lng": 46.6850 },
  "public_url": "https://aurmap.com/p/al-rayhan-olaya",
  "ordering": {
    "accepting_orders": true,
    "paused_until": null,
    "fulfilment": ["pickup"],
    "payment_methods": ["card", "cash"],
    "accept_window_minutes": 5
  },
  "menu": { "version": 42, "hash": "9f2c4be1d07a65e3c1f8a2b4d6e8f0a1b3c5d7e9f1a3b5c7d9e1f3a5b7c9d1e3", "source": "this_link" }
}

Field	Description
`timezone`	the place’s time zone, derived from its location, never picked by hand
`ordering.accepting_orders`	whether the place takes orders now
`ordering.paused_until`	when orders resume after a pause
`ordering.fulfilment`	how customers get orders; `pickup` only at launch
`ordering.payment_methods`	`card` and/or `cash`
`ordering.accept_window_minutes`	time to accept an order, 2 to 15 minutes, 5 by default
`menu.source`	`this_link` when your menu is the place’s source

Pause ordering

PATCH /places/{place_id}/ordering with orders:write.

Kitchen overloaded? Stop new orders without taking the place off the map.

bash

aurmap PATCH /v1/places/plc_9q3w7e/ordering '{"accepting_orders":false,"paused_until":"2026-10-14T13:30:00Z","reason":"busy"}'

json

{
  "place_id": "plc_9q3w7e",
  "ordering": { "accepting_orders": false, "paused_until": "2026-10-14T13:30:00Z", "fulfilment": ["pickup"], "payment_methods": ["card", "cash"], "accept_window_minutes": 5 }
}

With paused_until, orders resume by themselves at that time.
Without it, the pause lasts until you send "accepting_orders": true.
You set the accept window: send accept_window_minutes between 2 and 15 minutes. The default is 5. A value outside that range answers 400 VALIDATION_FAILED.

await aurmap('PATCH', '/v1/places/plc_9q3w7e/ordering', {
  accepting_orders: false,
  paused_until: new Date(Date.now() + 30 * 60 * 1000).toISOString(),
  reason: 'busy',
});

php

aurmap('PATCH', '/v1/places/plc_9q3w7e/ordering', [
    'accepting_orders' => false,
    'paused_until' => gmdate('Y-m-d\TH:i:s\Z', time() + 1800),
    'reason' => 'busy',
]);

What you receive on changes

Event	When
`place.updated`	the name, location, opening hours or time zone changed
`place.ordering_changed`	a pause or resume, or a new accept window or payment methods, from either side

The merchant sets opening hours in their account. Your menu’s schedules decide what can be ordered within those hours.