Objective-C

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. Objective-C

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

BOOL success = NO;

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

CkoHttp *http = [[CkoHttp alloc] init];

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

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/v2/catalog/images";
req.ContentType = @"multipart/form-data";
success = [req AddFileForUpload2: @"file" path: @"/local/path/to/file.jpg" contentType: @"image/jpeg"];

// Make sure to use an object_id for an already-existing catalog item.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"idempotency_key" value: @"528dea59-7bfb-43c1-bd48-4a6bba7dd61f86"];
[json UpdateString: @"object_id" value: @"2PTZYUOFGGDMT75UZLHQAPAC"];
[json UpdateString: @"image.id" value: @"#TEMP_ID"];
[json UpdateString: @"image.type" value: @"IMAGE"];
[json UpdateString: @"image.image_data.caption" value: @"A picture of a cup of coffee"];

[req AddParam: @"request" value: [json Emit]];

[req AddHeader: @"Expect" value: @"100-continue"];
[req AddHeader: @"Authorization" value: @"Bearer ACCESS_TOKEN"];
[req AddHeader: @"Accept" value: @"application/json"];
[req AddHeader: @"Square-Version" value: @"2020-07-22"];

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpSReq: @"connect.squareupsandbox.com" port: [NSNumber numberWithInt: 443] ssl: YES request: req response: resp];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"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

NSString *imageType = [jResp StringOf: @"image.type"];
NSString *imageId = [jResp StringOf: @"image.id"];
NSString *imageUpdated_at = [jResp StringOf: @"image.updated_at"];
int imageVersion = [[jResp IntOf: @"image.version"] intValue];
BOOL imageIs_deleted = [jResp BoolOf: @"image.is_deleted"];
BOOL imagePresent_at_all_locations = [jResp BoolOf: @"image.present_at_all_locations"];
NSString *imageImage_dataName = [jResp StringOf: @"image.image_data.name"];
NSString *imageImage_dataUrl = [jResp StringOf: @"image.image_data.url"];
NSString *imageImage_dataCaption = [jResp StringOf: @"image.image_data.caption"];