(Swift 3,4,5...) Square API - Batch Retrieve Catalog Objects

Returns a set of objects based on the provided ID.

For more information, see https://developer.squareup.com/reference/square/catalog-api/batch-retrieve-catalog-objects

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    let http = CkoHttp()!
    var success: Bool

    // Implements the following CURL command:

    // curl https://connect.squareup.com/v2/catalog/batch-retrieve \
    //   -X POST \
    //   -H 'Square-Version: 2020-07-22' \
    //   -H 'Authorization: Bearer ACCESS_TOKEN' \
    //   -H 'Content-Type: application/json' \
    //   -d '{
    //     "object_ids": [
    //       "W62UWFY35CWMYGVWK6TWJDNI",
    //       "AA27W3M2GGTF3H6AVPNB77CK"
    //     ],
    //     "include_related_objects": true
    //   }'

    // Use the following online tool to generate HTTP code from a CURL command
    // Convert a cURL Command to HTTP Source Code

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

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

    // {
    //   "object_ids": [
    //     "W62UWFY35CWMYGVWK6TWJDNI",
    //     "AA27W3M2GGTF3H6AVPNB77CK"
    //   ],
    //   "include_related_objects": true
    // }

    let json = CkoJsonObject()!
    var i: Int = 0
    json.i = i
    json.update("object_ids[i]", value: "W62UWFY35CWMYGVWK6TWJDNI")
    i = i + 1
    json.i = i
    json.update("object_ids[i]", value: "AA27W3M2GGTF3H6AVPNB77CK")
    json.updateBool("include_related_objects", value: true)

    // Adds the "Authorization: Bearer ACCESS_TOKEN" header.
    http.authToken = "ACCESS_TOKEN"
    http.setRequestHeader("Square-Version", value: "2020-07-22")
    http.setRequestHeader("Content-Type", value: "application/json")

    // This example uses the sandbox: connect.squareupsandbox.com
    // Production should use connect.squareup.com
    var resp: CkoHttpResponse? = http.postJson3("https://connect.squareupsandbox.com/v2/catalog/batch-retrieve", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "objects": [
    //     {
    //       "type": "ITEM",
    //       "id": "W62UWFY35CWMYGVWK6TWJDNI",
    //       "updated_at": "2016-11-16T22:25:24.878Z",
    //       "version": 1479335124878,
    //       "is_deleted": false,
    //       "present_at_all_locations": true,
    //       "item_data": {
    //         "name": "Tea",
    //         "description": "Hot Leaf Juice",
    //         "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
    //         "tax_ids": [
    //           "HURXQOOAIC4IZSI2BEXQRYFY"
    //         ],
    //         "variations": [
    //           {
    //             "type": "ITEM_VARIATION",
    //             "id": "2TZFAOHWGG7PAK2QEXWYPZSP",
    //             "updated_at": "2016-11-16T22:25:24.878Z",
    //             "version": 1479335124878,
    //             "is_deleted": false,
    //             "present_at_all_locations": true,
    //             "item_variation_data": {
    //               "item_id": "W62UWFY35CWMYGVWK6TWJDNI",
    //               "name": "Mug",
    //               "ordinal": 0,
    //               "pricing_type": "FIXED_PRICING",
    //               "price_money": {
    //                 "amount": 150,
    //                 "currency": "USD"
    //               }
    //             }
    //           }
    //         ]
    //       }
    //     },
    //     {
    //       "type": "ITEM",
    //       "id": "AA27W3M2GGTF3H6AVPNB77CK",
    //       "updated_at": "2016-11-16T22:25:24.878Z",
    //       "version": 1479335124878,
    //       "is_deleted": false,
    //       "present_at_all_locations": true,
    //       "item_data": {
    //         "name": "Coffee",
    //         "description": "Hot Bean Juice",
    //         "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
    //         "tax_ids": [
    //           "HURXQOOAIC4IZSI2BEXQRYFY"
    //         ],
    //         "variations": [
    //           {
    //             "type": "ITEM_VARIATION",
    //             "id": "LBTYIHNHU52WOIHWT7SNRIYH",
    //             "updated_at": "2016-11-16T22:25:24.878Z",
    //             "version": 1479335124878,
    //             "is_deleted": false,
    //             "present_at_all_locations": true,
    //             "item_variation_data": {
    //               "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
    //               "name": "Regular",
    //               "ordinal": 0,
    //               "pricing_type": "FIXED_PRICING",
    //               "price_money": {
    //                 "amount": 250,
    //                 "currency": "USD"
    //               }
    //             }
    //           },
    //           {
    //             "type": "ITEM_VARIATION",
    //             "id": "PKYIC7HGGKW5CYVSCVDEIMHY",
    //             "updated_at": "2016-11-16T22:25:24.878Z",
    //             "version": 1479335124878,
    //             "is_deleted": false,
    //             "present_at_all_locations": true,
    //             "item_variation_data": {
    //               "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
    //               "name": "Large",
    //               "ordinal": 1,
    //               "pricing_type": "FIXED_PRICING",
    //               "price_money": {
    //                 "amount": 350,
    //                 "currency": "USD"
    //               }
    //             }
    //           }
    //         ]
    //       }
    //     }
    //   ],
    //   "related_objects": [
    //     {
    //       "type": "CATEGORY",
    //       "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
    //       "updated_at": "2016-11-16T22:25:24.878Z",
    //       "version": 1479335124878,
    //       "is_deleted": false,
    //       "present_at_all_locations": true,
    //       "category_data": {
    //         "name": "Beverages"
    //       }
    //     },
    //     {
    //       "type": "TAX",
    //       "id": "HURXQOOAIC4IZSI2BEXQRYFY",
    //       "updated_at": "2016-11-16T22:25:24.878Z",
    //       "version": 1479335124878,
    //       "is_deleted": false,
    //       "present_at_all_locations": true,
    //       "tax_data": {
    //         "name": "Sales Tax",
    //         "calculation_phase": "TAX_SUBTOTAL_PHASE",
    //         "inclusion_type": "ADDITIVE",
    //         "percentage": "5.0",
    //         "enabled": true
    //       }
    //     }
    //   ]
    // }

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

    var v_type: String?
    var id: String?
    var updated_at: String?
    var version: Int
    var is_deleted: Bool
    var present_at_all_locations: Bool
    var item_dataName: String?
    var item_dataDescription: String?
    var item_dataCategory_id: String?
    var j: Int
    var count_j: Int
    var strVal: String?
    var item_variation_dataItem_id: String?
    var item_variation_dataName: String?
    var item_variation_dataOrdinal: Int
    var item_variation_dataPricing_type: String?
    var item_variation_dataPrice_moneyAmount: Int
    var item_variation_dataPrice_moneyCurrency: String?
    var category_dataName: String?
    var tax_dataName: String?
    var tax_dataCalculation_phase: String?
    var tax_dataInclusion_type: String?
    var tax_dataPercentage: String?
    var tax_dataEnabled: Bool

    i = 0
    var count_i: Int = jResp.size(ofArray: "objects").intValue
    while i < count_i {
        jResp.i = i
        v_type = jResp.string(of: "objects[i].type")
        id = jResp.string(of: "objects[i].id")
        updated_at = jResp.string(of: "objects[i].updated_at")
        version = jResp.int(of: "objects[i].version").intValue
        is_deleted = jResp.bool(of: "objects[i].is_deleted")
        present_at_all_locations = jResp.bool(of: "objects[i].present_at_all_locations")
        item_dataName = jResp.string(of: "objects[i].item_data.name")
        item_dataDescription = jResp.string(of: "objects[i].item_data.description")
        item_dataCategory_id = jResp.string(of: "objects[i].item_data.category_id")
        j = 0
        count_j = jResp.size(ofArray: "objects[i].item_data.tax_ids").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "objects[i].item_data.tax_ids[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "objects[i].item_data.variations").intValue
        while j < count_j {
            jResp.j = j
            v_type = jResp.string(of: "objects[i].item_data.variations[j].type")
            id = jResp.string(of: "objects[i].item_data.variations[j].id")
            updated_at = jResp.string(of: "objects[i].item_data.variations[j].updated_at")
            version = jResp.int(of: "objects[i].item_data.variations[j].version").intValue
            is_deleted = jResp.bool(of: "objects[i].item_data.variations[j].is_deleted")
            present_at_all_locations = jResp.bool(of: "objects[i].item_data.variations[j].present_at_all_locations")
            item_variation_dataItem_id = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.item_id")
            item_variation_dataName = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.name")
            item_variation_dataOrdinal = jResp.int(of: "objects[i].item_data.variations[j].item_variation_data.ordinal").intValue
            item_variation_dataPricing_type = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.pricing_type")
            item_variation_dataPrice_moneyAmount = jResp.int(of: "objects[i].item_data.variations[j].item_variation_data.price_money.amount").intValue
            item_variation_dataPrice_moneyCurrency = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.price_money.currency")
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "related_objects").intValue
    while i < count_i {
        jResp.i = i
        v_type = jResp.string(of: "related_objects[i].type")
        id = jResp.string(of: "related_objects[i].id")
        updated_at = jResp.string(of: "related_objects[i].updated_at")
        version = jResp.int(of: "related_objects[i].version").intValue
        is_deleted = jResp.bool(of: "related_objects[i].is_deleted")
        present_at_all_locations = jResp.bool(of: "related_objects[i].present_at_all_locations")
        category_dataName = jResp.string(of: "related_objects[i].category_data.name")
        tax_dataName = jResp.string(of: "related_objects[i].tax_data.name")
        tax_dataCalculation_phase = jResp.string(of: "related_objects[i].tax_data.calculation_phase")
        tax_dataInclusion_type = jResp.string(of: "related_objects[i].tax_data.inclusion_type")
        tax_dataPercentage = jResp.string(of: "related_objects[i].tax_data.percentage")
        tax_dataEnabled = jResp.bool(of: "related_objects[i].tax_data.enabled")
        i = i + 1
    }


}