Deletes courier

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields

Deletes information about the specified courier from the database.

HTTP Request

DELETE https://courier.yandex.ru/api/v1/companies/{company_id}/couriers/{courier_id}\
?shallow_delete={boolean}

Path Parameters

company_id *

integer

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

courier_id *

integer

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

company_id *

integer

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

courier_id *

integer

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

Query Parameters

shallow_delete

boolean

If true marks courier as deleted, no dependency affected.

shallow_delete

boolean

If true marks courier as deleted, no dependency affected.

Responses

Code 200

Information about the courier is deleted.

{
  "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.