Broniboy Merchant API (1.0b2b)

Download OpenAPI specification:Download

Авторизация

Для работы с API необходимо получить статичный токен, который передается в заголовке X-App-Token.

Формат ответа

Все успешные ответы имеют следующую структуру:

{
  "success": true,
  "status_code": 200,
  "data": <тело ответа>
}

Все 400 ошибки имеют следующую структуру:

{
  "success": false,
  "status_code": 400,
  "error": {
    "code": 3, // внутренний код ошибки
    "message": "Это поле обязательно.", // Общее описание ошибки, либо текст первой ошибки в поле.
    "dev_err": { // Техническая информация об ошибке, содержит имя поля и список его ошибок
      "comment": [
        "Это поле обязательно."
      ]
    },
  }
}

Все остальные ошибки имеют следующую структуру:

{
  "success": false,
  "status_code": 403,
  "error": {
    "code": 4, // внутренний код ошибки
    "message": "Операция запрещена, переавторизуйтесь", // Общее описание ошибки
    "dev_err": "Токен заблокирован.", Техническая информация об ошибке
  }
}

Заказы

Размещение заказа

Происходит в 2 этапа:

/orders/verify/ - проверка заказа, получение итоговой цены и доступного времени забора заказа
/orders/create/ - создание заказа на выбранное время

Статусы заказа

accepted - Заказ принят
cooking - Заказ готовится
ready - Заказ готов
on_way - Заказ в пути
finished - Заказ завершен
canceled - Заказ отменен

Статусы курьера

courier-not-assigned - Не назначен
courier-assigned - Назначен
courier-accepted - Принял заказ
courier-arrived - Прибыл на точку

Вебхуки

Для получения вебхуков о смене статуса заказа / курьера, необходимо предоставить url для их отправки.

URL для вебхуков должен:

принимать POST запрос
проверять целостность запроса с использованием HMAC

Если код ответа на вызов вебхука не равен 200, то будет совершено еще несколько попыток вызова вебхука.

Формат запроса

Заголовки:

Hook-Event - имя события
Hook-Delivery - Id запроса, может быть использован для реализации идемпотентности.
Hook-HMAC - подпись для проверки целостности запроса. Для проверки подписи нужно вычислить HMACSHA256 для содержимого поля data.

Тело запроса:

{
  "event": "order.changed",
  "data": {} // данные о заказе
}

Authentication

MerchantUserToken

Security Scheme Type	API Key
Header parameter name:	X-Auth-Token

MerchantAppToken

Security Scheme Type	API Key
Header parameter name:	X-App-Token

New B2B Order

Создание B2B заказа

Проверка заказа

Authorizations:

MerchantUserToken

MerchantAppToken

Request Body schema: application/json

required	object (PickupCreate) Время/место забора заказа. Одно из полей `place` или `external_place` является обязательным.
payment_type required	string (MerchantB2BPaymentType) Enum: "cash" "b2b_account" Способ оплаты. `cash` - наличными `b2b_account` - по счету
required	Array of objects (DropOffList) 1 items [ items ] Список адресов доставки. Текущая версия API поддерживает только один адрес.

Responses

Request samples

Payload

Content type

application/json

{"pickup": {"place": "eb3b595d-3653-41a3-a531-ebeba332154c",
"external_place": 123,
"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"time": "2020-01-31T12:00:00+03:00"
},
"payment_type": "cash",
"drop_off": [{"external_order_id": "string",
"client_phone": "+71234567890",
"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"delivery_interval": ["2020-01-31T12:00:00+03:00",
"2020-01-31T13:00:00+03:00"
],
"contents": "string",
"items": [{"item": {"external_id": 123,
"name": "Бургер",
"price": 100
},
"quantity": 1
}
],
"buyout_amount": 1000,
"taking_amount": 1000
}
]
}

Response samples

200
default

Content type

application/json

