Mark order items as cancelled
PUT/financing/v1/applications/:applicationId/order/cancel
When some or all order items were cancelled (won't be ever delivered), use /financing/v1/applications/{applicationId}/order/cancel resource where {applicationId} is the application ID you received in the response of /financing/v1/applications after its creation.
⚠️ If you want to cancel some items after marking those items as sent or delivered, use Mark order items as returned operation.
📘 For additional examples and more information, please refer to the Technical guide: Manage your orders.
| Financing type | Supported |
|---|---|
DEFERRED_PAYMENT | YES |
PAY_IN_THREE | YES |
| Application state | Availability |
|---|---|
PROCESSING | NO |
REJECTED | NO |
CANCELLED | NO |
READY | YES |
Use /financing/v1/applications/{applicationId}/order/cancel resource with an empty request to cancel all order items (the whole order) at once.
If you want to cancel specific order item/s, use /financing/v1/applications/{applicationId}/order/cancel resource with properly filled request that contains cancelled order items info. In this case request should contain array of cancelled order items with one or more particular order item identificators (code/EAN/name/type) - code, ean, name and type is used for identifying order item sent in Create application.
💡 TIP: Use an empty request if marking last (those not yet not marked) item(s) on order as cancelled.
⚠️ If multiple properties (
code,ean,nameortype) are used for identifying some order item, it all must exact match the item data.
If the request was successfully processed, you receive HTTP status code 200 and object of information about changed order plus basic information about respective application (ID, state, substate).
In other cases, you may receive errors similar to the following ones:
| Status code | Code | Explanation |
|---|---|---|
| 400 | INVALID_REQUEST | Request was not well formatted (malformed request syntax, size too large, etc.) |
| 404 | OBJECT_NOT_FOUND | The requested resource could not be found |
| 422 | NOT_SUPPORTED | Resource is not supported for given financing type |
System notification. Some or all of the order items were cancelled. Based on application financing type and partner setting, credit note may be issued.
Request
Responses
- 200
- 422
Some order items or the whole order was cancelled
Order items can not be canceled.