Edits multiple orders

Name

Description

Type: string

Delivery address in text format.

Type: number<float>

Order price in rubles.

Min value: 0

Type: string

Order comments.

Type: string

Recipient's name.

Max length: 1023

Type: string

Customer's number in the delivery company database.

Max length: 128

Type: string

Order description.

Max length: 1023

Type: string

ETA type. Affects the time of notification and automatic delivery detection. arrival_time: countdown starts from the moment the courier arrives at the point; delivery_time: countdown does not start until the start of the delivery window.

Default: null

Type: number<float>

Latitude of the delivery point.

Type: number<float>

Longitude of the delivery point.

Type: number<float>

Radius in meters. If null, depot.mark_delivered_radius or company.mark_delivered_radius is used instead. Order is marked as delivered automatically if mark_delivered_enabled is true and vehicle spent at least mark_delivered_service_time_coefficient * (order.service_duration_s + order.shared_service_duration_s) seconds within mark_delivered_radius meters from the order's location.

Default: null

Min value: 0

Max value: 10000

Type: RouteOrderNotification[]

List of push notification settings.

Type: string

Order number. Used for syncing with the delivery company's system.

Max length: 80

Type: string

Payment status. Possible values:

• paid — The order is already paid.
• unpaid — The order is not paid yet.

Enum: paid, unpaid, null

Type: string

Payment method. Possible values:

• cash — Payment to the courier in cash.
• card — Payment to the courier by bank card.
• prepaid — Prepayment (paid in advance).
• yandex_pay — Payment via Yandex Pay. Can only be set internally.

Enum: cash, card, prepaid, yandex_pay, null

Type: string

The recipient's phone number.

Type: number<float>

Latitude of the real (refined by courier) delivery point.

Type: number<float>

Logitude of the real (refined by courier) delivery point.

Type: integer

Route ID used in requests to the Track & Trace API.

Type: string

Route number. Used for syncing with the delivery company's system. You must specify route_id or route_number in the request to create a new order. If both route_id or route_number are specified route_number is used.

Type: integer

Expected time the courier will need to pass the order to the recipient, including going up to the floor and receiving payment. Default value: 600 seconds.

Type: integer

Service duration at the location, which can be shared with other orders at the same location. Shared service duration can include operations as parking a car, delivering documents, etc. Default value: 0 seconds.

Type: number[]

IDs of the companies that can access the order information. The following information is provided:

• Full information about the order.
• General description of the route this order is a part of.
• General description of the depot used in this order.
• General information about the delivery company (name and logo). If both shared_with_company_numbers and shared_with_company_ids are specified shared_with_company_numbers is used.
  

Type: string[]

Numbers of the companies that can access the order information. The following information is provided:

• Full information about the order.
• General description of the route this order is a part of.
• General description of the depot used in this order.
• General information about the delivery company (name and logo). If both shared_with_company_numbers and shared_with_company_ids are specified shared_with_company_numbers is used.
  

Type: boolean

Show Yandex Pay button.

Type: string

The current order status. Possible values:

• new — The order was created.
• confirmed — The order delivery time was set (confirmed with recipient).
• finished — The order was delivered.
• partially_finished — The order was delivered only partially. Order status can be set to partially_finished only for companies with company.partially_finished_status_enabled flag equals true.
• cancelled — The order was canceled.
• postponed — The order is postponed or the courier couldn't contact the customer.

Type: string

Desired delivery time interval. The following formats are supported:

• "T - T" or "T-T", where T is the time in HH, HH:MM, or HH:MM:SS format.
• ISO 8601, for example, 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00.

Type: string

Type of order. Possible values delivery, pickup, drop_off.

Type: number<float>

Order volume.

Type: number<float>

Order weight.

Name

Description

Type: string

Notification type.

Enum: before_arrival