Shipments

Attributes

Name Type Required Description
id string generated Unique reference
carrier_service string required Linked to resource Carrier service
sender_id string optional Linked to resource Senders
pickup_point_id string optional Pickup point ID of carrier
pickup_point_type string optional Pickup point type
order_reference string optional Reference of the order
packages array optional Array of packages
recipient.company_name string optional Company name
recipient.name string optional Name (autosplitted)
recipient.first_name string required First name
recipient.last_name string required Last name
recipient.address_line_1 string optional Addres (autosplitted)
recipient.street string required Street name
recipient.house_number string required * House number
recipient.house_number_extension string optional House number extension
recipient.address_line_2 string optional Optional second address line
recipient.zipcode string required Zipcode
recipient.city string required City
recipient.state string optional State
recipient.country string required Country (needs to be ISO 3166 2-char code)
recipient.email string optional E-mail address
recipient.phone string optional Phone number
products array optional Array with one or multiple products
products.external_id string optional External ID of product
products.name string required Name of product
products.product_code string optional Product code of product
products.price_including_vat float optional Product code of product
products.price_excluding_vat float optional Product code of product
products.quantity integer required Amount of products
products.weight integer optional Weight of product in grams
products.hs_code integer optional HS code of product (six-digit)
products.country_of_origin string optional Country of origin product (needs to be ISO 3166 2-char code)
print boolean optional If true Pakketpartner will print the generated label

* Housenumber is not required when shipping to Ireland, UK or France.

* Array of packages. A package has a weight (in grams).

Get all shipments

GEThttps://dashboard.pakketpartner.nl/api/v1/shipments
response       

HTTP/1.1 200 OK
{
    "count": 1,
    "data": [
            {
            "id": "ship_cFjQjbjb454bAF",
            "carrier_service": cs_cfdgFdin54bAF,
            "carrier": {
                "key": "gls",
                "name": "GLS",
                "service": "GLS Parcel",
                "profile": null
            },
            "order_reference": null,
            "recipient": {
                "company_name": "eConcepts",
                "first_name": "Jan",
                "last_name": "Jansen",
                "street": "Kerkstraat",
                "house_number": "42",
                "house_number_extension": null,
                "address_line_2": null,
                "zipcode": "6941AH",
                "city": "Didam",
                "state": null,
                "country": "NL",
                "email": null,
                "phone": "0123456789"
            },
            "pickup_point": {
                "id": "69410004",
                "type": null,
                "name": "Parcelshop naam",
                "street": "Hoofdstraat",
                "house_number": "1",
                "house_number_extension": null,
                "zipcode": "6942AA",
                "city": "Didam",
                "country": "NL",
                "options": null
            },
            "products": [
                {
                    "external_id": "6",
                    "name": "Product A",
                    "product_code": "123_12",
                    "price_including_vat": 12.1,
                    "price_excluding_vat": 10,
                    "quantity": 2,
                    "weight": 400,
                    "hs_code": "33049900",
                    "country_of_origin": "NL"
                }
            ],
            "labels": [
                {
                    "tracking_code": "JVGL123456789",
                    "tracking_url": "https://dhlparcel.nl/nl/particulier/ontvangen/volg-uw-zending?tt=JVGL123456789&pc=1000AB",
                    "label_url_pdf": "LINK_TO_PDF",
                    "label_url_png": "LINK_TO_PNG",
                    "label_url_zpl": "LINK_TO_ZPL"
                }
            ],
            "created_at": "2019-02-16 09:28:13"
        }
    ]
}

Get single shipment

GEThttps://dashboard.pakketpartner.nl/api/v1/shipments/{shipment_id}
response       

HTTP/1.1 200 OK
{
    "data": {
        "id": "ship_cFjQjbjb454bAF",
        "carrier_service": cs_cfdgFdin54bAF,
        "carrier": {
            "key": "gls",
            "name": "GLS",
            "service": "GLS Parcel",
            "profile": null
        },
        "order_reference": null,
        "recipient": {
            "company_name": "eConcepts",
            "first_name": "Jan",
            "last_name": "Jansen",
            "street": "Kerkstraat",
            "house_number": "42",
            "house_number_extension": null,
            "address_line_2": null,
            "zipcode": "6941AH",
            "city": "Didam",
            "state": null,
            "country": "NL",
            "email": null,
            "phone": "0123456789"
        },
        "pickup_point": {
            "id": "69410004",
            "type": null
            "name": "Parcelshop naam",
            "street": "Hoofdstraat",
            "house_number": "1",
            "house_number_extension": null,
            "zipcode": "6942AA",
            "city": "Didam",
            "country": "NL",
            "options": null
        },
        "products": [
            {
                "external_id": "6",
                "name": "Product A",
                "product_code": "123_12",
                "price_including_vat": 12.1,
                "price_excluding_vat": 10,
                "quantity": 2,
                "weight": 400,
                "hs_code": "33049900",
                "country_of_origin": "NL"
            }
        ],
        "labels": [
            {
                "tracking_code": "JVGL123456789",
                "tracking_url": "https://dhlparcel.nl/nl/particulier/ontvangen/volg-uw-zending?tt=JVGL123456789&pc=1000AB",
                "label_url_pdf": "LINK_TO_PDF",
                "label_url_png": "LINK_TO_PNG",
                "label_url_zpl": "LINK_TO_ZPL"
            }
        ],
        "created_at": "2018-02-16 09:28:13"
    }
}

