Chilkat Online Tools

Delphi (DLL) / ShipEngine Walkthrough / Compare rates for a shipment

Back to Collection Items

var

begin
CkJsonObject_UpdateString(json,'rate_options.carrier_ids[0]','{{stamps_com}}');CkJsonObject_UpdateString(json,'rate_options.carrier_ids[1]','{{fedex}}');CkJsonObject_UpdateString(json,'rate_options.carrier_ids[2]','{{ups}}');CkJsonObject_UpdateString(json,'rate_options.service_codes[0]','usps_priority_mail');CkJsonObject_UpdateString(json,'rate_options.service_codes[1]','fedex_ground');CkJsonObject_UpdateString(json,'rate_options.service_codes[2]','ups_ground');CkJsonObject_UpdateString(json,'shipment_id','{{shipment_id}}');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);rate_id := CkJsonObject__stringOf(jResp,'rate_response.rates[i].rate_id');rate_type := CkJsonObject__stringOf(jResp,'rate_response.rates[i].rate_type');carrier_id := CkJsonObject__stringOf(jResp,'rate_response.rates[i].carrier_id');v_Currency := CkJsonObject__stringOf(jResp,'rate_response.rates[i].shipping_amount.currency');Amount := CkJsonObject__stringOf(jResp,'rate_response.rates[i].shipping_amount.amount');insurance_amountCurrency := CkJsonObject__stringOf(jResp,'rate_response.rates[i].insurance_amount.currency');insurance_amountAmount := CkJsonObject_IntOf(jResp,'rate_response.rates[i].insurance_amount.amount');confirmation_amountCurrency := CkJsonObject__stringOf(jResp,'rate_response.rates[i].confirmation_amount.currency');confirmation_amountAmount := CkJsonObject_IntOf(jResp,'rate_response.rates[i].confirmation_amount.amount');other_amountCurrency := CkJsonObject__stringOf(jResp,'rate_response.rates[i].other_amount.currency');other_amountAmount := CkJsonObject_IntOf(jResp,'rate_response.rates[i].other_amount.amount');zone := CkJsonObject__stringOf(jResp,'rate_response.rates[i].zone');package_type := CkJsonObject__stringOf(jResp,'rate_response.rates[i].package_type');delivery_days := CkJsonObject_IntOf(jResp,'rate_response.rates[i].delivery_days');guaranteed_service := CkJsonObject_BoolOf(jResp,'rate_response.rates[i].guaranteed_service');estimated_delivery_date := CkJsonObject__stringOf(jResp,'rate_response.rates[i].estimated_delivery_date');carrier_delivery_days := CkJsonObject__stringOf(jResp,'rate_response.rates[i].carrier_delivery_days');ship_date := CkJsonObject__stringOf(jResp,'rate_response.rates[i].ship_date');negotiated_rate := CkJsonObject_BoolOf(jResp,'rate_response.rates[i].negotiated_rate');service_type := CkJsonObject__stringOf(jResp,'rate_response.rates[i].service_type');service_code := CkJsonObject__stringOf(jResp,'rate_response.rates[i].service_code');trackable := CkJsonObject_BoolOf(jResp,'rate_response.rates[i].trackable');carrier_code := CkJsonObject__stringOf(jResp,'rate_response.rates[i].carrier_code');carrier_nickname := CkJsonObject__stringOf(jResp,'rate_response.rates[i].carrier_nickname');carrier_friendly_name := CkJsonObject__stringOf(jResp,'rate_response.rates[i].carrier_friendly_name');validation_status := CkJsonObject__stringOf(jResp,'rate_response.rates[i].validation_status');j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'rate_response.rates[i].warning_messages');CkJsonObject_putJ(jResp,j);strVal := CkJsonObject__stringOf(jResp,'rate_response.rates[i].warning_messages[j]');j := j + 1;j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'rate_response.rates[i].error_messages');CkJsonObject_putJ(jResp,j);j := j + 1;i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'rate_response.invalid_rates');CkJsonObject_putI(jResp,i);i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'rate_response.errors');CkJsonObject_putI(jResp,i);i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'tags');CkJsonObject_putI(jResp,i);i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'packages');CkJsonObject_putI(jResp,i);package_code := CkJsonObject__stringOf(jResp,'packages[i].package_code');weightValue := CkJsonObject_IntOf(jResp,'packages[i].weight.value');weightUnit := CkJsonObject__stringOf(jResp,'packages[i].weight.unit');dimensionsUnit := CkJsonObject__stringOf(jResp,'packages[i].dimensions.unit');Length := CkJsonObject_IntOf(jResp,'packages[i].dimensions.length');Width := CkJsonObject_IntOf(jResp,'packages[i].dimensions.width');Height := CkJsonObject_IntOf(jResp,'packages[i].dimensions.height');insured_valueCurrency := CkJsonObject__stringOf(jResp,'packages[i].insured_value.currency');insured_valueAmount := CkJsonObject_IntOf(jResp,'packages[i].insured_value.amount');Reference1 := CkJsonObject__stringOf(jResp,'packages[i].label_messages.reference1');Reference2 := CkJsonObject__stringOf(jResp,'packages[i].label_messages.reference2');Reference3 := CkJsonObject__stringOf(jResp,'packages[i].label_messages.reference3');external_package_id := CkJsonObject__stringOf(jResp,'packages[i].external_package_id');i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'items');CkJsonObject_putI(jResp,i);i := i + 1;


Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '{
	"rate_options": {
		"carrier_ids": [
			"{{stamps_com}}",
			"{{fedex}}",
			"{{ups}}"
		],
		"service_codes": [
			"usps_priority_mail",
			"fedex_ground",
			"ups_ground"
		]
	},
	"shipment_id": "{{shipment_id}}"
}'
https://api.shipengine.com/v1/rates

