Negocio

Retrieve the store#

get/store

Permiso:

store:read

Plan:

todos los planes

Open, closed or paused right now, the next opening, order types, the statuses the restaurant uses, lead times, minimum order, opening and delivery hours, upcoming special days, contact details, address and location.

Respuesta200

OK

• objectstringobligatorio

  Always store.

  Valores:"store"

• idstring (uuid)obligatorio

  The restaurant.

• namestringobligatorio

  Name.

• slugstringobligatorio

  Its address: <slug>.flavoso.com.

• timezonestringobligatorio

  IANA time zone of all local times.

• currencystringobligatorio

  ISO 4217.

• statusstringobligatorio

  Right now: open, closed (outside hours or a closed special day), or paused.

  Valores:"open""closed""paused"

• paused_untilstring (date-time)obligatoriopuede ser null

  End of the running pause; null without one.

• pause_notestringobligatoriopuede ser null

  Reason of the running pause.

• next_opening_atstring (date-time)obligatoriopuede ser null

  Next opening while closed (looks two weeks ahead); null while open.

• preordersbooleanobligatorio

  Guests may order for a later time, also while closed.

• order_typesobjectobligatorio

  Which order types guests can choose.

  Campos anidados (3)

  • pickupbooleanobligatorio

    Pickup.

  • deliverybooleanobligatorio

    Delivery.

  • dine_inbooleanobligatorio

    Ordering at the table via QR code (Pro and up).

• order_statusesstring[]obligatorio

  Statuses this restaurant uses, in order, plus completed and cancelled.

• lead_timesobjectobligatorio

  How long the kitchen needs; the earliest pickup or delivery time.

  Campos anidados (2)

  • pickup_minutesintegerobligatorio

    Minutes until pickup, 0 to 240.

  • delivery_minutesintegerobligatorio

    Minutes until delivery, 0 to 360.

• min_orderintegerobligatorio

  Minimum order value for delivery (0 = none). Integer amount in the smallest currency unit (cents).

• always_openbooleanobligatorio

  No weekly schedule is set: online orders are taken around the clock (special days and pauses still apply) and no reservation times are offered.

• opening_hoursWeekWindow[]obligatorio

  The weekly opening windows; a weekday without windows is closed.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• delivery_hoursWeekWindow[]obligatorio

  Weekly delivery windows; empty means delivery follows opening_hours.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• closuresClosure[]obligatorio

  Upcoming special days (today and later).

  Campos anidados (5)

  • objectstringobligatorio

    Always closure.

    Valores:"closure"

  • datestring (date)obligatorio

    The day. A date YYYY-MM-DD in the restaurant's time zone.

  • closedbooleanobligatorio

    Closed all day.

  • hoursTimeWindow[]obligatorio

    The windows of that day when not closed (at most two).

    Campos anidados (2)

    • openstringobligatorio

      Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

    • closestringobligatorio

      Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • notestringobligatoriopuede ser null

    Note, e.g. the reason.

• contactobjectobligatorio

  Public contact details.

  Campos anidados (3)

  • phonestringobligatoriopuede ser null

    Phone.

  • emailstringobligatoriopuede ser null

    E-mail.

  • websitestringobligatoriopuede ser null

    Website.

• addressobjectobligatoriopuede ser null

  The address as far as it is known. Restaurants type it freely; postal code and city are only split out when a line starts with a postal code.

  Campos anidados (4)

  • linestringobligatoriopuede ser null

    Street and number (or the whole address when it cannot be split).

  • postal_codestringobligatoriopuede ser null

    Postal code, when it can be read from the address.

  • citystringobligatoriopuede ser null

    City, when it can be read from the address.

  • countrystringobligatoriopuede ser null

    ISO 3166-1 alpha-2, as in GET /me.

• locationobjectobligatoriopuede ser null

  Coordinates; null when not set.

  Campos anidados (2)

  • latnumberobligatorio

    Latitude.

  • lonnumberobligatorio

    Longitude.

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

Change lead times, pre-orders and order types#

patch/store

Permiso:

store:write

Plan:

todos los planes