{"order": {"price": 1000,
"final_price": 1200,
"payment_type": "cash",
"pickup": {"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"time": "2020-01-31T12:00:00+03:00"
},
"drop_off": [{"external_order_id": "string",
"client_phone": "+71234567890",
"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"delivery_interval": ["2020-01-31T12:00:00+03:00",
"2020-01-31T13:00:00+03:00"
],
"contents": "string",
"items": [{"item": {"external_id": 123,
"name": "Бургер",
"price": 100
},
"quantity": 1
}
],
"buyout_amount": 1000,
"taking_amount": 1000
}
]
},
"available_payment_types": ["cash"
],
"available_pickup_times": [{"date": "2020-01-31",
"times": [{"time": "2020-01-31T13:00:00+03:00",
"price": 100
}
]
}
]
}

Создание заказа

Authorizations:

MerchantUserToken

MerchantAppToken

Request Body schema: application/json

required	object (PickupCreate) Время/место забора заказа. Одно из полей `place` или `external_place` является обязательным.
payment_type required	string (MerchantB2BPaymentType) Enum: "cash" "b2b_account" Способ оплаты. `cash` - наличными `b2b_account` - по счету
required	Array of objects (DropOffList) 1 items [ items ] Список адресов доставки. Текущая версия API поддерживает только один адрес.

Responses

Request samples

Payload

Content type

application/json

{"pickup": {"place": "eb3b595d-3653-41a3-a531-ebeba332154c",
"external_place": 123,
"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"time": "2020-01-31T12:00:00+03:00"
},
"payment_type": "cash",
"drop_off": [{"external_order_id": "string",
"client_phone": "+71234567890",
"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"delivery_interval": ["2020-01-31T12:00:00+03:00",
"2020-01-31T13:00:00+03:00"
],
"contents": "string",
"items": [{"item": {"external_id": 123,
"name": "Бургер",
"price": 100
},
"quantity": 1
}
],
"buyout_amount": 1000,
"taking_amount": 1000
}
]
}

Response samples

200
default

Content type

application/json

{"price": 1000,
"final_price": 1200,
"payment_type": "cash",
"pickup": {"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"time": "2020-01-31T12:00:00+03:00"
},
"drop_off": [{"external_order_id": "string",
"client_phone": "+71234567890",
"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"delivery_interval": ["2020-01-31T12:00:00+03:00",
"2020-01-31T13:00:00+03:00"
],
"contents": "string",
"items": [{"item": {"external_id": 123,
"name": "Бургер",
"price": 100
},
"quantity": 1
}
],
"buyout_amount": 1000,
"taking_amount": 1000
}
],
"id": "eb3b595d-3653-41a3-a531-ebeba332154c",
"state": "finished",
"courier_state": "courier-assigned",
"number": 123,
"couriers": [{"name": "Иван И.",
"location": {"longitude": 38.967087,
"latitude": 45.020582
}
}
]
}

B2B Orders

Работа с B2B заказами

Список заказов

Authorizations:

MerchantUserToken

MerchantAppToken

query Parameters

limit	integer [ 0 .. 100 ] Default: 20 Example: limit=20 Паджинация. Кол-во возвращаемых объектов.
offset	integer >= 0 Default: 0 Example: offset=20 Паджинация. Смещение.
order_id	string <uuid> Example: order_id=eb3b595d-3653-41a3-a531-ebeba332154c Id заказа в системе Broniboy. Можно передать несколько значений. `order_id=<id1>&order_id=<id2>`. Нужно помнить про ограничение длины URL, если планируется передавать много значений разом.
states	string (MerchantB2BOrderState) Enum: "accepted" "cooking" "ready" "on_way" "finished" "canceled" Example: states=finished Статус заказа в системе Broniboy. Можно передать несколько значений. `states=<state1>&states=<state2>`.

Responses

Response samples

200
default

Content type

application/json

[{"price": 1000,
"final_price": 1200,
"payment_type": "cash",
"pickup": {"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"time": "2020-01-31T12:00:00+03:00"
},
"drop_off": [{"external_order_id": "string",
"client_phone": "+71234567890",
"address": {"longitude": 38.967087,
"latitude": 45.020582,
"address": "ул. Рашпилевская, д. 22",
"flat": 10,
"floor": 2,
"delivery_comment": "позвонить, когда курьер прибудет на место",
"entrance": 3,
"access_code_entrance": 1234
},
"delivery_interval": ["2020-01-31T12:00:00+03:00",
"2020-01-31T13:00:00+03:00"
],
"contents": "string",
"items": [{"item": {"external_id": 123,
"name": "Бургер",
"price": 100
},
"quantity": 1
}
],
"buyout_amount": 1000,
"taking_amount": 1000
}
],
"id": "eb3b595d-3653-41a3-a531-ebeba332154c",
"state": "finished",
"courier_state": "courier-assigned",
"number": 123,
"couriers": [{"name": "Иван И.",
"location": {"longitude": 38.967087,
"latitude": 45.020582
}
}
]
}
]

