Courier notifications

Method for sending courier notifications to the Partner.

Request

POST

/notifications/{placeId}

Path parameters

Name

Description

placeId*

Type: string

Unique store identifier in Partner’s system.

Headers

Name

Description

Authorization*

Type: string

Token received in response to the /security/oauth/token request

Body

application/json

{
    "courierName": "John",
    "courierPhone": "+74732006745,12099",
    "orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
    "type": "courier_assigned"
}

Name	Description
orderId*	Type: string Order identifier in the Partner’s system. Free format. UUID4 is recommended. Example: `03d3b69b-331c-4f84-b2c4-888b30320e63`
type*	Type: NotificationType Notification type. Enum: `courier_assigned`, `courier_arrived_to_place`
courierName	Type: string Courier name. For robots, the format is Robot courier [number]. Example: `John`
courierPhone	Type: string Courier phone number (empty field for robots). Example: `+74732006745,12099`

NotificationType

Notification type.

Type	Description
NotificationType	Enum: `courier_assigned`, `courier_arrived_to_place`

Responses

200 OK

Body

application/json

{
    "id": "string",
    "orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
    "type": "courier_assigned"
}

Name	Description
id*	Type: string Notification identifier.
orderId*	Type: string Order identifier in the Partner’s system. Free format. UUID4 is recommended. Example: `03d3b69b-331c-4f84-b2c4-888b30320e63`
type*	Type: NotificationType Notification type. Enum: `courier_assigned`, `courier_arrived_to_place`

400 Bad Request

Request error. The response is expected to contain an array with an error list object.

Body

application/json

[
    {
        "code": 400,
        "description": "Description of error"
    }
]

ErrorItem[]

ErrorItem

Name

Description

code*

Type: integer

Numeric error code agreed with Yango Deli.

Example: 400

description*

Type: string

Error description

Example: Description of error

Was the article helpful?

❗️Order status update initiated by Yango Deli

Opening the robot courier’s hatch