Versions Compared

Key

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

...

Name

Type

Example

Mandatory

Description

shipmentId

String

70724760322123456

yes

The id-number of the shipment

ediStatus

String

EXPORT_OK

yes

The current EDI-status of the shipment

shopid

Integer

1

yes

The id of the shop for the shipment

shopName

String

TestShop

yes

The name of the shop for the shipment

desiredDeliveryDate (WIP)

Date

2023-10-05

no

If available, the desired delivery date for the shipment

pickupDetails

Object

no

This object will be populated if the shipment is a pickup shipment

pickupDetails-returnCode

String

R-12345

no

The return code of the shipment

pickupDetails-placement

String

mailbox, door, common-box, newspaper

no

Where the consumer should place the shipment

pickupDetails-pickupDate

Date

2023-08-31

no

The date the shipment will be picked up by the distribution. If null, no date has been set.

The customer should place the shipment at the assigned spot the day before.

pickupDetails-possiblePickupDates

List<Date>

[2023-08-31, 2023-09-01, … ]

no

A list of future possible pickup dates

items

Array

yes

List of one or more items in the shipment

items-trackingReference

String

370724760322123456

yes

Tracking number for the given item

items-labellessCode

String

TESTCODE

no

Submission code received from PostNord in case this is a myPackGo item

...

Expand
titleAPI response example
Code Block
{
    "shipmentId": "70724760322123456",
    "ediStatus": "EXPORT_OK",
    "shopId": 1,
    "shopName": "Testbutikken",
    "desiredDeliveryDate": "2023-10-05",
    "pickupDetails": {
      "returnCode": "R-12345",
      "placement": "door",
      "pickupDate": "2023-08-23",
      "possiblePickupDates": [
        "2023-08-22",
        "2023-08-23",
        "2023-08-24",
        ...
      ]
    },
    "items": [
        {
            "trackingReference": "37072476032123456",
            "labellessCode": "TESTCODE"
        }
    ]
}

...