Отмена заказа

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

order_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Id заказа в системе Broniboy

Request Body schema: application/json

comment	string <= 256 characters Причина отмены в свободной форме.
reason required	string Enum: "long_waiting" "expensive" "other" Причина отмены. `long_waiting` - Долго ждать курьера `expensive` - У другого сервиса дешевле `other` - Другое

Responses

Request samples

Payload

Content type

application/json

{"comment": "Передумали.",
"reason": "expensive"
}

Response samples

default

Content type

application/json

{"success": false,
"status_code": 429,
"error": {"code": 1000,
"message": "string"
}
}

Merchant Places

Работа с Точками

Summary of places with multiple networks

Authorizations:

MerchantUserToken

MerchantAppToken

query Parameters

o	string Example: o=id&o=-id&o=created,id Сортировка

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"address": "Москва, ул. Уличная, д. 9",
"current_shift_state": { },
"active_orders_amount": 0,
"network": {"slug": "roga-i-kopita",
"name": "Рога и Копыта"
}
}
]

List Places with legal info

Authorizations:

MerchantUserToken

MerchantAppToken

Responses

Response samples

200

Content type

application/json

[{"id": "7ead94ee-47e5-4099-92a6-e223c7f1580f",
"name": "Рога и Копыта",
"slug": "roga-i-kopita",
"address": "ул. Уличная, д. 9",
"latitude": "45.020997",
"longitude": "38.967228",
"city": {"id": "7ead94ee-47e5-4099-92a6-e223c7f1580f",
"name": "Краснодар",
"domain": "krasnodar"
},
"contract": {"type": "Агентский договор (Партнёры)",
"number": "2018-82",
"date": "2018-02-15",
"payment_account": {"bik": "040349700",
"bank": "ПАО БАНК УРАЛСИБ",
"bank_city": "г. Краснодар",
"correspondent_account": "30101810400000000700",
"account": "40702810300000007249"
},
"legal_entity": {"name": "ООО ТВК-Р",
"entity_type": "ООО",
"inn": "2310123447",
"kpp": "231001001",
"ogrn": "1072310005426",
"tax_system": "НДС чека по ставке 20%",
"tax_system_type": "Общая",
"executive_position": "Директор",
"executive_fullname": "Иванов Иван Иванович",
"actual_address": "г. Краснодар, ул. Ставропольская, д. 213",
"legal_address": "г. Краснодар, ул. Красная, д. 202"
},
"service_legal_entity": {"name": "ООО ТВК-Р",
"entity_type": "ООО",
"inn": "2310123447",
"kpp": "231001001",
"ogrn": "1072310005426",
"tax_system": "НДС чека по ставке 20%",
"tax_system_type": "Общая",
"executive_position": "Директор",
"executive_fullname": "Иванов Иван Иванович",
"actual_address": "г. Краснодар, ул. Ставропольская, д. 213",
"legal_address": "г. Краснодар, ул. Красная, д. 202"
}
},
"contract_b2b": {"type": "Агентский договор (Партнёры)",
"number": "2018-82",
"date": "2018-02-15",
"payment_account": {"bik": "040349700",
"bank": "ПАО БАНК УРАЛСИБ",
"bank_city": "г. Краснодар",
"correspondent_account": "30101810400000000700",
"account": "40702810300000007249"
},
"legal_entity": {"name": "ООО ТВК-Р",
"entity_type": "ООО",
"inn": "2310123447",
"kpp": "231001001",
"ogrn": "1072310005426",
"tax_system": "НДС чека по ставке 20%",
"tax_system_type": "Общая",
"executive_position": "Директор",
"executive_fullname": "Иванов Иван Иванович",
"actual_address": "г. Краснодар, ул. Ставропольская, д. 213",
"legal_address": "г. Краснодар, ул. Красная, д. 202"
},
"service_legal_entity": {"name": "ООО ТВК-Р",
"entity_type": "ООО",
"inn": "2310123447",
"kpp": "231001001",
"ogrn": "1072310005426",
"tax_system": "НДС чека по ставке 20%",
"tax_system_type": "Общая",
"executive_position": "Директор",
"executive_fullname": "Иванов Иван Иванович",
"actual_address": "г. Краснодар, ул. Ставропольская, д. 213",
"legal_address": "г. Краснодар, ул. Красная, д. 202"
}
},
"contracts": [{"title": "Договор",
"values": [{"title": "Номер договора",
"value": 123456789
}
]
}
],
"terms": [{"type": "Доставка Broniboy",
"details": ["Оплата онлайн: комиссия сервиса 30%"
]
}
]
}
]

