Chilkat Online Tools

DataFlex / ShipEngine Walkthrough / Create a return label

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    Integer iValue
    String sUnit
    String sDimensionsUnit
    Integer iLength
    Integer iWidth
    Integer iHeight
    String sInsured_valueCurrency
    Integer iInsured_valueAmount
    String sReference1
    String sReference2
    String sReference3
    String sExternal_package_id
    String sLabel_id
    String sStatus
    String sShipment_id
    String sShip_date
    String sCreated_at
    String sV_Currency
    String sAmount
    String sInsurance_costCurrency
    Integer iInsurance_costAmount
    String sTracking_number
    Boolean iIs_return_label
    String sRma_number
    Boolean iIs_international
    String sBatch_id
    String sCarrier_id
    String sService_code
    String sPackage_code
    Boolean iVoided
    String sVoided_at
    String sLabel_format
    String sLabel_layout
    Boolean iTrackable
    String sCarrier_code
    String sTracking_status
    String sV_Pdf
    String sPng
    String sZpl
    String sHref
    String sForm_download
    String sInsurance_claim
    Integer i
    Integer iCount_i
    String sTemp1
    Boolean bTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "is_return_label": true,
    //   "rma_number": "123456789",
    //   "shipment": {
    //     "service_code": "usps_priority_mail",
    //     "ship_from": {
    //       "name": "Amanda Miller",
    //       "address_line1": "525 S Winchester Blvd",
    //       "city_locality": "San Jose",
    //       "state_province": "CA",
    //       "postal_code": "95128",
    //       "country_code": "US"
    //     },
    //     "ship_to": {
    //       "company_name": "Example Corp.",
    //       "address_line1": "4009 Marathon Blvd",
    //       "city_locality": "Austin",
    //       "state_province": "TX",
    //       "postal_code": "78756",
    //       "country_code": "US",
    //       "phone": "512-555-5555"
    //     },
    //     "packages": [
    //       {
    //         "weight": {
    //           "value": 17,
    //           "unit": "pound"
    //         },
    //         "dimensions": {
    //           "length": 36,
    //           "width": 12,
    //           "height": 24,
    //           "unit": "inch"
    //         }
    //       }
    //     ]
    //   }
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateBool Of hoJson "is_return_label" True To iSuccess
    Get ComUpdateString Of hoJson "rma_number" "123456789" To iSuccess
    Get ComUpdateString Of hoJson "shipment.service_code" "usps_priority_mail" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_from.name" "Amanda Miller" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_from.address_line1" "525 S Winchester Blvd" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_from.city_locality" "San Jose" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_from.state_province" "CA" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_from.postal_code" "95128" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_from.country_code" "US" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_to.company_name" "Example Corp." To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_to.address_line1" "4009 Marathon Blvd" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_to.city_locality" "Austin" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_to.state_province" "TX" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_to.postal_code" "78756" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_to.country_code" "US" To iSuccess
    Get ComUpdateString Of hoJson "shipment.ship_to.phone" "512-555-5555" To iSuccess
    Get ComUpdateInt Of hoJson "shipment.packages[0].weight.value" 17 To iSuccess
    Get ComUpdateString Of hoJson "shipment.packages[0].weight.unit" "pound" To iSuccess
    Get ComUpdateInt Of hoJson "shipment.packages[0].dimensions.length" 36 To iSuccess
    Get ComUpdateInt Of hoJson "shipment.packages[0].dimensions.width" 12 To iSuccess
    Get ComUpdateInt Of hoJson "shipment.packages[0].dimensions.height" 24 To iSuccess
    Get ComUpdateString Of hoJson "shipment.packages[0].dimensions.unit" "inch" To iSuccess

    Send ComSetRequestHeader To hoHttp "API-Key" "{{API_KEY}}"
    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://api.shipengine.com/v1/labels" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "label_id": "se-1382827",
    //   "status": "completed",
    //   "shipment_id": "se-4151872",
    //   "ship_date": "2019-09-18T00:00:00Z",
    //   "created_at": "2019-09-18T13:55:37.0247767Z",
    //   "shipment_cost": {
    //     "currency": "usd",
    //     "amount": 98.14
    //   },
    //   "insurance_cost": {
    //     "currency": "usd",
    //     "amount": 0
    //   },
    //   "tracking_number": "9405511899564298878259",
    //   "is_return_label": true,
    //   "rma_number": "123456789",
    //   "is_international": false,
    //   "batch_id": "",
    //   "carrier_id": "se-121861",
    //   "service_code": "usps_priority_mail",
    //   "package_code": "package",
    //   "voided": false,
    //   "voided_at": null,
    //   "label_format": "pdf",
    //   "label_layout": "4x6",
    //   "trackable": true,
    //   "carrier_code": "stamps_com",
    //   "tracking_status": "in_transit",
    //   "label_download": {
    //     "pdf": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf",
    //     "png": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.png",
    //     "zpl": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.zpl",
    //     "href": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf"
    //   },
    //   "form_download": null,
    //   "insurance_claim": null,
    //   "packages": [
    //     {
    //       "package_code": "package",
    //       "weight": {
    //         "value": 17,
    //         "unit": "pound"
    //       },
    //       "dimensions": {
    //         "unit": "inch",
    //         "length": 36,
    //         "width": 12,
    //         "height": 24
    //       },
    //       "insured_value": {
    //         "currency": "usd",
    //         "amount": 0
    //       },
    //       "tracking_number": "9405511899564298878259",
    //       "label_messages": {
    //         "reference1": null,
    //         "reference2": null,
    //         "reference3": null
    //       },
    //       "external_package_id": null
    //     }
    //   ]
    // }

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

    Get ComStringOf Of hoJResp "label_id" To sLabel_id
    Get ComStringOf Of hoJResp "status" To sStatus
    Get ComStringOf Of hoJResp "shipment_id" To sShipment_id
    Get ComStringOf Of hoJResp "ship_date" To sShip_date
    Get ComStringOf Of hoJResp "created_at" To sCreated_at
    Get ComStringOf Of hoJResp "shipment_cost.currency" To sV_Currency
    Get ComStringOf Of hoJResp "shipment_cost.amount" To sAmount
    Get ComStringOf Of hoJResp "insurance_cost.currency" To sInsurance_costCurrency
    Get ComIntOf Of hoJResp "insurance_cost.amount" To iInsurance_costAmount
    Get ComStringOf Of hoJResp "tracking_number" To sTracking_number
    Get ComBoolOf Of hoJResp "is_return_label" To iIs_return_label
    Get ComStringOf Of hoJResp "rma_number" To sRma_number
    Get ComBoolOf Of hoJResp "is_international" To iIs_international
    Get ComStringOf Of hoJResp "batch_id" To sBatch_id
    Get ComStringOf Of hoJResp "carrier_id" To sCarrier_id
    Get ComStringOf Of hoJResp "service_code" To sService_code
    Get ComStringOf Of hoJResp "package_code" To sPackage_code
    Get ComBoolOf Of hoJResp "voided" To iVoided
    Get ComStringOf Of hoJResp "voided_at" To sVoided_at
    Get ComStringOf Of hoJResp "label_format" To sLabel_format
    Get ComStringOf Of hoJResp "label_layout" To sLabel_layout
    Get ComBoolOf Of hoJResp "trackable" To iTrackable
    Get ComStringOf Of hoJResp "carrier_code" To sCarrier_code
    Get ComStringOf Of hoJResp "tracking_status" To sTracking_status
    Get ComStringOf Of hoJResp "label_download.pdf" To sV_Pdf
    Get ComStringOf Of hoJResp "label_download.png" To sPng
    Get ComStringOf Of hoJResp "label_download.zpl" To sZpl
    Get ComStringOf Of hoJResp "label_download.href" To sHref
    Get ComStringOf Of hoJResp "form_download" To sForm_download
    Get ComStringOf Of hoJResp "insurance_claim" To sInsurance_claim
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "packages" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "packages[i].package_code" To sPackage_code
        Get ComIntOf Of hoJResp "packages[i].weight.value" To iValue
        Get ComStringOf Of hoJResp "packages[i].weight.unit" To sUnit
        Get ComStringOf Of hoJResp "packages[i].dimensions.unit" To sDimensionsUnit
        Get ComIntOf Of hoJResp "packages[i].dimensions.length" To iLength
        Get ComIntOf Of hoJResp "packages[i].dimensions.width" To iWidth
        Get ComIntOf Of hoJResp "packages[i].dimensions.height" To iHeight
        Get ComStringOf Of hoJResp "packages[i].insured_value.currency" To sInsured_valueCurrency
        Get ComIntOf Of hoJResp "packages[i].insured_value.amount" To iInsured_valueAmount
        Get ComStringOf Of hoJResp "packages[i].tracking_number" To sTracking_number
        Get ComStringOf Of hoJResp "packages[i].label_messages.reference1" To sReference1
        Get ComStringOf Of hoJResp "packages[i].label_messages.reference2" To sReference2
        Get ComStringOf Of hoJResp "packages[i].label_messages.reference3" To sReference3
        Get ComStringOf Of hoJResp "packages[i].external_package_id" To sExternal_package_id
        Move (i + 1) To i
    Loop



