Add a store location

POST

/v1/merchant/locations

curl --request POST \
  --url https://driver-staging-api.delivr.no/v1/merchant/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --data '{ "externalStoreId": "example", "name": "example", "street": "example", "postalCode": "0667", "city": "example", "latitude": 1, "longitude": 1, "contactName": "example", "contactPhone": "example", "prepMinutes": 1, "readyDeadlineMinutes": 1, "defaultParcel": { "lengthCm": 1, "widthCm": 1, "heightCm": 1 }, "readySignal": "assumed", "pickupInstructions": "example" }'

• Sandbox (Delivr staging). Production base URL is given at onboarding.

Adds a store your goods are picked up at (scope orders). Without latitude and longitude the store is placed from street, postalCode and city in the address register (422 invalid_address when it is not found; markets without a register need the coordinates). Omitted fields take their defaults.

Authorizations

• apiKey

Parameters

Header Parameters

Idempotency-Key

required

string format: uuid

A UUID, one header. A retry of the same request (method, path, canonical JSON body) within 24 h gets the first successful reply again (Idempotent-Replayed: true). Another request under the key is 422 idempotency_key_reused; a retry while the first runs is 409 idempotency_key_in_flight. Refused or failed requests free the key.

Request Body^required

Media typeapplication/json

A new store (name, street, postalCode, city, contactName and contactPhone required) or a change to one (any subset). latitude and longitude go together. null or an omitted field keeps the value on a change (defaultParcel: null drops it).

object

externalStoreId

Your id of the store, unique among your stores.

string | null

<= 100 characters

name

string | null

<= 120 characters

street

string | null

<= 200 characters

postalCode

string | null

city

string | null

<= 100 characters

latitude

number | null

longitude

number | null

contactName

string | null

<= 120 characters

contactPhone

A phone number of the market (stored as E.164).

string | null

prepMinutes

Packing time used when readySignal is assumed. Default 0.

integer | null

<= 240

readyDeadlineMinutes

At least prepMinutes. Default 60.

integer | null

>= 5 <= 1440

defaultParcel

Size given to parcels declared by weight alone (1–1000 cm per side).

object

lengthCm

required

number

widthCm

required

number

heightCm

required

number

readySignal

One of:

string

assumed (default): goods taken as ready at readyBy, else after prepMinutes; the search is planned at placement. processing and ready still refine it. required: on-demand orders wait for processing or ready.

string

Allowed values: assumed required

null

null

pickupInstructions

Shown to the driver at pickup, never to the recipient.

string | null

<= 500 characters

Responses

201

The store location.

Media typeapplication/json

object

id

required

string format: uuid

externalStoreId

Your id of the store.

string

name

required

string

street

required

string

postalCode

required

string

city

required

string

country

required

string

latitude

required

number

longitude

required

number

contactName

required

Who the driver asks for at the store.

string

contactPhone

required

E.164, e.g. +4722880100.

string

prepMinutes

required

Packing time used when readySignal is assumed.

integer

readyDeadlineMinutes

required

Goods due this long after the order when no readyBy is sent.

integer

defaultParcel

Size given to parcels declared by weight alone.

object

lengthCm

number

widthCm

number

heightCm

number

readySignal

required

assumed (default): goods taken as ready at readyBy, else after prepMinutes; the search is planned at placement. processing and ready still refine it. required: on-demand orders wait for processing or ready.

string

Allowed values: assumed required

pickupInstructions

required

Standing instructions shown to the driver at pickup (entrance, counter); visible to you, never to the recipient. “” for none.

string

Example

{
  "readySignal": "assumed"
}

Headers

X-Request-Id

string

The request’s id (yours if you sent a valid one, up to 64 of A-Za-z0-9._-). Quote it to support.

Idempotent-Replayed

string

Allowed values: true

true when the reply is a replay under the Idempotency-Key.

400

malformed_json, idempotency_key_required.

Media typeapplication/json

object

error

required

object

code

required

Status per code: 400 malformed_json, idempotency_key_required; 401 unauthenticated; 403 merchant_suspended, insufficient_scope; 404 not_found, quote_not_found; 405 method_not_allowed; 409 conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, fee_changed, quote_already_used, external_ref_taken, window_full, order_ended; 422 invalid_request, idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address; 429 rate_limited; 500 internal; 503 unavailable.