Merchant Place Schedule

Работа с временем работы Точки

Get workload info

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

place_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Id Точки в системе Broniboy

Responses

Response samples

200

Content type

application/json

{"state": "default",
"reset_state_after": "2020-08-18T23:01:00+03:00",
"cooking_time_minutes_default": 30,
"cooking_time_minutes_medium": 30,
"cooking_time_minutes_high": 30,
"allowed_intervals": [30,
60,
120
]
}

Change workload

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

place_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Id Точки в системе Broniboy

Request Body schema: application/json

state required	string Enum: "pause" "default" "medium" "high"
reset_after_minutes	number <int> [ 30 .. 120 ] Do not send this field to change state until next day

Responses

Request samples

Payload

Content type

application/json

{"state": "default",
"reset_after_minutes": 30
}

Response samples

200

Content type

application/json

{"state": "default",
"reset_state_after": "2020-08-18T23:01:00+03:00",
"cooking_time_minutes_default": 30,
"cooking_time_minutes_medium": 30,
"cooking_time_minutes_high": 30,
"allowed_intervals": [30,
60,
120
]
}

Get schedule

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

place_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Id Точки в системе Broniboy

Responses

Response samples

200

Content type

application/json

[[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
]
]

Change schedule

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

place_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Id Точки в системе Broniboy

Request Body schema: application/json

Array (7 items)

Array

Array (2 items)

string <time>

Responses

Request samples

Payload

Content type

application/json

[[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
]
]

Response samples

200

Content type

application/json

[[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
],
[["10:00:00",
"10:00:00"
]
]
]

Get schedule overrides for Place

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

place_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Id Точки в системе Broniboy

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period": ["2019-08-24",
"2019-08-24"
],
"interval": ["14:15:22Z",
"14:15:22Z"
],
"is_day_off": true
}
]

Create schedule override

Authorizations:

MerchantUserToken

MerchantAppToken

Request Body schema: application/json

place required	string <uuid>
period required	Array of strings <date> 2 items
interval	Array of strings <time> 2 items
is_day_off	boolean

Responses

Request samples

Payload

Content type

application/json

{"place": "8d7f62ba-14c9-4fb2-8bc8-87d23513fd8e",
"period": ["2019-08-24",
"2019-08-24"
],
"interval": ["14:15:22Z",
"14:15:22Z"
],
"is_day_off": true
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period": ["2019-08-24",
"2019-08-24"
],
"interval": ["14:15:22Z",
"14:15:22Z"
],
"is_day_off": true
}

Get schedule override

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

schedule_override_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period": ["2019-08-24",
"2019-08-24"
],
"interval": ["14:15:22Z",
"14:15:22Z"
],
"is_day_off": true
}

Change schedule override

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

schedule_override_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Request Body schema: application/json

place required	string <uuid>
period required	Array of strings <date> 2 items
interval	Array of strings <time> 2 items
is_day_off	boolean

Responses

Request samples

Payload

Content type

application/json

{"place": "8d7f62ba-14c9-4fb2-8bc8-87d23513fd8e",
"period": ["2019-08-24",
"2019-08-24"
],
"interval": ["14:15:22Z",
"14:15:22Z"
],
"is_day_off": true
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"period": ["2019-08-24",
"2019-08-24"
],
"interval": ["14:15:22Z",
"14:15:22Z"
],
"is_day_off": true
}

