Content
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Use of Service
Cancel API is used to cancel a shipment before the shipment is in transit (has arrived in the value chain). The cancellation applies to all items in a shipment.
The shipment will be defined as in transit from the day before desired delivery date. Shipment without desired delivery date will be in transit immediately after booking.
...
Successful cancellation will set eventlog API key 71, 60 or 73.
Even with successful cancelation there will be corner cases where the carrier will try to deliver/pick up the parcel, this is because the distribution can override and/or start their distribution outside of times defined by them in the system.
Since pick-up shipments (C2C/C2B) do not arrive in the value chain before they are actually picked up, more flexibility is available.
Pick-up shipments have a later cut off for cancellation, usually until 23:00 p.m. the day before pick-up. This depends on geography and carrier, contact your carrier for exact details.
Pick-up shipments can also be canceled if the pick-up attempt failed
...
The user is a web service user
The user has access to the web service for edit orders
The user has access to the shop registered on the parcel
Limitations
Please note that this API is created for handling parcels delivered by distributors using the EDG or Buddy application. The solution currently does not support parcels delivered by the Plan&Go application.
Environments / Endpoints
Consider using the TEST-endpoint wile developing your system. By doing this you ensure that your test-data will not pollute any potential external systems.
...
HTTP Status code | Text | Description |
|---|---|---|
400 | Client or Validation Error | The request body/query string is not in the correct format. |
401 | Authentication Failure | Indicates that the Authorization header is either missing or incorrect. You can learn more about the Authorization header here. |
403 | Access denied | This indicates that the agent whose credentials were used in making this request was not authorized to perform this API call. It could be that you do not have access to the shop or transportsolution you provided in your request. If you believe this is a mistake, please reach out to your contact so it can be rectified. |
405 | Method not allowed | This API request used the wrong HTTP verb/method. For example a PUT request will result in this error. |
4xx | Client error | Generally receiving an error code that starts with 4 indicates that the client needs to change something. |
500 | Unexpected Server Error | Oops! This may indicates an error on our side. Please try again, if the error continues notify your contact person |
...