Changes only the fields you send; everything else stays as the restaurant set it. The same rules as the dashboard: lead times 0 to 240 minutes for pickup and 0 to 360 for delivery, and an order type can only be switched on when the restaurant's plan includes it (plan_required, ordering at the table needs Pro).

Opening hours are changed with PUT /store/hours, special days with /store/closures, a pause with /store/pause. A change produces store.updated.

Cuerpoapplication/json

• lead_timesobject

  Kitchen lead times.

  Campos anidados (2)

  • pickup_minutesinteger

    Minutes until pickup.

    0 to 240

  • delivery_minutesinteger

    Minutes until delivery.

    0 to 360

• order_typesobject

  Switch order types on or off. Switching on needs a plan that includes the type.

  Campos anidados (3)

  • pickupboolean

    Pickup.

  • deliveryboolean

    Delivery.

  • dine_inboolean

    Ordering at the table (Pro and up).

• preordersboolean

  Allow orders for a later time.

Respuesta200

The store after the change.

• objectstringobligatorio

  Always store.

  Valores:"store"

• idstring (uuid)obligatorio

  The restaurant.

• namestringobligatorio

  Name.

• slugstringobligatorio

  Its address: <slug>.flavoso.com.

• timezonestringobligatorio

  IANA time zone of all local times.

• currencystringobligatorio

  ISO 4217.

• statusstringobligatorio

  Right now: open, closed (outside hours or a closed special day), or paused.

  Valores:"open""closed""paused"

• paused_untilstring (date-time)obligatoriopuede ser null

  End of the running pause; null without one.

• pause_notestringobligatoriopuede ser null

  Reason of the running pause.

• next_opening_atstring (date-time)obligatoriopuede ser null

  Next opening while closed (looks two weeks ahead); null while open.

• preordersbooleanobligatorio

  Guests may order for a later time, also while closed.

• order_typesobjectobligatorio

  Which order types guests can choose.

  Campos anidados (3)

  • pickupbooleanobligatorio

    Pickup.

  • deliverybooleanobligatorio

    Delivery.

  • dine_inbooleanobligatorio

    Ordering at the table via QR code (Pro and up).

• order_statusesstring[]obligatorio

  Statuses this restaurant uses, in order, plus completed and cancelled.

• lead_timesobjectobligatorio

  How long the kitchen needs; the earliest pickup or delivery time.

  Campos anidados (2)

  • pickup_minutesintegerobligatorio

    Minutes until pickup, 0 to 240.

  • delivery_minutesintegerobligatorio

    Minutes until delivery, 0 to 360.

• min_orderintegerobligatorio

  Minimum order value for delivery (0 = none). Integer amount in the smallest currency unit (cents).

• always_openbooleanobligatorio

  No weekly schedule is set: online orders are taken around the clock (special days and pauses still apply) and no reservation times are offered.

• opening_hoursWeekWindow[]obligatorio

  The weekly opening windows; a weekday without windows is closed.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• delivery_hoursWeekWindow[]obligatorio

  Weekly delivery windows; empty means delivery follows opening_hours.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• closuresClosure[]obligatorio

  Upcoming special days (today and later).

  Campos anidados (5)

  • objectstringobligatorio

    Always closure.

    Valores:"closure"

  • datestring (date)obligatorio

    The day. A date YYYY-MM-DD in the restaurant's time zone.

  • closedbooleanobligatorio

    Closed all day.

  • hoursTimeWindow[]obligatorio

    The windows of that day when not closed (at most two).

    Campos anidados (2)

    • openstringobligatorio

      Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

    • closestringobligatorio

      Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • notestringobligatoriopuede ser null

    Note, e.g. the reason.

• contactobjectobligatorio

  Public contact details.

  Campos anidados (3)

  • phonestringobligatoriopuede ser null

    Phone.

  • emailstringobligatoriopuede ser null

    E-mail.

  • websitestringobligatoriopuede ser null

    Website.

• addressobjectobligatoriopuede ser null

  The address as far as it is known. Restaurants type it freely; postal code and city are only split out when a line starts with a postal code.

  Campos anidados (4)

  • linestringobligatoriopuede ser null

    Street and number (or the whole address when it cannot be split).

  • postal_codestringobligatoriopuede ser null

    Postal code, when it can be read from the address.

  • citystringobligatoriopuede ser null

    City, when it can be read from the address.

  • countrystringobligatoriopuede ser null

    ISO 3166-1 alpha-2, as in GET /me.

