TypeScript
import { Configuration, ShipmentsApi } from "@zippendo/sdk"
const api = new ShipmentsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.batchSendShipments({ orgId: "...", batchSendShipmentsRequest: { /* ... */ } })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.ShipmentsApi(client).batch_send_shipments("...", zippendo.BatchSendShipmentsRequest())<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(), $config);
$result = $api->batchSendShipments("...", new \Zippendo\Sdk\Model\BatchSendShipmentsRequest([]));client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.ShipmentsAPI.BatchSendShipments(ctx, "...").BatchSendShipmentsRequest(*zippendo.NewBatchSendShipmentsRequest()).Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::ShipmentsApi.new.batch_send_shipments("...", Zippendo::BatchSendShipmentsRequest.new)curl --request POST \
--url https://api.zippendo.com/orgs/{orgId}/shipments/batch-send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"shipmentIds": [
"shp_01H8XABC123",
"shp_01H8XDEF456"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({shipmentIds: ['shp_01H8XABC123', 'shp_01H8XDEF456']})
};
fetch('https://api.zippendo.com/orgs/{orgId}/shipments/batch-send', 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/batch-send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"shipmentIds\": [\n \"shp_01H8XABC123\",\n \"shp_01H8XDEF456\"\n ]\n}")
.asString();{
"results": [
{
"shipmentId": "shp_01H8XABC123",
"status": "sent",
"code": "CARRIER_ERROR",
"message": "Shipment must be in pending or error status to be sent",
"errors": [
{
"message": "Receiver postal code is invalid for the selected product.",
"code": "INVALID_POSTAL_CODE"
}
]
}
],
"summary": {
"total": 3,
"sent": 2,
"failed": 1,
"skipped": 0
}
}{
"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
Batch send shipments
Send multiple shipments in pending or error status to their carriers in one request. Each shipment is processed independently and reported in results; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
POST
/
orgs
/
{orgId}
/
shipments
/
batch-send
TypeScript
import { Configuration, ShipmentsApi } from "@zippendo/sdk"
const api = new ShipmentsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.batchSendShipments({ orgId: "...", batchSendShipmentsRequest: { /* ... */ } })import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.ShipmentsApi(client).batch_send_shipments("...", zippendo.BatchSendShipmentsRequest())<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(), $config);
$result = $api->batchSendShipments("...", new \Zippendo\Sdk\Model\BatchSendShipmentsRequest([]));client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.ShipmentsAPI.BatchSendShipments(ctx, "...").BatchSendShipmentsRequest(*zippendo.NewBatchSendShipmentsRequest()).Execute()require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::ShipmentsApi.new.batch_send_shipments("...", Zippendo::BatchSendShipmentsRequest.new)curl --request POST \
--url https://api.zippendo.com/orgs/{orgId}/shipments/batch-send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"shipmentIds": [
"shp_01H8XABC123",
"shp_01H8XDEF456"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({shipmentIds: ['shp_01H8XABC123', 'shp_01H8XDEF456']})
};
fetch('https://api.zippendo.com/orgs/{orgId}/shipments/batch-send', 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/batch-send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"shipmentIds\": [\n \"shp_01H8XABC123\",\n \"shp_01H8XDEF456\"\n ]\n}")
.asString();{
"results": [
{
"shipmentId": "shp_01H8XABC123",
"status": "sent",
"code": "CARRIER_ERROR",
"message": "Shipment must be in pending or error status to be sent",
"errors": [
{
"message": "Receiver postal code is invalid for the selected product.",
"code": "INVALID_POSTAL_CODE"
}
]
}
],
"summary": {
"total": 3,
"sent": 2,
"failed": 1,
"skipped": 0
}
}{
"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 ID
Example:
"org_8f3kd92ld0"
Body
application/json
IDs of the shipments to send. Each must be in pending or error status; duplicates are ignored. Max 100 per request.
Required array length:
1 - 100 elementsMinimum string length:
1Example:
["shp_01H8XABC123", "shp_01H8XDEF456"]
Was this page helpful?
⌘I