Changing the Delivery Date at Gold Apple's Request
If it becomes known that an order cannot be accepted by the customer on the date specified when the order was created, or in any other case requiring a change to the delivery date, the Gold Apple IS may send a request to change the delivery date for a shipment that has already been created. The delivery order created in the courier service IS is updated automatically (if this is permitted given the current delivery status), and the courier service IS records that it accepted the request. The endpoint must be published over the secure HTTPS protocol.
Basic Information
| Request method type | PATCH |
|---|---|
| Path / URL | /api/v1/orders/{orderNumber} |
| Description | Method for changing an order's planned delivery date at Gold Apple's request. |
| Direction | The request is executed by the Gold Apple IS. The response is provided by the courier service. |
Request
Header Parameters
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| Authorization | string | 1 | Access token obtained during authorization. Passed in the format Bearer <access_token> | The format is defined by the courier service (see Authorization in the ECS Service) |
| content-type | string | 1 | Request content type | Filled in as "application/json" |
Path Parameters
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| orderNumber | string | 1 | Gold Apple order number | Internal order number in the Gold Apple IS. Tracking number. |
Request Parameters
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| deliveryDate | date | 1 | Delivery date | Per the "ISO 8601" standard, UTC0. Format: YYYY-MM-DD |
| deliveryTimeIntervalFrom | date | 1 | Start of delivery interval | Per the "ISO 8601" standard, UTC0. Format: HH:mm |
| deliveryTimeIntervalTo | date | 1 | End of delivery interval | Per the "ISO 8601" standard, UTC0. Format: HH:mm |
Request example
{
"deliveryDate": "2026-03-05T00:00:00Z",
"deliveryTimeIntervalFrom": "10:00",
"deliveryTimeIntervalTo": "12:00"
}
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 courier service's IS |
| 400 | Bad Request | Missing or inappropriate required parameters | Required parameters are missing or invalid. The response body must list the names of the fields that failed validation, in an arbitrary string format. |
| 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 |
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": "Token is invalid"
}