Swift

Square API - Create Catalog Image

See more Square Examples

Uploads an image file to be represented by an CatalogImage object linked to an existing CatalogObject instance. Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

    // Implements the following CURL command:

    // curl https://connect.squareup.com/v2/catalog/images \
    //   -X POST \
    //   -H 'Square-Version: 2020-07-22' \
    //   -H 'Authorization: Bearer ACCESS_TOKEN' \
    //   -H 'Accept: application/json' \
    //   -F 'file=@/local/path/to/file.jpg' \
    //   -F 'request={
    //     "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
    //     "object_id": "ND6EA5AAJEO5WL3JNNIAQA32",
    //     "image": {
    //       "id": "#TEMP_ID",
    //       "type": "IMAGE",
    //       "image_data": {
    //         "caption": "A picture of a cup of coffee"
    //       }
    //     }
    //   }'

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

    let req = CkoHttpRequest()!
    req.httpVerb = "POST"
    req.path = "/v2/catalog/images"
    req.contentType = "multipart/form-data"
    success = req.addFile(forUpload2: "file", path: "/local/path/to/file.jpg", contentType: "image/jpeg")

    // Make sure to use an object_id for an already-existing catalog item.
    let json = CkoJsonObject()!
    json.updateString(jsonPath: "idempotency_key", value: "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86")
    json.updateString(jsonPath: "object_id", value: "2PTZYUOFGGDMT75UZLHQAPAC")
    json.updateString(jsonPath: "image.id", value: "#TEMP_ID")
    json.updateString(jsonPath: "image.type", value: "IMAGE")
    json.updateString(jsonPath: "image.image_data.caption", value: "A picture of a cup of coffee")

    req.addParam(name: "request", value: json.emit())

    req.addHeader(name: "Expect", value: "100-continue")
    req.addHeader(name: "Authorization", value: "Bearer ACCESS_TOKEN")
    req.addHeader(name: "Accept", value: "application/json")
    req.addHeader(name: "Square-Version", value: "2020-07-22")

    // This example uses the sandbox: connect.squareupsandbox.com
    // Production should use connect.squareup.com
    let resp = CkoHttpResponse()!
    success = http.httpSReq(domain: "connect.squareupsandbox.com", port: 443, ssl: true, request: req, response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp.getBodySb(sb: sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sb: 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.")
        return
    }

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

    // {
    //   "image": {
    //     "type": "IMAGE",
    //     "id": "UBXKMBQ4QK47QXMNQD6ELCZT",
    //     "updated_at": "2020-08-07T15:20:09.779Z",
    //     "version": 1596813609779,
    //     "is_deleted": false,
    //     "present_at_all_locations": true,
    //     "image_data": {
    //       "name": "",
    //       "url": "https://square-catalog-sandbox.s3.amazonaws.com/files/168973eab6f8b39b5cbdad52e3f82b23be196e2b/original.jpeg",
    //       "caption": "A picture of a cup of coffee"
    //     }
    //   }
    // }

    // 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 imageType: String? = jResp.string(of: "image.type")
    var imageId: String? = jResp.string(of: "image.id")
    var imageUpdated_at: String? = jResp.string(of: "image.updated_at")
    var imageVersion: Int = jResp.int(of: "image.version").intValue
    var imageIs_deleted: Bool = jResp.bool(of: "image.is_deleted")
    var imagePresent_at_all_locations: Bool = jResp.bool(of: "image.present_at_all_locations")
    var imageImage_dataName: String? = jResp.string(of: "image.image_data.name")
    var imageImage_dataUrl: String? = jResp.string(of: "image.image_data.url")
    var imageImage_dataCaption: String? = jResp.string(of: "image.image_data.caption")

}