TypeScript
import { Configuration, ShipmentsApi } from "@zippendo/sdk"
const api = new ShipmentsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.splitShipment({ orgId: "...", shipmentId: "...", splitShipmentRequest: { /* ... */ } })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.ShipmentsApi(client).split_shipment("...", "...", zippendo.SplitShipmentRequest())<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(), $config);
$result = $api->splitShipment("...", "...", new \Zippendo\Sdk\Model\SplitShipmentRequest([]));client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.ShipmentsAPI.SplitShipment(ctx, "...", "...").SplitShipmentRequest(*zippendo.NewSplitShipmentRequest()).Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::ShipmentsApi.new.split_shipment("...", "...", Zippendo::SplitShipmentRequest.new)curl --request POST \
--url https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}/split-shipment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parcelId": "prc_5a6b7c8d",
"orderLineIds": [
"ol_9c1d2e3f"
],
"carrierId": "car_pn_001",
"productId": "prod_mypack_home",
"services": [
"A7"
],
"additionalParameters": {
"notificationEmail": "[email protected]"
},
"reference": "ORDER-1042-split"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parcelId: 'prc_5a6b7c8d',
orderLineIds: ['ol_9c1d2e3f'],
carrierId: 'car_pn_001',
productId: 'prod_mypack_home',
services: ['A7'],
additionalParameters: {notificationEmail: '[email protected]'},
reference: 'ORDER-1042-split'
})
};
fetch('https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}/split-shipment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}/split-shipment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parcelId\": \"prc_5a6b7c8d\",\n \"orderLineIds\": [\n \"ol_9c1d2e3f\"\n ],\n \"carrierId\": \"car_pn_001\",\n \"productId\": \"prod_mypack_home\",\n \"services\": [\n \"A7\"\n ],\n \"additionalParameters\": {\n \"notificationEmail\": \"[email protected]\"\n },\n \"reference\": \"ORDER-1042-split\"\n}")
.asString();{
"originalShipment": {
"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"
},
"newShipment": {
"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
Split shipment
Move order lines from a parcel into a new shipment. Only draft or pending shipments can be split.
POST
/
orgs
/
{orgId}
/
shipments
/
{shipmentId}
/
split-shipment
TypeScript
import { Configuration, ShipmentsApi } from "@zippendo/sdk"
const api = new ShipmentsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.splitShipment({ orgId: "...", shipmentId: "...", splitShipmentRequest: { /* ... */ } })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.ShipmentsApi(client).split_shipment("...", "...", zippendo.SplitShipmentRequest())<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(), $config);
$result = $api->splitShipment("...", "...", new \Zippendo\Sdk\Model\SplitShipmentRequest([]));client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.ShipmentsAPI.SplitShipment(ctx, "...", "...").SplitShipmentRequest(*zippendo.NewSplitShipmentRequest()).Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::ShipmentsApi.new.split_shipment("...", "...", Zippendo::SplitShipmentRequest.new)curl --request POST \
--url https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}/split-shipment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parcelId": "prc_5a6b7c8d",
"orderLineIds": [
"ol_9c1d2e3f"
],
"carrierId": "car_pn_001",
"productId": "prod_mypack_home",
"services": [
"A7"
],
"additionalParameters": {
"notificationEmail": "[email protected]"
},
"reference": "ORDER-1042-split"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parcelId: 'prc_5a6b7c8d',
orderLineIds: ['ol_9c1d2e3f'],
carrierId: 'car_pn_001',
productId: 'prod_mypack_home',
services: ['A7'],
additionalParameters: {notificationEmail: '[email protected]'},
reference: 'ORDER-1042-split'
})
};
fetch('https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}/split-shipment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/shipments/{shipmentId}/split-shipment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parcelId\": \"prc_5a6b7c8d\",\n \"orderLineIds\": [\n \"ol_9c1d2e3f\"\n ],\n \"carrierId\": \"car_pn_001\",\n \"productId\": \"prod_mypack_home\",\n \"services\": [\n \"A7\"\n ],\n \"additionalParameters\": {\n \"notificationEmail\": \"[email protected]\"\n },\n \"reference\": \"ORDER-1042-split\"\n}")
.asString();{
"originalShipment": {
"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"
},
"newShipment": {
"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
Parcel whose order lines are split into a new shipment.
Example:
"prc_5a6b7c8d"
Order line IDs to move. If omitted, all order lines in the parcel are moved.
Example:
["ol_9c1d2e3f"]
Carrier for the new shipment. Copied from the original if omitted.
Example:
"car_pn_001"
Carrier product for the new shipment. Copied from the original if omitted.
Example:
"prod_mypack_home"
Service codes for the new shipment. Copied from the original if omitted.
Example:
["A7"]
Carrier-specific parameters for the new shipment. Copied from the original if omitted.
Show child attributes
Show child attributes
Example:
{ "notificationEmail": "[email protected]" }
Reference for the new shipment. Defaults to the original reference with a suffix.
Example:
"ORDER-1042-split"
Was this page helpful?
⌘I