Parcel Edit Order API
This API enables editing an order registered in DI
Content
Purpose and use of Service
Edit Order API is used to edit details for an existing order. Editing will update the entire order and applies to all items in that order.
Which fields that can be edited depends on freight product and order status, se description in flow chart below
Setup
Make sure you have the following information at hand before proceeding.
| Example | Description |
|---|---|---|
Username (see Authentication section) | wsfoobar | A valid username. |
Password (see Authentication section) | a-very-very-long-password | A password matching given username. |
The user is a web service user
The user has access to the web service for editing orders
The user has access to the shop registered on the order
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.
Authentication
This endpoint requires the user to be authenticated. Refer to the documentation here for more information on how to obtain a valid token to use in your request.
Making a Request
Notes
Clients using this API should not fail if new optional fields are added to the API. If a new field is added to the request or response on a later stage, existing clients should handle this in a way such as they just ignore the field.
Changes will be updated for all parcels/kolli for the shipment/order specified
You may have several patch operations in one request
If one of the operations in a request is invalid the whole request will be interrupted
It is not possible to undo an edit request, but you can do several edit requests on the same shipment
Request-Headers
key | value example | comment |
|---|---|---|
Authorization | Bearer "SECRET_WS_TOKEN" | See authentication on how to obtain a token |
Content-Type | application/json |
|
Request-Path-Parameters
Name | Example | Description |
|---|---|---|
shipmentId | 70724761617883184 | The message number of the order that will be edited |
Request-Body
JSON file containing an array of patch operations.. The current patch operations supported by JSON Patch are:
Name | Example | Description |
|---|---|---|
Replace | [
{ "op": "replace", "path": "/distributionDate", "value": "2020-09-30" }
] | Replace the existing value with new value for specified path. Description of each key: |
Edit operations available
See Parcel Booking API documentation for more details about use and definition of each path and value
Path | Operation supported | Value description | Example operation |
|---|---|---|---|
|
| String, | { "op":"replace", "path": "/distributionDate", "value": "2020-09-30" } |
|
| String, | { "op":"replace", "path": "/consignor/name", "value": "MyStore" } |
|
| String, | { "op":"replace", "path": "/consignor/phone1", "value": "12345678" } |
|
| String, | { "op":"replace", "path": "/consignor/email", "value": "info@email.com" } |
|
| String, | { "op":"replace", "path": "/consignor/coAddress", "value": "MyStores Corporate Group" } |
|
| String, | { "op":"replace","path":"/consignor/address","value":"Storgata 4B H0201"}, |
|
| String, | {"op":"replace","path":"/consignor/postalName","value":"Oslo"}, |
|
| String, | {"op":"replace","path":"/consignor/zipCode","value":"0577"} |
|
| String, | { "op":"replace", "path": "/consignor/reference", "value": "senderReference" } |
|
| String, | { "op":"replace", "path": "/consignee/name", "value": "Ola Normann" } |
|
| String, | { "op":"replace", "path": "/consignee/phone1", "value": "12345678" } |
|
| String, | { "op":"replace", "path": "/consignee/email", "value": "info@email.com" } |
|
| String, | { "op":"replace", "path": "/consignee/coAddress", "value": "Kari Normann" } |
|
| String, | { "op":"replace","path":"/consignee/address","value":"Storgata 4B H0201"}, |
|
| String, | {"op":"replace","path":"/consignee/postalName","value":"Oslo"}, |
|
| String, | {"op":"replace","path":"/consignee/zipCode","value":"0577"} |
|
| String, | { "op":"replace", "path": "/consignee/reference", "value": "receiverReference" } |
|
| String Adding new parcels | {
"op": "add",
"path": "/items",
"value": {
"itemNumber": 2,
"weight": 700,
"volume": null,
"length": null,
"height": null,
"width": null,
"externalSupplierId": "brødbakerne_østlandet",
"contents": "content",
"articles": [
{
"articleNumber": "2234",
"quantity": 1,
"articleName": "brødbaker"
}
]
}
}
|
|
| deletes return code from a parcel the argument is an integer which is a specific item number This operation can’t be used together with other types of change within one request. Unlike replace, this operation can be run on any parcel, also delivered ones. | [
{
"op": "remove",
"path": "/items/1/returnCode"
}
] |
Examples
Curl request edit consignor all details
Curl request edit consignee all details
Curl request edit distribution date
Response
Name | Type | Example | Mandatory | Description |
|---|---|---|---|---|
shipmentId | String | 70724761617883184 |
| This is a unique identifier. Typically named MessageNumber |
freightProductId | Whole number | 2 |
| The selected freight product for this shipment. |
parties | List of party objects |
|
| List of all the parties in this shipment. |
items | List of item objects |
|
| List of all the items in this shipment. |
properties | Map of root properties |
|
| Map with additional properties. Various information (properties) are specified only for certain transport products. |
additionalServices | List of additionalService objects |
|
| Additional services that should be applied to the shipment. |
The response is the same as for Parcel booking API, see example and more details in that documentation
Error handling
API requests that result in errors will return an appropriate HTTP status code to help you identify the type of error. You can use the table below to understand what each code means. og search online with the HTTP status code. The HTTP error keys used are based on the standard, and therefore available online (Tips to search “HTTP code XXX”)
In addition to HTTP status there may be more details in the errorKey field. Error Keys can be added at a later stage, clients should handle this as well as an empty value for errorKey.
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 |
Error response
In addition to the HTTP status code, most errors will also return a response body that contains more information to help you debug the error. A sample error response is shown below. The format of the error response body is explained after the example.
Sample error
{
"statusCode": 401,
"errorKey": "authentication.missing",
"errorMap": {}
}Field | Description |
|---|---|
statusCode | The HTTP code associated with this error. |
errorKey | A machine parseable error code. |
errorMap | Additional details pertaining to the error. |
Error keys