Dart

Shippo Create Transaction Object

See more Shippo Examples

Creates a Transaction object that represents a shipping label purchase and is based on the shipping rate. Dart

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/transactions \
  //     -H "Authorization: ShippoToken <API_TOKEN>" \
  //     -d rate="478fb066930e4e3195a3686f7ea5b612"
  //     -d label_file_type="PDF"
  //     -d async=false

  final req = CkHttpRequest();
  req.httpVerb = 'POST';
  req.path = '/transactions';
  req.contentType = 'application/x-www-form-urlencoded';
  req.addParam('rate', '478fb066930e4e3195a3686f7ea5b612');
  req.addParam('label_file_type', 'PDF');
  req.addParam('async', 'false');

  req.addHeader('Authorization', 'ShippoToken <API_TOKEN>');

  final resp = CkHttpResponse();
  try {
    http.httpReq('https://api.goshippo.com/transactions', req, 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)

  // {
  //   "object_state": "VALID",
  //   "status": "SUCCESS",
  //   "object_created": "2019-06-28T18:04:08.679Z",
  //   "object_updated": "2019-06-28T18:04:10.516Z",
  //   "object_id": "6178e155da304f10aa4b4271fdca84fb",
  //   "object_owner": "admin@chilkatsoft.com",
  //   "test": true,
  //   "rate": "dd7556c284e8444294d2ab7099e662d2",
  //   "tracking_number": "92701902416755000000000015",
  //   "tracking_status": "UNKNOWN",
  //   "eta": null,
  //   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92701902416755000000000015",
  //   "label_url": "https://shippo-delivery-east.s3.amazonaws.com/6178e155da304f10aa4b4271fdca84fb.pdf?Signature=1LU0Qf11nQJGei%2FeLZr%2BQ5EwJS4%3D&Expires=1593281050&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
  //   "commercial_invoice_url": null,
  //   "messages": [
  //   ],
  //   "order": null,
  //   "metadata": "",
  //   "parcel": "5af766ff15684a4186b0e3c833348fac",
  //   "billing": {
  //     "payments": [
  //     ]
  //   }
  // }

  // Sample code for parsing the JSON response...
  // Use the following online tool to generate parsing code from sample JSON:
  // Generate Parsing Code from JSON

  final objectState = jResp.stringOf('object_state');
  final status = jResp.stringOf('status');
  final objectCreated = jResp.stringOf('object_created');
  final objectUpdated = jResp.stringOf('object_updated');
  final objectId = jResp.stringOf('object_id');
  final objectOwner = jResp.stringOf('object_owner');
  final rate = jResp.stringOf('rate');
  final trackingNumber = jResp.stringOf('tracking_number');
  final trackingStatus = jResp.stringOf('tracking_status');
  final eta = jResp.stringOf('eta');
  final trackingUrlProvider = jResp.stringOf('tracking_url_provider');
  final labelUrl = jResp.stringOf('label_url');
  final commercialInvoiceUrl = jResp.stringOf('commercial_invoice_url');
  final order = jResp.stringOf('order');
  final metadata = jResp.stringOf('metadata');
  final parcel = jResp.stringOf('parcel');
  var i = 0;
  var countI = jResp.sizeOfArray('messages');
  while (i < countI) {
    jResp.i = i;
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('billing.payments');
  while (i < countI) {
    jResp.i = i;
    i++;
  }
}