(Java) Square API - Create Catalog Image

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

For more information, see https://developer.squareup.com/reference/square/catalog-api/create-catalog-image

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    // 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

    CkHttpRequest req = new CkHttpRequest();
    req.put_HttpVerb("POST");
    req.put_Path("/v2/catalog/images");
    req.put_ContentType("multipart/form-data");
    success = req.AddFileForUpload2("file","/local/path/to/file.jpg","image/jpeg");

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

    req.AddParam("request",json.emit());

    req.AddHeader("Expect","100-continue");
    req.AddHeader("Authorization","Bearer ACCESS_TOKEN");
    req.AddHeader("Accept","application/json");
    req.AddHeader("Square-Version","2020-07-22");

    // This example uses the sandbox: connect.squareupsandbox.com
    // Production should use connect.squareup.com
    CkHttpResponse resp = http.SynchronousRequest("connect.squareupsandbox.com",443,true,req);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);
    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("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

    String imageType = jResp.stringOf("image.type");
    String imageId = jResp.stringOf("image.id");
    String imageUpdated_at = jResp.stringOf("image.updated_at");
    int imageVersion = jResp.IntOf("image.version");
    boolean imageIs_deleted = jResp.BoolOf("image.is_deleted");
    boolean imagePresent_at_all_locations = jResp.BoolOf("image.present_at_all_locations");
    String imageImage_dataName = jResp.stringOf("image.image_data.name");
    String imageImage_dataUrl = jResp.stringOf("image.image_data.url");
    String imageImage_dataCaption = jResp.stringOf("image.image_data.caption");
  }
}