Edits multiple couriers

  1. HTTP Request
  2. Path Parameters
  3. Request Body
    1. Representation
    2. Fields

Adds information about new couriers to the database or updates information about existing ones if their numbers match.

HTTP Request

POST https://courier.yandex.ru/api/v1/companies/{company_id}/couriers-batch

Path Parameters

company_id *

integer

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

company_id *

integer

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

Request Body

[
  {
    "company_id": integer,
    "id": integer,
    "name": string,
    "number": string,
    "phone": string,
    "sms_enabled": boolean
  }
]
Copied to clipboard

Representation

Collapse all
Expand all

Fields

company_id

integer

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

id

integer

Mobile employee ID used in requests to the Track & Trace API.

name

string

Name of the courier.

number

string

Mobile employee number that matches the number in the delivery company's system.

phone

string

Mobile employee's phone number in +7XXXXXXXXXX format. You can only enter one phone number for each courier.

sms_enabled

boolean

Indicates whether clients are notified via SMS. The true value means that an SMS notification is sent for orders delivered by this mobile employee.

company_id

integer

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

id

integer

Mobile employee ID used in requests to the Track & Trace API.

name

string

Name of the courier.

number

string

Mobile employee number that matches the number in the delivery company's system.

phone

string

Mobile employee's phone number in +7XXXXXXXXXX format. You can only enter one phone number for each courier.

sms_enabled

boolean

Indicates whether clients are notified via SMS. The true value means that an SMS notification is sent for orders delivered by this mobile employee.