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. Example: `` |
Headers
|
Name |
Description |
|
Authorization |
Type: string Token received in response to the Example: `` |
Body
application/json
{
"courierName": "John",
"courierPhone": "+74732006745,12099",
"orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
"type": "courier_assigned"
}
|
Name |
Description |
|
orderId |
Type: OrderId Order identifier in the Partner’s system. Free format. UUID4 is recommended. Example: |
|
type |
Type: NotificationType Notification type. Enum: |
|
courierName |
Type: string Courier name. For robots, the format is Robot courier [number]. Example: |
|
courierPhone |
Type: string Courier phone number (empty field for robots). Example: |
OrderId
Order identifier in the Partner’s system. Free format. UUID4 is recommended.
Type: string
Example: 03d3b69b-331c-4f84-b2c4-888b30320e63
NotificationType
Notification type.
Type: string
Enum: courier_assigned, courier_arrived_to_place
Responses
200 OK
OK
Body
application/json
{
"id": "example",
"orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
"type": "courier_assigned"
}
|
Name |
Description |
|
id |
Type: string Notification identifier. Example: |
|
orderId |
Type: OrderId Order identifier in the Partner’s system. Free format. UUID4 is recommended. Example: |
|
type |
Type: NotificationType Notification type. Enum: |
400 Bad Request
Request error. The response is expected to contain an array with an error list object.
ErrorItem
|
Name |
Description |
|
code |
Type: integer Numeric error code agreed with Yango Deli. |
|
description |
Type: string Error description Example: |
Example
{
"code": 400,
"description": "Description of error"
}