End_Procedure

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '{
	"is_return_label": true,
	"rma_number": "123456789",
	"shipment": {
		"service_code": "usps_priority_mail",
		"ship_from": {
			"name": "Amanda Miller",
			"address_line1": "525 S Winchester Blvd",
			"city_locality": "San Jose",
			"state_province": "CA",
			"postal_code": "95128",
			"country_code": "US"
		},
		"ship_to": {
			"company_name": "Example Corp.",
			"address_line1": "4009 Marathon Blvd",
			"city_locality": "Austin",
			"state_province": "TX",
			"postal_code": "78756",
			"country_code": "US",
			"phone": "512-555-5555"
		},
		"packages": [
			{
				"weight": {
					"value": 17,
					"unit": "pound"
				},
				"dimensions": {
					"length": 36,
					"width": 12,
					"height": 24,
					"unit": "inch"
				}
			}
		]
	}
}'
https://api.shipengine.com/v1/labels

Postman Collection Item JSON

{
  "name": "Create a return label",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"is_return_label\": true,\n\t\"rma_number\": \"123456789\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"ship_to\": {\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/labels",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "labels"
      ]
    },
    "description": "Return labels are created just like outgoing labels, but with an additional `is_return_label` flag. You can also optionally specify an `rma_number` (Return Merchandise Authorization)"
  },
  "response": [
    {
      "name": "Create a return label",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"is_return_label\": true,\n\t\"rma_number\": \"123456789\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"ship_to\": {\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.shipengine.com/v1/labels",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "labels"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 18 Sep 2019 13:55:37 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "1826"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "e876812b-185e-432d-ac30-f65a3ff3b3ef"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"label_id\": \"se-1382827\",\n    \"status\": \"completed\",\n    \"shipment_id\": \"se-4151872\",\n    \"ship_date\": \"2019-09-18T00:00:00Z\",\n    \"created_at\": \"2019-09-18T13:55:37.0247767Z\",\n    \"shipment_cost\": {\n        \"currency\": \"usd\",\n        \"amount\": 98.14\n    },\n    \"insurance_cost\": {\n        \"currency\": \"usd\",\n        \"amount\": 0\n    },\n    \"tracking_number\": \"9405511899564298878259\",\n    \"is_return_label\": true,\n    \"rma_number\": \"123456789\",\n    \"is_international\": false,\n    \"batch_id\": \"\",\n    \"carrier_id\": \"se-121861\",\n    \"service_code\": \"usps_priority_mail\",\n    \"package_code\": \"package\",\n    \"voided\": false,\n    \"voided_at\": null,\n    \"label_format\": \"pdf\",\n    \"label_layout\": \"4x6\",\n    \"trackable\": true,\n    \"carrier_code\": \"stamps_com\",\n    \"tracking_status\": \"in_transit\",\n    \"label_download\": {\n        \"pdf\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf\",\n        \"png\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.png\",\n        \"zpl\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.zpl\",\n        \"href\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf\"\n    },\n    \"form_download\": null,\n    \"insurance_claim\": null,\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            \"tracking_number\": \"9405511899564298878259\",\n            \"label_messages\": {\n                \"reference1\": null,\n                \"reference2\": null,\n                \"reference3\": null\n            },\n            \"external_package_id\": null\n        }\n    ]\n}"
    }
  ]
}