Get the store

The restaurant's address, branding, order types, payment methods, delivery zones and opening hours. Load this first: orderTypes tells you what the shopper can order right now.

GET

https://api.unipage.eu/storefront/v1/store

Authorization

publicKey
optional
API key in header

secretKey
optional
HTTP

Returns

200

The store.

JSON

id
optional
string
name
optional
string
address
optional
object
- line1
  optional
  string
- postcode
  optional
  string
- city
  optional
  string
- country
  optional
  string
}
phone
optional
string | null
email
optional
string | null
timezone
optional
string
Every date and time in the API is in this timezone.
currency
optional
string
branding
optional
object
- primaryColor
  optional
  string | null
- secondaryColor
  optional
  string | null
- coverImage
  optional
  string | null
  Image URL.
- logo
  optional
  string | null
  Image URL.
}
acceptsOrders
optional
boolean
orderTypes
optional
array of
TAKEOUT
or
DELIVERY
What you can order through this API right now. Empty when the restaurant does not accept orders. TAKEOUT unless the restaurant only delivers; DELIVERY when delivery is on and the restaurant has at least one postcode zone. A delivery-only restaurant without a postcode zone has no order type here.
payment
optional
object
- methods
  optional
  array of
  online
  or
  offline
  The ways the restaurant collects the money itself: pass one of these as paymentType when placing an order. external (you collect the money) is always accepted and is not listed here.
- default
  optional
  online
  or
  offline
  or
  null
  The first of methods, null when there is none.
}
delivery
optional
object
- enabled
  optional
  boolean
- minimumAmount
  optional
  number
- zones
  optional
  array of
  object
  Postcode zones.
  
  id
  optional
  string
  Send as delivery.zoneId.
  
  postcode
  optional
  string
  name
  optional
  string
  cost
  optional
  number
  freeFrom
  optional
  number
  0 means the fee is always charged.
}
serviceCost
optional
object
- amount
  optional
  number
  0 means no service cost.
- omitFrom
  optional
  number
  0 means always charged; otherwise only when the subtotal is below it.
}
notesEnabled
optional
boolean
openingHours
optional
array of
object
- day
  optional
  MON
  or
  TUE
  or
  WED
  or
  THU
  or
  FRI
  or
  SAT
  +1 more
- isOpen
  optional
  boolean
- periods
  optional
  array of
  object
  start
  optional
  string
  HH:MM.
  
  end
  optional
  string
  HH:MM.
}

401

A missing, unknown or revoked key (UNAUTHENTICATED).

JSON

error
object
required
- code
  UNAUTHENTICATED
  or
  FORBIDDEN
  or
  NOT_FOUND
  or
  METHOD_NOT_ALLOWED
  or
  VALIDATION
  or
  SLOT_UNAVAILABLE
  +6 more
  required
- message
  string
  required
  Human readable.
- fields
  optional
  map of
  string
  Only present when the error belongs to specific request fields.
}

403

A public key on a secret route, or used from an origin that is not registered for it (FORBIDDEN).

JSON

error
object
required
- code
  UNAUTHENTICATED
  or
  FORBIDDEN
  or
  NOT_FOUND
  or
  METHOD_NOT_ALLOWED
  or
  VALIDATION
  or
  SLOT_UNAVAILABLE
  +6 more
  required
- message
  string
  required
  Human readable.
- fields
  optional
  map of
  string
  Only present when the error belongs to specific request fields.
}

429

Too many requests (RATE_LIMITED). Wait Retry-After seconds.

JSON

error
object
required
- code
  UNAUTHENTICATED
  or
  FORBIDDEN
  or
  NOT_FOUND
  or
  METHOD_NOT_ALLOWED
  or
  VALIDATION
  or
  SLOT_UNAVAILABLE
  +6 more
  required
- message
  string
  required
  Human readable.
- fields
  optional
  map of
  string
  Only present when the error belongs to specific request fields.
}