Delete schedule override

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

schedule_override_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Responses

Merchant Orders

Работа с заказами

Order details

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

order_id

required

string <uuid>

Example: eb3b595d-3653-41a3-a531-ebeba332154c

Id заказа в системе Broniboy

Responses

Response samples

200

Content type

application/json

{"comment": "string",
"delivery_type": "string",
"tasks": ["string"
],
"is_service_delivery": true,
"from_address": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_address_id": "42779c56-a6ff-4acb-b570-797130184ba3",
"longitude": 0,
"latitude": 0,
"address": "string",
"flat": "string",
"floor": "string",
"entrance": "string",
"access_code_entrance": "string",
"phone": "string",
"name": "string",
"delivery_comment": "string"
},
"asap": true,
"price": 0,
"currency": "RUB",
"number": "string",
"full_price": 0,
"has_review": true,
"services": [{"id": "string",
"service": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"place_id": "f0968ed8-288a-49fe-ae98-74c720303b1b",
"description": "string",
"base_unit_price": "115 ₽ за 100 г.",
"composition": "1 мягкая булочка, 1 сочная котлета, 1 листик салата",
"purpose": "Быстро утолить голод",
"storage_requirements": "Хранить в прохладном тёмном месте",
"expires_in": "3 дня",
"vendor_country": "Россия",
"package_info": "Упаковочная пленка",
"photo": {"property1": "string",
"property2": "string"
},
"use_points": true,
"price": 0,
"currency": "RUB",
"discounted_price": 0,
"amount": 0,
"measure": "string",
"nutrition": {"calories": 0,
"protein": 0,
"fat": 0,
"carbohydrate": 0
},
"nutrition_per_serving": {"calories": 0,
"protein": 0,
"fat": 0,
"carbohydrate": 0
},
"measure_value": 1000,
"measure_unit": "gram",
"measure_quantum": 0.05,
"measure_by_weight": false,
"addon_types": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"is_required": true,
"type": "string",
"addons": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"price": 0,
"currency": "RUB"
}
]
}
],
"is_available": true
},
"count": 0,
"initial_count": 0,
"description": "string",
"price": 0,
"currency": "RUB",
"addons": [{"id": "string"
}
],
"categories": ["string"
]
}
],
"delivery": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_address_id": "42779c56-a6ff-4acb-b570-797130184ba3",
"longitude": 0,
"latitude": 0,
"address": "string",
"flat": "string",
"floor": "string",
"entrance": "string",
"access_code_entrance": "string",
"phone": "string",
"name": "string",
"delivery_comment": "string"
},
"to_address": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_address_id": "42779c56-a6ff-4acb-b570-797130184ba3",
"longitude": 0,
"latitude": 0,
"address": "string",
"flat": "string",
"floor": "string",
"entrance": "string",
"access_code_entrance": "string",
"phone": "string",
"name": "string",
"delivery_comment": "string"
},
"change_amount": 0,
"guest_count": 0,
"display_date_short": "string",
"id": "string",
"business_type": "string",
"order_type": "string",
"cancellable": true,
"payment_binding": "string",
"display_date_full": "string",
"state": "created",
"points": 0,
"date_of_visit": "01.01.2021 13:21:00",
"date_of_visit_iso": "2021-06-17T17:49:24+03:00",
"final_price": 0,
"services_text": "string",
"date_of_pickup": "01.01.2021 13:21:00",
"date_of_pickup_iso": "2021-06-17T17:49:24+03:00",
"payment_type": "card-online",
"merchant_order_state": "created",
"merchant_delivery_type": "Доставка Broniboy",
"merchant_list_title": "#123",
"merchant_price": 0,
"result_tags": [{"name": "string",
"text_color": "string",
"bg_color": "string"
}
],
"terminal_state": {"bookkeeping_merchant_terminal_state": "string",
"bookkeeping_merchant_terminal_state_at": "2019-08-24T14:15:22Z",
"merchant_terminal_state": "string",
"merchant_terminal_state_at": "2019-08-24T14:15:22Z"
},
"group_name": "string"
}

Orders list

Authorizations:

