Changing the Delivery Date at the Courier Service's Request
If it becomes known that an order cannot be delivered to the customer on the date accepted by the courier service's IS when the delivery order was created, the courier service's IS may send a request to change the delivery date to the Gold Apple IS. The delivery order recorded in the Gold Apple IS when the shipment was created is updated automatically (if this is permitted given the current delivery status), and the Gold Apple IS records that it accepted the request.
Send this request in the following cases:
- postponing the delivery date due to logistics constraints or delays;
- a change in delivery timing to a pickup point (PP);
- when delivery can be completed earlier than planned;
- any other changes affecting the planned delivery date of the order.
The request must be sent both when the delivery date is postponed to a later date and when it is moved to an earlier date.
Basic Information
| Request method type | PATCH |
|---|---|
| Path / URL | /api/v1/orders/{orderNumber} |
| Description | Method for changing an order's delivery date information at the courier service's request |
| Direction | The request is executed by the courier service. The response is provided by the Gold Apple IS. |
Request
Header Parameters
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| Authorization | string | 1 | Access token issued by the service | see the Authorization in the Service method |
| content-type | string | 1 | Request content type | Filled in as "application/json" |
Request Path Parameters
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| orderNumber | string | 1 | Order number in the Gold Apple IS | Internal order number in the Gold Apple IS. Tracking number |
Request Parameters
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| deliveryServiceCode | string | 1 | Courier service code | Agreed upon during system integration |
| deliveryDate | date | 1 | Delivery date | Per the "ISO 8601" standard. Format: YYYY-MM-DD |
| deliveryTimeIntervalFrom | date | 1 | Start of delivery interval | Per the "ISO 8601" standard. Format: HH:mm |
| deliveryTimeIntervalTo | date | 1 | End of delivery interval | Per the "ISO 8601" standard. Format: HH:mm |
| dateChangeReason | string | 1 | Reason for the date change | Reason for the delivery date change, free-form string |
Request example
{
"deliveryServiceCode": "CDEK",
"deliveryDate": "2026-03-05T00:00:00Z",
"deliveryTimeIntervalFrom": "10:00",
"deliveryTimeIntervalTo": "12:00",
"dateChangeReason": "Delayed due to logistics constraints, rescheduled to next business day"
}
Response
Response Codes and Messages
| Code | Status | Message | Reason |
|---|---|---|---|
| 200 | OK | Delivery date has been updated | Everything completed successfully. The delivery date was updated in the Gold Apple IS |
| 400 | Bad Request | Missing or inappropriate required parameters | Required parameters are missing or invalid |
| 401 | Unauthorized | Token is invalid | Authentication error at the courier service |
| 403 | Forbidden | Has no permission | Insufficient permissions |
| 500 | Internal Server Error | Server unavailable | The server is unavailable |
Successful Response Parameters
200 OK
Unsuccessful Response Parameters
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| error | string | 1 | Human-readable description of the error | see the "Response Codes and Messages" section |
Unsuccessful response example
{
"error": "Missing or inappropriate required parameters"
}