Java

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. Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpRequest;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

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

        Http http = new Http();

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

        HttpRequest req = new HttpRequest();
        req.setHttpVerb("POST");
        req.setPath("/v2/catalog/images");
        req.setContentType("multipart/form-data");
        req.addFileForUpload2("file", "/local/path/to/file.jpg", "image/jpeg");

        // Make sure to use an object_id for an already-existing catalog item.
        JsonObject json = new JsonObject();
        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
        HttpResponse resp = new HttpResponse();
        try {
            http.httpSReq("connect.squareupsandbox.com", 443, true, req, resp);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        StringBuilder sbResponseBody = new StringBuilder();
        resp.getBodySb(sbResponseBody);
        JsonObject jResp = new JsonObject();
        jResp.loadSb(sbResponseBody);
        jResp.setEmitCompact(false);

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

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