cURL
curl -X POST https://api.goshippo.com/batches/<BATCH OBJECT ID>/add_shipments \
-H "Authorization: ShippoToken <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '[
{
"shipment": {
"address_from": {
"name": "Mr Hippo",
"street1": "965 Mission St",
"street2": "Ste 201",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US",
"phone": "4151234567",
},
"address_to": {
"name": "Hippo Jr",
"street1": "915 Broadway",
"street2": "19th Floor",
"city": "New York",
"state": "NY",
"zip": "10010",
"country": "US",
"phone": "2129947880",
},
"parcels": [{
"length": "12",
"width": "12",
"height": "12",
"distance_unit": "in",
"weight": "12",
"mass_unit": "oz"
}]
}
},
{
"shipment": {
"address_from": {
"name": "Ms Hippo",
"street1": "1092 Indian Summer Ct",
"city": "San Jose",
"state": "CA",
"zip": "95122",
"country": "US",
"phone": "4151234567",
},
"address_to": {
"name": "Mr Hippo",
"street1": "965 Mission St",
"street2": "Ste 201",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US",
"phone": "4151234567",
},
"parcels": [{
"length": "5",
"width": "5",
"height": "5",
"distance_unit": "in",
"weight": "2",
"mass_unit": "lb"
}]
},
"carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
"servicelevel_token": "fedex_2_day"
}
]'import shippo
from shippo.models import components
s = shippo.Shippo(
api_key_header='ShippoToken <API_TOKEN>',
shippo_api_version='2018-02-08',
)
res = s.batches.add_shipments(request_body=[
components.BatchShipmentCreateRequest(
carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',
metadata='SHIPMENT #1',
servicelevel_token='fedex_ground',
shipment=components.ShipmentCreateRequest(
extra=components.ShipmentExtra(
accounts_receivable_customer_account=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
appropriation_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
bill_of_lading_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
cod_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
customer_reference=components.CustomerReference(
ref_sort=1,
),
dealer_order_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
dept_number=components.DepartmentNumber(
ref_sort=3,
),
fda_product_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
insurance=components.Insurance(
amount='5.5',
currency='USD',
),
invoice_number=components.InvoiceNumber(
ref_sort=2,
),
manifest_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
model_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
part_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
po_number=components.PoNumber(
ref_sort=2,
),
production_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
purchase_request_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
rma_number=components.RmaNumber(
ref_sort=1,
),
salesperson_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
serial_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
store_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
transaction_reference_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
),
metadata='Customer ID 123456',
shipment_date='2021-03-22T12:00:00Z',
address_from=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_return=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_to='d799c2679e644279b59fe661ac8fa489',
customs_declaration='adcfdddf8ec64b84ad22772bce3ea37a',
carrier_accounts=[
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels=[
'<value>',
'<value>',
components.ParcelCreateFromTemplateRequest(
extra=components.ParcelExtra(
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
insurance=components.ParcelInsurance(
amount='5.5',
content='Laptop',
currency='USD',
provider=components.ParcelInsuranceProvider.UPS,
),
),
metadata='Customer ID 123456',
mass_unit=components.WeightUnitEnum.LB,
weight='1',
template=components.ParcelTemplateUSPSEnum.USPS_SMALL_FLAT_RATE_ENVELOPE,
),
],
),
),
components.BatchShipmentCreateRequest(
carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',
metadata='SHIPMENT #1',
servicelevel_token='fedex_ground',
shipment=components.ShipmentCreateRequest(
extra=components.ShipmentExtra(
accounts_receivable_customer_account=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
appropriation_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
bill_of_lading_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
cod_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
customer_reference=components.CustomerReference(
ref_sort=1,
),
dealer_order_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
dept_number=components.DepartmentNumber(
ref_sort=3,
),
fda_product_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
insurance=components.Insurance(
amount='5.5',
currency='USD',
),
invoice_number=components.InvoiceNumber(
ref_sort=2,
),
manifest_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
model_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
part_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
po_number=components.PoNumber(
ref_sort=2,
),
production_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
purchase_request_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
rma_number=components.RmaNumber(
ref_sort=1,
),
salesperson_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
serial_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
store_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
transaction_reference_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
),
metadata='Customer ID 123456',
shipment_date='2021-03-22T12:00:00Z',
address_from=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_return=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_to=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
customs_declaration=components.CustomsDeclarationCreateRequest(
b13a_filing_option=components.CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY,
certify=True,
certify_signer='Shawn Ippotle',
contents_explanation='T-Shirt purchase',
duties_payor=components.DutiesPayor(
account='2323434543',
type=components.CustomsDeclarationCreateRequestType.THIRD_PARTY,
address=components.CustomsDeclarationCreateRequestAddress(
name='Patrick Kavanagh',
zip='80331',
country='DE',
),
),
exporter_identification=components.CustomsExporterIdentification(
eori_number='PL123456790ABCDE',
tax_id=components.CustomsTaxIdentification(
number='123456789',
type=components.CustomsTaxIdentificationType.EIN,
),
),
invoice='#123123',
metadata='Order ID #123123',
address_importer=components.AddressImporter(
name='Shwan Ippotle',
company='Shippo',
street1='Blumenstraße',
street3='',
street_no='22',
city='München',
state='CA',
zip='80331',
country='DE',
phone='80331',
email='shippotle@shippo.com',
is_residential=True,
),
contents_type=components.CustomsDeclarationContentsTypeEnum.MERCHANDISE,
eel_pfc=components.CustomsDeclarationEelPfcEnum.NOEEI_30_37_A,
incoterm=components.CustomsDeclarationIncotermEnum.DDP,
items=[
components.CustomsItemCreateRequest(
description='T-Shirt',
mass_unit=components.WeightUnitEnum.LB,
metadata='Order ID "123454"',
net_weight='5',
origin_country='<value>',
quantity=20,
sku_code='HM-123',
hs_code='0901.21',
value_amount='200',
value_currency='USD',
),
],
non_delivery_option=components.CustomsDeclarationNonDeliveryOptionEnum.RETURN,
test=True,
),
carrier_accounts=[
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels=[
components.ParcelCreateFromTemplateRequest(
extra=components.ParcelExtra(
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
insurance=components.ParcelInsurance(
amount='5.5',
content='Laptop',
currency='USD',
provider=components.ParcelInsuranceProvider.UPS,
),
),
metadata='Customer ID 123456',
mass_unit=components.WeightUnitEnum.LB,
weight='1',
template=components.ParcelTemplateDPDUKEnum.DPD_UK_EXPRESS_PAK,
),
components.ParcelCreateFromTemplateRequest(
extra=components.ParcelExtra(
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
insurance=components.ParcelInsurance(
amount='5.5',
content='Laptop',
currency='USD',
provider=components.ParcelInsuranceProvider.UPS,
),
),
metadata='Customer ID 123456',
mass_unit=components.WeightUnitEnum.LB,
weight='1',
template=components.ParcelTemplateDHLeCommerceEnum.DH_LE_C_IRREGULAR,
),
],
),
),
components.BatchShipmentCreateRequest(
carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',
metadata='SHIPMENT #1',
servicelevel_token='fedex_ground',
shipment=components.ShipmentCreateRequest(
extra=components.ShipmentExtra(
accounts_receivable_customer_account=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
appropriation_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
bill_of_lading_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
cod_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
customer_reference=components.CustomerReference(
ref_sort=1,
),
dealer_order_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
dept_number=components.DepartmentNumber(
ref_sort=3,
),
fda_product_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
insurance=components.Insurance(
amount='5.5',
currency='USD',
),
invoice_number=components.InvoiceNumber(
ref_sort=2,
),
manifest_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
model_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
part_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
po_number=components.PoNumber(
ref_sort=2,
),
production_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
purchase_request_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
rma_number=components.RmaNumber(
ref_sort=1,
),
salesperson_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
serial_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
store_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
transaction_reference_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
),
metadata='Customer ID 123456',
shipment_date='2021-03-22T12:00:00Z',
address_from='d799c2679e644279b59fe661ac8fa488',
address_return='d799c2679e644279b59fe661ac8fa488',
address_to=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
customs_declaration='adcfdddf8ec64b84ad22772bce3ea37a',
carrier_accounts=[
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels=[
'<value>',
],
),
),
], batch_id='<id>')
if res is not None:
# handle response
passimport { Shippo } from "shippo";
const shippo = new Shippo({
apiKeyHeader: "ShippoToken <API_TOKEN>",
shippoApiVersion: "2018-02-08",
});
async function run() {
const result = await shippo.batches.addShipments([
{
carrierAccount: "a4391cd4ab974f478f55dc08b5c8e3b3",
metadata: "SHIPMENT #1",
servicelevelToken: "fedex_ground",
shipment: {
extra: {
accountsReceivableCustomerAccount: {
prefix: "ABC",
value: "value",
refSort: 1,
},
appropriationNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
billOfLadingNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
codNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
customerReference: {
refSort: 1,
},
dealerOrderNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
deptNumber: {
refSort: 3,
},
fdaProductCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
insurance: {
amount: "5.5",
currency: "USD",
},
invoiceNumber: {
refSort: 2,
},
manifestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
modelNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
partNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
poNumber: {
refSort: 2,
},
productionCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
purchaseRequestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
rmaNumber: {
refSort: 1,
},
salespersonNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
serialNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
storeNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
transactionReferenceNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
},
metadata: "Customer ID 123456",
shipmentDate: "2021-03-22T12:00:00Z",
addressFrom: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressReturn: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressTo: "d799c2679e644279b59fe661ac8fa489",
customsDeclaration: "adcfdddf8ec64b84ad22772bce3ea37a",
carrierAccounts: [
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
],
parcels: [
"<value>",
"<value>",
{
extra: {
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
insurance: {
amount: "5.5",
content: "Laptop",
currency: "USD",
provider: "UPS",
},
},
metadata: "Customer ID 123456",
massUnit: "lb",
weight: "1",
template: "USPS_SmallFlatRateEnvelope",
},
],
},
},
{
carrierAccount: "a4391cd4ab974f478f55dc08b5c8e3b3",
metadata: "SHIPMENT #1",
servicelevelToken: "fedex_ground",
shipment: {
extra: {
accountsReceivableCustomerAccount: {
prefix: "ABC",
value: "value",
refSort: 1,
},
appropriationNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
billOfLadingNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
codNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
customerReference: {
refSort: 1,
},
dealerOrderNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
deptNumber: {
refSort: 3,
},
fdaProductCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
insurance: {
amount: "5.5",
currency: "USD",
},
invoiceNumber: {
refSort: 2,
},
manifestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
modelNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
partNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
poNumber: {
refSort: 2,
},
productionCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
purchaseRequestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
rmaNumber: {
refSort: 1,
},
salespersonNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
serialNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
storeNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
transactionReferenceNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
},
metadata: "Customer ID 123456",
shipmentDate: "2021-03-22T12:00:00Z",
addressFrom: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressReturn: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressTo: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
customsDeclaration: {
b13aFilingOption: "FILED_ELECTRONICALLY",
certify: true,
certifySigner: "Shawn Ippotle",
contentsExplanation: "T-Shirt purchase",
dutiesPayor: {
account: "2323434543",
type: "THIRD_PARTY",
address: {
name: "Patrick Kavanagh",
zip: "80331",
country: "DE",
},
},
exporterIdentification: {
eoriNumber: "PL123456790ABCDE",
taxId: {
number: "123456789",
type: "EIN",
},
},
invoice: "#123123",
metadata: "Order ID #123123",
addressImporter: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "Blumenstraße",
street3: "",
streetNo: "22",
city: "München",
state: "CA",
zip: "80331",
country: "DE",
phone: "80331",
email: "shippotle@shippo.com",
isResidential: true,
},
contentsType: "MERCHANDISE",
eelPfc: "NOEEI_30_37_a",
incoterm: "DDP",
items: [
{
description: "T-Shirt",
massUnit: "lb",
metadata: "Order ID \"123454\"",
netWeight: "5",
originCountry: "<value>",
quantity: 20,
skuCode: "HM-123",
hsCode: "0901.21",
valueAmount: "200",
valueCurrency: "USD",
},
],
nonDeliveryOption: "RETURN",
test: true,
},
carrierAccounts: [
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
],
parcels: [
{
extra: {
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
insurance: {
amount: "5.5",
content: "Laptop",
currency: "USD",
provider: "UPS",
},
},
metadata: "Customer ID 123456",
massUnit: "lb",
weight: "1",
template: "DPD_UK_Express_Pak",
},
{
extra: {
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
insurance: {
amount: "5.5",
content: "Laptop",
currency: "USD",
provider: "UPS",
},
},
metadata: "Customer ID 123456",
massUnit: "lb",
weight: "1",
template: "DHLeC_Irregular",
},
],
},
},
{
carrierAccount: "a4391cd4ab974f478f55dc08b5c8e3b3",
metadata: "SHIPMENT #1",
servicelevelToken: "fedex_ground",
shipment: {
extra: {
accountsReceivableCustomerAccount: {
prefix: "ABC",
value: "value",
refSort: 1,
},
appropriationNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
billOfLadingNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
codNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
customerReference: {
refSort: 1,
},
dealerOrderNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
deptNumber: {
refSort: 3,
},
fdaProductCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
insurance: {
amount: "5.5",
currency: "USD",
},
invoiceNumber: {
refSort: 2,
},
manifestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
modelNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
partNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
poNumber: {
refSort: 2,
},
productionCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
purchaseRequestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
rmaNumber: {
refSort: 1,
},
salespersonNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
serialNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
storeNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
transactionReferenceNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
},
metadata: "Customer ID 123456",
shipmentDate: "2021-03-22T12:00:00Z",
addressFrom: "d799c2679e644279b59fe661ac8fa488",
addressReturn: "d799c2679e644279b59fe661ac8fa488",
addressTo: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
customsDeclaration: "adcfdddf8ec64b84ad22772bce3ea37a",
carrierAccounts: [
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
],
parcels: [
"<value>",
],
},
},
], "<id>");
// Handle the result
console.log(result);
}
run();using Shippo;
using Shippo.Models.Components;
using System.Collections.Generic;
var sdk = new ShippoSDK(
apiKeyHeader: "ShippoToken <API_TOKEN>",
shippoApiVersion: "2018-02-08"
);
var res = await sdk.Batches.AddShipmentsAsync(
batchId: "<id>",
requestBody: new List<BatchShipmentCreateRequest>() {
new BatchShipmentCreateRequest() {
CarrierAccount = "a4391cd4ab974f478f55dc08b5c8e3b3",
Metadata = "SHIPMENT #1",
ServicelevelToken = "fedex_ground",
Shipment = new ShipmentCreateRequest() {
Extra = new ShipmentExtra() {
AccountsReceivableCustomerAccount = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
AppropriationNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
BillOfLadingNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
Cod = new Cod() {
Amount = "5.5",
Currency = "USD",
PaymentMethod = PaymentMethod.Cash,
},
CodNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
CustomerReference = new CustomerReference() {
RefSort = 1,
},
DealerOrderNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
DeptNumber = new DepartmentNumber() {
RefSort = 3,
},
FdaProductCode = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
Insurance = new Insurance() {
Amount = "5.5",
Currency = "USD",
},
InvoiceNumber = new InvoiceNumber() {
RefSort = 2,
},
ManifestNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
ModelNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
PartNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
PoNumber = new PoNumber() {
RefSort = 2,
},
ProductionCode = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
PurchaseRequestNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
RmaNumber = new RmaNumber() {
RefSort = 1,
},
SalespersonNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
SerialNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
StoreNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
TransactionReferenceNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
},
Metadata = "Customer ID 123456",
ShipmentDate = "2021-03-22T12:00:00Z",
AddressFrom = AddressFrom.CreateStr(
"d799c2679e644279b59fe661ac8fa488"
),
AddressReturn = AddressReturn.CreateAddressCreateRequest(
new AddressCreateRequest() {
Name = "Shwan Ippotle",
Company = "Shippo",
Street1 = "215 Clayton St.",
Street3 = "",
StreetNo = "",
City = "San Francisco",
State = "CA",
Zip = "94117",
Country = "US",
Phone = "+1 555 341 9393",
Email = "shippotle@shippo.com",
IsResidential = true,
Metadata = "Customer ID 123456",
Validate = true,
}
),
AddressTo = AddressTo.CreateAddressCreateRequest(
new AddressCreateRequest() {
Name = "Shwan Ippotle",
Company = "Shippo",
Street1 = "215 Clayton St.",
Street3 = "",
StreetNo = "",
City = "San Francisco",
State = "CA",
Zip = "94117",
Country = "US",
Phone = "+1 555 341 9393",
Email = "shippotle@shippo.com",
IsResidential = true,
Metadata = "Customer ID 123456",
Validate = true,
}
),
CustomsDeclaration = ShipmentCreateRequestCustomsDeclaration.CreateStr(
"adcfdddf8ec64b84ad22772bce3ea37a"
),
CarrierAccounts = new List<string>() {
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
},
Parcels = new List<Models.Components.Parcels>() {
Parcels.CreateStr(
"<value>"
),
},
},
},
},
shippoApiVersion: "2018-02-08"
);
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use Shippo\API;
use Shippo\API\Models\Components;
$sdk = API\Shippo::builder()
->setSecurity(
'ShippoToken <API_TOKEN>'
)
->setShippoApiVersion('2018-02-08')
->build();
$response = $sdk->batches->addShipments(
batchId: '<id>',
requestBody: [
new Components\BatchShipmentCreateRequest(
carrierAccount: 'a4391cd4ab974f478f55dc08b5c8e3b3',
metadata: 'SHIPMENT #1',
servicelevelToken: 'fedex_ground',
shipment: new Components\ShipmentCreateRequest(
extra: new Components\ShipmentExtra(
accountsReceivableCustomerAccount: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
appropriationNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
billOfLadingNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
cod: new Components\Cod(
amount: '5.5',
currency: 'USD',
paymentMethod: Components\PaymentMethod::Cash,
),
codNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
customerReference: new Components\CustomerReference(
refSort: 1,
),
dealerOrderNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
deptNumber: new Components\DepartmentNumber(
refSort: 3,
),
fdaProductCode: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
insurance: new Components\Insurance(
amount: '5.5',
currency: 'USD',
),
invoiceNumber: new Components\InvoiceNumber(
refSort: 2,
),
manifestNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
modelNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
partNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
poNumber: new Components\PoNumber(
refSort: 2,
),
productionCode: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
purchaseRequestNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
rmaNumber: new Components\RmaNumber(
refSort: 1,
),
salespersonNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
serialNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
storeNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
transactionReferenceNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
),
metadata: 'Customer ID 123456',
shipmentDate: '2021-03-22T12:00:00Z',
addressFrom: 'd799c2679e644279b59fe661ac8fa488',
addressReturn: new Components\AddressCreateRequest(
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street3: '',
streetNo: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
country: 'US',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
isResidential: true,
metadata: 'Customer ID 123456',
validate: true,
),
addressTo: new Components\AddressCreateRequest(
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street3: '',
streetNo: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
country: 'US',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
isResidential: true,
metadata: 'Customer ID 123456',
validate: true,
),
customsDeclaration: 'adcfdddf8ec64b84ad22772bce3ea37a',
carrierAccounts: [
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels: [
'<value>',
],
),
),
],
shippoApiVersion: '2018-02-08'
);
if ($response->batch !== null) {
// handle response
}package hello.world;
import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.AddressCreateRequest;
import com.goshippo.shippo_sdk.models.components.AddressFrom;
import com.goshippo.shippo_sdk.models.components.AddressImporter;
import com.goshippo.shippo_sdk.models.components.AddressReturn;
import com.goshippo.shippo_sdk.models.components.AddressTo;
import com.goshippo.shippo_sdk.models.components.BatchShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.Cod;
import com.goshippo.shippo_sdk.models.components.CustomerReference;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationB13AFilingOptionEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationContentsTypeEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequest;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestAddress;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestType;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationEelPfcEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationIncotermEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationNonDeliveryOptionEnum;
import com.goshippo.shippo_sdk.models.components.CustomsExporterIdentification;
import com.goshippo.shippo_sdk.models.components.CustomsItemCreateRequest;
import com.goshippo.shippo_sdk.models.components.CustomsTaxIdentification;
import com.goshippo.shippo_sdk.models.components.CustomsTaxIdentificationType;
import com.goshippo.shippo_sdk.models.components.DepartmentNumber;
import com.goshippo.shippo_sdk.models.components.DutiesPayor;
import com.goshippo.shippo_sdk.models.components.Insurance;
import com.goshippo.shippo_sdk.models.components.InvoiceNumber;
import com.goshippo.shippo_sdk.models.components.ParcelCreateFromTemplateRequest;
import com.goshippo.shippo_sdk.models.components.ParcelExtra;
import com.goshippo.shippo_sdk.models.components.ParcelInsurance;
import com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateDHLeCommerceEnum;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateDPDUKEnum;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateEnumSet;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateUSPSEnum;
import com.goshippo.shippo_sdk.models.components.Parcels;
import com.goshippo.shippo_sdk.models.components.PaymentMethod;
import com.goshippo.shippo_sdk.models.components.PoNumber;
import com.goshippo.shippo_sdk.models.components.RmaNumber;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequestCustomsDeclaration;
import com.goshippo.shippo_sdk.models.components.ShipmentExtra;
import com.goshippo.shippo_sdk.models.components.UPSReferenceFields;
import com.goshippo.shippo_sdk.models.components.WeightUnitEnum;
import com.goshippo.shippo_sdk.models.operations.AddShipmentsToBatchResponse;
import java.lang.Exception;
import java.util.List;
public class Application {
public static void main(String[] args) throws Exception {
Shippo sdk = Shippo.builder()
.apiKeyHeader("ShippoToken <API_TOKEN>")
.shippoApiVersion("2018-02-08")
.build();
AddShipmentsToBatchResponse res = sdk.batches().addShipments()
.batchId("<id>")
.shippoApiVersion("2018-02-08")
.requestBody(List.of(
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.addressTo(AddressTo.of("d799c2679e644279b59fe661ac8fa489"))
.parcels(List.of(
Parcels.of("<value>"),
Parcels.of("<value>"),
Parcels.of(ParcelCreateFromTemplateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.template(ParcelTemplateEnumSet.of(ParcelTemplateUSPSEnum.USPS_SMALL_FLAT_RATE_ENVELOPE))
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build())))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of("adcfdddf8ec64b84ad22772bce3ea37a"))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build(),
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.addressTo(AddressTo.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.parcels(List.of(
Parcels.of(ParcelCreateFromTemplateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.template(ParcelTemplateEnumSet.of(ParcelTemplateDPDUKEnum.DPDUK_EXPRESS_PAK))
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build()),
Parcels.of(ParcelCreateFromTemplateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.template(ParcelTemplateEnumSet.of(ParcelTemplateDHLeCommerceEnum.DH_LE_C_IRREGULAR))
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build())))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of(CustomsDeclarationCreateRequest.builder()
.certify(true)
.certifySigner("Shawn Ippotle")
.contentsType(CustomsDeclarationContentsTypeEnum.MERCHANDISE)
.items(List.of(
CustomsItemCreateRequest.builder()
.description("T-Shirt")
.massUnit(WeightUnitEnum.LB)
.netWeight("5")
.originCountry("<value>")
.quantity(20L)
.valueAmount("200")
.valueCurrency("USD")
.metadata("Order ID \"123454\"")
.skuCode("HM-123")
.hsCode("0901.21")
.build()))
.nonDeliveryOption(CustomsDeclarationNonDeliveryOptionEnum.RETURN)
.b13aFilingOption(CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY)
.contentsExplanation("T-Shirt purchase")
.dutiesPayor(DutiesPayor.builder()
.account("2323434543")
.type(CustomsDeclarationCreateRequestType.THIRD_PARTY)
.address(CustomsDeclarationCreateRequestAddress.builder()
.name("Patrick Kavanagh")
.zip("80331")
.country("DE")
.build())
.build())
.exporterIdentification(CustomsExporterIdentification.builder()
.eoriNumber("PL123456790ABCDE")
.taxId(CustomsTaxIdentification.builder()
.number("123456789")
.type(CustomsTaxIdentificationType.EIN)
.build())
.build())
.invoice("#123123")
.metadata("Order ID #123123")
.addressImporter(AddressImporter.builder()
.name("Shwan Ippotle")
.company("Shippo")
.street1("Blumenstraße")
.street3("")
.streetNo("22")
.city("München")
.state("CA")
.zip("80331")
.country("DE")
.phone("80331")
.email("shippotle@shippo.com")
.isResidential(true)
.build())
.eelPfc(CustomsDeclarationEelPfcEnum.NOEEI3037_A)
.incoterm(CustomsDeclarationIncotermEnum.DDP)
.test(true)
.build()))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build(),
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of("d799c2679e644279b59fe661ac8fa488"))
.addressTo(AddressTo.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.parcels(List.of(
Parcels.of("<value>")))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of("d799c2679e644279b59fe661ac8fa488"))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of("adcfdddf8ec64b84ad22772bce3ea37a"))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build()))
.call();
if (res.batch().isPresent()) {
// handle response
}
}
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
shipment: {
address_from: {
country: 'US',
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street2: '<string>',
street3: '',
street_no: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
is_residential: true,
metadata: 'Customer ID 123456',
validate: true
},
address_to: {
country: 'US',
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street2: '<string>',
street3: '',
street_no: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
is_residential: true,
metadata: 'Customer ID 123456',
validate: true
},
parcels: [
{
mass_unit: 'lb',
weight: '1',
distance_unit: 'in',
height: '1',
length: '1',
width: '1',
extra: {
COD: {amount: '5.5', currency: 'USD', payment_method: 'CASH'},
insurance: {amount: '5.5', content: 'Laptop', currency: 'USD', provider: 'UPS'},
reference_1: '<string>',
reference_2: '<string>'
},
metadata: 'Customer ID 123456'
}
],
extra: {
accounts_receivable_customer_account: {prefix: 'ABC', value: 'value', ref_sort: 1},
alcohol: {contains_alcohol: true},
appropriation_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
authority_to_leave: true,
bill_of_lading_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
billing: {
account: '<string>',
country: '<string>',
participation_code: '<string>',
zip: '<string>'
},
bypass_address_validation: true,
carbon_neutral: true,
carrier_hub_id: '<string>',
carrier_hub_travel_time: 123,
COD: {amount: '5.5', currency: 'USD', payment_method: 'CASH'},
cod_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
container_type: '<string>',
critical_pull_time: '<string>',
customer_branch: '<string>',
customer_reference: {prefix: '<string>', value: '<string>', ref_sort: 1},
dangerous_goods: {
contains: true,
biological_material: {contains: true},
lithium_batteries: {contains: true}
},
dealer_order_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
delivery_instructions: '<string>',
dept_number: {prefix: '<string>', value: '<string>', ref_sort: 3},
dry_ice: {contains_dry_ice: true, weight: '<string>'},
fda_product_code: {prefix: 'ABC', value: 'value', ref_sort: 1},
fulfillment_center: '<string>',
insurance: {amount: '5.5', content: '<string>', currency: 'USD'},
invoice_number: {prefix: '<string>', value: '<string>', ref_sort: 2},
is_return: true,
lasership_attrs: [],
lasership_declared_value: '<string>',
manifest_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
model_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
part_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
po_number: {prefix: '<string>', value: '<string>', ref_sort: 2},
premium: true,
production_code: {prefix: 'ABC', value: 'value', ref_sort: 1},
purchase_request_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
qr_code_requested: true,
reference_1: '<string>',
reference_2: '<string>',
request_retail_rates: true,
rma_number: {prefix: '<string>', value: '<string>', ref_sort: 1},
saturday_delivery: true,
salesperson_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
serial_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
store_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
transaction_reference_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
usmca_eligible: true
},
metadata: 'Customer ID 123456',
shipment_date: '2021-03-22T12:00:00Z',
address_return: {
country: 'US',
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street2: '<string>',
street3: '',
street_no: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
is_residential: true,
metadata: 'Customer ID 123456',
validate: true
},
customs_declaration: {
certify: true,
certify_signer: 'Shawn Ippotle',
contents_type: 'MERCHANDISE',
items: [
{
description: 'T-Shirt',
mass_unit: 'lb',
net_weight: '5',
origin_country: '<string>',
quantity: 20,
value_amount: '200',
value_currency: 'USD',
eccn_ear99: '<string>',
metadata: 'Order ID "123454"',
sku_code: 'HM-123',
hs_code: '0901.21',
tariff_number: '<string>'
}
],
non_delivery_option: 'RETURN',
aes_itn: '<string>',
b13a_filing_option: 'FILED_ELECTRONICALLY',
b13a_number: '<string>',
certificate: '<string>',
commercial_invoice: true,
contents_explanation: 'T-Shirt purchase',
disclaimer: '<string>',
duties_payor: {
account: '2323434543',
type: 'THIRD_PARTY',
address: {name: 'Patrick Kavanagh', zip: '80331', country: 'DE'}
},
exporter_identification: {eori_number: 'PL123456790ABCDE', tax_id: {number: '123456789', type: 'EIN'}},
exporter_reference: '<string>',
importer_reference: '<string>',
is_vat_collected: true,
invoice: '#123123',
license: '<string>',
metadata: 'Order ID #123123',
notes: '<string>',
address_importer: {
name: 'Shwan Ippotle',
company: 'Shippo',
street1: 'Blumenstraße',
street2: '<string>',
street3: '',
street_no: '22',
city: 'München',
state: 'CA',
zip: '80331',
country: 'DE',
phone: '80331',
email: 'shippotle@shippo.com',
is_residential: true
},
eel_pfc: 'NOEEI_30_37_a',
incoterm: 'DDP',
test: true
},
async: true,
carrier_accounts: ['065a4a8c10d24a34ab932163a1b87f52', '73f706f4bdb94b54a337563840ce52b0']
},
carrier_account: 'a4391cd4ab974f478f55dc08b5c8e3b3',
metadata: 'SHIPMENT #1',
servicelevel_token: 'fedex_ground'
}
])
};
fetch('https://api.goshippo.com/batches/{BatchId}/add_shipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.goshippo.com/batches/{BatchId}/add_shipments"
payload := strings.NewReader("[\n {\n \"shipment\": {\n \"address_from\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"address_to\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"parcels\": [\n {\n \"mass_unit\": \"lb\",\n \"weight\": \"1\",\n \"distance_unit\": \"in\",\n \"height\": \"1\",\n \"length\": \"1\",\n \"width\": \"1\",\n \"extra\": {\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"Laptop\",\n \"currency\": \"USD\",\n \"provider\": \"UPS\"\n },\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\"\n },\n \"metadata\": \"Customer ID 123456\"\n }\n ],\n \"extra\": {\n \"accounts_receivable_customer_account\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"alcohol\": {\n \"contains_alcohol\": true\n },\n \"appropriation_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"authority_to_leave\": true,\n \"bill_of_lading_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"billing\": {\n \"account\": \"<string>\",\n \"country\": \"<string>\",\n \"participation_code\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"bypass_address_validation\": true,\n \"carbon_neutral\": true,\n \"carrier_hub_id\": \"<string>\",\n \"carrier_hub_travel_time\": 123,\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"cod_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"container_type\": \"<string>\",\n \"critical_pull_time\": \"<string>\",\n \"customer_branch\": \"<string>\",\n \"customer_reference\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"dangerous_goods\": {\n \"contains\": true,\n \"biological_material\": {\n \"contains\": true\n },\n \"lithium_batteries\": {\n \"contains\": true\n }\n },\n \"dealer_order_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"delivery_instructions\": \"<string>\",\n \"dept_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 3\n },\n \"dry_ice\": {\n \"contains_dry_ice\": true,\n \"weight\": \"<string>\"\n },\n \"fda_product_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"fulfillment_center\": \"<string>\",\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"<string>\",\n \"currency\": \"USD\"\n },\n \"invoice_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"is_return\": true,\n \"lasership_attrs\": [],\n \"lasership_declared_value\": \"<string>\",\n \"manifest_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"model_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"part_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"po_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"premium\": true,\n \"production_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"purchase_request_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"qr_code_requested\": true,\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\",\n \"request_retail_rates\": true,\n \"rma_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"saturday_delivery\": true,\n \"salesperson_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"serial_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"store_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"transaction_reference_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"usmca_eligible\": true\n },\n \"metadata\": \"Customer ID 123456\",\n \"shipment_date\": \"2021-03-22T12:00:00Z\",\n \"address_return\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"customs_declaration\": {\n \"certify\": true,\n \"certify_signer\": \"Shawn Ippotle\",\n \"contents_type\": \"MERCHANDISE\",\n \"items\": [\n {\n \"description\": \"T-Shirt\",\n \"mass_unit\": \"lb\",\n \"net_weight\": \"5\",\n \"origin_country\": \"<string>\",\n \"quantity\": 20,\n \"value_amount\": \"200\",\n \"value_currency\": \"USD\",\n \"eccn_ear99\": \"<string>\",\n \"metadata\": \"Order ID \\\"123454\\\"\",\n \"sku_code\": \"HM-123\",\n \"hs_code\": \"0901.21\",\n \"tariff_number\": \"<string>\"\n }\n ],\n \"non_delivery_option\": \"RETURN\",\n \"aes_itn\": \"<string>\",\n \"b13a_filing_option\": \"FILED_ELECTRONICALLY\",\n \"b13a_number\": \"<string>\",\n \"certificate\": \"<string>\",\n \"commercial_invoice\": true,\n \"contents_explanation\": \"T-Shirt purchase\",\n \"disclaimer\": \"<string>\",\n \"duties_payor\": {\n \"account\": \"2323434543\",\n \"type\": \"THIRD_PARTY\",\n \"address\": {\n \"name\": \"Patrick Kavanagh\",\n \"zip\": \"80331\",\n \"country\": \"DE\"\n }\n },\n \"exporter_identification\": {\n \"eori_number\": \"PL123456790ABCDE\",\n \"tax_id\": {\n \"number\": \"123456789\",\n \"type\": \"EIN\"\n }\n },\n \"exporter_reference\": \"<string>\",\n \"importer_reference\": \"<string>\",\n \"is_vat_collected\": true,\n \"invoice\": \"#123123\",\n \"license\": \"<string>\",\n \"metadata\": \"Order ID #123123\",\n \"notes\": \"<string>\",\n \"address_importer\": {\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"Blumenstraße\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"22\",\n \"city\": \"München\",\n \"state\": \"CA\",\n \"zip\": \"80331\",\n \"country\": \"DE\",\n \"phone\": \"80331\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true\n },\n \"eel_pfc\": \"NOEEI_30_37_a\",\n \"incoterm\": \"DDP\",\n \"test\": true\n },\n \"async\": true,\n \"carrier_accounts\": [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"\n ]\n },\n \"carrier_account\": \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n \"metadata\": \"SHIPMENT #1\",\n \"servicelevel_token\": \"fedex_ground\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.goshippo.com/batches/{BatchId}/add_shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"shipment\": {\n \"address_from\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"address_to\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"parcels\": [\n {\n \"mass_unit\": \"lb\",\n \"weight\": \"1\",\n \"distance_unit\": \"in\",\n \"height\": \"1\",\n \"length\": \"1\",\n \"width\": \"1\",\n \"extra\": {\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"Laptop\",\n \"currency\": \"USD\",\n \"provider\": \"UPS\"\n },\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\"\n },\n \"metadata\": \"Customer ID 123456\"\n }\n ],\n \"extra\": {\n \"accounts_receivable_customer_account\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"alcohol\": {\n \"contains_alcohol\": true\n },\n \"appropriation_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"authority_to_leave\": true,\n \"bill_of_lading_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"billing\": {\n \"account\": \"<string>\",\n \"country\": \"<string>\",\n \"participation_code\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"bypass_address_validation\": true,\n \"carbon_neutral\": true,\n \"carrier_hub_id\": \"<string>\",\n \"carrier_hub_travel_time\": 123,\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"cod_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"container_type\": \"<string>\",\n \"critical_pull_time\": \"<string>\",\n \"customer_branch\": \"<string>\",\n \"customer_reference\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"dangerous_goods\": {\n \"contains\": true,\n \"biological_material\": {\n \"contains\": true\n },\n \"lithium_batteries\": {\n \"contains\": true\n }\n },\n \"dealer_order_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"delivery_instructions\": \"<string>\",\n \"dept_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 3\n },\n \"dry_ice\": {\n \"contains_dry_ice\": true,\n \"weight\": \"<string>\"\n },\n \"fda_product_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"fulfillment_center\": \"<string>\",\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"<string>\",\n \"currency\": \"USD\"\n },\n \"invoice_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"is_return\": true,\n \"lasership_attrs\": [],\n \"lasership_declared_value\": \"<string>\",\n \"manifest_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"model_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"part_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"po_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"premium\": true,\n \"production_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"purchase_request_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"qr_code_requested\": true,\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\",\n \"request_retail_rates\": true,\n \"rma_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"saturday_delivery\": true,\n \"salesperson_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"serial_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"store_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"transaction_reference_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"usmca_eligible\": true\n },\n \"metadata\": \"Customer ID 123456\",\n \"shipment_date\": \"2021-03-22T12:00:00Z\",\n \"address_return\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"customs_declaration\": {\n \"certify\": true,\n \"certify_signer\": \"Shawn Ippotle\",\n \"contents_type\": \"MERCHANDISE\",\n \"items\": [\n {\n \"description\": \"T-Shirt\",\n \"mass_unit\": \"lb\",\n \"net_weight\": \"5\",\n \"origin_country\": \"<string>\",\n \"quantity\": 20,\n \"value_amount\": \"200\",\n \"value_currency\": \"USD\",\n \"eccn_ear99\": \"<string>\",\n \"metadata\": \"Order ID \\\"123454\\\"\",\n \"sku_code\": \"HM-123\",\n \"hs_code\": \"0901.21\",\n \"tariff_number\": \"<string>\"\n }\n ],\n \"non_delivery_option\": \"RETURN\",\n \"aes_itn\": \"<string>\",\n \"b13a_filing_option\": \"FILED_ELECTRONICALLY\",\n \"b13a_number\": \"<string>\",\n \"certificate\": \"<string>\",\n \"commercial_invoice\": true,\n \"contents_explanation\": \"T-Shirt purchase\",\n \"disclaimer\": \"<string>\",\n \"duties_payor\": {\n \"account\": \"2323434543\",\n \"type\": \"THIRD_PARTY\",\n \"address\": {\n \"name\": \"Patrick Kavanagh\",\n \"zip\": \"80331\",\n \"country\": \"DE\"\n }\n },\n \"exporter_identification\": {\n \"eori_number\": \"PL123456790ABCDE\",\n \"tax_id\": {\n \"number\": \"123456789\",\n \"type\": \"EIN\"\n }\n },\n \"exporter_reference\": \"<string>\",\n \"importer_reference\": \"<string>\",\n \"is_vat_collected\": true,\n \"invoice\": \"#123123\",\n \"license\": \"<string>\",\n \"metadata\": \"Order ID #123123\",\n \"notes\": \"<string>\",\n \"address_importer\": {\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"Blumenstraße\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"22\",\n \"city\": \"München\",\n \"state\": \"CA\",\n \"zip\": \"80331\",\n \"country\": \"DE\",\n \"phone\": \"80331\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true\n },\n \"eel_pfc\": \"NOEEI_30_37_a\",\n \"incoterm\": \"DDP\",\n \"test\": true\n },\n \"async\": true,\n \"carrier_accounts\": [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"\n ]\n },\n \"carrier_account\": \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n \"metadata\": \"SHIPMENT #1\",\n \"servicelevel_token\": \"fedex_ground\"\n }\n]"
response = http.request(request)
puts response.read_body{
"default_carrier_account": "078870331023437cb917f5187429b093",
"default_servicelevel_token": "usps_priority",
"batch_shipments": {
"next": "baseurl?page=3&results=10",
"previous": "baseurl?page=1&results=10",
"results": [
{
"object_id": "e11c95a6788d4ddcaa22f03175838740",
"shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
"status": "INVALID",
"carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
"metadata": "SHIPMENT #1",
"servicelevel_token": "fedex_ground",
"messages": [
"<unknown>"
],
"transaction": "4c33736a67e2450da88b38c42deef6b7"
}
]
},
"label_url": [
"<string>"
],
"object_created": "2016-01-04T00:15:44.394Z",
"object_id": "5ef63c54f5bf45d3b1f8fb37dcb1c5f4",
"object_owner": "shippo@shippo.com",
"object_results": {
"creation_failed": 3,
"creation_succeeded": 5,
"purchase_failed": 0,
"purchase_succeeded": 0
},
"object_updated": "2016-01-04T00:48:13.841Z",
"status": "VALID",
"label_filetype": "PDF_4x6",
"metadata": "BATCH #1",
"test": false
}{}Batches
Add shipments to a batch
Adds batch shipments to an existing batch.
POST
/
batches
/
{BatchId}
/
add_shipments
cURL
curl -X POST https://api.goshippo.com/batches/<BATCH OBJECT ID>/add_shipments \
-H "Authorization: ShippoToken <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '[
{
"shipment": {
"address_from": {
"name": "Mr Hippo",
"street1": "965 Mission St",
"street2": "Ste 201",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US",
"phone": "4151234567",
},
"address_to": {
"name": "Hippo Jr",
"street1": "915 Broadway",
"street2": "19th Floor",
"city": "New York",
"state": "NY",
"zip": "10010",
"country": "US",
"phone": "2129947880",
},
"parcels": [{
"length": "12",
"width": "12",
"height": "12",
"distance_unit": "in",
"weight": "12",
"mass_unit": "oz"
}]
}
},
{
"shipment": {
"address_from": {
"name": "Ms Hippo",
"street1": "1092 Indian Summer Ct",
"city": "San Jose",
"state": "CA",
"zip": "95122",
"country": "US",
"phone": "4151234567",
},
"address_to": {
"name": "Mr Hippo",
"street1": "965 Mission St",
"street2": "Ste 201",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US",
"phone": "4151234567",
},
"parcels": [{
"length": "5",
"width": "5",
"height": "5",
"distance_unit": "in",
"weight": "2",
"mass_unit": "lb"
}]
},
"carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
"servicelevel_token": "fedex_2_day"
}
]'import shippo
from shippo.models import components
s = shippo.Shippo(
api_key_header='ShippoToken <API_TOKEN>',
shippo_api_version='2018-02-08',
)
res = s.batches.add_shipments(request_body=[
components.BatchShipmentCreateRequest(
carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',
metadata='SHIPMENT #1',
servicelevel_token='fedex_ground',
shipment=components.ShipmentCreateRequest(
extra=components.ShipmentExtra(
accounts_receivable_customer_account=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
appropriation_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
bill_of_lading_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
cod_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
customer_reference=components.CustomerReference(
ref_sort=1,
),
dealer_order_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
dept_number=components.DepartmentNumber(
ref_sort=3,
),
fda_product_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
insurance=components.Insurance(
amount='5.5',
currency='USD',
),
invoice_number=components.InvoiceNumber(
ref_sort=2,
),
manifest_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
model_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
part_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
po_number=components.PoNumber(
ref_sort=2,
),
production_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
purchase_request_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
rma_number=components.RmaNumber(
ref_sort=1,
),
salesperson_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
serial_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
store_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
transaction_reference_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
),
metadata='Customer ID 123456',
shipment_date='2021-03-22T12:00:00Z',
address_from=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_return=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_to='d799c2679e644279b59fe661ac8fa489',
customs_declaration='adcfdddf8ec64b84ad22772bce3ea37a',
carrier_accounts=[
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels=[
'<value>',
'<value>',
components.ParcelCreateFromTemplateRequest(
extra=components.ParcelExtra(
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
insurance=components.ParcelInsurance(
amount='5.5',
content='Laptop',
currency='USD',
provider=components.ParcelInsuranceProvider.UPS,
),
),
metadata='Customer ID 123456',
mass_unit=components.WeightUnitEnum.LB,
weight='1',
template=components.ParcelTemplateUSPSEnum.USPS_SMALL_FLAT_RATE_ENVELOPE,
),
],
),
),
components.BatchShipmentCreateRequest(
carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',
metadata='SHIPMENT #1',
servicelevel_token='fedex_ground',
shipment=components.ShipmentCreateRequest(
extra=components.ShipmentExtra(
accounts_receivable_customer_account=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
appropriation_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
bill_of_lading_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
cod_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
customer_reference=components.CustomerReference(
ref_sort=1,
),
dealer_order_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
dept_number=components.DepartmentNumber(
ref_sort=3,
),
fda_product_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
insurance=components.Insurance(
amount='5.5',
currency='USD',
),
invoice_number=components.InvoiceNumber(
ref_sort=2,
),
manifest_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
model_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
part_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
po_number=components.PoNumber(
ref_sort=2,
),
production_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
purchase_request_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
rma_number=components.RmaNumber(
ref_sort=1,
),
salesperson_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
serial_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
store_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
transaction_reference_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
),
metadata='Customer ID 123456',
shipment_date='2021-03-22T12:00:00Z',
address_from=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_return=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
address_to=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
customs_declaration=components.CustomsDeclarationCreateRequest(
b13a_filing_option=components.CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY,
certify=True,
certify_signer='Shawn Ippotle',
contents_explanation='T-Shirt purchase',
duties_payor=components.DutiesPayor(
account='2323434543',
type=components.CustomsDeclarationCreateRequestType.THIRD_PARTY,
address=components.CustomsDeclarationCreateRequestAddress(
name='Patrick Kavanagh',
zip='80331',
country='DE',
),
),
exporter_identification=components.CustomsExporterIdentification(
eori_number='PL123456790ABCDE',
tax_id=components.CustomsTaxIdentification(
number='123456789',
type=components.CustomsTaxIdentificationType.EIN,
),
),
invoice='#123123',
metadata='Order ID #123123',
address_importer=components.AddressImporter(
name='Shwan Ippotle',
company='Shippo',
street1='Blumenstraße',
street3='',
street_no='22',
city='München',
state='CA',
zip='80331',
country='DE',
phone='80331',
email='shippotle@shippo.com',
is_residential=True,
),
contents_type=components.CustomsDeclarationContentsTypeEnum.MERCHANDISE,
eel_pfc=components.CustomsDeclarationEelPfcEnum.NOEEI_30_37_A,
incoterm=components.CustomsDeclarationIncotermEnum.DDP,
items=[
components.CustomsItemCreateRequest(
description='T-Shirt',
mass_unit=components.WeightUnitEnum.LB,
metadata='Order ID "123454"',
net_weight='5',
origin_country='<value>',
quantity=20,
sku_code='HM-123',
hs_code='0901.21',
value_amount='200',
value_currency='USD',
),
],
non_delivery_option=components.CustomsDeclarationNonDeliveryOptionEnum.RETURN,
test=True,
),
carrier_accounts=[
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels=[
components.ParcelCreateFromTemplateRequest(
extra=components.ParcelExtra(
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
insurance=components.ParcelInsurance(
amount='5.5',
content='Laptop',
currency='USD',
provider=components.ParcelInsuranceProvider.UPS,
),
),
metadata='Customer ID 123456',
mass_unit=components.WeightUnitEnum.LB,
weight='1',
template=components.ParcelTemplateDPDUKEnum.DPD_UK_EXPRESS_PAK,
),
components.ParcelCreateFromTemplateRequest(
extra=components.ParcelExtra(
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
insurance=components.ParcelInsurance(
amount='5.5',
content='Laptop',
currency='USD',
provider=components.ParcelInsuranceProvider.UPS,
),
),
metadata='Customer ID 123456',
mass_unit=components.WeightUnitEnum.LB,
weight='1',
template=components.ParcelTemplateDHLeCommerceEnum.DH_LE_C_IRREGULAR,
),
],
),
),
components.BatchShipmentCreateRequest(
carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',
metadata='SHIPMENT #1',
servicelevel_token='fedex_ground',
shipment=components.ShipmentCreateRequest(
extra=components.ShipmentExtra(
accounts_receivable_customer_account=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
appropriation_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
bill_of_lading_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
cod=components.Cod(
amount='5.5',
currency='USD',
payment_method=components.PaymentMethod.CASH,
),
cod_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
customer_reference=components.CustomerReference(
ref_sort=1,
),
dealer_order_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
dept_number=components.DepartmentNumber(
ref_sort=3,
),
fda_product_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
insurance=components.Insurance(
amount='5.5',
currency='USD',
),
invoice_number=components.InvoiceNumber(
ref_sort=2,
),
manifest_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
model_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
part_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
po_number=components.PoNumber(
ref_sort=2,
),
production_code=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
purchase_request_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
rma_number=components.RmaNumber(
ref_sort=1,
),
salesperson_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
serial_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
store_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
transaction_reference_number=components.UPSReferenceFields(
prefix='ABC',
value='value',
ref_sort=1,
),
),
metadata='Customer ID 123456',
shipment_date='2021-03-22T12:00:00Z',
address_from='d799c2679e644279b59fe661ac8fa488',
address_return='d799c2679e644279b59fe661ac8fa488',
address_to=components.AddressCreateRequest(
name='Shwan Ippotle',
company='Shippo',
street1='215 Clayton St.',
street3='',
street_no='',
city='San Francisco',
state='CA',
zip='94117',
country='US',
phone='+1 555 341 9393',
email='shippotle@shippo.com',
is_residential=True,
metadata='Customer ID 123456',
validate=True,
),
customs_declaration='adcfdddf8ec64b84ad22772bce3ea37a',
carrier_accounts=[
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels=[
'<value>',
],
),
),
], batch_id='<id>')
if res is not None:
# handle response
passimport { Shippo } from "shippo";
const shippo = new Shippo({
apiKeyHeader: "ShippoToken <API_TOKEN>",
shippoApiVersion: "2018-02-08",
});
async function run() {
const result = await shippo.batches.addShipments([
{
carrierAccount: "a4391cd4ab974f478f55dc08b5c8e3b3",
metadata: "SHIPMENT #1",
servicelevelToken: "fedex_ground",
shipment: {
extra: {
accountsReceivableCustomerAccount: {
prefix: "ABC",
value: "value",
refSort: 1,
},
appropriationNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
billOfLadingNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
codNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
customerReference: {
refSort: 1,
},
dealerOrderNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
deptNumber: {
refSort: 3,
},
fdaProductCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
insurance: {
amount: "5.5",
currency: "USD",
},
invoiceNumber: {
refSort: 2,
},
manifestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
modelNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
partNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
poNumber: {
refSort: 2,
},
productionCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
purchaseRequestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
rmaNumber: {
refSort: 1,
},
salespersonNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
serialNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
storeNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
transactionReferenceNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
},
metadata: "Customer ID 123456",
shipmentDate: "2021-03-22T12:00:00Z",
addressFrom: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressReturn: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressTo: "d799c2679e644279b59fe661ac8fa489",
customsDeclaration: "adcfdddf8ec64b84ad22772bce3ea37a",
carrierAccounts: [
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
],
parcels: [
"<value>",
"<value>",
{
extra: {
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
insurance: {
amount: "5.5",
content: "Laptop",
currency: "USD",
provider: "UPS",
},
},
metadata: "Customer ID 123456",
massUnit: "lb",
weight: "1",
template: "USPS_SmallFlatRateEnvelope",
},
],
},
},
{
carrierAccount: "a4391cd4ab974f478f55dc08b5c8e3b3",
metadata: "SHIPMENT #1",
servicelevelToken: "fedex_ground",
shipment: {
extra: {
accountsReceivableCustomerAccount: {
prefix: "ABC",
value: "value",
refSort: 1,
},
appropriationNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
billOfLadingNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
codNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
customerReference: {
refSort: 1,
},
dealerOrderNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
deptNumber: {
refSort: 3,
},
fdaProductCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
insurance: {
amount: "5.5",
currency: "USD",
},
invoiceNumber: {
refSort: 2,
},
manifestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
modelNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
partNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
poNumber: {
refSort: 2,
},
productionCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
purchaseRequestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
rmaNumber: {
refSort: 1,
},
salespersonNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
serialNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
storeNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
transactionReferenceNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
},
metadata: "Customer ID 123456",
shipmentDate: "2021-03-22T12:00:00Z",
addressFrom: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressReturn: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
addressTo: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
customsDeclaration: {
b13aFilingOption: "FILED_ELECTRONICALLY",
certify: true,
certifySigner: "Shawn Ippotle",
contentsExplanation: "T-Shirt purchase",
dutiesPayor: {
account: "2323434543",
type: "THIRD_PARTY",
address: {
name: "Patrick Kavanagh",
zip: "80331",
country: "DE",
},
},
exporterIdentification: {
eoriNumber: "PL123456790ABCDE",
taxId: {
number: "123456789",
type: "EIN",
},
},
invoice: "#123123",
metadata: "Order ID #123123",
addressImporter: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "Blumenstraße",
street3: "",
streetNo: "22",
city: "München",
state: "CA",
zip: "80331",
country: "DE",
phone: "80331",
email: "shippotle@shippo.com",
isResidential: true,
},
contentsType: "MERCHANDISE",
eelPfc: "NOEEI_30_37_a",
incoterm: "DDP",
items: [
{
description: "T-Shirt",
massUnit: "lb",
metadata: "Order ID \"123454\"",
netWeight: "5",
originCountry: "<value>",
quantity: 20,
skuCode: "HM-123",
hsCode: "0901.21",
valueAmount: "200",
valueCurrency: "USD",
},
],
nonDeliveryOption: "RETURN",
test: true,
},
carrierAccounts: [
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
],
parcels: [
{
extra: {
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
insurance: {
amount: "5.5",
content: "Laptop",
currency: "USD",
provider: "UPS",
},
},
metadata: "Customer ID 123456",
massUnit: "lb",
weight: "1",
template: "DPD_UK_Express_Pak",
},
{
extra: {
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
insurance: {
amount: "5.5",
content: "Laptop",
currency: "USD",
provider: "UPS",
},
},
metadata: "Customer ID 123456",
massUnit: "lb",
weight: "1",
template: "DHLeC_Irregular",
},
],
},
},
{
carrierAccount: "a4391cd4ab974f478f55dc08b5c8e3b3",
metadata: "SHIPMENT #1",
servicelevelToken: "fedex_ground",
shipment: {
extra: {
accountsReceivableCustomerAccount: {
prefix: "ABC",
value: "value",
refSort: 1,
},
appropriationNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
billOfLadingNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
cod: {
amount: "5.5",
currency: "USD",
paymentMethod: "CASH",
},
codNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
customerReference: {
refSort: 1,
},
dealerOrderNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
deptNumber: {
refSort: 3,
},
fdaProductCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
insurance: {
amount: "5.5",
currency: "USD",
},
invoiceNumber: {
refSort: 2,
},
manifestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
modelNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
partNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
poNumber: {
refSort: 2,
},
productionCode: {
prefix: "ABC",
value: "value",
refSort: 1,
},
purchaseRequestNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
rmaNumber: {
refSort: 1,
},
salespersonNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
serialNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
storeNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
transactionReferenceNumber: {
prefix: "ABC",
value: "value",
refSort: 1,
},
},
metadata: "Customer ID 123456",
shipmentDate: "2021-03-22T12:00:00Z",
addressFrom: "d799c2679e644279b59fe661ac8fa488",
addressReturn: "d799c2679e644279b59fe661ac8fa488",
addressTo: {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
street3: "",
streetNo: "",
city: "San Francisco",
state: "CA",
zip: "94117",
country: "US",
phone: "+1 555 341 9393",
email: "shippotle@shippo.com",
isResidential: true,
metadata: "Customer ID 123456",
validate: true,
},
customsDeclaration: "adcfdddf8ec64b84ad22772bce3ea37a",
carrierAccounts: [
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
],
parcels: [
"<value>",
],
},
},
], "<id>");
// Handle the result
console.log(result);
}
run();using Shippo;
using Shippo.Models.Components;
using System.Collections.Generic;
var sdk = new ShippoSDK(
apiKeyHeader: "ShippoToken <API_TOKEN>",
shippoApiVersion: "2018-02-08"
);
var res = await sdk.Batches.AddShipmentsAsync(
batchId: "<id>",
requestBody: new List<BatchShipmentCreateRequest>() {
new BatchShipmentCreateRequest() {
CarrierAccount = "a4391cd4ab974f478f55dc08b5c8e3b3",
Metadata = "SHIPMENT #1",
ServicelevelToken = "fedex_ground",
Shipment = new ShipmentCreateRequest() {
Extra = new ShipmentExtra() {
AccountsReceivableCustomerAccount = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
AppropriationNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
BillOfLadingNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
Cod = new Cod() {
Amount = "5.5",
Currency = "USD",
PaymentMethod = PaymentMethod.Cash,
},
CodNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
CustomerReference = new CustomerReference() {
RefSort = 1,
},
DealerOrderNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
DeptNumber = new DepartmentNumber() {
RefSort = 3,
},
FdaProductCode = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
Insurance = new Insurance() {
Amount = "5.5",
Currency = "USD",
},
InvoiceNumber = new InvoiceNumber() {
RefSort = 2,
},
ManifestNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
ModelNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
PartNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
PoNumber = new PoNumber() {
RefSort = 2,
},
ProductionCode = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
PurchaseRequestNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
RmaNumber = new RmaNumber() {
RefSort = 1,
},
SalespersonNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
SerialNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
StoreNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
TransactionReferenceNumber = new UPSReferenceFields() {
Prefix = "ABC",
Value = "value",
RefSort = 1,
},
},
Metadata = "Customer ID 123456",
ShipmentDate = "2021-03-22T12:00:00Z",
AddressFrom = AddressFrom.CreateStr(
"d799c2679e644279b59fe661ac8fa488"
),
AddressReturn = AddressReturn.CreateAddressCreateRequest(
new AddressCreateRequest() {
Name = "Shwan Ippotle",
Company = "Shippo",
Street1 = "215 Clayton St.",
Street3 = "",
StreetNo = "",
City = "San Francisco",
State = "CA",
Zip = "94117",
Country = "US",
Phone = "+1 555 341 9393",
Email = "shippotle@shippo.com",
IsResidential = true,
Metadata = "Customer ID 123456",
Validate = true,
}
),
AddressTo = AddressTo.CreateAddressCreateRequest(
new AddressCreateRequest() {
Name = "Shwan Ippotle",
Company = "Shippo",
Street1 = "215 Clayton St.",
Street3 = "",
StreetNo = "",
City = "San Francisco",
State = "CA",
Zip = "94117",
Country = "US",
Phone = "+1 555 341 9393",
Email = "shippotle@shippo.com",
IsResidential = true,
Metadata = "Customer ID 123456",
Validate = true,
}
),
CustomsDeclaration = ShipmentCreateRequestCustomsDeclaration.CreateStr(
"adcfdddf8ec64b84ad22772bce3ea37a"
),
CarrierAccounts = new List<string>() {
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
},
Parcels = new List<Models.Components.Parcels>() {
Parcels.CreateStr(
"<value>"
),
},
},
},
},
shippoApiVersion: "2018-02-08"
);
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use Shippo\API;
use Shippo\API\Models\Components;
$sdk = API\Shippo::builder()
->setSecurity(
'ShippoToken <API_TOKEN>'
)
->setShippoApiVersion('2018-02-08')
->build();
$response = $sdk->batches->addShipments(
batchId: '<id>',
requestBody: [
new Components\BatchShipmentCreateRequest(
carrierAccount: 'a4391cd4ab974f478f55dc08b5c8e3b3',
metadata: 'SHIPMENT #1',
servicelevelToken: 'fedex_ground',
shipment: new Components\ShipmentCreateRequest(
extra: new Components\ShipmentExtra(
accountsReceivableCustomerAccount: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
appropriationNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
billOfLadingNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
cod: new Components\Cod(
amount: '5.5',
currency: 'USD',
paymentMethod: Components\PaymentMethod::Cash,
),
codNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
customerReference: new Components\CustomerReference(
refSort: 1,
),
dealerOrderNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
deptNumber: new Components\DepartmentNumber(
refSort: 3,
),
fdaProductCode: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
insurance: new Components\Insurance(
amount: '5.5',
currency: 'USD',
),
invoiceNumber: new Components\InvoiceNumber(
refSort: 2,
),
manifestNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
modelNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
partNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
poNumber: new Components\PoNumber(
refSort: 2,
),
productionCode: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
purchaseRequestNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
rmaNumber: new Components\RmaNumber(
refSort: 1,
),
salespersonNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
serialNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
storeNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
transactionReferenceNumber: new Components\UPSReferenceFields(
prefix: 'ABC',
value: 'value',
refSort: 1,
),
),
metadata: 'Customer ID 123456',
shipmentDate: '2021-03-22T12:00:00Z',
addressFrom: 'd799c2679e644279b59fe661ac8fa488',
addressReturn: new Components\AddressCreateRequest(
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street3: '',
streetNo: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
country: 'US',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
isResidential: true,
metadata: 'Customer ID 123456',
validate: true,
),
addressTo: new Components\AddressCreateRequest(
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street3: '',
streetNo: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
country: 'US',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
isResidential: true,
metadata: 'Customer ID 123456',
validate: true,
),
customsDeclaration: 'adcfdddf8ec64b84ad22772bce3ea37a',
carrierAccounts: [
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels: [
'<value>',
],
),
),
],
shippoApiVersion: '2018-02-08'
);
if ($response->batch !== null) {
// handle response
}package hello.world;
import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.AddressCreateRequest;
import com.goshippo.shippo_sdk.models.components.AddressFrom;
import com.goshippo.shippo_sdk.models.components.AddressImporter;
import com.goshippo.shippo_sdk.models.components.AddressReturn;
import com.goshippo.shippo_sdk.models.components.AddressTo;
import com.goshippo.shippo_sdk.models.components.BatchShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.Cod;
import com.goshippo.shippo_sdk.models.components.CustomerReference;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationB13AFilingOptionEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationContentsTypeEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequest;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestAddress;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestType;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationEelPfcEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationIncotermEnum;
import com.goshippo.shippo_sdk.models.components.CustomsDeclarationNonDeliveryOptionEnum;
import com.goshippo.shippo_sdk.models.components.CustomsExporterIdentification;
import com.goshippo.shippo_sdk.models.components.CustomsItemCreateRequest;
import com.goshippo.shippo_sdk.models.components.CustomsTaxIdentification;
import com.goshippo.shippo_sdk.models.components.CustomsTaxIdentificationType;
import com.goshippo.shippo_sdk.models.components.DepartmentNumber;
import com.goshippo.shippo_sdk.models.components.DutiesPayor;
import com.goshippo.shippo_sdk.models.components.Insurance;
import com.goshippo.shippo_sdk.models.components.InvoiceNumber;
import com.goshippo.shippo_sdk.models.components.ParcelCreateFromTemplateRequest;
import com.goshippo.shippo_sdk.models.components.ParcelExtra;
import com.goshippo.shippo_sdk.models.components.ParcelInsurance;
import com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateDHLeCommerceEnum;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateDPDUKEnum;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateEnumSet;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateUSPSEnum;
import com.goshippo.shippo_sdk.models.components.Parcels;
import com.goshippo.shippo_sdk.models.components.PaymentMethod;
import com.goshippo.shippo_sdk.models.components.PoNumber;
import com.goshippo.shippo_sdk.models.components.RmaNumber;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequestCustomsDeclaration;
import com.goshippo.shippo_sdk.models.components.ShipmentExtra;
import com.goshippo.shippo_sdk.models.components.UPSReferenceFields;
import com.goshippo.shippo_sdk.models.components.WeightUnitEnum;
import com.goshippo.shippo_sdk.models.operations.AddShipmentsToBatchResponse;
import java.lang.Exception;
import java.util.List;
public class Application {
public static void main(String[] args) throws Exception {
Shippo sdk = Shippo.builder()
.apiKeyHeader("ShippoToken <API_TOKEN>")
.shippoApiVersion("2018-02-08")
.build();
AddShipmentsToBatchResponse res = sdk.batches().addShipments()
.batchId("<id>")
.shippoApiVersion("2018-02-08")
.requestBody(List.of(
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.addressTo(AddressTo.of("d799c2679e644279b59fe661ac8fa489"))
.parcels(List.of(
Parcels.of("<value>"),
Parcels.of("<value>"),
Parcels.of(ParcelCreateFromTemplateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.template(ParcelTemplateEnumSet.of(ParcelTemplateUSPSEnum.USPS_SMALL_FLAT_RATE_ENVELOPE))
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build())))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of("adcfdddf8ec64b84ad22772bce3ea37a"))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build(),
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.addressTo(AddressTo.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.parcels(List.of(
Parcels.of(ParcelCreateFromTemplateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.template(ParcelTemplateEnumSet.of(ParcelTemplateDPDUKEnum.DPDUK_EXPRESS_PAK))
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build()),
Parcels.of(ParcelCreateFromTemplateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.template(ParcelTemplateEnumSet.of(ParcelTemplateDHLeCommerceEnum.DH_LE_C_IRREGULAR))
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build())))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of(CustomsDeclarationCreateRequest.builder()
.certify(true)
.certifySigner("Shawn Ippotle")
.contentsType(CustomsDeclarationContentsTypeEnum.MERCHANDISE)
.items(List.of(
CustomsItemCreateRequest.builder()
.description("T-Shirt")
.massUnit(WeightUnitEnum.LB)
.netWeight("5")
.originCountry("<value>")
.quantity(20L)
.valueAmount("200")
.valueCurrency("USD")
.metadata("Order ID \"123454\"")
.skuCode("HM-123")
.hsCode("0901.21")
.build()))
.nonDeliveryOption(CustomsDeclarationNonDeliveryOptionEnum.RETURN)
.b13aFilingOption(CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY)
.contentsExplanation("T-Shirt purchase")
.dutiesPayor(DutiesPayor.builder()
.account("2323434543")
.type(CustomsDeclarationCreateRequestType.THIRD_PARTY)
.address(CustomsDeclarationCreateRequestAddress.builder()
.name("Patrick Kavanagh")
.zip("80331")
.country("DE")
.build())
.build())
.exporterIdentification(CustomsExporterIdentification.builder()
.eoriNumber("PL123456790ABCDE")
.taxId(CustomsTaxIdentification.builder()
.number("123456789")
.type(CustomsTaxIdentificationType.EIN)
.build())
.build())
.invoice("#123123")
.metadata("Order ID #123123")
.addressImporter(AddressImporter.builder()
.name("Shwan Ippotle")
.company("Shippo")
.street1("Blumenstraße")
.street3("")
.streetNo("22")
.city("München")
.state("CA")
.zip("80331")
.country("DE")
.phone("80331")
.email("shippotle@shippo.com")
.isResidential(true)
.build())
.eelPfc(CustomsDeclarationEelPfcEnum.NOEEI3037_A)
.incoterm(CustomsDeclarationIncotermEnum.DDP)
.test(true)
.build()))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build(),
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of("d799c2679e644279b59fe661ac8fa488"))
.addressTo(AddressTo.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("shippotle@shippo.com")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.parcels(List.of(
Parcels.of("<value>")))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of("d799c2679e644279b59fe661ac8fa488"))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of("adcfdddf8ec64b84ad22772bce3ea37a"))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build()))
.call();
if (res.batch().isPresent()) {
// handle response
}
}
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
shipment: {
address_from: {
country: 'US',
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street2: '<string>',
street3: '',
street_no: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
is_residential: true,
metadata: 'Customer ID 123456',
validate: true
},
address_to: {
country: 'US',
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street2: '<string>',
street3: '',
street_no: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
is_residential: true,
metadata: 'Customer ID 123456',
validate: true
},
parcels: [
{
mass_unit: 'lb',
weight: '1',
distance_unit: 'in',
height: '1',
length: '1',
width: '1',
extra: {
COD: {amount: '5.5', currency: 'USD', payment_method: 'CASH'},
insurance: {amount: '5.5', content: 'Laptop', currency: 'USD', provider: 'UPS'},
reference_1: '<string>',
reference_2: '<string>'
},
metadata: 'Customer ID 123456'
}
],
extra: {
accounts_receivable_customer_account: {prefix: 'ABC', value: 'value', ref_sort: 1},
alcohol: {contains_alcohol: true},
appropriation_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
authority_to_leave: true,
bill_of_lading_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
billing: {
account: '<string>',
country: '<string>',
participation_code: '<string>',
zip: '<string>'
},
bypass_address_validation: true,
carbon_neutral: true,
carrier_hub_id: '<string>',
carrier_hub_travel_time: 123,
COD: {amount: '5.5', currency: 'USD', payment_method: 'CASH'},
cod_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
container_type: '<string>',
critical_pull_time: '<string>',
customer_branch: '<string>',
customer_reference: {prefix: '<string>', value: '<string>', ref_sort: 1},
dangerous_goods: {
contains: true,
biological_material: {contains: true},
lithium_batteries: {contains: true}
},
dealer_order_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
delivery_instructions: '<string>',
dept_number: {prefix: '<string>', value: '<string>', ref_sort: 3},
dry_ice: {contains_dry_ice: true, weight: '<string>'},
fda_product_code: {prefix: 'ABC', value: 'value', ref_sort: 1},
fulfillment_center: '<string>',
insurance: {amount: '5.5', content: '<string>', currency: 'USD'},
invoice_number: {prefix: '<string>', value: '<string>', ref_sort: 2},
is_return: true,
lasership_attrs: [],
lasership_declared_value: '<string>',
manifest_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
model_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
part_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
po_number: {prefix: '<string>', value: '<string>', ref_sort: 2},
premium: true,
production_code: {prefix: 'ABC', value: 'value', ref_sort: 1},
purchase_request_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
qr_code_requested: true,
reference_1: '<string>',
reference_2: '<string>',
request_retail_rates: true,
rma_number: {prefix: '<string>', value: '<string>', ref_sort: 1},
saturday_delivery: true,
salesperson_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
serial_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
store_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
transaction_reference_number: {prefix: 'ABC', value: 'value', ref_sort: 1},
usmca_eligible: true
},
metadata: 'Customer ID 123456',
shipment_date: '2021-03-22T12:00:00Z',
address_return: {
country: 'US',
name: 'Shwan Ippotle',
company: 'Shippo',
street1: '215 Clayton St.',
street2: '<string>',
street3: '',
street_no: '',
city: 'San Francisco',
state: 'CA',
zip: '94117',
phone: '+1 555 341 9393',
email: 'shippotle@shippo.com',
is_residential: true,
metadata: 'Customer ID 123456',
validate: true
},
customs_declaration: {
certify: true,
certify_signer: 'Shawn Ippotle',
contents_type: 'MERCHANDISE',
items: [
{
description: 'T-Shirt',
mass_unit: 'lb',
net_weight: '5',
origin_country: '<string>',
quantity: 20,
value_amount: '200',
value_currency: 'USD',
eccn_ear99: '<string>',
metadata: 'Order ID "123454"',
sku_code: 'HM-123',
hs_code: '0901.21',
tariff_number: '<string>'
}
],
non_delivery_option: 'RETURN',
aes_itn: '<string>',
b13a_filing_option: 'FILED_ELECTRONICALLY',
b13a_number: '<string>',
certificate: '<string>',
commercial_invoice: true,
contents_explanation: 'T-Shirt purchase',
disclaimer: '<string>',
duties_payor: {
account: '2323434543',
type: 'THIRD_PARTY',
address: {name: 'Patrick Kavanagh', zip: '80331', country: 'DE'}
},
exporter_identification: {eori_number: 'PL123456790ABCDE', tax_id: {number: '123456789', type: 'EIN'}},
exporter_reference: '<string>',
importer_reference: '<string>',
is_vat_collected: true,
invoice: '#123123',
license: '<string>',
metadata: 'Order ID #123123',
notes: '<string>',
address_importer: {
name: 'Shwan Ippotle',
company: 'Shippo',
street1: 'Blumenstraße',
street2: '<string>',
street3: '',
street_no: '22',
city: 'München',
state: 'CA',
zip: '80331',
country: 'DE',
phone: '80331',
email: 'shippotle@shippo.com',
is_residential: true
},
eel_pfc: 'NOEEI_30_37_a',
incoterm: 'DDP',
test: true
},
async: true,
carrier_accounts: ['065a4a8c10d24a34ab932163a1b87f52', '73f706f4bdb94b54a337563840ce52b0']
},
carrier_account: 'a4391cd4ab974f478f55dc08b5c8e3b3',
metadata: 'SHIPMENT #1',
servicelevel_token: 'fedex_ground'
}
])
};
fetch('https://api.goshippo.com/batches/{BatchId}/add_shipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.goshippo.com/batches/{BatchId}/add_shipments"
payload := strings.NewReader("[\n {\n \"shipment\": {\n \"address_from\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"address_to\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"parcels\": [\n {\n \"mass_unit\": \"lb\",\n \"weight\": \"1\",\n \"distance_unit\": \"in\",\n \"height\": \"1\",\n \"length\": \"1\",\n \"width\": \"1\",\n \"extra\": {\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"Laptop\",\n \"currency\": \"USD\",\n \"provider\": \"UPS\"\n },\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\"\n },\n \"metadata\": \"Customer ID 123456\"\n }\n ],\n \"extra\": {\n \"accounts_receivable_customer_account\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"alcohol\": {\n \"contains_alcohol\": true\n },\n \"appropriation_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"authority_to_leave\": true,\n \"bill_of_lading_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"billing\": {\n \"account\": \"<string>\",\n \"country\": \"<string>\",\n \"participation_code\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"bypass_address_validation\": true,\n \"carbon_neutral\": true,\n \"carrier_hub_id\": \"<string>\",\n \"carrier_hub_travel_time\": 123,\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"cod_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"container_type\": \"<string>\",\n \"critical_pull_time\": \"<string>\",\n \"customer_branch\": \"<string>\",\n \"customer_reference\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"dangerous_goods\": {\n \"contains\": true,\n \"biological_material\": {\n \"contains\": true\n },\n \"lithium_batteries\": {\n \"contains\": true\n }\n },\n \"dealer_order_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"delivery_instructions\": \"<string>\",\n \"dept_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 3\n },\n \"dry_ice\": {\n \"contains_dry_ice\": true,\n \"weight\": \"<string>\"\n },\n \"fda_product_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"fulfillment_center\": \"<string>\",\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"<string>\",\n \"currency\": \"USD\"\n },\n \"invoice_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"is_return\": true,\n \"lasership_attrs\": [],\n \"lasership_declared_value\": \"<string>\",\n \"manifest_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"model_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"part_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"po_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"premium\": true,\n \"production_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"purchase_request_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"qr_code_requested\": true,\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\",\n \"request_retail_rates\": true,\n \"rma_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"saturday_delivery\": true,\n \"salesperson_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"serial_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"store_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"transaction_reference_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"usmca_eligible\": true\n },\n \"metadata\": \"Customer ID 123456\",\n \"shipment_date\": \"2021-03-22T12:00:00Z\",\n \"address_return\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"customs_declaration\": {\n \"certify\": true,\n \"certify_signer\": \"Shawn Ippotle\",\n \"contents_type\": \"MERCHANDISE\",\n \"items\": [\n {\n \"description\": \"T-Shirt\",\n \"mass_unit\": \"lb\",\n \"net_weight\": \"5\",\n \"origin_country\": \"<string>\",\n \"quantity\": 20,\n \"value_amount\": \"200\",\n \"value_currency\": \"USD\",\n \"eccn_ear99\": \"<string>\",\n \"metadata\": \"Order ID \\\"123454\\\"\",\n \"sku_code\": \"HM-123\",\n \"hs_code\": \"0901.21\",\n \"tariff_number\": \"<string>\"\n }\n ],\n \"non_delivery_option\": \"RETURN\",\n \"aes_itn\": \"<string>\",\n \"b13a_filing_option\": \"FILED_ELECTRONICALLY\",\n \"b13a_number\": \"<string>\",\n \"certificate\": \"<string>\",\n \"commercial_invoice\": true,\n \"contents_explanation\": \"T-Shirt purchase\",\n \"disclaimer\": \"<string>\",\n \"duties_payor\": {\n \"account\": \"2323434543\",\n \"type\": \"THIRD_PARTY\",\n \"address\": {\n \"name\": \"Patrick Kavanagh\",\n \"zip\": \"80331\",\n \"country\": \"DE\"\n }\n },\n \"exporter_identification\": {\n \"eori_number\": \"PL123456790ABCDE\",\n \"tax_id\": {\n \"number\": \"123456789\",\n \"type\": \"EIN\"\n }\n },\n \"exporter_reference\": \"<string>\",\n \"importer_reference\": \"<string>\",\n \"is_vat_collected\": true,\n \"invoice\": \"#123123\",\n \"license\": \"<string>\",\n \"metadata\": \"Order ID #123123\",\n \"notes\": \"<string>\",\n \"address_importer\": {\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"Blumenstraße\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"22\",\n \"city\": \"München\",\n \"state\": \"CA\",\n \"zip\": \"80331\",\n \"country\": \"DE\",\n \"phone\": \"80331\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true\n },\n \"eel_pfc\": \"NOEEI_30_37_a\",\n \"incoterm\": \"DDP\",\n \"test\": true\n },\n \"async\": true,\n \"carrier_accounts\": [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"\n ]\n },\n \"carrier_account\": \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n \"metadata\": \"SHIPMENT #1\",\n \"servicelevel_token\": \"fedex_ground\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.goshippo.com/batches/{BatchId}/add_shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"shipment\": {\n \"address_from\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"address_to\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"parcels\": [\n {\n \"mass_unit\": \"lb\",\n \"weight\": \"1\",\n \"distance_unit\": \"in\",\n \"height\": \"1\",\n \"length\": \"1\",\n \"width\": \"1\",\n \"extra\": {\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"Laptop\",\n \"currency\": \"USD\",\n \"provider\": \"UPS\"\n },\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\"\n },\n \"metadata\": \"Customer ID 123456\"\n }\n ],\n \"extra\": {\n \"accounts_receivable_customer_account\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"alcohol\": {\n \"contains_alcohol\": true\n },\n \"appropriation_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"authority_to_leave\": true,\n \"bill_of_lading_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"billing\": {\n \"account\": \"<string>\",\n \"country\": \"<string>\",\n \"participation_code\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"bypass_address_validation\": true,\n \"carbon_neutral\": true,\n \"carrier_hub_id\": \"<string>\",\n \"carrier_hub_travel_time\": 123,\n \"COD\": {\n \"amount\": \"5.5\",\n \"currency\": \"USD\",\n \"payment_method\": \"CASH\"\n },\n \"cod_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"container_type\": \"<string>\",\n \"critical_pull_time\": \"<string>\",\n \"customer_branch\": \"<string>\",\n \"customer_reference\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"dangerous_goods\": {\n \"contains\": true,\n \"biological_material\": {\n \"contains\": true\n },\n \"lithium_batteries\": {\n \"contains\": true\n }\n },\n \"dealer_order_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"delivery_instructions\": \"<string>\",\n \"dept_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 3\n },\n \"dry_ice\": {\n \"contains_dry_ice\": true,\n \"weight\": \"<string>\"\n },\n \"fda_product_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"fulfillment_center\": \"<string>\",\n \"insurance\": {\n \"amount\": \"5.5\",\n \"content\": \"<string>\",\n \"currency\": \"USD\"\n },\n \"invoice_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"is_return\": true,\n \"lasership_attrs\": [],\n \"lasership_declared_value\": \"<string>\",\n \"manifest_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"model_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"part_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"po_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 2\n },\n \"premium\": true,\n \"production_code\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"purchase_request_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"qr_code_requested\": true,\n \"reference_1\": \"<string>\",\n \"reference_2\": \"<string>\",\n \"request_retail_rates\": true,\n \"rma_number\": {\n \"prefix\": \"<string>\",\n \"value\": \"<string>\",\n \"ref_sort\": 1\n },\n \"saturday_delivery\": true,\n \"salesperson_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"serial_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"store_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"transaction_reference_number\": {\n \"prefix\": \"ABC\",\n \"value\": \"value\",\n \"ref_sort\": 1\n },\n \"usmca_eligible\": true\n },\n \"metadata\": \"Customer ID 123456\",\n \"shipment_date\": \"2021-03-22T12:00:00Z\",\n \"address_return\": {\n \"country\": \"US\",\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"215 Clayton St.\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94117\",\n \"phone\": \"+1 555 341 9393\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true,\n \"metadata\": \"Customer ID 123456\",\n \"validate\": true\n },\n \"customs_declaration\": {\n \"certify\": true,\n \"certify_signer\": \"Shawn Ippotle\",\n \"contents_type\": \"MERCHANDISE\",\n \"items\": [\n {\n \"description\": \"T-Shirt\",\n \"mass_unit\": \"lb\",\n \"net_weight\": \"5\",\n \"origin_country\": \"<string>\",\n \"quantity\": 20,\n \"value_amount\": \"200\",\n \"value_currency\": \"USD\",\n \"eccn_ear99\": \"<string>\",\n \"metadata\": \"Order ID \\\"123454\\\"\",\n \"sku_code\": \"HM-123\",\n \"hs_code\": \"0901.21\",\n \"tariff_number\": \"<string>\"\n }\n ],\n \"non_delivery_option\": \"RETURN\",\n \"aes_itn\": \"<string>\",\n \"b13a_filing_option\": \"FILED_ELECTRONICALLY\",\n \"b13a_number\": \"<string>\",\n \"certificate\": \"<string>\",\n \"commercial_invoice\": true,\n \"contents_explanation\": \"T-Shirt purchase\",\n \"disclaimer\": \"<string>\",\n \"duties_payor\": {\n \"account\": \"2323434543\",\n \"type\": \"THIRD_PARTY\",\n \"address\": {\n \"name\": \"Patrick Kavanagh\",\n \"zip\": \"80331\",\n \"country\": \"DE\"\n }\n },\n \"exporter_identification\": {\n \"eori_number\": \"PL123456790ABCDE\",\n \"tax_id\": {\n \"number\": \"123456789\",\n \"type\": \"EIN\"\n }\n },\n \"exporter_reference\": \"<string>\",\n \"importer_reference\": \"<string>\",\n \"is_vat_collected\": true,\n \"invoice\": \"#123123\",\n \"license\": \"<string>\",\n \"metadata\": \"Order ID #123123\",\n \"notes\": \"<string>\",\n \"address_importer\": {\n \"name\": \"Shwan Ippotle\",\n \"company\": \"Shippo\",\n \"street1\": \"Blumenstraße\",\n \"street2\": \"<string>\",\n \"street3\": \"\",\n \"street_no\": \"22\",\n \"city\": \"München\",\n \"state\": \"CA\",\n \"zip\": \"80331\",\n \"country\": \"DE\",\n \"phone\": \"80331\",\n \"email\": \"shippotle@shippo.com\",\n \"is_residential\": true\n },\n \"eel_pfc\": \"NOEEI_30_37_a\",\n \"incoterm\": \"DDP\",\n \"test\": true\n },\n \"async\": true,\n \"carrier_accounts\": [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"\n ]\n },\n \"carrier_account\": \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n \"metadata\": \"SHIPMENT #1\",\n \"servicelevel_token\": \"fedex_ground\"\n }\n]"
response = http.request(request)
puts response.read_body{
"default_carrier_account": "078870331023437cb917f5187429b093",
"default_servicelevel_token": "usps_priority",
"batch_shipments": {
"next": "baseurl?page=3&results=10",
"previous": "baseurl?page=1&results=10",
"results": [
{
"object_id": "e11c95a6788d4ddcaa22f03175838740",
"shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
"status": "INVALID",
"carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
"metadata": "SHIPMENT #1",
"servicelevel_token": "fedex_ground",
"messages": [
"<unknown>"
],
"transaction": "4c33736a67e2450da88b38c42deef6b7"
}
]
},
"label_url": [
"<string>"
],
"object_created": "2016-01-04T00:15:44.394Z",
"object_id": "5ef63c54f5bf45d3b1f8fb37dcb1c5f4",
"object_owner": "shippo@shippo.com",
"object_results": {
"creation_failed": 3,
"creation_succeeded": 5,
"purchase_failed": 0,
"purchase_succeeded": 0
},
"object_updated": "2016-01-04T00:48:13.841Z",
"status": "VALID",
"label_filetype": "PDF_4x6",
"metadata": "BATCH #1",
"test": false
}{}Authorizations
API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123
Headers
Optional string used to pick a non-default API version to use. See our API version guide.
Example:
"2018-02-08"
Path Parameters
Object ID of the batch
Body
application/json
Array of shipments to add to the batch
Show child attributes
Show child attributes
Object ID of the carrier account to be used for this shipment (will override batch default)
Example:
"a4391cd4ab974f478f55dc08b5c8e3b3"
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
Maximum string length:
100Example:
"SHIPMENT #1"
A token that sets the shipping method for the batch, overriding the batch default. Servicelevel tokens can be found in this list or at this endpoint.
Example:
"fedex_ground"
Response
Batch
ID of the Carrier Account object to use as the default for all shipments in this Batch. The carrier account can be changed on a per-shipment basis by changing the carrier_account in the corresponding BatchShipment object.
Example:
"078870331023437cb917f5187429b093"
Token of the service level to use as the default for all shipments in this Batch. The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the corresponding BatchShipment object. Servicelevel tokens can be found here.
Example:
"usps_priority"
Array of BatchShipment objects. The response keeps the same order as in the request array.
Show child attributes
Show child attributes
An array of URLs each pointing to a merged file of 100 labels each
Date and time of Batch creation
Example:
"2016-01-04T00:15:44.394Z"
Unique identifier of the given Batch object
Example:
"5ef63c54f5bf45d3b1f8fb37dcb1c5f4"
Username of the user who created the Batch object.
Example:
"shippo@shippo.com"
An object containing the following counts: creation_succeeded, creation_failed, purchase_succeeded, purchase_failed
Show child attributes
Show child attributes
Date and time of last update to the Batch
Example:
"2016-01-04T00:48:13.841Z"
VALIDATING: the batch is being created and validatedVALID: the batch can be purchasedINVALID: the batch cannot be purchased;INVALIDBatchShipments must be removedPURCHASING: the batch is being purchasedPURCHASED: the batch is finished purchasing
Available options:
VALIDATING, VALID, INVALID, PURCHASING, PURCHASED Example:
"VALID"
Print format of the label. If empty, will use the default format set from the Shippo dashboard.
Available options:
PNG, PNG_2.3x7.5, PDF, PDF_2.3x7.5, PDF_4x6, PDF_4x8, PDF_A4, PDF_A5, PDF_A6, ZPLII Example:
"PDF_4x6"
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
Maximum string length:
100Example:
"BATCH #1"
Example:
false
Last modified on July 16, 2026
Was this page helpful?
⌘I