TypeScript
import { Configuration, ShipmentsApi } from "@zippendo/sdk"
const api = new ShipmentsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.updateShipment({ orgId: "...", shipmentId: "...", updateShipmentRequest: { /* ... */ } })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.ShipmentsApi(client).update_shipment("...", "...", zippendo.UpdateShipmentRequest())<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(), $config);
$result = $api->updateShipment("...", "...", new \Zippendo\Sdk\Model\UpdateShipmentRequest([]));client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.ShipmentsAPI.UpdateShipment(ctx, "...", "...").UpdateShipmentRequest(*zippendo.NewUpdateShipmentRequest()).Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::ShipmentsApi.new.update_shipment("...", "...", Zippendo::UpdateShipmentRequest.new)curl --request PATCH \
--url https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reference": "ORDER-1042",
"addressId": "addr_7e8f9a0b",
"servicePointId": "sp_pn_4521",
"parties": [
{
"type": "receiver",
"name": "Anna Jensen",
"address1": "Vesterbrogade 12",
"postalCode": "1620",
"city": "København V",
"countryCode": "DK",
"attention": "Reception",
"address2": "2. sal",
"email": "[email protected]",
"phone": "+4520123456",
"attributes": []
}
],
"type": "outbound",
"parcels": [
{
"weight": 2.5,
"weightUnit": "kg",
"dimensions": {
"length": 30,
"width": 20,
"height": 15
},
"orderLines": [
{
"quantity": 2,
"id": "ol_9c1d2e3f",
"orderLineId": "clz9k2f0a0004abcd3456qrst",
"sku": "SKU-1024",
"description": "Wool sweater, navy",
"unitPrice": 299.95,
"currency": "DKK",
"vatPercent": 25,
"location": "A-12-3",
"countryOfOrigin": "DK",
"hsCode": "61101100",
"tarrifNumber": "61101100"
}
],
"id": "prc_5a6b7c8d",
"trackingNumber": "00370724710000012345",
"trackingUrl": "https://tracking.postnord.com/00370724710000012345",
"labelFreeCode": "AB12CD34",
"qrCodeLink": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeDataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeUrl": "https://qr.bring.com/label-free/AB12CD34.png"
}
],
"pickupDetails": {
"date": "2026-06-22",
"from": "08:00:00",
"to": "16:00:00",
"instruction": "Ring the bell at the loading dock."
},
"termOfTrade": "DAP",
"status": "pending",
"orderId": "ord_5e6f7a8b",
"labelPrinterId": "prn_label_01",
"documentPrinterId": "prn_doc_01",
"shippingRuleId": "rule_3c4d5e6f",
"droppoint": {
"id": "SP-1234",
"name": "Brugsen Vesterbro",
"address": "Vesterbrogade 12, 1620 København"
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reference: 'ORDER-1042',
addressId: 'addr_7e8f9a0b',
servicePointId: 'sp_pn_4521',
parties: [
{
type: 'receiver',
name: 'Anna Jensen',
address1: 'Vesterbrogade 12',
postalCode: '1620',
city: 'København V',
countryCode: 'DK',
attention: 'Reception',
address2: '2. sal',
email: '[email protected]',
phone: '+4520123456',
attributes: []
}
],
type: 'outbound',
parcels: [
{
weight: 2.5,
weightUnit: 'kg',
dimensions: {length: 30, width: 20, height: 15},
orderLines: [
{
quantity: 2,
id: 'ol_9c1d2e3f',
orderLineId: 'clz9k2f0a0004abcd3456qrst',
sku: 'SKU-1024',
description: 'Wool sweater, navy',
unitPrice: 299.95,
currency: 'DKK',
vatPercent: 25,
location: 'A-12-3',
countryOfOrigin: 'DK',
hsCode: '61101100',
tarrifNumber: '61101100'
}
],
id: 'prc_5a6b7c8d',
trackingNumber: '00370724710000012345',
trackingUrl: 'https://tracking.postnord.com/00370724710000012345',
labelFreeCode: 'AB12CD34',
qrCodeLink: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
qrCodeDataUri: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
qrCodeUrl: 'https://qr.bring.com/label-free/AB12CD34.png'
}
],
pickupDetails: {
date: '2026-06-22',
from: '08:00:00',
to: '16:00:00',
instruction: 'Ring the bell at the loading dock.'
},
termOfTrade: 'DAP',
status: 'pending',
orderId: 'ord_5e6f7a8b',
labelPrinterId: 'prn_label_01',
documentPrinterId: 'prn_doc_01',
shippingRuleId: 'rule_3c4d5e6f',
droppoint: {
id: 'SP-1234',
name: 'Brugsen Vesterbro',
address: 'Vesterbrogade 12, 1620 København'
}
})
};
fetch('https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"ORDER-1042\",\n \"addressId\": \"addr_7e8f9a0b\",\n \"servicePointId\": \"sp_pn_4521\",\n \"parties\": [\n {\n \"type\": \"receiver\",\n \"name\": \"Anna Jensen\",\n \"address1\": \"Vesterbrogade 12\",\n \"postalCode\": \"1620\",\n \"city\": \"København V\",\n \"countryCode\": \"DK\",\n \"attention\": \"Reception\",\n \"address2\": \"2. sal\",\n \"email\": \"[email protected]\",\n \"phone\": \"+4520123456\",\n \"attributes\": []\n }\n ],\n \"type\": \"outbound\",\n \"parcels\": [\n {\n \"weight\": 2.5,\n \"weightUnit\": \"kg\",\n \"dimensions\": {\n \"length\": 30,\n \"width\": 20,\n \"height\": 15\n },\n \"orderLines\": [\n {\n \"quantity\": 2,\n \"id\": \"ol_9c1d2e3f\",\n \"orderLineId\": \"clz9k2f0a0004abcd3456qrst\",\n \"sku\": \"SKU-1024\",\n \"description\": \"Wool sweater, navy\",\n \"unitPrice\": 299.95,\n \"currency\": \"DKK\",\n \"vatPercent\": 25,\n \"location\": \"A-12-3\",\n \"countryOfOrigin\": \"DK\",\n \"hsCode\": \"61101100\",\n \"tarrifNumber\": \"61101100\"\n }\n ],\n \"id\": \"prc_5a6b7c8d\",\n \"trackingNumber\": \"00370724710000012345\",\n \"trackingUrl\": \"https://tracking.postnord.com/00370724710000012345\",\n \"labelFreeCode\": \"AB12CD34\",\n \"qrCodeLink\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n \"qrCodeDataUri\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n \"qrCodeUrl\": \"https://qr.bring.com/label-free/AB12CD34.png\"\n }\n ],\n \"pickupDetails\": {\n \"date\": \"2026-06-22\",\n \"from\": \"08:00:00\",\n \"to\": \"16:00:00\",\n \"instruction\": \"Ring the bell at the loading dock.\"\n },\n \"termOfTrade\": \"DAP\",\n \"status\": \"pending\",\n \"orderId\": \"ord_5e6f7a8b\",\n \"labelPrinterId\": \"prn_label_01\",\n \"documentPrinterId\": \"prn_doc_01\",\n \"shippingRuleId\": \"rule_3c4d5e6f\",\n \"droppoint\": {\n \"id\": \"SP-1234\",\n \"name\": \"Brugsen Vesterbro\",\n \"address\": \"Vesterbrogade 12, 1620 København\"\n }\n}")
.asString();{
"id": "shp_4d9e7a2f",
"reference": "ORDER-1042",
"parties": [
{
"type": "receiver",
"name": "Anna Jensen",
"address1": "Vesterbrogade 12",
"postalCode": "1620",
"city": "København V",
"countryCode": "DK",
"attributes": [],
"attention": "Reception",
"address2": "2. sal",
"email": "[email protected]",
"phone": "+4520123456"
}
],
"type": "outbound",
"carrierSettings": {
"carrierId": "car_pn_001",
"productId": "prod_mypack_home",
"services": [
"A7"
],
"additionalParameters": {
"notificationEmail": "[email protected]"
}
},
"parcels": [
{
"weight": 2.5,
"weightUnit": "kg",
"dimensions": {
"length": 30,
"width": 20,
"height": 15
},
"orderLines": [
{
"quantity": 2,
"id": "ol_9c1d2e3f",
"orderLineId": "clz9k2f0a0004abcd3456qrst",
"sku": "SKU-1024",
"description": "Wool sweater, navy",
"unitPrice": 299.95,
"currency": "DKK",
"vatPercent": 25,
"location": "A-12-3",
"countryOfOrigin": "DK",
"hsCode": "61101100",
"tarrifNumber": "61101100"
}
],
"id": "prc_5a6b7c8d",
"trackingNumber": "00370724710000012345",
"trackingUrl": "https://tracking.postnord.com/00370724710000012345",
"labelFreeCode": "AB12CD34",
"qrCodeLink": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeDataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeUrl": "https://qr.bring.com/label-free/AB12CD34.png"
}
],
"termOfTrade": "DAP",
"errors": [],
"status": "pending",
"orgId": "org_1a2b3c4d",
"logs": [],
"activities": [],
"createdAt": "2026-06-22T14:30:00.000Z",
"updatedAt": "2026-06-22T14:30:00.000Z",
"addressId": "addr_7e8f9a0b",
"servicePointId": "sp_pn_4521",
"pickupDetails": {
"date": "2026-06-22",
"from": "08:00:00",
"to": "16:00:00",
"instruction": "Ring the bell at the loading dock."
},
"documents": [
{
"id": "doc_8f3a2b1c",
"shipmentId": "shp_4d9e7a2f",
"documentType": "label",
"format": "pdf",
"content": "JVBERi0xLjQKJeLjz9MKMS...",
"size": "100X150",
"createdAt": "2026-06-22T14:30:00.000Z",
"updatedAt": "2026-06-22T14:30:00.000Z"
}
],
"tracking": {
"url": "https://tracking.postnord.com/00370724710000012345",
"number": "00370724710000012345",
"labelFreeCode": "AB12CD34",
"qrCodeLink": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeDataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeUrl": "https://qr.bring.com/label-free/AB12CD34.png"
},
"orderId": "ord_5e6f7a8b",
"shippingRuleId": "rule_3c4d5e6f",
"shippingRule": {
"id": "rule_3c4d5e6f",
"name": "Domestic standard",
"carrierId": "car_pn_001",
"productId": "prod_mypack_home",
"services": [
"A7"
],
"addressId": "addr_7e8f9a0b",
"returnShippingRuleId": "rule_return_01",
"autoCreateReturnShipment": false,
"autoPrintLabels": true,
"autoPrintDocuments": false,
"labelPrinterId": "prn_label_01",
"documentPrinterId": "prn_doc_01"
},
"labelPrinterId": "prn_label_01",
"documentPrinterId": "prn_doc_01"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}Shipments
Update shipment
Update an existing shipment. Only draft, pending or error shipments can be updated; an applied shipping rule overrides carrier settings and sender party.
PATCH
/
orgs
/
{orgId}
/
shipments
/
{shipmentId}
TypeScript
import { Configuration, ShipmentsApi } from "@zippendo/sdk"
const api = new ShipmentsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.updateShipment({ orgId: "...", shipmentId: "...", updateShipmentRequest: { /* ... */ } })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.ShipmentsApi(client).update_shipment("...", "...", zippendo.UpdateShipmentRequest())<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(), $config);
$result = $api->updateShipment("...", "...", new \Zippendo\Sdk\Model\UpdateShipmentRequest([]));client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.ShipmentsAPI.UpdateShipment(ctx, "...", "...").UpdateShipmentRequest(*zippendo.NewUpdateShipmentRequest()).Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::ShipmentsApi.new.update_shipment("...", "...", Zippendo::UpdateShipmentRequest.new)curl --request PATCH \
--url https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reference": "ORDER-1042",
"addressId": "addr_7e8f9a0b",
"servicePointId": "sp_pn_4521",
"parties": [
{
"type": "receiver",
"name": "Anna Jensen",
"address1": "Vesterbrogade 12",
"postalCode": "1620",
"city": "København V",
"countryCode": "DK",
"attention": "Reception",
"address2": "2. sal",
"email": "[email protected]",
"phone": "+4520123456",
"attributes": []
}
],
"type": "outbound",
"parcels": [
{
"weight": 2.5,
"weightUnit": "kg",
"dimensions": {
"length": 30,
"width": 20,
"height": 15
},
"orderLines": [
{
"quantity": 2,
"id": "ol_9c1d2e3f",
"orderLineId": "clz9k2f0a0004abcd3456qrst",
"sku": "SKU-1024",
"description": "Wool sweater, navy",
"unitPrice": 299.95,
"currency": "DKK",
"vatPercent": 25,
"location": "A-12-3",
"countryOfOrigin": "DK",
"hsCode": "61101100",
"tarrifNumber": "61101100"
}
],
"id": "prc_5a6b7c8d",
"trackingNumber": "00370724710000012345",
"trackingUrl": "https://tracking.postnord.com/00370724710000012345",
"labelFreeCode": "AB12CD34",
"qrCodeLink": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeDataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeUrl": "https://qr.bring.com/label-free/AB12CD34.png"
}
],
"pickupDetails": {
"date": "2026-06-22",
"from": "08:00:00",
"to": "16:00:00",
"instruction": "Ring the bell at the loading dock."
},
"termOfTrade": "DAP",
"status": "pending",
"orderId": "ord_5e6f7a8b",
"labelPrinterId": "prn_label_01",
"documentPrinterId": "prn_doc_01",
"shippingRuleId": "rule_3c4d5e6f",
"droppoint": {
"id": "SP-1234",
"name": "Brugsen Vesterbro",
"address": "Vesterbrogade 12, 1620 København"
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reference: 'ORDER-1042',
addressId: 'addr_7e8f9a0b',
servicePointId: 'sp_pn_4521',
parties: [
{
type: 'receiver',
name: 'Anna Jensen',
address1: 'Vesterbrogade 12',
postalCode: '1620',
city: 'København V',
countryCode: 'DK',
attention: 'Reception',
address2: '2. sal',
email: '[email protected]',
phone: '+4520123456',
attributes: []
}
],
type: 'outbound',
parcels: [
{
weight: 2.5,
weightUnit: 'kg',
dimensions: {length: 30, width: 20, height: 15},
orderLines: [
{
quantity: 2,
id: 'ol_9c1d2e3f',
orderLineId: 'clz9k2f0a0004abcd3456qrst',
sku: 'SKU-1024',
description: 'Wool sweater, navy',
unitPrice: 299.95,
currency: 'DKK',
vatPercent: 25,
location: 'A-12-3',
countryOfOrigin: 'DK',
hsCode: '61101100',
tarrifNumber: '61101100'
}
],
id: 'prc_5a6b7c8d',
trackingNumber: '00370724710000012345',
trackingUrl: 'https://tracking.postnord.com/00370724710000012345',
labelFreeCode: 'AB12CD34',
qrCodeLink: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
qrCodeDataUri: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
qrCodeUrl: 'https://qr.bring.com/label-free/AB12CD34.png'
}
],
pickupDetails: {
date: '2026-06-22',
from: '08:00:00',
to: '16:00:00',
instruction: 'Ring the bell at the loading dock.'
},
termOfTrade: 'DAP',
status: 'pending',
orderId: 'ord_5e6f7a8b',
labelPrinterId: 'prn_label_01',
documentPrinterId: 'prn_doc_01',
shippingRuleId: 'rule_3c4d5e6f',
droppoint: {
id: 'SP-1234',
name: 'Brugsen Vesterbro',
address: 'Vesterbrogade 12, 1620 København'
}
})
};
fetch('https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"ORDER-1042\",\n \"addressId\": \"addr_7e8f9a0b\",\n \"servicePointId\": \"sp_pn_4521\",\n \"parties\": [\n {\n \"type\": \"receiver\",\n \"name\": \"Anna Jensen\",\n \"address1\": \"Vesterbrogade 12\",\n \"postalCode\": \"1620\",\n \"city\": \"København V\",\n \"countryCode\": \"DK\",\n \"attention\": \"Reception\",\n \"address2\": \"2. sal\",\n \"email\": \"[email protected]\",\n \"phone\": \"+4520123456\",\n \"attributes\": []\n }\n ],\n \"type\": \"outbound\",\n \"parcels\": [\n {\n \"weight\": 2.5,\n \"weightUnit\": \"kg\",\n \"dimensions\": {\n \"length\": 30,\n \"width\": 20,\n \"height\": 15\n },\n \"orderLines\": [\n {\n \"quantity\": 2,\n \"id\": \"ol_9c1d2e3f\",\n \"orderLineId\": \"clz9k2f0a0004abcd3456qrst\",\n \"sku\": \"SKU-1024\",\n \"description\": \"Wool sweater, navy\",\n \"unitPrice\": 299.95,\n \"currency\": \"DKK\",\n \"vatPercent\": 25,\n \"location\": \"A-12-3\",\n \"countryOfOrigin\": \"DK\",\n \"hsCode\": \"61101100\",\n \"tarrifNumber\": \"61101100\"\n }\n ],\n \"id\": \"prc_5a6b7c8d\",\n \"trackingNumber\": \"00370724710000012345\",\n \"trackingUrl\": \"https://tracking.postnord.com/00370724710000012345\",\n \"labelFreeCode\": \"AB12CD34\",\n \"qrCodeLink\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n \"qrCodeDataUri\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n \"qrCodeUrl\": \"https://qr.bring.com/label-free/AB12CD34.png\"\n }\n ],\n \"pickupDetails\": {\n \"date\": \"2026-06-22\",\n \"from\": \"08:00:00\",\n \"to\": \"16:00:00\",\n \"instruction\": \"Ring the bell at the loading dock.\"\n },\n \"termOfTrade\": \"DAP\",\n \"status\": \"pending\",\n \"orderId\": \"ord_5e6f7a8b\",\n \"labelPrinterId\": \"prn_label_01\",\n \"documentPrinterId\": \"prn_doc_01\",\n \"shippingRuleId\": \"rule_3c4d5e6f\",\n \"droppoint\": {\n \"id\": \"SP-1234\",\n \"name\": \"Brugsen Vesterbro\",\n \"address\": \"Vesterbrogade 12, 1620 København\"\n }\n}")
.asString();{
"id": "shp_4d9e7a2f",
"reference": "ORDER-1042",
"parties": [
{
"type": "receiver",
"name": "Anna Jensen",
"address1": "Vesterbrogade 12",
"postalCode": "1620",
"city": "København V",
"countryCode": "DK",
"attributes": [],
"attention": "Reception",
"address2": "2. sal",
"email": "[email protected]",
"phone": "+4520123456"
}
],
"type": "outbound",
"carrierSettings": {
"carrierId": "car_pn_001",
"productId": "prod_mypack_home",
"services": [
"A7"
],
"additionalParameters": {
"notificationEmail": "[email protected]"
}
},
"parcels": [
{
"weight": 2.5,
"weightUnit": "kg",
"dimensions": {
"length": 30,
"width": 20,
"height": 15
},
"orderLines": [
{
"quantity": 2,
"id": "ol_9c1d2e3f",
"orderLineId": "clz9k2f0a0004abcd3456qrst",
"sku": "SKU-1024",
"description": "Wool sweater, navy",
"unitPrice": 299.95,
"currency": "DKK",
"vatPercent": 25,
"location": "A-12-3",
"countryOfOrigin": "DK",
"hsCode": "61101100",
"tarrifNumber": "61101100"
}
],
"id": "prc_5a6b7c8d",
"trackingNumber": "00370724710000012345",
"trackingUrl": "https://tracking.postnord.com/00370724710000012345",
"labelFreeCode": "AB12CD34",
"qrCodeLink": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeDataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeUrl": "https://qr.bring.com/label-free/AB12CD34.png"
}
],
"termOfTrade": "DAP",
"errors": [],
"status": "pending",
"orgId": "org_1a2b3c4d",
"logs": [],
"activities": [],
"createdAt": "2026-06-22T14:30:00.000Z",
"updatedAt": "2026-06-22T14:30:00.000Z",
"addressId": "addr_7e8f9a0b",
"servicePointId": "sp_pn_4521",
"pickupDetails": {
"date": "2026-06-22",
"from": "08:00:00",
"to": "16:00:00",
"instruction": "Ring the bell at the loading dock."
},
"documents": [
{
"id": "doc_8f3a2b1c",
"shipmentId": "shp_4d9e7a2f",
"documentType": "label",
"format": "pdf",
"content": "JVBERi0xLjQKJeLjz9MKMS...",
"size": "100X150",
"createdAt": "2026-06-22T14:30:00.000Z",
"updatedAt": "2026-06-22T14:30:00.000Z"
}
],
"tracking": {
"url": "https://tracking.postnord.com/00370724710000012345",
"number": "00370724710000012345",
"labelFreeCode": "AB12CD34",
"qrCodeLink": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeDataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"qrCodeUrl": "https://qr.bring.com/label-free/AB12CD34.png"
},
"orderId": "ord_5e6f7a8b",
"shippingRuleId": "rule_3c4d5e6f",
"shippingRule": {
"id": "rule_3c4d5e6f",
"name": "Domestic standard",
"carrierId": "car_pn_001",
"productId": "prod_mypack_home",
"services": [
"A7"
],
"addressId": "addr_7e8f9a0b",
"returnShippingRuleId": "rule_return_01",
"autoCreateReturnShipment": false,
"autoPrintLabels": true,
"autoPrintDocuments": false,
"labelPrinterId": "prn_label_01",
"documentPrinterId": "prn_doc_01"
},
"labelPrinterId": "prn_label_01",
"documentPrinterId": "prn_doc_01"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}{
"error": "Bad Request",
"message": "Failed to create address",
"code": "CARRIER_GLS_WRONG_ADDRESS"
}Authorizations
JWT access token or API token (prefixed with zipp_)
Path Parameters
Organization identifier.
Example:
"org_1a2b3c4d"
Shipment identifier.
Example:
"shp_4d9e7a2f"
Body
application/json
Customer-facing shipment reference.
Minimum string length:
1Example:
"ORDER-1042"
Sender address identifier.
Example:
"addr_7e8f9a0b"
Selected service point ID.
Example:
"sp_pn_4521"
Parties involved in the shipment. Optional when orderId is provided.
Minimum array length:
1Show child attributes
Show child attributes
Direction of the shipment relative to the organization.
Available options:
outbound, inbound Example:
"outbound"
Show child attributes
Show child attributes
Parcels to include. Optional when orderId is provided.
Minimum array length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Incoterm governing the shipment.
Example:
"DAP"
Lifecycle status of the shipment.
Available options:
draft, pending, processing, dispatched, partly_dispatched, error, cancelled, on_hold Example:
"pending"
Order to derive parties and parcels from.
Example:
"ord_5e6f7a8b"
Printer to assign for labels.
Example:
"prn_label_01"
Printer to assign for documents.
Example:
"prn_doc_01"
Shipping rule to apply to the shipment. Pass null to clear.
Example:
"rule_3c4d5e6f"
Display details of the selected service point, stored alongside servicePointId. Used when applying a service-point shipping rule (whose parameters otherwise replace it).
Show child attributes
Show child attributes
Example:
{
"id": "SP-1234",
"name": "Brugsen Vesterbro",
"address": "Vesterbrogade 12, 1620 København"
}
Response
Default Response
Unique shipment identifier.
Example:
"shp_4d9e7a2f"
Customer-facing shipment reference.
Example:
"ORDER-1042"
Parties involved in the shipment (sender, receiver, etc.).
Show child attributes
Show child attributes
Direction of the shipment relative to the organization.
Available options:
outbound, inbound Example:
"outbound"
Show child attributes
Show child attributes
Parcels included in the shipment.
Show child attributes
Show child attributes
Incoterm governing the shipment.
Example:
"DAP"
Carrier errors recorded for the shipment.
Show child attributes
Show child attributes
Lifecycle status of the shipment.
Available options:
draft, pending, processing, dispatched, partly_dispatched, error, cancelled, on_hold Example:
"pending"
Owning organization identifier.
Example:
"org_1a2b3c4d"
Request/response logs captured during carrier interactions.
Show child attributes
Show child attributes
Chronological activity history of the shipment.
Show child attributes
Show child attributes
Timestamp when the shipment was created.
Example:
"2026-06-22T14:30:00.000Z"
Timestamp when the shipment was last updated.
Example:
"2026-06-22T14:30:00.000Z"
Sender address identifier.
Example:
"addr_7e8f9a0b"
Selected service point ID.
Example:
"sp_pn_4521"
Show child attributes
Show child attributes
Documents generated for the shipment (labels, invoices).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Associated order identifier.
Example:
"ord_5e6f7a8b"
Applied shipping rule identifier.
Example:
"rule_3c4d5e6f"
Show child attributes
Show child attributes
Printer assigned for labels on this shipment.
Example:
"prn_label_01"
Printer assigned for documents on this shipment.
Example:
"prn_doc_01"
Was this page helpful?
⌘I