• locationobjectobligatoriopuede ser null

  Coordinates; null when not set.

  Campos anidados (2)

  • latnumberobligatorio

    Latitude.

  • lonnumberobligatorio

    Longitude.

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 409invalid_transition (the status of the object does not allow this), stage_not_used (the restaurant does not use this status), external_id_taken (your app already uses this external_id for another object of the same kind in this restaurant), slot_unavailable (the time or the table is taken), idempotency_in_progress (a request with this Idempotency-Key is still running) or conflict (the same data was changed elsewhere at the same moment, three times in a row; retry unchanged after Retry-After seconds).
• 413payload_too_large: the body is larger than the operation takes, counted in bytes: 64 KB, 2 MB for PUT /menu. Split the request.
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

Retrieve opening and delivery hours#

get/store/hours

Permiso:

store:read

Plan:

todos los planes

The weekly schedule. Several windows on one weekday are a lunch break. A weekday without windows is closed. Special days are separate (/store/closures).

Respuesta200

OK

• objectstringobligatorio

  Always store_hours.

  Valores:"store_hours"

• always_openbooleanobligatorio

  No weekly schedule: online orders around the clock, no reservation times.

• opening_hoursWeekWindow[]obligatorio

  Opening windows.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• delivery_hoursWeekWindow[]obligatorio

  Delivery windows; empty means the opening hours apply.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

Replace opening and/or delivery hours#

put/store/hours

Permiso:

store:write

Plan:

todos los planes

Each list you send replaces that whole schedule; a list you leave out stays as it is. At most two windows per weekday, times HH:MM; a window may run past midnight (18:00–02:00). Weekdays missing from a list are closed.

An empty opening_hours list means the restaurant has no weekly schedule: online orders are taken around the clock and no reservation times are offered. An empty delivery_hours list means delivery follows the opening hours. A change produces store.updated.

Cuerpoapplication/json

• opening_hoursWeekWindow[]

  At most two windows per weekday. Empty: no weekly schedule.

  max 14 items

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• delivery_hoursWeekWindow[]

  At most two windows per weekday. Empty: delivery follows the opening hours.

  max 14 items

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

Respuesta200

OK

• objectstringobligatorio

  Always store_hours.

  Valores:"store_hours"

• always_openbooleanobligatorio

  No weekly schedule: online orders around the clock, no reservation times.

• opening_hoursWeekWindow[]obligatorio

  Opening windows.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• delivery_hoursWeekWindow[]obligatorio

  Delivery windows; empty means the opening hours apply.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 409invalid_transition (the status of the object does not allow this), stage_not_used (the restaurant does not use this status), external_id_taken (your app already uses this external_id for another object of the same kind in this restaurant), slot_unavailable (the time or the table is taken), idempotency_in_progress (a request with this Idempotency-Key is still running) or conflict (the same data was changed elsewhere at the same moment, three times in a row; retry unchanged after Retry-After seconds).
• 413payload_too_large: the body is larger than the operation takes, counted in bytes: 64 KB, 2 MB for PUT /menu. Split the request.
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

List special days#

get/store/closures

Permiso:

store:read

Plan:

todos los planes

