Dart
Dart
Add order to a ShippingEasy account
See more HTTP Misc Examples
Adds an order to a ShippingEasy account (calls the ShippingEasy REST API).Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// First create the JSON for the order.
// See https://shippingeasy.readme.io/v1.0/docs/creating-a-signature
// for sample JSON.
// You may use the online tool at https://tools.chilkat.io/Default.cshtml to
// generate the following code by pasting sample JSON into the tool.
final json = CkJsonObject();
json.updateString('order.external_order_identifier', 'ABC-100');
json.updateString('order.ordered_at', '2014-01-16 14:37:56 -0600');
json.updateString('order.order_status', 'awaiting_shipment');
json.updateString('order.subtotal_including_tax', '10.00');
json.updateString('order.total_including_tax', '10.00');
json.updateString('order.total_excluding_tax', '10.00');
json.updateString('order.discount_amount', '0.00');
json.updateString('order.coupon_discount', '1.00');
json.updateString('order.subtotal_including_tax', '0.00');
json.updateString('order.subtotal_excluding_tax', '0.00');
json.updateString('order.subtotal_excluding_tax', '0.00');
json.updateString('order.subtotal_tax', '0.00');
json.updateString('order.total_tax', '0');
json.updateString('order.base_shipping_cost', '0.00');
json.updateString('order.shipping_cost_including_tax', '0.00');
json.updateString('order.shipping_cost_excluding_tax', '0.00');
json.updateString('order.shipping_cost_tax', '0.00');
json.updateString('order.base_handling_cost', '0.00');
json.updateString('order.handling_cost_excluding_tax', '0.00');
json.updateString('order.handling_cost_including_tax', '0.00');
json.updateString('order.handling_cost_tax', '0.00');
json.updateString('order.base_wrapping_cost', '0.00');
json.updateString('order.wrapping_cost_excluding_tax', '0.00');
json.updateString('order.wrapping_cost_including_tax', '0.00');
json.updateString('order.wrapping_cost_tax', '0.00');
json.updateString('order.notes', 'Please send promptly.');
json.updateString('order.billing_company', 'Acme Inc.');
json.updateString('order.billing_first_name', 'Fred');
json.updateString('order.billing_last_name', 'Jones');
json.updateString('order.billing_address', '1234 Street');
json.updateString('order.billing_address2', 'Suite 100');
json.updateString('order.billing_city', 'Austin');
json.updateString('order.billing_state', 'TX');
json.updateString('order.billing_postal_code', '78701');
json.updateString('order.billing_country', 'USA');
json.updateString('order.billing_phone_number', '512-123-1234');
json.updateString('order.billing_email', 'test@test.com');
json.updateString('order.recipients[0].first_name', 'Colin');
json.updateString('order.recipients[0].last_name', 'Homenick');
json.updateString('order.recipients[0].company', 'Wintheiser-Hickle');
json.updateString('order.recipients[0].email', 'charles.crona@okeefe.org');
json.updateString('order.recipients[0].phone_number', '637-481-6505');
json.updateString('order.recipients[0].residential', 'true');
json.updateString('order.recipients[0].address', '21937 Adelbert Springs');
json.updateString('order.recipients[0].address2', '');
json.updateString('order.recipients[0].province', '');
json.updateString('order.recipients[0].state', 'CT');
json.updateString('order.recipients[0].city', 'Terryfurt');
json.updateString('order.recipients[0].postal_code', '93322');
json.updateString('order.recipients[0].postal_code_plus_4', '1234');
json.updateString('order.recipients[0].country', 'Andorra');
json.updateString('order.recipients[0].shipping_method', 'Ground');
json.updateString('order.recipients[0].base_cost', '10.00');
json.updateString('order.recipients[0].cost_excluding_tax', '10.00');
json.updateString('order.recipients[0].cost_tax', '0.00');
json.updateString('order.recipients[0].base_handling_cost', '0.00');
json.updateString('order.recipients[0].handling_cost_excluding_tax', '0.00');
json.updateString('order.recipients[0].handling_cost_including_tax', '0.00');
json.updateString('order.recipients[0].handling_cost_tax', '0.00');
json.updateString('order.recipients[0].shipping_zone_id', '123');
json.updateString('order.recipients[0].shipping_zone_name', 'XYZ');
json.updateString('order.recipients[0].items_total', '1');
json.updateString('order.recipients[0].items_shipped', '0');
json.updateString('order.recipients[0].line_items[0].item_name', 'Pencil Holder');
json.updateString('order.recipients[0].line_items[0].sku', '9876543');
json.updateString('order.recipients[0].line_items[0].bin_picking_number', '7');
json.updateString('order.recipients[0].line_items[0].unit_price', '1.30');
json.updateString('order.recipients[0].line_items[0].total_excluding_tax', '1.30');
json.updateString('order.recipients[0].line_items[0].weight_in_ounces', '10');
json.updateString('order.recipients[0].line_items[0].product_options.pa_size', 'large');
json.updateString('order.recipients[0].line_items[0].product_options.Colour', 'Blue');
json.updateString('order.recipients[0].line_items[0].quantity', '1');
// Replace these values with your actual apiKey and apiSecret.
// (These are not valid values..)
final storeApiKey = '569dc30d267f2c4d1f85f9920b2bf9f4';
final apiKey = 'f9a7c8ebdfd34beaf260d9b0296c7059';
final apiSecret = 'd3e9f8737d7196b1271a725f89e2156672bc1d900a25e6e0c1364e2f7a20f605';
// Our request will be sent to:
// https://app.shippingeasy.com/api/stores/:store_api_key/orders
// The path part of this request is: /api/stores/:store_api_key/orders
// See https://shippingeasy.readme.io/v1.0/docs/authentication-signing-requests
final sbSigStr = CkStringBuilder();
sbSigStr.append('POST&/api/stores/');
sbSigStr.append(storeApiKey);
sbSigStr.append('/orders&');
sbSigStr.append('api_key=');
sbSigStr.append(apiKey);
sbSigStr.append('&api_timestamp=');
final dt = CkDateTime();
dt.setFromCurrentSystemTime();
sbSigStr.append(dt.getAsUnixTimeStr(false));
sbSigStr.append('&');
json.emitCompact = true;
json.emitSb(sbSigStr);
// Calculate the HMAC-SHA256 of the API Signature String using the API Secret as the HMAC key.
final crypt = CkCrypt2();
crypt.macAlgorithm = 'hmac';
crypt.encodingMode = 'hex';
crypt.setMacKeyString(apiSecret);
crypt.hashAlgorithm = 'sha256';
final sbSignature = CkStringBuilder();
sbSignature.append(crypt.macStringENC(sbSigStr.getAsString()));
sbSignature.toLowercase();
final sbUrl = CkStringBuilder();
sbUrl.append('https://app.shippingeasy.com/api/stores/');
sbUrl.append(storeApiKey);
sbUrl.append('/orders?');
sbUrl.append('api_key=');
sbUrl.append(apiKey);
sbUrl.append('&api_timestamp=');
sbUrl.append(dt.getAsUnixTimeStr(false));
sbUrl.append('&api_signature=');
sbUrl.append(sbSignature.getAsString());
// Send a POST equivalent the following curl request:
// curl -H "Content-Type: application/json" --data @body.json "https://app.shippingeasy.com/api/stores/27aa472e16faa83dd13b7758d31974ed/orders?
// api_key=f9a7c8ebdfd34beaf260d9b0296c7059&
// api_timestamp=1401803554&
// api_signature=c65f43beed46e581939898a78acd10064cfa146845e97885ec02124d7ad648e4"
final http = CkHttp();
http.sessionLogFilename = 'qa_output/shippingEasy.txt';
final url = sbUrl.getAsString();
final resp = CkHttpResponse();
try {
http.httpJson('POST', url, json, 'application/json', resp);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
print('response status code = ${resp.statusCode}');
print('response body:');
print(resp.bodyStr);
}