Request to Reverse a Cancellation
If a cancellation request (see Order Cancellation at the Courier Service's Request) was sent by the courier service by mistake, or the courier service is ready to resume delivery to the customer for any other reason within 48 hours after the order was marked for cancellation, the courier service's IS may send a request to reverse a cancellation to the Gold Apple IS. When this request is executed, the cancellation mark is automatically removed from the order and the courier service can resume delivery and send order statuses as normal.
The courier service may also send a request to reverse a cancellation for an order for which a cancellation was previously initiated at Gold Apple's request (see Order Cancellation at Gold Apple's Request) within 48 hours of receiving the request. When this request is executed, the cancellation mark is automatically removed from the order and the courier service can resume delivery and send order statuses as normal.
When using this method, the previously sent cancellation status must be excluded from the order's status history in order to avoid logical gaps in the status history.
Please note that the specified time period (48 hours) depends on the terms of the service agreement concluded between Gold Apple and the Courier Service.
Basic Information
| Request method type | POST |
|---|---|
| Path / URL | /api/v1/orders/{orderNumber}/reopen |
| Description | Method for returning an order to processing after cancellation |
| 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 |
|---|---|---|---|---|
| comment | string | 1 | Comment on the request to reverse a cancellation | Human-readable comment, free-form string |
Request example
{
"comment": "Cancellation withdrawn, delivery will proceed as planned"
}
Response
Response Codes and Messages
| Code | Status | Message | Reason |
|---|---|---|---|
| 200 | OK | Order has been reopened | Everything completed successfully. The order was marked for cancellation 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": "Invalid request format"
}