Path | Operation supported | Value description | Example operation |
|---|
/distributionDate
| "op": "replace"
| String,
Date with format YYYY-MM-DD | | Code Block |
|---|
| { "op":"replace", "path": "/distributionDate", "value": "2020-09-30" } |
|
/consignor/name
| "op": "replace"
| String,
Consignor/sender name | | Code Block |
|---|
| { "op":"replace", "path": "/consignor/name", "value": "MyStore" } |
|
/consignor/phone1
| "op": "replace"
| String,
Consignor/sender phone number | | Code Block |
|---|
| { "op":"replace", "path": "/consignor/phone1", "value": "12345678" } |
|
/consignor/email
| "op": "replace"
| String,
Consignor/sender email | | Code Block |
|---|
| { "op":"replace", "path": "/consignor/email", "value": "info@email.com" } |
|
/consignor/coAddress
| "op": "replace"
| String,
Consignor/sender co address | | Code Block |
|---|
| { "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 |
|---|
| { "op":"replace", "path": "/consignor/reference", "value": "senderReference" } |
|
/consignee/name
| "op": "replace"
| String,
Consignee/receiver name | | Code Block |
|---|
| { "op":"replace", "path": "/consignee/name", "value": "Ola Normann" } |
|
/consignee/phone1
| "op": "replace"
| String,
Consignee/receiver phone number | | Code Block |
|---|
| { "op":"replace", "path": "/consignee/phone1", "value": "12345678" } |
|
/consignee/email
| "op": "replace"
| String,
Consignee/receiver email | | Code Block |
|---|
| { "op":"replace", "path": "/consignee/email", "value": "info@email.com" } |
|
/consignee/coAddress
| "op": "replace"
| String,
Consignee/receiver co address | | Code Block |
|---|
| { "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 |
|---|
| { "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"
}
]
}]
} |
|
/items
| "op": "remove"
| integer identifying an 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. | | Code Block |
|---|
[
{
"op": "remove",
"path": "/items/1/returnCode"
}
] |
|