Upcoming special days (today and later, in the restaurant's time zone): closed days and days with their own hours. At most 60.

Respuesta200

OK

• objectstringobligatorio

  Always list.

  Valores:"list"

• dataClosure[]obligatorio

  The items of this page.

  Campos anidados (5)

  • objectstringobligatorio

    Always closure.

    Valores:"closure"

  • datestring (date)obligatorio

    The day. A date YYYY-MM-DD in the restaurant's time zone.

  • closedbooleanobligatorio

    Closed all day.

  • hoursTimeWindow[]obligatorio

    The windows of that day when not closed (at most two).

    Campos anidados (2)

    • openstringobligatorio

      Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

    • closestringobligatorio

      Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • notestringobligatoriopuede ser null

    Note, e.g. the reason.

• has_morebooleanobligatorio

  Whether another page follows.

• next_cursorstringobligatoriopuede ser null

  Pass as cursor (with the same filters) to get the next page; null on the last page.

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

Create or replace a special day#

post/store/closures

Permiso:

store:write

Plan:

todos los planes

Idempotency-Key

Sets what applies on one date instead of the weekly schedule: closed: true, or hours with that day's windows. A new special day answers 201; one on the same date is replaced and answers 200. Today or later only; at most 60 special days (limit_exceeded). A running pause is not affected. Produces store.updated.

Parámetros

Cuerpoapplication/json

• datestring (date)obligatorio

  Today or later. A date YYYY-MM-DD in the restaurant's time zone.

• closedboolean

  true: closed all day.

• hoursTimeWindow[]

  The windows of that day (one or two).

  max 2 items

  Campos anidados (2)

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• notestring

  Note, e.g. the reason.

  max 140 chars

Respuesta200

A special day on this date was replaced.

• objectstringobligatorio

  Always closure.

  Valores:"closure"

• datestring (date)obligatorio

  The day. A date YYYY-MM-DD in the restaurant's time zone.

• closedbooleanobligatorio

  Closed all day.

• hoursTimeWindow[]obligatorio

  The windows of that day when not closed (at most two).

  Campos anidados (2)

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• notestringobligatoriopuede ser null

  Note, e.g. the reason.

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 409invalid_transition (the status of the object does not allow this), stage_not_used (the restaurant does not use this status), external_id_taken (your app already uses this external_id for another object of the same kind in this restaurant), slot_unavailable (the time or the table is taken), idempotency_in_progress (a request with this Idempotency-Key is still running) or conflict (the same data was changed elsewhere at the same moment, three times in a row; retry unchanged after Retry-After seconds).
• 413payload_too_large: the body is larger than the operation takes, counted in bytes: 64 KB, 2 MB for PUT /menu. Split the request.
• 422idempotency_key_reused (the key was used with a different request) or limit_exceeded (too many entries in one request, such as products in PUT /menu, or a limit of the restaurant is reached, such as 60 special days).
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

Delete a special day#

delete/store/closures/{date}

Permiso:

store:write

Plan:

todos los planes

Removes the special day on this date; the weekly schedule applies again. Produces store.updated.

Parámetros

Respuesta200

OK

• objectstringobligatorio

  Always closure.

  Valores:"closure"

• datestring (date)obligatorio

  The date that was removed. A date YYYY-MM-DD in the restaurant's time zone.

• deletedbooleanobligatorio

  Always true.

  Valores:true

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 404not_found: no such object in this restaurant (objects of other restaurants are never found).
• 409invalid_transition (the status of the object does not allow this), stage_not_used (the restaurant does not use this status), external_id_taken (your app already uses this external_id for another object of the same kind in this restaurant), slot_unavailable (the time or the table is taken), idempotency_in_progress (a request with this Idempotency-Key is still running) or conflict (the same data was changed elsewhere at the same moment, three times in a row; retry unchanged after Retry-After seconds).
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

Pause online ordering#

post/store/pause

Permiso:

store:write

Plan:

todos los planes

Idempotency-Key

Stops new online orders until the given time, exactly like the pause button in the dashboard. A pause always ends by itself; at most 12 hours. Without a body: 30 minutes. Send minutes or until, not both. Produces store.paused.

Parámetros

Cuerpoapplication/json

• minutesinteger

  Pause for this many minutes from now. Default 30.

  1 to 720

• untilstring (date-time)

  Pause until this instant (ISO 8601 with time zone, at most 12 hours ahead). Without a zone: 400.

• notestring

  Reason, shown to guests on the ordering page. Longer than 140 characters answers 400 with param.

  max 140 chars

Respuesta200

OK

• objectstringobligatorio

  Always store.

  Valores:"store"

• idstring (uuid)obligatorio

  The restaurant.

• namestringobligatorio

  Name.

• slugstringobligatorio

  Its address: <slug>.flavoso.com.

• timezonestringobligatorio

  IANA time zone of all local times.

• currencystringobligatorio

  ISO 4217.

• statusstringobligatorio

  Right now: open, closed (outside hours or a closed special day), or paused.

  Valores:"open""closed""paused"

• paused_untilstring (date-time)obligatoriopuede ser null

  End of the running pause; null without one.

• pause_notestringobligatoriopuede ser null

  Reason of the running pause.

• next_opening_atstring (date-time)obligatoriopuede ser null

  Next opening while closed (looks two weeks ahead); null while open.

• preordersbooleanobligatorio

  Guests may order for a later time, also while closed.

• order_typesobjectobligatorio

  Which order types guests can choose.

  Campos anidados (3)

  • pickupbooleanobligatorio

    Pickup.

  • deliverybooleanobligatorio

    Delivery.

  • dine_inbooleanobligatorio

    Ordering at the table via QR code (Pro and up).

• order_statusesstring[]obligatorio

  Statuses this restaurant uses, in order, plus completed and cancelled.

• lead_timesobjectobligatorio

  How long the kitchen needs; the earliest pickup or delivery time.

  Campos anidados (2)

  • pickup_minutesintegerobligatorio

    Minutes until pickup, 0 to 240.

  • delivery_minutesintegerobligatorio

    Minutes until delivery, 0 to 360.

• min_orderintegerobligatorio

  Minimum order value for delivery (0 = none). Integer amount in the smallest currency unit (cents).

• always_openbooleanobligatorio

  No weekly schedule is set: online orders are taken around the clock (special days and pauses still apply) and no reservation times are offered.

• opening_hoursWeekWindow[]obligatorio

  The weekly opening windows; a weekday without windows is closed.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• delivery_hoursWeekWindow[]obligatorio

  Weekly delivery windows; empty means delivery follows opening_hours.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• closuresClosure[]obligatorio

  Upcoming special days (today and later).

  Campos anidados (5)

  • objectstringobligatorio

    Always closure.

    Valores:"closure"

  • datestring (date)obligatorio

    The day. A date YYYY-MM-DD in the restaurant's time zone.

  • closedbooleanobligatorio

    Closed all day.

  • hoursTimeWindow[]obligatorio

    The windows of that day when not closed (at most two).

    Campos anidados (2)

    • openstringobligatorio

      Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

    • closestringobligatorio

      Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • notestringobligatoriopuede ser null

    Note, e.g. the reason.

• contactobjectobligatorio

  Public contact details.

  Campos anidados (3)

  • phonestringobligatoriopuede ser null

    Phone.

  • emailstringobligatoriopuede ser null

    E-mail.

  • websitestringobligatoriopuede ser null

    Website.

• addressobjectobligatoriopuede ser null

  The address as far as it is known. Restaurants type it freely; postal code and city are only split out when a line starts with a postal code.

  Campos anidados (4)

  • linestringobligatoriopuede ser null

    Street and number (or the whole address when it cannot be split).

  • postal_codestringobligatoriopuede ser null

    Postal code, when it can be read from the address.

  • citystringobligatoriopuede ser null

    City, when it can be read from the address.

  • countrystringobligatoriopuede ser null

    ISO 3166-1 alpha-2, as in GET /me.

• locationobjectobligatoriopuede ser null

  Coordinates; null when not set.

  Campos anidados (2)

  • latnumberobligatorio

    Latitude.

  • lonnumberobligatorio

    Longitude.

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 409invalid_transition (the status of the object does not allow this), stage_not_used (the restaurant does not use this status), external_id_taken (your app already uses this external_id for another object of the same kind in this restaurant), slot_unavailable (the time or the table is taken), idempotency_in_progress (a request with this Idempotency-Key is still running) or conflict (the same data was changed elsewhere at the same moment, three times in a row; retry unchanged after Retry-After seconds).
• 413payload_too_large: the body is larger than the operation takes, counted in bytes: 64 KB, 2 MB for PUT /menu. Split the request.
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error

Resume online ordering#

post/store/resume

Permiso:

store:write

Plan:

todos los planes

Idempotency-Key

Lifts a running pause early. Without a running pause there is nothing to do; the store is returned unchanged. Produces store.resumed.

Parámetros

Respuesta200

OK

• objectstringobligatorio

  Always store.

  Valores:"store"

• idstring (uuid)obligatorio

  The restaurant.

• namestringobligatorio

  Name.

• slugstringobligatorio

  Its address: <slug>.flavoso.com.

• timezonestringobligatorio

  IANA time zone of all local times.

• currencystringobligatorio

  ISO 4217.

• statusstringobligatorio

  Right now: open, closed (outside hours or a closed special day), or paused.

  Valores:"open""closed""paused"

• paused_untilstring (date-time)obligatoriopuede ser null

  End of the running pause; null without one.

• pause_notestringobligatoriopuede ser null

  Reason of the running pause.

• next_opening_atstring (date-time)obligatoriopuede ser null

  Next opening while closed (looks two weeks ahead); null while open.

• preordersbooleanobligatorio

  Guests may order for a later time, also while closed.

• order_typesobjectobligatorio

  Which order types guests can choose.

  Campos anidados (3)

  • pickupbooleanobligatorio

    Pickup.

  • deliverybooleanobligatorio

    Delivery.

  • dine_inbooleanobligatorio

    Ordering at the table via QR code (Pro and up).

• order_statusesstring[]obligatorio

  Statuses this restaurant uses, in order, plus completed and cancelled.

• lead_timesobjectobligatorio

  How long the kitchen needs; the earliest pickup or delivery time.

  Campos anidados (2)

  • pickup_minutesintegerobligatorio

    Minutes until pickup, 0 to 240.

  • delivery_minutesintegerobligatorio

    Minutes until delivery, 0 to 360.

• min_orderintegerobligatorio

  Minimum order value for delivery (0 = none). Integer amount in the smallest currency unit (cents).

• always_openbooleanobligatorio

  No weekly schedule is set: online orders are taken around the clock (special days and pauses still apply) and no reservation times are offered.

• opening_hoursWeekWindow[]obligatorio

  The weekly opening windows; a weekday without windows is closed.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• delivery_hoursWeekWindow[]obligatorio

  Weekly delivery windows; empty means delivery follows opening_hours.

  Campos anidados (3)

  • weekdayintegerobligatorio

    0 = Monday … 6 = Sunday.

    0 to 6

  • openstringobligatorio

    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • closestringobligatorio

    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

• closuresClosure[]obligatorio

  Upcoming special days (today and later).

  Campos anidados (5)

  • objectstringobligatorio

    Always closure.

    Valores:"closure"

  • datestring (date)obligatorio

    The day. A date YYYY-MM-DD in the restaurant's time zone.

  • closedbooleanobligatorio

    Closed all day.

  • hoursTimeWindow[]obligatorio

    The windows of that day when not closed (at most two).

    Campos anidados (2)

    • openstringobligatorio

      Opening. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

    • closestringobligatorio

      Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.

      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$

  • notestringobligatoriopuede ser null

    Note, e.g. the reason.

• contactobjectobligatorio

  Public contact details.

  Campos anidados (3)

  • phonestringobligatoriopuede ser null

    Phone.

  • emailstringobligatoriopuede ser null

    E-mail.

  • websitestringobligatoriopuede ser null

    Website.

• addressobjectobligatoriopuede ser null

  The address as far as it is known. Restaurants type it freely; postal code and city are only split out when a line starts with a postal code.

  Campos anidados (4)

  • linestringobligatoriopuede ser null

    Street and number (or the whole address when it cannot be split).

  • postal_codestringobligatoriopuede ser null

    Postal code, when it can be read from the address.

  • citystringobligatoriopuede ser null

    City, when it can be read from the address.

  • countrystringobligatoriopuede ser null

    ISO 3166-1 alpha-2, as in GET /me.

• locationobjectobligatoriopuede ser null

  Coordinates; null when not set.

  Campos anidados (2)

  • latnumberobligatorio

    Latitude.

  • lonnumberobligatorio

    Longitude.

Errores

• 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
• 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
• 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
• 409invalid_transition (the status of the object does not allow this), stage_not_used (the restaurant does not use this status), external_id_taken (your app already uses this external_id for another object of the same kind in this restaurant), slot_unavailable (the time or the table is taken), idempotency_in_progress (a request with this Idempotency-Key is still running) or conflict (the same data was changed elsewhere at the same moment, three times in a row; retry unchanged after Retry-After seconds).
• 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
• 500server_error. Safe to retry with the same Idempotency-Key.

Todos los códigos de error