Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
[http SetRequestHeader: @"API-Key" value: @"{{API_KEY}}"];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.shipengine.com/v1/carriers/se-963358/options" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "options": [
// {
// "name": "bill_to_account",
// "default_value": "",
// "description": ""
// },
// {
// "name": "bill_to_country_code",
// "default_value": "",
// "description": ""
// },
// {
// "name": "bill_to_party",
// "default_value": "",
// "description": ""
// },
// {
// "name": "bill_to_postal_code",
// "default_value": "",
// "description": ""
// },
// {
// "name": "contains_alcohol",
// "default_value": "false",
// "description": ""
// },
// {
// "name": "delivered_duty_paid",
// "default_value": "false",
// "description": ""
// },
// {
// "name": "dry_ice",
// "default_value": "false",
// "description": ""
// },
// {
// "name": "dry_ice_weight",
// "default_value": "0",
// "description": ""
// },
// {
// "name": "freight_class",
// "default_value": "",
// "description": ""
// },
// {
// "name": "non_machinable",
// "default_value": "false",
// "description": ""
// },
// {
// "name": "saturday_delivery",
// "default_value": "false",
// "description": ""
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *name = 0;
NSString *default_value = 0;
NSString *description = 0;
int i = 0;
int count_i = [[jResp SizeOfArray: @"options"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
name = [jResp StringOf: @"options[i].name"];
default_value = [jResp StringOf: @"options[i].default_value"];
description = [jResp StringOf: @"options[i].description"];
i = i + 1;
}
Curl Command
curl -X GET
-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/carriers/se-963358/options
Postman Collection Item JSON
{
"name": "List a carrier's options",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response.options.length > 0) {",
" const template = `",
" <link rel=\"stylesheet\" href=\"https://cdnjs.cloudflare.com/ajax/libs/meyer-reset/2.0/reset.min.css\">",
" <link rel=\"stylesheet\" href=\"https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css\">",
" ",
" <h1>Carrier Options</h1>",
" <table class=\"table\" style=\"max-width: 600px\">",
" <thead class=\"thead-dark\">",
" <tr>",
" <th>Option</th>",
" <th>Default Value</th>",
" </tr>",
" </thead>",
" <tbody>",
" {{#each options}}",
" <tr>",
" <td>",
" <samp>{{name}}</samp>",
" </td>",
" <td>{{default_value}}</td>",
" </tr>",
" {{/each}}",
" </tbody>",
" </table>",
" `;",
" ",
" pm.visualizer.set(template, response);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{ups}}/options",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{ups}}",
"options"
]
},
"description": "Many carriers support \"advanced options\", such as the ability to ship alcohol, bill to the receiving party, request money on delivery, or many others. This request shows you how to list the options that are supported by a carrier."
},
"response": [
{
"name": "List a carrier's options",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{ups}}/options",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{ups}}",
"options"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 17 Sep 2019 14:56:45 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1174"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "54453653-caa0-4bb3-bcca-c86dd8a44317"
}
],
"cookie": [
],
"body": "{\n \"options\": [\n {\n \"name\": \"bill_to_account\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"bill_to_country_code\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"bill_to_party\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"bill_to_postal_code\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"contains_alcohol\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"delivered_duty_paid\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"dry_ice\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"dry_ice_weight\",\n \"default_value\": \"0\",\n \"description\": \"\"\n },\n {\n \"name\": \"freight_class\",\n \"default_value\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"non_machinable\",\n \"default_value\": \"false\",\n \"description\": \"\"\n },\n {\n \"name\": \"saturday_delivery\",\n \"default_value\": \"false\",\n \"description\": \"\"\n }\n ]\n}"
}
]
}