string

Allowed values: invalid_request malformed_json not_found method_not_allowed unauthenticated merchant_suspended insufficient_scope conflict cancellation_not_allowed idempotency_key_required idempotency_key_reused idempotency_key_in_flight unavailable rate_limited quote_not_found no_delivery_options manual_quote_required invalid_address price_changed option_unavailable fee_changed quote_already_used external_ref_taken window_full order_ended internal

message

required

Human-readable; may change. Branch on code.

string

param

The request field at fault, e.g. delivery.address (an unknown field: its name).

string

requestId

string

details

One of:

object

object

quotedAmountMinor

required

integer

option

required

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

alternatives

required

Options offered instead (may be empty). Book one by key.

Array<object>

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

fee

required

object

cancellable

required

boolean

stage

required

string

Allowed values: free driver_en_route driver_arrived not_cancellable

fee

required

VAT split only when charged.

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

graceEndsAt

string format: date-time

Example

{
  "error": {
    "code": "invalid_request",
    "details": {
      "option": {
        "type": "on_demand",
        "key": "on_demand",
        "price": {
          "currency": "NOK"
        }
      }
    }
  }
}

401

unauthenticated: missing, unknown or revoked key.

Media typeapplication/json

object

error

required

object

code

required

Status per code: 400 malformed_json, idempotency_key_required; 401 unauthenticated; 403 merchant_suspended, insufficient_scope; 404 not_found, quote_not_found; 405 method_not_allowed; 409 conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, fee_changed, quote_already_used, external_ref_taken, window_full, order_ended; 422 invalid_request, idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address; 429 rate_limited; 500 internal; 503 unavailable.

string

Allowed values: invalid_request malformed_json not_found method_not_allowed unauthenticated merchant_suspended insufficient_scope conflict cancellation_not_allowed idempotency_key_required idempotency_key_reused idempotency_key_in_flight unavailable rate_limited quote_not_found no_delivery_options manual_quote_required invalid_address price_changed option_unavailable fee_changed quote_already_used external_ref_taken window_full order_ended internal

message

required

Human-readable; may change. Branch on code.

string

param

The request field at fault, e.g. delivery.address (an unknown field: its name).

string

requestId

string

details

One of:

object

object

quotedAmountMinor

required

integer

option

required

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

alternatives

required

Options offered instead (may be empty). Book one by key.

Array<object>

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

fee

required

object

cancellable

required

boolean

stage

required

string

Allowed values: free driver_en_route driver_arrived not_cancellable

fee

required

VAT split only when charged.

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

graceEndsAt

string format: date-time

Example

{
  "error": {
    "code": "invalid_request",
    "details": {
      "option": {
        "type": "on_demand",
        "key": "on_demand",
        "price": {
          "currency": "NOK"
        }
      }
    }
  }
}

403

merchant_suspended, insufficient_scope.

Media typeapplication/json

object

error

required

object

code

required

Status per code: 400 malformed_json, idempotency_key_required; 401 unauthenticated; 403 merchant_suspended, insufficient_scope; 404 not_found, quote_not_found; 405 method_not_allowed; 409 conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, fee_changed, quote_already_used, external_ref_taken, window_full, order_ended; 422 invalid_request, idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address; 429 rate_limited; 500 internal; 503 unavailable.

string

Allowed values: invalid_request malformed_json not_found method_not_allowed unauthenticated merchant_suspended insufficient_scope conflict cancellation_not_allowed idempotency_key_required idempotency_key_reused idempotency_key_in_flight unavailable rate_limited quote_not_found no_delivery_options manual_quote_required invalid_address price_changed option_unavailable fee_changed quote_already_used external_ref_taken window_full order_ended internal

message

required

Human-readable; may change. Branch on code.

string

param

The request field at fault, e.g. delivery.address (an unknown field: its name).

string

requestId

string

details

One of:

object

object

quotedAmountMinor

required

integer

option

required

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

alternatives

required

Options offered instead (may be empty). Book one by key.

