Shipments

Shipments are at the core of our services. Get shipments and their data to inform your customers about them.

The shipment model

The shipment model contains all the information about the shipments used in your proposition.

Properties

Name
id
Type
string
Description
A generated unique identifier for the shipment.
Name
shipmentDate
Type
date
Description
The date on wich the shipment was shipped
Name
trackingCode
Type
string
Description
The trackingCode for the shipment
Name
shippingAgent
Type
string
Description
The shipping agent that handled the shipment.
Name
shippingService
Type
string
Description
The code for the service of the shipping agent.
Name
trackingLink
Type
string
Description
The trackingLink for the shipment. Share this with your customer.
Name
lines
Type
array
Description
The collection containing the shipment lines for this shipment. Refer to the shipmentLine model to see the properties for a line.
Name
outbound
Type
object
Description
The outbound this shipment belongs to. Refer to the outbound model to see the properties for a outbound.

GET/fulfilment/v3/shipments?skip=:skip&take=:take

List your shipments

This endpoint allows you to retrieve a list of shipments.

Optional arguments

Name
skip
Type
number
Description
How many shipments to skip
Name
take
Type
number
Description
How many shipments to return. Minimum for this argument is 10 maximum is 100
Name
filter
Type
filter
Description
Consult the filtering guide for more information.
Name
change-interval
Type
integer
Description
Get all records that have changed in the last change-interval minutes. Value between 5 and 2800
Allthough we support polling. We recommend using webhooks. If you are going to poll please use this property to keep traffic manageable.
Name
include
Type
enum
Description
The releated record to include. Valid values: lines, outbound

Request

GET

/v3/shipments

curl --location https://partner.punt-uit.nl/api/fulfilment/v3/shipments \
  --header "Authorization: Bearer {token}" \

Response

[
  {
      "id": "cloft5bsn0001kw08wtrxbt60",
      "shipmentDate": "2023-11-01",
      "trackingCode": "DOT11291",
      "shippingAgent": "PUNTUIT",
      "shippingService": "PICKUP",
      "trackingLink": "",
      "lines": [
          {
              "quantity": 1,
              "outboundRef": "249060670",
              "outboundLineRef": "492843012",
              "sku": "17177"
          }
      ],
      "outbound": {
          "ref": "249060670",
          "orderRef": "ORD1159861",
          "message": "",
          "shippingAdvice": "complete",
          "shipToName": "Punt-uit",
          "shipToContact": "Paul Katuin",
          "shipToAddressLine1": "Nieuw-Amsterdamsestraat 40",
          "shipToAddressLine2": "",
          "shipToCity": "Emmen",
          "shipToCountryCode": "NL",
          "shipToPostCode": "7814 VA",
          "shippingContactName": "Paul Katuin",
          "shippingContactEmail": "financieel@punt-uit.nl",
          "shippingContactPhonenumber": "",
          "shippingContactAddress": "Nieuw-Amsterdamsestraat 40",
          "shippingContactPostCode": "7814 VA",
          "shippingContactCity": "Emmen",
          "shippingContactCountryCode": "NL",
          "shipmentMethodCode": "PUNTUIT-PICKUP-DAP",
          "deliveryDate": null,
          "status": "picked_up"
      }
  },
  {
    ...
  }
]

GET/fulfilment/v3/shipments/:id

Retrieve a shipment

This endpoint allows you to retrieve a shipment by providing the id. The id is supplied in the webhook for shipment-shipped

Required attributes

Name
id
Type
string
Description
Path parameter representing the id of the shipment.

Optional arguments

Name
include
Type
enum
Description
The releated record to include. Valid values: lines, outbound

Request

GET

/fulfilment/v3/shipments/:id

curl --location https://partner.punt-uit.nl/api/fulfilment/v3/shipments/cloft5bsn0001kw08wtrxbt60 \
  --header "Authorization: Bearer {token}"

Response

  {
    "id": "cloft5bsn0001kw08wtrxbt60",
    "shipmentDate": "2023-11-01",
    "trackingCode": "DOT11291",
    "shippingAgent": "PUNTUIT",
    "shippingService": "PICKUP",
    "trackingLink": "",
    "lines": [
        {
            "quantity": 1,
            "outboundRef": "249060670",
            "outboundLineRef": "492843012",
            "sku": "17177"
        }
    ],
    "outbound": {
        "ref": "249060670",
        "orderRef": "ORD1159861",
        "message": "",
        "shippingAdvice": "complete",
        "shipToName": "Punt-uit",
        "shipToContact": "Paul Katuin",
        "shipToAddressLine1": "Nieuw-Amsterdamsestraat 40",
        "shipToAddressLine2": "",
        "shipToCity": "Emmen",
        "shipToCountryCode": "NL",
        "shipToPostCode": "7814 VA",
        "shippingContactName": "Paul Katuin",
        "shippingContactEmail": "financieel@punt-uit.nl",
        "shippingContactPhonenumber": "",
        "shippingContactAddress": "Nieuw-Amsterdamsestraat 40",
        "shippingContactPostCode": "7814 VA",
        "shippingContactCity": "Emmen",
        "shippingContactCountryCode": "NL",
        "shipmentMethodCode": "PUNTUIT-PICKUP-DAP",
        "deliveryDate": null,
        "status": "picked_up"
    }
 }

The shipmentLine model

The shipmentLine model contains all the information about shipmentLines, such as their sku, outboundRef, outboundLineRef and quantity.

Properties

Name
sku
Type
string
Description
The unique sku for the product that has been shipped.
Name
outboundRef
Type
string
Description
Your unique reference for the outbound.
Name
outboundLineRef
Type
string
Description
Your unique reference for the outboundLine
Name
quantity
Type
integer
Description
The number of items that have been shipped.