Versions Compared

Old Version 50

changes.mady.by.user Anastasiia Bogolepova (Deactivated)

Saved on

compared with

New Version 51

changes.mady.by.user Håvard Neset

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

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.

TEST

Status
colourBlue
titlePATCH

https://staging-ws.di.no/ws/json/parcel/booking/v-1/orders/{shipmentId}

PRODUCTION

Status
colourBlue
titlePATCH

https://ws.di.no/ws/json/parcel/booking/v-1/orders/{shipmentId}

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. 

...

Info

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

Code Block
languagejson
[
  { "op": "replace", "path": "/distributionDate", "value": "2020-09-30" }
]

Replace the existing value with new value for specified path.
The old value is not stored, and can not be retrieved after replaced.

Description of each key:
“op“ → operation used
”path” → JSON Pointer used to specify which part of the model needs to be changed
”value” → The value that will be changed

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

/distributionDate

"op": "replace"

String,
Date with format YYYY-MM-DD

Code Block
languagejson
{ "op":"replace", "path": "/distributionDate", "value": "2020-09-30" }

/consignor/name

"op": "replace"

String,
Consignor/sender name

Code Block
languagejson
{ "op":"replace", "path": "/consignor/name", "value": "MyStore" }

/consignor/phone1

"op": "replace"

String,
Consignor/sender phone number

Code Block
languagejson
{ "op":"replace", "path": "/consignor/phone1", "value": "12345678" }

/consignor/email

"op": "replace"

String,
Consignor/sender email

Code Block
languagejson
{ "op":"replace", "path": "/consignor/email", "value": "info@email.com" }

/consignor/coAddress

"op": "replace"

String,
Consignor/sender co address

Code Block
languagejson
{ "op":"replace", "path": "/consignor/coAddress", "value": "MyStores Corporate Group" }

/consignor/address

"op": "replace"

String,
Consignor/sender street address, number and household

Code Block
{ "op":"replace","path":"/consignor/address","value":"Storgata 4B H0201"},

/consignor/postalName

"op": "replace"

String,
Consignor/sender city

Code Block
{"op":"replace","path":"/consignor/postalName","value":"Oslo"}, 

/consignor/zipCode

"op": "replace"

String,
Consignor/sender postal code

Code Block
{"op":"replace","path":"/consignor/zipCode","value":"0577"}

/consignorReference

"op": "replace"

String,
Consignor/sender reference

Code Block
languagejson
{ "op":"replace", "path": "/consignor/reference", "value": "senderReference" }

/consignee/name

"op": "replace"

String,
Consignee/receiver name

Code Block
languagejson
{ "op":"replace", "path": "/consignee/name", "value": "Ola Normann" }

/consignee/phone1

"op": "replace"

String,
Consignee/receiver phone number

Code Block
languagejson
{ "op":"replace", "path": "/consignee/phone1", "value": "12345678" }

/consignee/email

"op": "replace"

String,
Consignee/receiver email

Code Block
languagejson
{ "op":"replace", "path": "/consignee/email", "value": "info@email.com" }

/consignee/coAddress

"op": "replace"

String,
Consignee/receiver co address

Code Block
languagejson
{ "op":"replace", "path": "/consignee/coAddress", "value": "Kari Normann" }

/consignee/address

"op": "replace"

String,
Consignee/receiver street address, number and household

Code Block
{ "op":"replace","path":"/consignee/address","value":"Storgata 4B H0201"},

/consignee/postalName

"op": "replace"

String,
Consignee/receiver city

Code Block
{"op":"replace","path":"/consignee/postalName","value":"Oslo"}, 

/consignee/zipCode

"op": "replace"

String,
Consignee/receiver postal code

Code Block
{"op":"replace","path":"/consignee/zipCode","value":"0577"}

/consigneeReference

"op": "replace"

String,
Consignee/receiver reference

Code Block
languagejson
{ "op":"replace", "path": "/consignee/reference", "value": "receiverReference" }

/items (WIP)

"op": "add"

String

Adding new parcels

Code Block
{
        "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"
                }
            ]
        }]
    }

Examples

Curl request edit consignor all details

...

Expand
titleCurl request edit distribution date
Code Block
curl --location --request PATCH 'https://staging-ws.di.no/ws/json/parcel/booking/v-1/orders/70724762044206508' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $SECRET_WS_TOKEN' \
--data-raw '[    
{
        "op": "replace",
        "path": "/distributionDate",
        "value": "2021-12-22"
    }
]'

Response

Name

Type

Example

Mandatory

Description

shipmentId

String

70724761617883184

(tick)

This is a unique identifier. Typically named MessageNumber

freightProductId

Whole number

2

(tick)

The selected freight product for this shipment.

parties

List of party objects

(tick)

List of all the parties in this shipment.

items

List of item objects

(tick)

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

...

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.

...

Code Block
{
    "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

Expand
titleList of error keys

Error key

Status code

Action

no.access.api

403

Your user does not have access to this API. Notify your carrier contact person to update your access

no.access.shop.id

403

Your user does not have access to the shop registered to the order you try to edit. Notify your carrier contact person to update your access

cannot.find.order

404

We can not recognise the shipmentID specified, please check that it is a valid and correct ID

unable.to.edit.exporter.order

400

For some carriers and freight products we do not have the possibility to edit and order after they have registered the order, therefor these orders can not be edited. See flow chart under “use of service” for details.

order.cancelled

400

It is not possible to edit cancelled ordres

no.changes.in.patch

400

The edit order request you are trying to perform does not have any changes from what information is already registered on the order.

invalid.format.desiredDeliveryDate

400

Please check your date format

order.changes.freightproduct

400

The edit order request you have will result in a different delivery method (freight product), and is not possible to perform. This can be for several reasons, maybe the date or address changes are not supported for the existing freight product

failed.to.parse.request

400

Please check your path value, we are not able to recognise the key. Remember this path value is case sensitive

JsonPatch.format.invalid

400

Please check you request format, see valid format in examples above.

failed.to.map.JsonPatch

400

distributionDate.must.be.in.future

400

Change distribution date.

error.parcel.final.status

400

Parcel has reach a final destination and can not be edited.

order.exported

400

For some carriers and freight products we do not have the possibility to edit and order after they have registered the order, therefor these orders can not be edited. See flow chart under “use of service” for details.

party.name.required

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

party.name.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

address.required

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

address.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

zipCode.required

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

email.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

phone.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

co.address.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

zipCode.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

postalName.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

countryCode.too.long

400

Required information and validation for each value is equal to the booking API, see details in Parcel Booking API documentation

error.parcel.under.distribution

409

Please see https://jira-di.atlassian.net/wiki/spaces/DIPUB/pages/2177597504/Parcel+Edit+Order+API#Use-of-Service for when parcels can be edited.

internal.error

500

If you receive this error please notify your carrier contact person, and provide the request(s) you try to perform

...