Dart
Dart
Shippo Create Shipment Object
See more Shippo Examples
Create a Shipment object to retrieve rates. It represents a request to ship a given package from the sender to the recipient address.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
final http = CkHttp();
// Implements the following CURL command:
// curl https://api.goshippo.com/shipments/ \
// -H "Authorization: ShippoToken <API_TOKEN>" \
// -H "Content-Type: application/json" \
// -d '{
// "address_from":{
// "name":"Mr. Hippo",
// "street1":"215 Clayton St.",
// "city":"San Francisco",
// "state":"CA",
// "zip":"94117",
// "country":"US"
// },
// "address_to":{
// "name":"Mrs. Hippo",
// "street1":"965 Mission St.",
// "city":"San Francisco",
// "state":"CA",
// "zip":"94105",
// "country":"US"
// },
// "parcels":[{
// "length":"5",
// "width":"5",
// "height":"5",
// "distance_unit":"in",
// "weight":"2",
// "mass_unit":"lb"
// }],
// "async": false
// }'
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "address_from": {
// "name": "Mr. Hippo",
// "street1": "215 Clayton St.",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94117",
// "country": "US"
// },
// "address_to": {
// "name": "Mrs. Hippo",
// "street1": "965 Mission St.",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94105",
// "country": "US"
// },
// "parcels": [
// {
// "length": "5",
// "width": "5",
// "height": "5",
// "distance_unit": "in",
// "weight": "2",
// "mass_unit": "lb"
// }
// ],
// "async": false
// }
final json = CkJsonObject();
json.updateString('address_from.name', 'Mr. Hippo');
json.updateString('address_from.street1', '215 Clayton St.');
json.updateString('address_from.city', 'San Francisco');
json.updateString('address_from.state', 'CA');
json.updateString('address_from.zip', '94117');
json.updateString('address_from.country', 'US');
json.updateString('address_to.name', 'Mrs. Hippo');
json.updateString('address_to.street1', '965 Mission St.');
json.updateString('address_to.city', 'San Francisco');
json.updateString('address_to.state', 'CA');
json.updateString('address_to.zip', '94105');
json.updateString('address_to.country', 'US');
json.updateString('parcels[0].length', '5');
json.updateString('parcels[0].width', '5');
json.updateString('parcels[0].height', '5');
json.updateString('parcels[0].distance_unit', 'in');
json.updateString('parcels[0].weight', '2');
json.updateString('parcels[0].mass_unit', 'lb');
json.updateBool('async', false);
http.setRequestHeader('Authorization', 'ShippoToken <API_TOKEN>');
http.setRequestHeader('Content-Type', 'application/json');
final resp = CkHttpResponse();
try {
http.httpJson('POST', 'https://api.goshippo.com/shipments/', json, 'application/json', resp);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
final sbResponseBody = CkStringBuilder();
resp.getBodySb(sbResponseBody);
final jResp = CkJsonObject();
jResp.loadSb(sbResponseBody);
jResp.emitCompact = false;
print('Response Body:');
print(jResp.emit());
final respStatusCode = resp.statusCode;
print('Response Status Code = $respStatusCode');
if (respStatusCode >= 400) {
print('Response Header:');
print(resp.header);
print('Failed.');
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "carrier_accounts": [
// ],
// "object_created": "2019-06-28T17:45:20.441Z",
// "object_updated": "2019-06-28T17:45:20.511Z",
// "object_id": "17b01795a4884d8a9002ccc17c9d09d1",
// "object_owner": "admin@chilkatsoft.com",
// "status": "SUCCESS",
// "address_from": {
// "object_id": "427489906b604f498f7bd2429ab7d9a1",
// "is_complete": true,
// "name": "Mr. Hippo",
// "company": "",
// "street_no": "",
// "street1": "215 Clayton St.",
// "validation_results": {},
// "street2": "",
// "street3": "",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94117",
// "country": "US",
// "phone": "",
// "email": "",
// "is_residential": null,
// "test": true
// },
// "address_to": {
// "object_id": "3d7166269a2844b7842ef9ace942ec7c",
// "is_complete": true,
// "name": "Mrs. Hippo",
// "company": "",
// "street_no": "",
// "street1": "965 Mission St.",
// "validation_results": {},
// "street2": "",
// "street3": "",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94105",
// "country": "US",
// "phone": "",
// "email": "",
// "is_residential": null,
// "test": true
// },
// "parcels": [
// {
// "object_state": "VALID",
// "object_created": "2019-06-28T17:45:20.411Z",
// "object_updated": "2019-06-28T17:45:20.455Z",
// "object_id": "5af766ff15684a4186b0e3c833348fac",
// "object_owner": "admin@chilkatsoft.com",
// "template": null,
// "extra": {},
// "length": "5.0000",
// "width": "5.0000",
// "height": "5.0000",
// "distance_unit": "in",
// "weight": "2.0000",
// "mass_unit": "lb",
// "value_amount": null,
// "value_currency": null,
// "metadata": "",
// "line_items": [
// ],
// "test": true
// }
// ],
// "shipment_date": "2019-06-28T17:45:20.511Z",
// "address_return": {
// "object_id": "427489906b604f498f7bd2429ab7d9a1",
// "is_complete": true,
// "name": "Mr. Hippo",
// "company": "",
// "street_no": "",
// "street1": "215 Clayton St.",
// "validation_results": {},
// "street2": "",
// "street3": "",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94117",
// "country": "US",
// "phone": "",
// "email": "",
// "is_residential": null,
// "test": true
// },
// "alternate_address_to": null,
// "customs_declaration": null,
// "extra": {},
// "rates": [
// {
// "object_created": "2019-06-28T17:45:20.789Z",
// "object_id": "dd7556c284e8444294d2ab7099e662d2",
// "object_owner": "admin@chilkatsoft.com",
// "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
// "attributes": [
// "FASTEST"
// ],
// "amount": "22.78",
// "currency": "USD",
// "amount_local": "22.78",
// "currency_local": "USD",
// "provider": "USPS",
// "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
// "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
// "servicelevel": {
// "name": "Priority Mail Express",
// "token": "usps_priority_express",
// "terms": ""
// },
// "estimated_days": 2,
// "arrives_by": null,
// "duration_terms": "Overnight delivery to most U.S. locations.",
// "messages": [
// ],
// "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
// "test": true,
// "zone": "1"
// },
// {
// "object_created": "2019-06-28T17:45:20.786Z",
// "object_id": "ec11cc297e2f4583986097f6d409e5c6",
// "object_owner": "admin@chilkatsoft.com",
// "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
// "attributes": [
// "BESTVALUE",
// "CHEAPEST",
// "FASTEST"
// ],
// "amount": "6.95",
// "currency": "USD",
// "amount_local": "6.95",
// "currency_local": "USD",
// "provider": "USPS",
// "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
// "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
// "servicelevel": {
// "name": "Priority Mail",
// "token": "usps_priority",
// "terms": ""
// },
// "estimated_days": 2,
// "arrives_by": null,
// "duration_terms": "Delivery within 1, 2, or 3 days based on where your package started and where it’s being sent.",
// "messages": [
// ],
// "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
// "test": true,
// "zone": "1"
// },
// {
// "object_created": "2019-06-28T17:45:20.785Z",
// "object_id": "d256586f539f4c93a2f02cc11f4942ac",
// "object_owner": "admin@chilkatsoft.com",
// "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
// "attributes": [
// ],
// "amount": "7.32",
// "currency": "USD",
// "amount_local": "7.32",
// "currency_local": "USD",
// "provider": "USPS",
// "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
// "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
// "servicelevel": {
// "name": "Parcel Select",
// "token": "usps_parcel_select",
// "terms": ""
// },
// "estimated_days": 7,
// "arrives_by": null,
// "duration_terms": "Delivery in 2 to 8 days.",
// "messages": [
// ],
// "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
// "test": true,
// "zone": "1"
// }
// ],
// "messages": [
// {
// "source": "DHLExpress",
// "code": "",
// "text": "Shippo's DHL Express master account doesn't support shipments to inside of the US"
// }
// ],
// "metadata": "",
// "test": true,
// "order": null
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
var objectState = '';
var template = '';
var length = '';
var width = '';
var height = '';
var distanceUnit = '';
var weight = '';
var massUnit = '';
var valueAmount = '';
var valueCurrency = '';
var j = 0;
var countJ = 0;
var shipment = '';
var amount = '';
var currency = '';
var amountLocal = '';
var currencyLocal = '';
var provider = '';
var providerImage_75 = '';
var providerImage_200 = '';
var servicelevelName = '';
var servicelevelToken = '';
var servicelevelTerms = '';
var estimatedDays = 0;
var arrivesBy = '';
var durationTerms = '';
var carrierAccount = '';
var zone = '';
var strVal = '';
var source = '';
var code = '';
var text = '';
var objectCreated = jResp.stringOf('object_created');
var objectUpdated = jResp.stringOf('object_updated');
var objectId = jResp.stringOf('object_id');
var objectOwner = jResp.stringOf('object_owner');
final status = jResp.stringOf('status');
final addressFromObjectId = jResp.stringOf('address_from.object_id');
final addressFromName = jResp.stringOf('address_from.name');
final addressFromCompany = jResp.stringOf('address_from.company');
final addressFromStreetNo = jResp.stringOf('address_from.street_no');
final addressFromStreet1 = jResp.stringOf('address_from.street1');
final addressFromStreet2 = jResp.stringOf('address_from.street2');
final addressFromStreet3 = jResp.stringOf('address_from.street3');
final addressFromCity = jResp.stringOf('address_from.city');
final addressFromState = jResp.stringOf('address_from.state');
final addressFromZip = jResp.stringOf('address_from.zip');
final addressFromCountry = jResp.stringOf('address_from.country');
final addressFromPhone = jResp.stringOf('address_from.phone');
final addressFromEmail = jResp.stringOf('address_from.email');
final addressFromIsResidential = jResp.stringOf('address_from.is_residential');
final addressToObjectId = jResp.stringOf('address_to.object_id');
final addressToName = jResp.stringOf('address_to.name');
final addressToCompany = jResp.stringOf('address_to.company');
final addressToStreetNo = jResp.stringOf('address_to.street_no');
final addressToStreet1 = jResp.stringOf('address_to.street1');
final addressToStreet2 = jResp.stringOf('address_to.street2');
final addressToStreet3 = jResp.stringOf('address_to.street3');
final addressToCity = jResp.stringOf('address_to.city');
final addressToState = jResp.stringOf('address_to.state');
final addressToZip = jResp.stringOf('address_to.zip');
final addressToCountry = jResp.stringOf('address_to.country');
final addressToPhone = jResp.stringOf('address_to.phone');
final addressToEmail = jResp.stringOf('address_to.email');
final addressToIsResidential = jResp.stringOf('address_to.is_residential');
final shipmentDate = jResp.stringOf('shipment_date');
final addressReturnObjectId = jResp.stringOf('address_return.object_id');
final addressReturnName = jResp.stringOf('address_return.name');
final addressReturnCompany = jResp.stringOf('address_return.company');
final addressReturnStreetNo = jResp.stringOf('address_return.street_no');
final addressReturnStreet1 = jResp.stringOf('address_return.street1');
final addressReturnStreet2 = jResp.stringOf('address_return.street2');
final addressReturnStreet3 = jResp.stringOf('address_return.street3');
final addressReturnCity = jResp.stringOf('address_return.city');
final addressReturnState = jResp.stringOf('address_return.state');
final addressReturnZip = jResp.stringOf('address_return.zip');
final addressReturnCountry = jResp.stringOf('address_return.country');
final addressReturnPhone = jResp.stringOf('address_return.phone');
final addressReturnEmail = jResp.stringOf('address_return.email');
final addressReturnIsResidential = jResp.stringOf('address_return.is_residential');
final alternateAddressTo = jResp.stringOf('alternate_address_to');
final customsDeclaration = jResp.stringOf('customs_declaration');
var metadata = jResp.stringOf('metadata');
final order = jResp.stringOf('order');
var i = 0;
var countI = jResp.sizeOfArray('carrier_accounts');
while (i < countI) {
jResp.i = i;
i++;
}
i = 0;
countI = jResp.sizeOfArray('parcels');
while (i < countI) {
jResp.i = i;
objectState = jResp.stringOf('parcels[i].object_state');
objectCreated = jResp.stringOf('parcels[i].object_created');
objectUpdated = jResp.stringOf('parcels[i].object_updated');
objectId = jResp.stringOf('parcels[i].object_id');
objectOwner = jResp.stringOf('parcels[i].object_owner');
template = jResp.stringOf('parcels[i].template');
length = jResp.stringOf('parcels[i].length');
width = jResp.stringOf('parcels[i].width');
height = jResp.stringOf('parcels[i].height');
distanceUnit = jResp.stringOf('parcels[i].distance_unit');
weight = jResp.stringOf('parcels[i].weight');
massUnit = jResp.stringOf('parcels[i].mass_unit');
valueAmount = jResp.stringOf('parcels[i].value_amount');
valueCurrency = jResp.stringOf('parcels[i].value_currency');
metadata = jResp.stringOf('parcels[i].metadata');
jResp.boolOf('parcels[i].test');
j = 0;
countJ = jResp.sizeOfArray('parcels[i].line_items');
while (j < countJ) {
jResp.j = j;
j++;
}
i++;
}
i = 0;
countI = jResp.sizeOfArray('rates');
while (i < countI) {
jResp.i = i;
objectCreated = jResp.stringOf('rates[i].object_created');
objectId = jResp.stringOf('rates[i].object_id');
objectOwner = jResp.stringOf('rates[i].object_owner');
shipment = jResp.stringOf('rates[i].shipment');
amount = jResp.stringOf('rates[i].amount');
currency = jResp.stringOf('rates[i].currency');
amountLocal = jResp.stringOf('rates[i].amount_local');
currencyLocal = jResp.stringOf('rates[i].currency_local');
provider = jResp.stringOf('rates[i].provider');
providerImage_75 = jResp.stringOf('rates[i].provider_image_75');
providerImage_200 = jResp.stringOf('rates[i].provider_image_200');
servicelevelName = jResp.stringOf('rates[i].servicelevel.name');
servicelevelToken = jResp.stringOf('rates[i].servicelevel.token');
servicelevelTerms = jResp.stringOf('rates[i].servicelevel.terms');
estimatedDays = jResp.intOf('rates[i].estimated_days');
arrivesBy = jResp.stringOf('rates[i].arrives_by');
durationTerms = jResp.stringOf('rates[i].duration_terms');
carrierAccount = jResp.stringOf('rates[i].carrier_account');
jResp.boolOf('rates[i].test');
zone = jResp.stringOf('rates[i].zone');
j = 0;
countJ = jResp.sizeOfArray('rates[i].attributes');
while (j < countJ) {
jResp.j = j;
strVal = jResp.stringOf('rates[i].attributes[j]');
j++;
}
j = 0;
countJ = jResp.sizeOfArray('rates[i].messages');
while (j < countJ) {
jResp.j = j;
j++;
}
i++;
}
i = 0;
countI = jResp.sizeOfArray('messages');
while (i < countI) {
jResp.i = i;
source = jResp.stringOf('messages[i].source');
code = jResp.stringOf('messages[i].code');
text = jResp.stringOf('messages[i].text');
i++;
}
}