Parcel Replace Order API
This API enables replacing an order registered in DI
Content
Purpose and use of Service
Replace Order API is used to replace details for an existing order. Replacing will create a new order, cancel an old one and applies to all items in that order.
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 while 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 request contains
remove
operation it should be the last operation in the requestIf one of the operations in a request is invalid the whole request will be interrupted
It is not possible to undo a replace request, but you can do several replace requests on the same shipment which will cause creating new order every time
Notes
It is neccessary to remove the servicePoint party to if it should be automatically re-assigned. This could be relevant if consignee address has been changed, and servicePoint should be re-evaluated and re-assigned.
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 replaced |
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":Β "/transportSolutionId",Β "value":Β 1Β }
] | Replace the existing value with new value for specified path. Description of each key: |
Add | [
Β Β {Β "op":Β "add",Β "path":Β "/parties",Β "value":Β
{ "type": "servicePoint", "id": 1 }
}
] | Add new value with the specified properties. Value objectβs structure is dependant on the type of the object. Supported paths:
|
Remove | [
Β Β {Β "op":Β "remove",Β "path":Β "/parties/servicePoint" }
] | Removes an object from the order. Supported paths:
|
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 |
---|---|---|---|
|
| Whole number, | |
|
| String, A user presentable name of the shopId. | |
|
| Whole number, | |
|
| String. ShipmentId is identificator for the entire order. | |
|
| String, Date format yyyyMMdd. This date should be defined as distribution date. | |
|
| String, Time format HHmm-HHmm (desiredDeliveryTimeStart - desiredDeliveryTimeEnd) | |
|
| String, Typically delivery instructions. | |
|
| String, This information can be placed on some shipping labels in the information field. | |
|
| String, proof of delivery options. Possible values: NO_CONFIRMATION, SIMPLE_CONFIRMATION, SCAN, SCAN_AND_PICTURE, PICTURE | |
|
| Boolean, When set to true, an asterix (*) will be visible on some labels. | |
|
| String, | |
|
| String, | |
|
| String, | |
|
| String, | |
|
| String, | |
|
| String, | |
Β |
| String, | |
Β |
| String, | |
Β |
| String, | |
Β |
| String, | |
Β |
| String, | |
|
| String, | |
|
| String, | |
|
| Whole Number, Item/package number of the shipment. | |
|
| String, If not specified as a part of the request this will be generated and returned in the response. | |
|
| String, If specified this will be used for custom return functionality. | |
|
| Whole Number, Measuring unit is gram. | |
|
| Decimal Number, Measuring unit is cubic decimeter. | |
|
| Decimal Number, Measuring unit is centimeter. | |
|
| Decimal Number, Measuring unit is centimeter. | |
|
| Decimal Number, Measuring unit is centimeter. | |
|
| Decimal Number, Currency is according to the location of the shopId. | |
|
| String, ExternalSupplierId is the id of the supplier to the shop. It can be used for access control or filtering. | |
|
| String, Description of the contents. This can be placed on some shipping labels. | |
|
| Map with additional properties. Various information (properties) are specified only for certain transport products. | |
|
| Adds Additional services that should be applied to the shipment. | |
|
| Removes additional services that should be applied to the shipment. |
Examples
Curl request replace consignee details
Curl request replace transport solution ID
Curl request remove party
Curl request add party
ResponseΒ
Name | Type | Example | Mandatory | Description |
---|---|---|---|---|
shipmentId | string | (401)70712190172720651 | See description with the same name in the request. | |
freightProductId | whole number | 2 | The selected freight product for this shipment. SeeΒ example freight products ablow | |
parties | list of party objects | Β | Note that the API could make minor changes to the returned consignee address. | |
items | list of item objects | Β | See description with the same name in the request. | |
properties | map of properties | Β | Β | Map with additional properties. Various information (properties) are specified only for certain transport products. |
additionalServices | list ofΒ additionalServices objects | Β | Β | See description with the same name in the request. |
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
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
Β