Array<object>

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

fee

required

object

cancellable

required

boolean

stage

required

string

Allowed values: free driver_en_route driver_arrived not_cancellable

fee

required

VAT split only when charged.

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

graceEndsAt

string format: date-time

Example

{
  "error": {
    "code": "invalid_request",
    "details": {
      "option": {
        "type": "on_demand",
        "key": "on_demand",
        "price": {
          "currency": "NOK"
        }
      }
    }
  }
}

409

conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, window_full, fee_changed, quote_already_used, external_ref_taken, order_ended. See details for what to do.

Media typeapplication/json

object

error

required

object

code

required

Status per code: 400 malformed_json, idempotency_key_required; 401 unauthenticated; 403 merchant_suspended, insufficient_scope; 404 not_found, quote_not_found; 405 method_not_allowed; 409 conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, fee_changed, quote_already_used, external_ref_taken, window_full, order_ended; 422 invalid_request, idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address; 429 rate_limited; 500 internal; 503 unavailable.

string

Allowed values: invalid_request malformed_json not_found method_not_allowed unauthenticated merchant_suspended insufficient_scope conflict cancellation_not_allowed idempotency_key_required idempotency_key_reused idempotency_key_in_flight unavailable rate_limited quote_not_found no_delivery_options manual_quote_required invalid_address price_changed option_unavailable fee_changed quote_already_used external_ref_taken window_full order_ended internal

message

required

Human-readable; may change. Branch on code.

string

param

The request field at fault, e.g. delivery.address (an unknown field: its name).

string

requestId

string

details

One of:

object

object

quotedAmountMinor

required

integer

option

required

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

alternatives

required

Options offered instead (may be empty). Book one by key.

Array<object>

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

fee

required

object

cancellable

required

boolean

stage

required

string

Allowed values: free driver_en_route driver_arrived not_cancellable

fee

required

VAT split only when charged.

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

graceEndsAt

string format: date-time

Example

{
  "error": {
    "code": "invalid_request",
    "details": {
      "option": {
        "type": "on_demand",
        "key": "on_demand",
        "price": {
          "currency": "NOK"
        }
      }
    }
  }
}

422

invalid_request (with param), idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address.

Media typeapplication/json

object

error

required

object

code

required

Status per code: 400 malformed_json, idempotency_key_required; 401 unauthenticated; 403 merchant_suspended, insufficient_scope; 404 not_found, quote_not_found; 405 method_not_allowed; 409 conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, fee_changed, quote_already_used, external_ref_taken, window_full, order_ended; 422 invalid_request, idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address; 429 rate_limited; 500 internal; 503 unavailable.

string

Allowed values: invalid_request malformed_json not_found method_not_allowed unauthenticated merchant_suspended insufficient_scope conflict cancellation_not_allowed idempotency_key_required idempotency_key_reused idempotency_key_in_flight unavailable rate_limited quote_not_found no_delivery_options manual_quote_required invalid_address price_changed option_unavailable fee_changed quote_already_used external_ref_taken window_full order_ended internal

message

required

Human-readable; may change. Branch on code.

string

param

The request field at fault, e.g. delivery.address (an unknown field: its name).

string

requestId

string

details

One of:

object

object

quotedAmountMinor

required

integer

option

required

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

alternatives

required

Options offered instead (may be empty). Book one by key.

Array<object>

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

fee

required

object

cancellable

required

boolean

stage

required

string

Allowed values: free driver_en_route driver_arrived not_cancellable

fee

required

VAT split only when charged.

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

graceEndsAt

string format: date-time

Example

{
  "error": {
    "code": "invalid_request",
    "details": {
      "option": {
        "type": "on_demand",
        "key": "on_demand",
        "price": {
          "currency": "NOK"
        }
      }
    }
  }
}

429

rate_limited. Also after repeated failed sign-ins from one address.

Media typeapplication/json

object

error

required

object

code

required

Status per code: 400 malformed_json, idempotency_key_required; 401 unauthenticated; 403 merchant_suspended, insufficient_scope; 404 not_found, quote_not_found; 405 method_not_allowed; 409 conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, fee_changed, quote_already_used, external_ref_taken, window_full, order_ended; 422 invalid_request, idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address; 429 rate_limited; 500 internal; 503 unavailable.