Postman Collection Item JSON

{
  "name": "Compare rates for a shipment",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let response = pm.response.json();",
          "",
          "if (response.rate_response.rates.length > 0) {",
          "    pm.collectionVariables.set(\"rate_id\", response.rate_response.rates[0].rate_id);",
          "}"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"rate_options\": {\n\t\t\"carrier_ids\": [\n\t\t\t\"{{stamps_com}}\",\n\t\t\t\"{{fedex}}\",\n\t\t\t\"{{ups}}\"\n\t\t],\n\t\t\"service_codes\": [\n\t\t\t\"usps_priority_mail\",\n\t\t\t\"fedex_ground\",\n\t\t\t\"ups_ground\"\n\t\t]\n\t},\n\t\"shipment_id\": \"{{shipment_id}}\"\n}"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/rates",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "rates"
      ]
    },
    "description": "If you've already created a shipment in ShipEngine, then you can easily compare rates using the `shipment_id`."
  },
  "response": [
    {
      "name": "Compare rates for a shipment",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"rate_options\": {\n\t\t\"carrier_ids\": [\n\t\t\t\"{{stamps_com}}\",\n\t\t\t\"{{fedex}}\",\n\t\t\t\"{{ups}}\"\n\t\t],\n\t\t\"service_codes\": [\n\t\t\t\"usps_priority_mail\",\n\t\t\t\"fedex_ground\",\n\t\t\t\"ups_ground\"\n\t\t]\n\t},\n\t\"shipment_id\": \"{{shipment_id}}\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.shipengine.com/v1/rates",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "rates"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 17 Sep 2019 18:33:10 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "13899"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "5824483d-bb0d-4dfd-bb6c-86f657a87119"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"rate_response\": {\n        \"rates\": [\n            {\n                \"rate_id\": \"se-12444425\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121862\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 65.58\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": null,\n                \"package_type\": null,\n                \"delivery_days\": 4,\n                \"guaranteed_service\": true,\n                \"estimated_delivery_date\": \"2019-09-23T23:00:00Z\",\n                \"carrier_delivery_days\": \"Monday 9/23 by 11:00 PM\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"UPS® Ground\",\n                \"service_code\": \"ups_ground\",\n                \"trackable\": true,\n                \"carrier_code\": \"ups\",\n                \"carrier_nickname\": \"ShipEngine Test Account - UPS\",\n                \"carrier_friendly_name\": \"UPS\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444426\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121861\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 98.14\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": 7,\n                \"package_type\": \"package\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-19T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"stamps_com\",\n                \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n                \"carrier_friendly_name\": \"Stamps.com\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444427\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121861\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 12.72\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": 7,\n                \"package_type\": \"medium_flat_rate_box\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-19T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"stamps_com\",\n                \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n                \"carrier_friendly_name\": \"Stamps.com\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444428\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121861\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 6.98\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": 7,\n                \"package_type\": \"small_flat_rate_box\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-19T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"stamps_com\",\n                \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n                \"carrier_friendly_name\": \"Stamps.com\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444429\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121861\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 17.47\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": 7,\n                \"package_type\": \"large_flat_rate_box\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-19T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"stamps_com\",\n                \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n                \"carrier_friendly_name\": \"Stamps.com\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444430\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121861\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 6.48\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": 7,\n                \"package_type\": \"flat_rate_envelope\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-19T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"stamps_com\",\n                \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n                \"carrier_friendly_name\": \"Stamps.com\",\n                \"validation_status\": \"has_warnings\",\n                \"warning_messages\": [\n                    \"Heads up! You've included custom dimensions for a package type with a standardized size. For more accurate rates, consider removing the dimensions for this shipment.\"\n                ],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444431\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121861\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 7.03\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": 7,\n                \"package_type\": \"flat_rate_padded_envelope\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-19T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"stamps_com\",\n                \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n                \"carrier_friendly_name\": \"Stamps.com\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444432\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121861\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 6.78\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"zone\": 7,\n                \"package_type\": \"flat_rate_legal_envelope\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-19T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"stamps_com\",\n                \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n                \"carrier_friendly_name\": \"Stamps.com\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            },\n            {\n                \"rate_id\": \"se-12444433\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-121863\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 58.37\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 4.09\n                },\n                \"zone\": null,\n                \"package_type\": null,\n                \"delivery_days\": 3,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n                \"carrier_delivery_days\": \"3\",\n                \"ship_date\": \"2019-09-17T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"FedEx Ground®\",\n                \"service_code\": \"fedex_ground\",\n                \"trackable\": true,\n                \"carrier_code\": \"fedex\",\n                \"carrier_nickname\": \"ShipEngine Test Account - FedEx\",\n                \"carrier_friendly_name\": \"FedEx\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            }\n        ],\n        \"invalid_rates\": [],\n        \"rate_request_id\": \"se-1426242\",\n        \"shipment_id\": \"se-4134271\",\n        \"created_at\": \"2019-09-17T18:33:10.7692662Z\",\n        \"status\": \"completed\",\n        \"errors\": []\n    },\n    \"shipment_id\": \"se-4134271\",\n    \"carrier_id\": null,\n    \"service_code\": null,\n    \"external_shipment_id\": null,\n    \"ship_date\": \"2019-09-17T00:00:00Z\",\n    \"created_at\": \"2019-09-17T18:31:35.03Z\",\n    \"modified_at\": \"2019-09-17T18:31:35.03Z\",\n    \"shipment_status\": \"pending\",\n    \"ship_to\": {\n        \"name\": \"Amanda Miller\",\n        \"phone\": null,\n        \"company_name\": null,\n        \"address_line1\": \"525 S WINCHESTER BLVD\",\n        \"address_line2\": \"\",\n        \"address_line3\": null,\n        \"city_locality\": \"SAN JOSE\",\n        \"state_province\": \"CA\",\n        \"postal_code\": \"95128-2537\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"no\"\n    },\n    \"ship_from\": {\n        \"name\": \"John Doe\",\n        \"phone\": \"512-555-5555\",\n        \"company_name\": null,\n        \"address_line1\": \"4009 Marathon Blvd\",\n        \"address_line2\": null,\n        \"address_line3\": null,\n        \"city_locality\": \"Austin\",\n        \"state_province\": \"TX\",\n        \"postal_code\": \"78756\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"unknown\"\n    },\n    \"warehouse_id\": null,\n    \"return_to\": {\n        \"name\": \"John Doe\",\n        \"phone\": \"512-555-5555\",\n        \"company_name\": null,\n        \"address_line1\": \"4009 Marathon Blvd\",\n        \"address_line2\": null,\n        \"address_line3\": null,\n        \"city_locality\": \"Austin\",\n        \"state_province\": \"TX\",\n        \"postal_code\": \"78756\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"unknown\"\n    },\n    \"confirmation\": \"none\",\n    \"customs\": null,\n    \"external_order_id\": null,\n    \"order_source_code\": null,\n    \"advanced_options\": {\n        \"bill_to_account\": null,\n        \"bill_to_country_code\": null,\n        \"bill_to_party\": null,\n        \"bill_to_postal_code\": null,\n        \"contains_alcohol\": false,\n        \"delivered_duty_paid\": false,\n        \"non_machinable\": false,\n        \"saturday_delivery\": false,\n        \"dry_ice\": false,\n        \"dry_ice_weight\": null,\n        \"freight_class\": null,\n        \"custom_field1\": null,\n        \"custom_field2\": null,\n        \"custom_field3\": null\n    },\n    \"insurance_provider\": \"none\",\n    \"tags\": [],\n    \"packages\": [\n        {\n            \"package_code\": \"package\",\n            \"weight\": {\n                \"value\": 17,\n                \"unit\": \"pound\"\n            },\n            \"dimensions\": {\n                \"unit\": \"inch\",\n                \"length\": 36,\n                \"width\": 12,\n                \"height\": 24\n            },\n            \"insured_value\": {\n                \"currency\": \"usd\",\n                \"amount\": 0\n            },\n            \"label_messages\": {\n                \"reference1\": null,\n                \"reference2\": null,\n                \"reference3\": null\n            },\n            \"external_package_id\": null\n        }\n    ],\n    \"total_weight\": {\n        \"value\": 17,\n        \"unit\": \"pound\"\n    },\n    \"items\": []\n}"
    }
  ]
}