Path | Operation supported | Value description | Example operation |
|---|
/shopId
| "op": "replace"
| Whole number,
The shop this booking is made for. | | Code Block |
|---|
| { "op":"replace", "path": "/shopId", "value": 95123 } |
|
/shopDisplayName
| "op": "replace"
| String, A user presentable name of the shopId. | | Code Block |
|---|
| { "op":"replace", "path": "/shopDisplayName", "value": "My Company Ltd" } |
|
/transportSolutionId
| "op": "replace"
| Whole number,
A transport solution is a construct that contains multiple freight products | | Code Block |
|---|
| { "op":"replace", "path": "/transportSolutionId", "value": 123 } |
|
/shipmentId
| "op": "replace"
| String. ShipmentId is identificator for the entire order. | | Code Block |
|---|
| { "op":"replace", "path": "/shipmentId", "value": "(401)70712190172720651" } |
|
/desiredDeliveryDate
| "op": "replace"
| String, Date format yyyyMMdd. This date should be defined as distribution date. | | Code Block |
|---|
| { "op":"replace", "path": "/desiredDeliveryDate", "value": "20250101" } |
|
/desiredDeliveryTimePeriod
| "op": "replace"
| String, Time format HHmm-HHmm (desiredDeliveryTimeStart - desiredDeliveryTimeEnd)
Default value '2000-2200' will be used as delivery time interval if it is not given. | | Code Block |
|---|
| { "op":"replace", "path": "/desiredDeliveryTimePeriod", "value": "1930-2130" } |
|
/messageToCarrier
| "op": "replace"
| String, Typically delivery instructions. | | Code Block |
|---|
| { "op":"replace", "path": "/messageToCarrier", "value": "Some Instruction Here" } |
|
/messageToConsignee
| "op": "replace"
| String, This information can be placed on some shipping labels in the information field. | | Code Block |
|---|
| { "op":"replace", "path": "/messageToConsignee", "value": "Some Information Here" } |
|
/campaignMark
| "op": "replace"
| Boolean, When set to true, an asterix (*) will be visible on some labels. | | Code Block |
|---|
| { "op":"replace", "path": "/campaignMark", "value": true } |
|
/parties/{partyType}/type
| "op": "replace"
| String,
Type of party involved. | | Code Block |
|---|
| { "op":"replace", "path": "/parties/consignor/type", "value": "consignee" } |
|
/parties/{partyType}/id
| "op": "replace"
| String,
Identifier that can be used to identify the same party between different shipments. | | Code Block |
|---|
| { "op":"replace", "path": "/parties/servicePoint/id", "value": "1234" } |
|
/parties/{partyType}/name
| "op": "replace"
| String,
Consignor/sender name | | Code Block |
|---|
| { "op":"replace", "path": "/parties/consignor/name", "value": "MyStore" } |
|
/parties/{partyType}/countryCode
| "op": "replace"
| String,
Country code, according to ISO 3166-1 | | Code Block |
|---|
| { "op":"replace", "path": "/parties/consignor/countryCode", "value": "NO" } |
|
/parties/{partyType}/postalName | "op": "replace"
| String,
Consignor/sender city | | Code Block |
|---|
{"op":"replace","path":"/parties/consignor/postalName","value":"Oslo"}, |
|
/parties/{partyType}/zipCode | "op": "replace"
| String,
Consignor/sender postal code | | Code Block |
|---|
{"op":"replace","path":"/parties/consignor/zipCode","value":"0577"} |
|
/parties/{partyType}/address | "op": "replace"
| String,
Consignor/sender street address, number and household | | Code Block |
|---|
{ "op":"replace","path":"/parties/consignor/address","value":"Storgata 4B H0201"}, |
|
/parties/{partyType}/coAddress
| "op": "replace"
| String,
Consignor/sender co address | | Code Block |
|---|
| { "op":"replace", "path": "/parties/consignor/coAddress", "value": "MyStores Corporate Group" } |
|
/parties/{partyType}/phone1
| "op": "replace"
| String,
This can be used for automated SMS notification. | | Code Block |
|---|
| { "op":"replace", "path": "/parties/consignor/phone1", "value": "12345678" } |
|
/parties/{partyType}/phone2
| "op": "replace"
| String,
This can be used for automated SMS notification. | | Code Block |
|---|
| { "op":"replace", "path": "/parties/consignor/phone2", "value": "12345678" } |
|
/parties/{partyType}/email
| "op": "replace"
| String,
Consignor/sender email | | Code Block |
|---|
| { "op":"replace", "path": "/parties/consignor/email", "value": "info@email.com" } |
|
/parties/{partyType}/reference | "op": "replace"
| String,
This can be an orderId or some other reference. consignee and consignor reference can be placed on some shipping labels. | | Code Block |
|---|
{"op":"replace","path":"/parties/consignor/reference","value":"senderReference"}, |
|
/parties/{partyType}/contact | "op": "replace"
| String,
Contact information for the party. Consignee contact can be printed on some shipping labels. | | Code Block |
|---|
{"op":"replace","path":"/parties/consignor/contact","value":"Customer service contact name"} |
|
/items/{itemNumber}/itemNumber | "op": "replace"
| Whole Number, Item/package number of the shipment. | | Code Block |
|---|
{"op":"replace","path":"/items/1/itemNumber","value": 2} |
|
/items/{itemNumber}/trackingReference | "op": "replace"
| String, If not specified as a part of the request this will be generated and returned in the response. | | Code Block |
|---|
{"op":"replace","path":"/items/1/trackingReference","value": "(00)370724760010119754" } |
|
/items/{itemNumber}/returnCode | "op": "replace"
| String, If specified this will be used for custom return functionality. | | Code Block |
|---|
{"op":"replace","path":"/items/1/returnCode","value": "R-1234567" } |
|
/items/{itemNumber}/linkedParcelType
| "op": "replace"
| String, Used for when a customer wants to defined a linked package type. | | Code Block |
|---|
{"op":"replace","path":"/items/1/linkedParcelType","value": "RET" } |
|
/items/{itemNumber}/linkedTrackingReference | "op": "replace"
| String, Used for when a customer wants to define a linked package. | | Code Block |
|---|
{"op":"replace","path":"/items/1/linkedTrackingReference","value": "(00)370724760010119754" } |
|
/items/{itemNumber}/weight
| "op": "replace"
| Whole Number, Measuring unit is gram. | | Code Block |
|---|
{"op":"replace","path":"/items/1/weight","value": 600 } |
|
/items/{itemNumber}/volume | "op": "replace"
| Decimal Number, Measuring unit is cubic decimeter. | | Code Block |
|---|
{"op":"replace","path":"/items/1/volume","value": 4 } |
|
/items/{itemNumber}/length | "op": "replace"
| Decimal Number, Measuring unit is centimeter. | | Code Block |
|---|
{"op":"replace","path":"/items/1/length","value": 120 } |
|
/items/{itemNumber}/height | "op": "replace"
| Decimal Number, Measuring unit is centimeter. | | Code Block |
|---|
{"op":"replace","path":"/items/1/height","value": 5 } |
|
/items/{itemNumber}/width | "op": "replace"
| Decimal Number, Measuring unit is centimeter. | | Code Block |
|---|
{"op":"replace","path":"/items/1/width","value": 12 } |
|
/items/{itemNumber}/contentValue
| "op": "replace"
| Decimal Number, Currency is according to the location of the shopId. | | Code Block |
|---|
{"op":"replace","path":"/items/1/contentValue","value": 580 } |
|
/items/{itemNumber}/externalSupplierId
| "op": "replace"
| String, ExternalSupplierId is the id of the supplier to the shop. It can be used for access control or filtering. | | Code Block |
|---|
{"op":"replace","path":"/items/1/externalSupplierId","value": 5415 } |
|
/items/{itemNumber}/contents
| "op": "replace"
| String, Description of the contents. This can be placed on some shipping labels. | | Code Block |
|---|
{"op":"replace","path":"/items/1/contents","value": "Brown shirt" } |
|
/items/{itemNumber}/properties
| "op": "replace"
| Map with additional properties. Various information (properties) are specified only for certain transport products. | | Code Block |
|---|
{"op":"replace","path":"/items/1/properties","value": {"productType": "Bread"} } |
|
/additionalServices
| "op": "add"
| Adds Additional services that should be applied to the shipment. | | Code Block |
|---|
{"op":"add","path":"/additionalServices", "value": {"key" : "KEY", "value": "VALUE"} } |
|
/additionalServices/{key}
| "op": "remove"
| Removes additional services that should be applied to the shipment. | | Code Block |
|---|
{"op":"remove","path":"/additionalServices/ASA" } |
|