DELETE v3/orderItems/:id
DELETE/v3/orderItems
Cancel an order item, or as much of it as has not shipped yet.
Invoking this endpoint will cause the server to make an effort to cancel an orderItem. This may succeed when there are no shipments fulfilling the orderItem yet. Otherwise the cancellation will be at best partially successfull. Depending on the outcome the server response will be (sligtly) different as outlined below
Responses
Partial or Complete Cancellation
If the orderItem was partially or completely cancelled (for example, if it was already partially fulfilled), the server will respond with a field meta.modified attribute set to true. This indicates that the orderItem was modified. If the value of the quantity attribute equals zero then the orderItem was successfully cancelled. Otherwise, when the value is larger than zero, the orderItem was partially cancelled.
No Change
If the orderItem could not be cancelled, because it has already been fulfilled, the server will still respond also with a 200: OK. However, the attribute meta.modified will be set to false, indicating that the orderItem was not modified as a result of this request.
Responses
- 200
- 401
- 403
- 404
- 406
- 409
- 415
Response
401 Unauthorized
A 401 Unauthorized response occurs when attempting to access a resource or perform an action that requires authentication, but no valid credentials have been provided. It indicates that the requester is unauthorized to access the requested resource.
The following are common scenarios that may lead to a 401 Unauthorized response:
- Attempting to access a protected API endpoint without providing authentication credentials.
- Providing an invalid or expired authentication token.
- Providing valid authentication credentials, but lacking sufficient privileges to access the requested resource.
- Providing authentication credentials that are valid for a different resource or API endpoint than the one being requested.
403 Forbidden
The HTTP 403 Forbidden client error response status code indicates that the server understood the request but refused to process it. This status is similar to 401 Unauthorized, except that for 403 Forbidden responses, authenticating or re-authenticating makes no difference. The request failure is tied to application logic, such as insufficient permissions to a resource or action.
404 Not Found
A 404 Not Found response occurs when attempting to access a resource that cannot be found on the server. It indicates that the requested resource does not exist, either because it has been deleted, the URL is incorrect or because the endpoint has not been realized.
The following are common scenarios that may lead to a 404 Not Found response:
- Attempting to access an endpoint with an invalid or non-existent URL.
- Attempting to access an endpoint that has not (yet) been realized
- Requesting a resource that has been deleted or moved.
406 Not Acceptable
A 406 Not Acceptable response occurs when the server cannot provide a response that matches the client's requested format or content language for the requested resource. For instance, if a client sends an Accept header of text/html to an API endpoint that only supports application/json responses, the server would respond with a 406 Not Acceptable status code. This type of response is a required response for JSON:API compatible endpoints.
409 Conflict
A 409 Conflict response occurs when attempting to perform an action that conflicts with the current state of a resource on the server. It indicates that the requested action cannot be completed due to a conflict between the provided information and the current state of the resource.
415 Unsupported Media Type
A 415 Unsupported Media Type response occurs when the server cannot process the request because the media type specified in the request is not supported for the requested resource. For example, if a client sends a request with a Content-Type header of application/pdf to an API endpoint that only supports application/json (the only valid media type for JSON:API), the server would respond with a 415 Unsupported Media Type status code. This type of error-response is a required for JSON:API compatible endpoints.