string

Allowed values: invalid_request malformed_json not_found method_not_allowed unauthenticated merchant_suspended insufficient_scope conflict cancellation_not_allowed idempotency_key_required idempotency_key_reused idempotency_key_in_flight unavailable rate_limited quote_not_found no_delivery_options manual_quote_required invalid_address price_changed option_unavailable fee_changed quote_already_used external_ref_taken window_full order_ended internal

message

required

Human-readable; may change. Branch on code.

string

param

The request field at fault, e.g. delivery.address (an unknown field: its name).

string

requestId

string

details

One of:

object

object

quotedAmountMinor

required

integer

option

required

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

alternatives

required

Options offered instead (may be empty). Book one by key.

Array<object>

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

fee

required

object

cancellable

required

boolean

stage

required

string

Allowed values: free driver_en_route driver_arrived not_cancellable

fee

required

VAT split only when charged.

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

graceEndsAt

string format: date-time

Example

{
  "error": {
    "code": "invalid_request",
    "details": {
      "option": {
        "type": "on_demand",
        "key": "on_demand",
        "price": {
          "currency": "NOK"
        }
      }
    }
  }
}

Headers

Retry-After

integer

Seconds to wait.

RateLimit-Limit

integer

Requests per minute for your merchant (600).

RateLimit-Remaining

integer

RateLimit-Reset

integer

Seconds until the window resets.

503

unavailable: retry later (same Idempotency-Key).

Media typeapplication/json

object

error

required

object

code

required

Status per code: 400 malformed_json, idempotency_key_required; 401 unauthenticated; 403 merchant_suspended, insufficient_scope; 404 not_found, quote_not_found; 405 method_not_allowed; 409 conflict, cancellation_not_allowed, idempotency_key_in_flight, price_changed, option_unavailable, fee_changed, quote_already_used, external_ref_taken, window_full, order_ended; 422 invalid_request, idempotency_key_reused, no_delivery_options, manual_quote_required, invalid_address; 429 rate_limited; 500 internal; 503 unavailable.

string

Allowed values: invalid_request malformed_json not_found method_not_allowed unauthenticated merchant_suspended insufficient_scope conflict cancellation_not_allowed idempotency_key_required idempotency_key_reused idempotency_key_in_flight unavailable rate_limited quote_not_found no_delivery_options manual_quote_required invalid_address price_changed option_unavailable fee_changed quote_already_used external_ref_taken window_full order_ended internal

message

required

Human-readable; may change. Branch on code.

string

param

The request field at fault, e.g. delivery.address (an unknown field: its name).

string

requestId

string

details

One of:

object

object

quotedAmountMinor

required

integer

option

required

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

alternatives

required

Options offered instead (may be empty). Book one by key.

Array<object>

object

type

required

string

Allowed values: on_demand window

key

required

Stable key to book (on_demand or window:<start>/<end> in the market’s zone). The same delivery quoted again lists the same keys.

string

eta

On demand. Arrival band.

object

from

required

string format: date-time

to

required

string format: date-time

window

Window option.

object

start

required

string format: date-time

end

required

string format: date-time

cutoffAt

Window option. Book and cancel free before it.

string format: date-time

price

required

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

supply

On demand only. HINT for the seller, never a promise: drivers near the store when quoted and when the first-ranked could reach it. Do not show a driver count to shoppers.

object

nearbyDrivers

required

integer

pickupEta

required

object

from

required

string format: date-time

to

required

string format: date-time

object

object

fee

required

object

cancellable

required

boolean

stage

required

string

Allowed values: free driver_en_route driver_arrived not_cancellable

fee

required

VAT split only when charged.

object

amountMinor

required

VAT included.

integer

vatMinor

integer

exVatMinor

integer

currency

required

string

graceEndsAt

string format: date-time

Example

{
  "error": {
    "code": "invalid_request",
    "details": {
      "option": {
        "type": "on_demand",
        "key": "on_demand",
        "price": {
          "currency": "NOK"
        }
      }
    }
  }
}