Store locations
A location is a store or warehouse a driver picks your goods up from. Every quote and order names one.
Add a store
Section titled “Add a store”curl https://driver-staging-api.delivr.no/v1/merchant/locations \ -H "Authorization: Bearer $DELIVR_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{ "externalStoreId": "oslo-sentrum", "name": "Oslo Sentrum", "street": "Akersgata 45", "postalCode": "0158", "city": "Oslo", "contactName": "Store staff", "contactPhone": "+4722000000", "prepMinutes": 10, "readyDeadlineMinutes": 60, "readySignal": "assumed", "pickupInstructions": "Staff entrance in the back yard. Ring the bell marked Delivr." }'name, street, postalCode, city, contactName and contactPhone are required. The answer is 201 with the location and its id.
| Field | Default | Meaning |
|---|---|---|
externalStoreId |
none | Your own id for the store, unique among your stores. Use it instead of id in quotes and orders. |
contactName, contactPhone |
required | Who the driver asks for at the store. The phone is stored as E.164. |
prepMinutes |
0 |
How long packing takes, used when readySignal is assumed. |
readyDeadlineMinutes |
60 |
When the goods are due, counted from the order, if the order has no readyBy. At least prepMinutes. |
readySignal |
assumed |
Whether Delivr assumes the goods are ready, or waits for you. See Goods ready signals. |
defaultParcel |
none | A size (lengthCm, widthCm, heightCm) for parcels you declare by weight only. |
pickupInstructions |
"" |
Standing instructions for drivers at this store, such as the entrance or counter. |
latitude, longitude |
from the address | Send both or neither. |
Where the store is
Section titled “Where the store is”Without coordinates, Delivr places the store from its address in the national address register. If the address is not found, you get 422 invalid_address; send latitude and longitude then.
Who sees the instructions
Section titled “Who sees the instructions”pickupInstructions reach the driver only. You can read them back, but they never appear on the recipient’s tracking page, in SMS or in webhooks.
Change a store
Section titled “Change a store”PATCH /v1/merchant/locations/{id} changes only the fields you send.
""clearsexternalStoreIdorpickupInstructions, and"defaultParcel": nulldrops the default size.- A new street, postal code or city places the store again from its address, unless you send coordinates too.
- Orders already placed keep their pickup. New quotes and orders use the change.
Read your stores
Section titled “Read your stores”GET /v1/merchant/locations lists your stores, and GET /v1/merchant/locations/{id} reads one. Reading needs scope quotes; adding and changing need scope orders and an Idempotency-Key.
Locations cannot be removed yet. Change one to reuse it.