Create new shipment

Note: Instead of sending recipient.first_name and recipient.last_name as a seperated field you can send recipient.name. We will try to split the name for you.

The address can be splitted for your also. You can send a recipient.address_line_1 instead of recipient.street, recipient.house_number and recipient.house_number_extension.

POSThttps://dashboard.pakketpartner.nl/api/v1/shipments
request       

HTTP/1.1 200 OK
{
    "order_reference": null,
    "packages": [
    	{
    		"weight" : 2500
    	},
    	{
    		"weight" : 2200
    	}
    ],
    "pickup_point_id" : "69410004",
    "pickup_point_type" : null,
    "recipient": {
        "first_name": "Jan",
        "last_name": "Jansen",
        "company_name": null,
        "street": "Kerkstraat",
        "house_number": "42",
        "house_number_extension" : null,
        "address_line_2": null,
        "zipcode": "6941AH",
        "city": "Didam",
        "country": "NL",
        "phone": null,
        "email": "info@pakketpartner.nl"
    },
    "products": [
        {
            "external_id": "6",
            "name": "Product A",
            "product_code": "123_12",
            "price_including_vat": 12.1,
            "price_excluding_vat": 10,
            "quantity": 2,
            "weight": 400,
            "hs_code": "33049900",
            "country_of_origin": "NL"
        }
    ],
    "sender_hash" : "s_gdFN39Cnns3",
    "carrier_service" : "acsr_lprnwdSxzT4V6dps",
    "print": true
}
successful response       

HTTP/1.1 200 OK
{
    "data": {
        "id": "ship_cFjQjbjb454bAF",
        "carrier_service": 37,
        "carrier": {
            "key": "dhl",
            "name": "DHL",
            "service": "DHL For you",
            "profile": null
        },
        "order_reference": "8ptF0m8U",
        "recipient": {
            "company_name": "",
            "first_name": "Jan",
            "last_name": "Jansen",
            "street": "Kerkstraat",
            "house_number": "42",
            "house_number_extension": "",
            "address_line_2": null,
            "zipcode": "6941AH",
            "city": "Didam",
            "state": null,
            "country": "NL",
            "email": "info@pakketpartner.nl",
            "phone": "0123456789"
        },
        "pickup_point": {
            "id": "69410004",
            "type": null,
            "name": null,
            "street": null,
            "house_number": null,
            "house_number_extension": null,
            "zipcode": null,
            "city": null,
            "country": null,
            "options": null
        },
        "products": [
            {
                "external_id": "6",
                "name": "Product A",
                "product_code": "123_12",
                "price_including_vat": 12.1,
                "price_excluding_vat": 10,
                "quantity": 2,
                "weight": 400,
                "hs_code": "33049900",
                "country_of_origin": "NL"
            }
        ],
        "labels": [
            {
                "tracking_code": "JVGL123456788",
                "tracking_url": "https://dhlparcel.nl/nl/particulier/ontvangen/volg-uw-zending?tt=JVGL123456788&pc=6941AH",
                "label_url_pdf": "LINK_TO_PDF",
                "label_url_png": "LINK_TO_PNG",
                "label_url_zpl": "LINK_TO_ZPL"
            },
            {
                "tracking_code": "JVGL123456789",
                "tracking_url": "https://dhlparcel.nl/nl/particulier/ontvangen/volg-uw-zending?tt=JVGL123456789&pc=6941AH",
                "label_url_pdf": "LINK_TO_PDF",
                "label_url_png": "LINK_TO_PNG",
                "label_url_zpl": "LINK_TO_ZPL"
            }
        ],
        "created_at": "2018-05-09 10:50:12"
    }
}
error response       

HTTP/1.1 400 Bad request
{
    "success": false,
    "errors": {
        "carrier": [
            "Carrier has no free parcel numbers available"
        ],
        "carrier_service": [
            "Carrier service is verplicht."
        ],
        "recipient.first_name": [
            "Recipient.first name is verplicht."
        ],
        "recipient.last_name": [
            "Recipient.last name is verplicht."
        ],
        "recipient.street": [
            "Straatnaam is verplicht."
        ],
        "recipient.house_number": [
            "Huisnummer is verplicht."
        ],
        "recipient.zipcode": [
            "Postcode is verplicht."
        ],
        "recipient.city": [
            "Plaats is verplicht."
        ],
        "recipient.country": [
            "Land is verplicht."
        ]
    }
}

Get shipment labels on A4

PDF of shipment label(s) on A4. Maximum of four labels per page. The PDF document will be send directly with an Content-Type: application/pdf header as response.

GEThttps://dashboard.pakketpartner.nl/api/v1/shipments/labels?shipments[]={shipment_id}&shipments[]={shipment_id}