MerchantUserToken

MerchantAppToken

path Parameters

state

required

string

Enum: "active" "history"

active - created, accepted, on_way, cooking, ready, picking_up_order,

history - on_way (only if is_service_delivery=true and not b2b), finished, canceled, canceled_place, canceled_bb,

query Parameters

date_after	string <date>
date_before	string <date>
place	string <uuid>

Responses

Response samples

200

Content type

application/json

[{"comment": "string",
"delivery_type": "string",
"tasks": ["string"
],
"is_service_delivery": true,
"from_address": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_address_id": "42779c56-a6ff-4acb-b570-797130184ba3",
"longitude": 0,
"latitude": 0,
"address": "string",
"flat": "string",
"floor": "string",
"entrance": "string",
"access_code_entrance": "string",
"phone": "string",
"name": "string",
"delivery_comment": "string"
},
"asap": true,
"price": 0,
"currency": "RUB",
"number": "string",
"full_price": 0,
"has_review": true,
"services": [{"id": "string",
"service": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"place_id": "f0968ed8-288a-49fe-ae98-74c720303b1b",
"description": "string",
"base_unit_price": "115 ₽ за 100 г.",
"composition": "1 мягкая булочка, 1 сочная котлета, 1 листик салата",
"purpose": "Быстро утолить голод",
"storage_requirements": "Хранить в прохладном тёмном месте",
"expires_in": "3 дня",
"vendor_country": "Россия",
"package_info": "Упаковочная пленка",
"photo": {"property1": "string",
"property2": "string"
},
"use_points": true,
"price": 0,
"currency": "RUB",
"discounted_price": 0,
"amount": 0,
"measure": "string",
"nutrition": {"calories": 0,
"protein": 0,
"fat": 0,
"carbohydrate": 0
},
"nutrition_per_serving": {"calories": 0,
"protein": 0,
"fat": 0,
"carbohydrate": 0
},
"measure_value": 1000,
"measure_unit": "gram",
"measure_quantum": 0.05,
"measure_by_weight": false,
"addon_types": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"is_required": true,
"type": "string",
"addons": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"price": 0,
"currency": "RUB"
}
]
}
],
"is_available": true
},
"count": 0,
"initial_count": 0,
"description": "string",
"price": 0,
"currency": "RUB",
"addons": [{"id": "string"
}
],
"categories": ["string"
]
}
],
"delivery": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_address_id": "42779c56-a6ff-4acb-b570-797130184ba3",
"longitude": 0,
"latitude": 0,
"address": "string",
"flat": "string",
"floor": "string",
"entrance": "string",
"access_code_entrance": "string",
"phone": "string",
"name": "string",
"delivery_comment": "string"
},
"to_address": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_address_id": "42779c56-a6ff-4acb-b570-797130184ba3",
"longitude": 0,
"latitude": 0,
"address": "string",
"flat": "string",
"floor": "string",
"entrance": "string",
"access_code_entrance": "string",
"phone": "string",
"name": "string",
"delivery_comment": "string"
},
"change_amount": 0,
"guest_count": 0,
"display_date_short": "string",
"id": "string",
"business_type": "string",
"order_type": "string",
"cancellable": true,
"payment_binding": "string",
"display_date_full": "string",
"state": "created",
"points": 0,
"date_of_visit": "01.01.2021 13:21:00",
"date_of_visit_iso": "2021-06-17T17:49:24+03:00",
"final_price": 0,
"services_text": "string",
"date_of_pickup": "01.01.2021 13:21:00",
"date_of_pickup_iso": "2021-06-17T17:49:24+03:00",
"payment_type": "card-online",
"merchant_order_state": "created",
"merchant_delivery_type": "Доставка Broniboy",
"merchant_list_title": "#123",
"merchant_price": 0,
"result_tags": [{"name": "string",
"text_color": "string",
"bg_color": "string"
}
],
"terminal_state": {"bookkeeping_merchant_terminal_state": "string",
"bookkeeping_merchant_terminal_state_at": "2019-08-24T14:15:22Z",
"merchant_terminal_state": "string",
"merchant_terminal_state_at": "2019-08-24T14:15:22Z"
},
"group_name": "string"
}
]