curl https://api.goshippo.com/shipments/ \
-H "Authorization: ShippoToken <API_TOKEN>" \
-H "Content-Type: application/json" \
-d $'{
"address_to": {
"name": "Mr Hippo",
"street1": "965 Mission St #572",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US",
"phone": "4151234567",
"email": "mrhippo@shippo.com"
},
"address_from": {
"name": "Mrs Hippo",
"street1": "1092 Indian Summer Ct",
"city": "San Jose",
"state": "CA",
"zip": "95122",
"country": "US",
"phone": "4159876543",
"email": "mrshippo@shippo.com"
},
"parcels": [{
"length": "10",
"width": "15",
"height": "10",
"distance_unit": "in",
"weight": "1",
"mass_unit": "lb"
}],
"async": false
}'import shippo
from shippo.models import components
s = shippo.Shippo(
api_key_header='ShippoToken <API_TOKEN>',
shippo_api_version='2018-02-08',
)
res = s.shipments.create(request=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='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=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=[
'<value>',
components.ParcelCreateRequest(
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',
distance_unit=components.DistanceUnitEnum.IN,
height='1',
length='1',
width='1',
),
components.ParcelCreateRequest(
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',
distance_unit=components.DistanceUnitEnum.IN,
height='1',
length='1',
width='1',
),
],
))
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.shipments.create({
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: "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: {
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: [
"<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",
distanceUnit: "in",
height: "1",
length: "1",
width: "1",
},
{
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",
distanceUnit: "in",
height: "1",
length: "1",
width: "1",
},
],
});
// Handle the result
console.log(result);
}
run();declare(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();
$shipmentCreateRequest = 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: 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,
),
addressReturn: 'd799c2679e644279b59fe661ac8fa488',
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: new Components\CustomsDeclarationCreateRequest(
b13aFilingOption: Components\CustomsDeclarationB13AFilingOptionEnum::FiledElectronically,
certify: true,
certifySigner: 'Shawn Ippotle',
contentsExplanation: 'T-Shirt purchase',
dutiesPayor: new Components\DutiesPayor(
account: '2323434543',
type: Components\CustomsDeclarationCreateRequestType::ThirdParty,
address: new Components\CustomsDeclarationCreateRequestAddress(
name: 'Patrick Kavanagh',
zip: '80331',
country: 'DE',
),
),
exporterIdentification: new Components\CustomsExporterIdentification(
eoriNumber: 'PL123456790ABCDE',
taxId: new Components\CustomsTaxIdentification(
number: '123456789',
type: Components\CustomsTaxIdentificationType::Ein,
),
),
invoice: '#123123',
metadata: 'Order ID #123123',
addressImporter: new Components\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: Components\CustomsDeclarationContentsTypeEnum::Merchandise,
eelPfc: Components\CustomsDeclarationEelPfcEnum::NOEEI3037A,
incoterm: Components\CustomsDeclarationIncotermEnum::Ddp,
items: [
new Components\CustomsItemCreateRequest(
description: 'T-Shirt',
massUnit: Components\WeightUnitEnum::Lb,
metadata: 'Order ID "123454"',
netWeight: '5',
originCountry: '<value>',
quantity: 20,
skuCode: 'HM-123',
hsCode: '0901.21',
valueAmount: '200',
valueCurrency: 'USD',
),
],
nonDeliveryOption: Components\CustomsDeclarationNonDeliveryOptionEnum::Return,
test: true,
),
carrierAccounts: [
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels: [
new Components\ParcelCreateRequest(
extra: new Components\ParcelExtra(
cod: new Components\Cod(
amount: '5.5',
currency: 'USD',
paymentMethod: Components\PaymentMethod::Cash,
),
insurance: new Components\ParcelInsurance(
amount: '5.5',
content: 'Laptop',
currency: 'USD',
provider: Components\ParcelInsuranceProvider::Ups,
),
),
metadata: 'Customer ID 123456',
massUnit: Components\WeightUnitEnum::Lb,
weight: '1',
distanceUnit: Components\DistanceUnitEnum::In,
height: '1',
length: '1',
width: '1',
),
],
);
$response = $sdk->shipments->create(
shipmentCreateRequest: $shipmentCreateRequest,
shippoApiVersion: '2018-02-08'
);
if ($response->shipment !== null) {
// handle response
}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.Shipments.CreateAsync(
shipmentCreateRequest: 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.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,
}
),
AddressReturn = AddressReturn.CreateStr(
"d799c2679e644279b59fe661ac8fa488"
),
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.CreateCustomsDeclarationCreateRequest(
new CustomsDeclarationCreateRequest() {
B13aFilingOption = CustomsDeclarationB13AFilingOptionEnum.FiledElectronically,
Certify = true,
CertifySigner = "Shawn Ippotle",
ContentsExplanation = "T-Shirt purchase",
DutiesPayor = new DutiesPayor() {
Account = "2323434543",
Type = CustomsDeclarationCreateRequestType.ThirdParty,
Address = new CustomsDeclarationCreateRequestAddress() {
Name = "Patrick Kavanagh",
Zip = "80331",
Country = "DE",
},
},
ExporterIdentification = new CustomsExporterIdentification() {
EoriNumber = "PL123456790ABCDE",
TaxId = new CustomsTaxIdentification() {
Number = "123456789",
Type = CustomsTaxIdentificationType.Ein,
},
},
Invoice = "#123123",
Metadata = "Order ID #123123",
AddressImporter = new 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 = CustomsDeclarationContentsTypeEnum.Merchandise,
EelPfc = CustomsDeclarationEelPfcEnum.Noeei3037A,
Incoterm = CustomsDeclarationIncotermEnum.Ddp,
Items = new List<CustomsItemCreateRequest>() {
new CustomsItemCreateRequest() {
Description = "T-Shirt",
MassUnit = WeightUnitEnum.Lb,
Metadata = "Order ID \"123454\"",
NetWeight = "5",
OriginCountry = "<value>",
Quantity = 20,
SkuCode = "HM-123",
HsCode = "0901.21",
ValueAmount = "200",
ValueCurrency = "USD",
},
},
NonDeliveryOption = CustomsDeclarationNonDeliveryOptionEnum.Return,
Test = true,
}
),
CarrierAccounts = new List<string>() {
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
},
Parcels = new List<Models.Components.Parcels>() {
Parcels.CreateParcelCreateRequest(
new ParcelCreateRequest() {
Extra = new ParcelExtra() {
Cod = new Cod() {
Amount = "5.5",
Currency = "USD",
PaymentMethod = PaymentMethod.Cash,
},
Insurance = new ParcelInsurance() {
Amount = "5.5",
Content = "Laptop",
Currency = "USD",
Provider = ParcelInsuranceProvider.Ups,
},
},
Metadata = "Customer ID 123456",
MassUnit = WeightUnitEnum.Lb,
Weight = "1",
DistanceUnit = DistanceUnitEnum.In,
Height = "1",
Length = "1",
Width = "1",
}
),
},
},
shippoApiVersion: "2018-02-08"
);
// handle responsepackage 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.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.DistanceUnitEnum;
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.ParcelCreateRequest;
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.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.CreateShipmentResponse;
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();
CreateShipmentResponse res = sdk.shipments().create()
.shippoApiVersion("2018-02-08")
.shipmentCreateRequest(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("<value>"),
Parcels.of(ParcelCreateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.distanceUnit(DistanceUnitEnum.IN)
.height("1")
.length("1")
.width("1")
.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(ParcelCreateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.distanceUnit(DistanceUnitEnum.IN)
.height("1")
.length("1")
.width("1")
.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("d799c2679e644279b59fe661ac8fa488"))
.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())
.call();
if (res.shipment().isPresent()) {
// handle response
}
}
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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']
})
};
fetch('https://api.goshippo.com/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/shipments"
payload := strings.NewReader("{\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}")
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/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 \"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}"
response = http.request(request)
puts response.read_body{
"metadata": "Customer ID 123456",
"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",
"is_complete": true,
"latitude": 123,
"longitude": 123,
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "d799c2679e644279b59fe661ac8fa488",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-09T02:19:13.174Z",
"validation_results": {
"is_valid": false,
"messages": [
{
"code": "Unknown Street",
"source": "Shippo Address Validator",
"text": "City, State and ZIP Code are valid, but street address is not a match.",
"type": "address_warning"
}
]
},
"test": false
},
"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",
"is_complete": true,
"latitude": 123,
"longitude": 123,
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "d799c2679e644279b59fe661ac8fa488",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-09T02:19:13.174Z",
"validation_results": {
"is_valid": false,
"messages": [
{
"code": "Unknown Street",
"source": "Shippo Address Validator",
"text": "City, State and ZIP Code are valid, but street address is not a match.",
"type": "address_warning"
}
]
},
"test": false
},
"carrier_accounts": [
"<string>"
],
"messages": [
{
"source": "UPS",
"code": "carrier_timeout",
"text": "UPS API did not respond. Please try again in a few minutes."
}
],
"object_created": "2023-11-07T05:31:56Z",
"object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
"object_owner": "pp@gmail.com",
"object_updated": "2023-11-07T05:31:56Z",
"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",
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
"object_owner": "shippotle@shippo.com",
"object_state": "VALID",
"object_updated": "2014-07-09T02:19:13.174Z",
"test": true
}
],
"rates": [
{
"amount": "5.5",
"amount_local": "5.5",
"currency": "USD",
"currency_local": "USD",
"attributes": [],
"carrier_account": "078870331023437cb917f5187429b093",
"object_created": "2023-11-07T05:31:56Z",
"object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
"object_owner": "pp@gmail.com",
"provider": "USPS",
"servicelevel": {
"name": "Priority Mail Express",
"terms": "<string>",
"token": "usps_priority_express",
"extended_token": "<string>",
"parent_servicelevel": {
"name": "Priority Mail Express",
"terms": "<string>",
"token": "usps_priority_express",
"extended_token": "<string>"
}
},
"shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
"arrives_by": "08:30:00",
"duration_terms": "Delivery in 1 to 3 business days",
"estimated_days": 2,
"included_insurance_price": "1.05",
"messages": [
{
"source": "UPS",
"code": "carrier_timeout",
"text": "UPS API did not respond. Please try again in a few minutes."
}
],
"provider_image_75": "https://cdn2.goshippo.com/providers/75/USPS.png",
"provider_image_200": "https://cdn2.goshippo.com/providers/200/USPS.png",
"test": true,
"zone": "1"
}
],
"status": "QUEUED",
"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
},
"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",
"is_complete": true,
"latitude": 123,
"longitude": 123,
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "d799c2679e644279b59fe661ac8fa488",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-09T02:19:13.174Z",
"validation_results": {
"is_valid": false,
"messages": [
{
"code": "Unknown Street",
"source": "Shippo Address Validator",
"text": "City, State and ZIP Code are valid, but street address is not a match.",
"type": "address_warning"
}
]
},
"test": false
},
"customs_declaration": {
"certify": true,
"certify_signer": "Shawn Ippotle",
"contents_type": "MERCHANDISE",
"items": [
"5087f181d1dc4b14b73fdbf636498886"
],
"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": "257ba08436604d2aaf069caafe7acb2a",
"eel_pfc": "NOEEI_30_37_a",
"incoterm": "DDP",
"invoiced_charges": {
"currency": "<string>",
"total_shipping": "<string>",
"total_taxes": "<string>",
"total_duties": "<string>",
"other_fees": "<string>"
},
"object_created": "2014-07-17T01:01:08.306Z",
"object_id": "e2197a54da9d470480f4f8796cc419cb",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-17T01:01:08.306Z",
"test": true
},
"test": true
}{}Create a new shipment
Creates a new shipment object.
curl https://api.goshippo.com/shipments/ \
-H "Authorization: ShippoToken <API_TOKEN>" \
-H "Content-Type: application/json" \
-d $'{
"address_to": {
"name": "Mr Hippo",
"street1": "965 Mission St #572",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US",
"phone": "4151234567",
"email": "mrhippo@shippo.com"
},
"address_from": {
"name": "Mrs Hippo",
"street1": "1092 Indian Summer Ct",
"city": "San Jose",
"state": "CA",
"zip": "95122",
"country": "US",
"phone": "4159876543",
"email": "mrshippo@shippo.com"
},
"parcels": [{
"length": "10",
"width": "15",
"height": "10",
"distance_unit": "in",
"weight": "1",
"mass_unit": "lb"
}],
"async": false
}'import shippo
from shippo.models import components
s = shippo.Shippo(
api_key_header='ShippoToken <API_TOKEN>',
shippo_api_version='2018-02-08',
)
res = s.shipments.create(request=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='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=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=[
'<value>',
components.ParcelCreateRequest(
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',
distance_unit=components.DistanceUnitEnum.IN,
height='1',
length='1',
width='1',
),
components.ParcelCreateRequest(
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',
distance_unit=components.DistanceUnitEnum.IN,
height='1',
length='1',
width='1',
),
],
))
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.shipments.create({
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: "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: {
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: [
"<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",
distanceUnit: "in",
height: "1",
length: "1",
width: "1",
},
{
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",
distanceUnit: "in",
height: "1",
length: "1",
width: "1",
},
],
});
// Handle the result
console.log(result);
}
run();declare(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();
$shipmentCreateRequest = 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: 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,
),
addressReturn: 'd799c2679e644279b59fe661ac8fa488',
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: new Components\CustomsDeclarationCreateRequest(
b13aFilingOption: Components\CustomsDeclarationB13AFilingOptionEnum::FiledElectronically,
certify: true,
certifySigner: 'Shawn Ippotle',
contentsExplanation: 'T-Shirt purchase',
dutiesPayor: new Components\DutiesPayor(
account: '2323434543',
type: Components\CustomsDeclarationCreateRequestType::ThirdParty,
address: new Components\CustomsDeclarationCreateRequestAddress(
name: 'Patrick Kavanagh',
zip: '80331',
country: 'DE',
),
),
exporterIdentification: new Components\CustomsExporterIdentification(
eoriNumber: 'PL123456790ABCDE',
taxId: new Components\CustomsTaxIdentification(
number: '123456789',
type: Components\CustomsTaxIdentificationType::Ein,
),
),
invoice: '#123123',
metadata: 'Order ID #123123',
addressImporter: new Components\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: Components\CustomsDeclarationContentsTypeEnum::Merchandise,
eelPfc: Components\CustomsDeclarationEelPfcEnum::NOEEI3037A,
incoterm: Components\CustomsDeclarationIncotermEnum::Ddp,
items: [
new Components\CustomsItemCreateRequest(
description: 'T-Shirt',
massUnit: Components\WeightUnitEnum::Lb,
metadata: 'Order ID "123454"',
netWeight: '5',
originCountry: '<value>',
quantity: 20,
skuCode: 'HM-123',
hsCode: '0901.21',
valueAmount: '200',
valueCurrency: 'USD',
),
],
nonDeliveryOption: Components\CustomsDeclarationNonDeliveryOptionEnum::Return,
test: true,
),
carrierAccounts: [
'065a4a8c10d24a34ab932163a1b87f52',
'73f706f4bdb94b54a337563840ce52b0',
],
parcels: [
new Components\ParcelCreateRequest(
extra: new Components\ParcelExtra(
cod: new Components\Cod(
amount: '5.5',
currency: 'USD',
paymentMethod: Components\PaymentMethod::Cash,
),
insurance: new Components\ParcelInsurance(
amount: '5.5',
content: 'Laptop',
currency: 'USD',
provider: Components\ParcelInsuranceProvider::Ups,
),
),
metadata: 'Customer ID 123456',
massUnit: Components\WeightUnitEnum::Lb,
weight: '1',
distanceUnit: Components\DistanceUnitEnum::In,
height: '1',
length: '1',
width: '1',
),
],
);
$response = $sdk->shipments->create(
shipmentCreateRequest: $shipmentCreateRequest,
shippoApiVersion: '2018-02-08'
);
if ($response->shipment !== null) {
// handle response
}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.Shipments.CreateAsync(
shipmentCreateRequest: 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.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,
}
),
AddressReturn = AddressReturn.CreateStr(
"d799c2679e644279b59fe661ac8fa488"
),
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.CreateCustomsDeclarationCreateRequest(
new CustomsDeclarationCreateRequest() {
B13aFilingOption = CustomsDeclarationB13AFilingOptionEnum.FiledElectronically,
Certify = true,
CertifySigner = "Shawn Ippotle",
ContentsExplanation = "T-Shirt purchase",
DutiesPayor = new DutiesPayor() {
Account = "2323434543",
Type = CustomsDeclarationCreateRequestType.ThirdParty,
Address = new CustomsDeclarationCreateRequestAddress() {
Name = "Patrick Kavanagh",
Zip = "80331",
Country = "DE",
},
},
ExporterIdentification = new CustomsExporterIdentification() {
EoriNumber = "PL123456790ABCDE",
TaxId = new CustomsTaxIdentification() {
Number = "123456789",
Type = CustomsTaxIdentificationType.Ein,
},
},
Invoice = "#123123",
Metadata = "Order ID #123123",
AddressImporter = new 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 = CustomsDeclarationContentsTypeEnum.Merchandise,
EelPfc = CustomsDeclarationEelPfcEnum.Noeei3037A,
Incoterm = CustomsDeclarationIncotermEnum.Ddp,
Items = new List<CustomsItemCreateRequest>() {
new CustomsItemCreateRequest() {
Description = "T-Shirt",
MassUnit = WeightUnitEnum.Lb,
Metadata = "Order ID \"123454\"",
NetWeight = "5",
OriginCountry = "<value>",
Quantity = 20,
SkuCode = "HM-123",
HsCode = "0901.21",
ValueAmount = "200",
ValueCurrency = "USD",
},
},
NonDeliveryOption = CustomsDeclarationNonDeliveryOptionEnum.Return,
Test = true,
}
),
CarrierAccounts = new List<string>() {
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0",
},
Parcels = new List<Models.Components.Parcels>() {
Parcels.CreateParcelCreateRequest(
new ParcelCreateRequest() {
Extra = new ParcelExtra() {
Cod = new Cod() {
Amount = "5.5",
Currency = "USD",
PaymentMethod = PaymentMethod.Cash,
},
Insurance = new ParcelInsurance() {
Amount = "5.5",
Content = "Laptop",
Currency = "USD",
Provider = ParcelInsuranceProvider.Ups,
},
},
Metadata = "Customer ID 123456",
MassUnit = WeightUnitEnum.Lb,
Weight = "1",
DistanceUnit = DistanceUnitEnum.In,
Height = "1",
Length = "1",
Width = "1",
}
),
},
},
shippoApiVersion: "2018-02-08"
);
// handle responsepackage 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.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.DistanceUnitEnum;
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.ParcelCreateRequest;
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.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.CreateShipmentResponse;
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();
CreateShipmentResponse res = sdk.shipments().create()
.shippoApiVersion("2018-02-08")
.shipmentCreateRequest(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("<value>"),
Parcels.of(ParcelCreateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.distanceUnit(DistanceUnitEnum.IN)
.height("1")
.length("1")
.width("1")
.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(ParcelCreateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.distanceUnit(DistanceUnitEnum.IN)
.height("1")
.length("1")
.width("1")
.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("d799c2679e644279b59fe661ac8fa488"))
.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())
.call();
if (res.shipment().isPresent()) {
// handle response
}
}
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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']
})
};
fetch('https://api.goshippo.com/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/shipments"
payload := strings.NewReader("{\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}")
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/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 \"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}"
response = http.request(request)
puts response.read_body{
"metadata": "Customer ID 123456",
"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",
"is_complete": true,
"latitude": 123,
"longitude": 123,
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "d799c2679e644279b59fe661ac8fa488",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-09T02:19:13.174Z",
"validation_results": {
"is_valid": false,
"messages": [
{
"code": "Unknown Street",
"source": "Shippo Address Validator",
"text": "City, State and ZIP Code are valid, but street address is not a match.",
"type": "address_warning"
}
]
},
"test": false
},
"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",
"is_complete": true,
"latitude": 123,
"longitude": 123,
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "d799c2679e644279b59fe661ac8fa488",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-09T02:19:13.174Z",
"validation_results": {
"is_valid": false,
"messages": [
{
"code": "Unknown Street",
"source": "Shippo Address Validator",
"text": "City, State and ZIP Code are valid, but street address is not a match.",
"type": "address_warning"
}
]
},
"test": false
},
"carrier_accounts": [
"<string>"
],
"messages": [
{
"source": "UPS",
"code": "carrier_timeout",
"text": "UPS API did not respond. Please try again in a few minutes."
}
],
"object_created": "2023-11-07T05:31:56Z",
"object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
"object_owner": "pp@gmail.com",
"object_updated": "2023-11-07T05:31:56Z",
"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",
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
"object_owner": "shippotle@shippo.com",
"object_state": "VALID",
"object_updated": "2014-07-09T02:19:13.174Z",
"test": true
}
],
"rates": [
{
"amount": "5.5",
"amount_local": "5.5",
"currency": "USD",
"currency_local": "USD",
"attributes": [],
"carrier_account": "078870331023437cb917f5187429b093",
"object_created": "2023-11-07T05:31:56Z",
"object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
"object_owner": "pp@gmail.com",
"provider": "USPS",
"servicelevel": {
"name": "Priority Mail Express",
"terms": "<string>",
"token": "usps_priority_express",
"extended_token": "<string>",
"parent_servicelevel": {
"name": "Priority Mail Express",
"terms": "<string>",
"token": "usps_priority_express",
"extended_token": "<string>"
}
},
"shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
"arrives_by": "08:30:00",
"duration_terms": "Delivery in 1 to 3 business days",
"estimated_days": 2,
"included_insurance_price": "1.05",
"messages": [
{
"source": "UPS",
"code": "carrier_timeout",
"text": "UPS API did not respond. Please try again in a few minutes."
}
],
"provider_image_75": "https://cdn2.goshippo.com/providers/75/USPS.png",
"provider_image_200": "https://cdn2.goshippo.com/providers/200/USPS.png",
"test": true,
"zone": "1"
}
],
"status": "QUEUED",
"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
},
"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",
"is_complete": true,
"latitude": 123,
"longitude": 123,
"object_created": "2014-07-09T02:19:13.174Z",
"object_id": "d799c2679e644279b59fe661ac8fa488",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-09T02:19:13.174Z",
"validation_results": {
"is_valid": false,
"messages": [
{
"code": "Unknown Street",
"source": "Shippo Address Validator",
"text": "City, State and ZIP Code are valid, but street address is not a match.",
"type": "address_warning"
}
]
},
"test": false
},
"customs_declaration": {
"certify": true,
"certify_signer": "Shawn Ippotle",
"contents_type": "MERCHANDISE",
"items": [
"5087f181d1dc4b14b73fdbf636498886"
],
"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": "257ba08436604d2aaf069caafe7acb2a",
"eel_pfc": "NOEEI_30_37_a",
"incoterm": "DDP",
"invoiced_charges": {
"currency": "<string>",
"total_shipping": "<string>",
"total_taxes": "<string>",
"total_duties": "<string>",
"other_fees": "<string>"
},
"object_created": "2014-07-17T01:01:08.306Z",
"object_id": "e2197a54da9d470480f4f8796cc419cb",
"object_owner": "shippotle@shippo.com",
"object_updated": "2014-07-17T01:01:08.306Z",
"test": true
},
"test": true
}{}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.
"2018-02-08"
Body
Shipment details and contact info.
Address represents the address as retrieved from the database
Show child attributes
Show child attributes
Address represents the address as retrieved from the database
Show child attributes
Show child attributes
List of parcels to be shipped.
Carrier-Specific Constraints:
| Carrier | Constraints |
|---|---|
| FedEx | Max 30 items |
Show child attributes
Show child attributes
An object holding optional extra services to be requested.
Show child attributes
Show child attributes
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
100"Customer ID 123456"
Date the shipment will be tendered to the carrier. Must be in the format 2014-01-18T00:35:03.463Z.
Defaults to current date and time if no value is provided. Please note that some carriers require this value to
be in the future, on a working day, or similar.
"2021-03-22T12:00:00Z"
Address represents the address as retrieved from the database
Show child attributes
Show child attributes
Show child attributes
Show child attributes
List of Carrier Accounts object_ids used to filter
the returned rates. If set, only rates from these carriers will be returned.
[
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"
]Response
Shipment
Shipment represents the parcel as retrieved from the database
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
100"Customer ID 123456"
An array of object_ids of the carrier account objects to be used for getting shipping rates for this shipment.
If no carrier account object_ids are set in this field, Shippo will attempt to generate rates using all the
carrier accounts that have the active field set.
Show child attributes
Show child attributes
Date and time of Shipment creation.
Unique identifier of the given Shipment object.
"adcfdddf8ec64b84ad22772bce3ea37a"
Username of the user who created the Shipment object.
"pp@gmail.com"
Date and time of last Shipment update.
List of Parcel objects to be shipped.
Show child attributes
Show child attributes
An array with all available rates. If async has been set to false in the request,
this will be populated with all available rates in the response. Otherwise rates will be created
asynchronously and this array will initially be empty.
Show child attributes
Show child attributes
Waiting shipments have been successfully submitted but not yet been processed.
Queued shipments are currently being processed.
Success shipments have been processed successfully, meaning that rate generation has concluded.
Error does not occur currently and is reserved for future use.
ERROR, QUEUED, SUCCESS, WAITING "QUEUED"
An object holding optional extra services to be requested.
Show child attributes
Show child attributes
Date the shipment will be tendered to the carrier. Must be in the format 2014-01-18T00:35:03.463Z.
Defaults to current date and time if no value is provided. Please note that some carriers require this value to
be in the future, on a working day, or similar.
"2021-03-22T12:00:00Z"
ID of the Address object where the shipment will be sent back to if it is not delivered
(Only available for UPS, USPS, and Fedex shipments).
If this field is not set, your shipments will be returned to the address_from.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Indicates whether the object has been created in test mode.
Was this page helpful?