List branches

Response

{
  "data": [
    {
      "id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
      "reference": "noerrebro",
      "name": "Norrebro Bakery",
      "address": {
        "street": "Jagtvej 12",
        "city": "Copenhagen",
        "postcode": "2200"
      },
      "routesTo": {
        "fleet": { "name": "Copenhagen Couriers" },
        "zone": { "code": "CZ-K7M2PQR4", "name": "Central Zone" }
      },
      "connectedZones": [
        { "code": "CZ-K7M2PQR4", "name": "Central Zone", "isPrimary": true },
        { "code": "NW-P2K9RT4M", "name": "Northwest Zone", "isPrimary": false }
      ]
    }
  ],
  "hasMore": false
}

Errors

reference and id

reference is the code you set in the dashboard. It is unique in your organization, and it is what you send as branch. It is null until you set it. Use the id for such a branch.

Univooz reads a UUID as an id, and all other values as a reference. So a reference can never be a UUID.

routesTo and connectedZones

routesTo is the destination when you do not send zoneCode.

routesTo: null means the branch has no primary connection. Univooz then rejects orders with 422 branch_not_connected.

connectedZones shows the values you can send as zoneCode. A branch can connect to more than one zone and send orders to one.

Closed branches

This endpoint does not list them, because they cannot accept an order.

List orders does accept a closed branch in its branch filter, because a shop you closed still has orders to check.