Dart

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. Dart

import 'package:chilkat/chilkat.dart';

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

  final http = CkHttp();

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

  final req = CkHttpRequest();
  req.httpVerb = 'POST';
  req.path = '/v2/catalog/images';
  req.contentType = '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.
  final json = 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
  final resp = CkHttpResponse();
  try {
    http.httpSReq('connect.squareupsandbox.com', 443, true, req, resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbResponseBody = CkStringBuilder();
  resp.getBodySb(sbResponseBody);
  final jResp = CkJsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  final respStatusCode = resp.statusCode;
  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

  final imageType = jResp.stringOf('image.type');
  final imageId = jResp.stringOf('image.id');
  final imageUpdatedAt = jResp.stringOf('image.updated_at');
  final imageVersion = jResp.intOf('image.version');
  final imageImageDataName = jResp.stringOf('image.image_data.name');
  final imageImageDataUrl = jResp.stringOf('image.image_data.url');
  final imageImageDataCaption = jResp.stringOf('image.image_data.caption');
}