React Native

Square API - Retrieve Catalog Object

See more Square Examples

Returns a single CatalogItem as a CatalogObject based on the provided ID. React Native

import { Http, JsonObject, StringBuilder } from '@chilkat/react-native'

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

  const http = new Http();

  // Implements the following CURL command:

  // curl https://connect.squareup.com/v2/catalog/object/W62UWFY35CWMYGVWK6TWJDNI?include_related_objects=true \
  //   -H 'Square-Version: 2020-07-22' \
  //   -H 'Authorization: Bearer ACCESS_TOKEN' \
  //   -H 'Content-Type: application/json'

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

  // Adds the "Authorization: Bearer ACCESS_TOKEN" header.
  http.authToken = 'ACCESS_TOKEN';
  http.setRequestHeader('Square-Version', '2020-07-22');
  http.setRequestHeader('Content-Type', 'application/json');

  http.setUrlVar('id', '2PTZYUOFGGDMT75UZLHQAPAC');

  // This example uses the sandbox: connect.squareupsandbox.com
  // Production should use connect.squareup.com
  const sbResponseBody = new StringBuilder();
  try {
    await http.quickGetSbAsync('https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true', sbResponseBody);
  } catch {
    console.log(http.lastErrorText);
    return;
  }

  const jResp = new JsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  console.log('Response Body:');
  console.log(jResp.emit());

  const respStatusCode = http.lastStatus;
  console.log(`Response Status Code = ${respStatusCode}`);
  if (respStatusCode >= 400) {
    console.log('Response Header:');
    console.log(http.lastHeader);
    console.log('Failed.');
    return;
  }

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

  // {
  //   "object": {
  //     "type": "ITEM",
  //     "id": "W62UWFY35CWMYGVWK6TWJDNI",
  //     "updated_at": "2016-11-16T22:25:24.878Z",
  //     "version": 1479335124878,
  //     "is_deleted": false,
  //     "present_at_all_locations": true,
  //     "item_data": {
  //       "name": "Tea",
  //       "description": "Hot Leaf Juice",
  //       "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
  //       "tax_ids": [
  //         "HURXQOOAIC4IZSI2BEXQRYFY"
  //       ],
  //       "variations": [
  //         {
  //           "type": "ITEM_VARIATION",
  //           "id": "2TZFAOHWGG7PAK2QEXWYPZSP",
  //           "updated_at": "2016-11-16T22:25:24.878Z",
  //           "version": 1479335124878,
  //           "is_deleted": false,
  //           "present_at_all_locations": true,
  //           "item_variation_data": {
  //             "item_id": "W62UWFY35CWMYGVWK6TWJDNI",
  //             "name": "Mug",
  //             "ordinal": 0,
  //             "pricing_type": "FIXED_PRICING",
  //             "price_money": {
  //               "amount": 150,
  //               "currency": "USD"
  //             }
  //           }
  //         }
  //       ]
  //     }
  //   },
  //   "related_objects": [
  //     {
  //       "type": "CATEGORY",
  //       "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
  //       "updated_at": "2016-11-16T22:25:24.878Z",
  //       "version": 1479335124878,
  //       "is_deleted": false,
  //       "present_at_all_locations": true,
  //       "category_data": {
  //         "name": "Beverages"
  //       }
  //     },
  //     {
  //       "type": "TAX",
  //       "id": "HURXQOOAIC4IZSI2BEXQRYFY",
  //       "updated_at": "2016-11-16T22:25:24.878Z",
  //       "version": 1479335124878,
  //       "is_deleted": false,
  //       "present_at_all_locations": true,
  //       "tax_data": {
  //         "name": "Sales Tax",
  //         "calculation_phase": "TAX_SUBTOTAL_PHASE",
  //         "inclusion_type": "ADDITIVE",
  //         "percentage": "5.0",
  //         "enabled": true
  //       }
  //     }
  //   ]
  // }

  // Sample code for parsing the JSON response...
  // Use the following online tool to generate parsing code from sample JSON:
  // Generate Parsing Code from JSON

  let strVal = '';
  let vType = '';
  let id = '';
  let updatedAt = '';
  let version = 0;
  let itemVariationDataItemId = '';
  let itemVariationDataName = '';
  let itemVariationDataOrdinal = 0;
  let itemVariationDataPricingType = '';
  let itemVariationDataPriceMoneyAmount = 0;
  let itemVariationDataPriceMoneyCurrency = '';
  let categoryDataName = '';
  let taxDataName = '';
  let taxDataCalculationPhase = '';
  let taxDataInclusionType = '';
  let taxDataPercentage = '';

  const objectType = jResp.stringOf('object.type');
  const objectId = jResp.stringOf('object.id');
  const objectUpdatedAt = jResp.stringOf('object.updated_at');
  const objectVersion = jResp.intOf('object.version');
  const objectItemDataName = jResp.stringOf('object.item_data.name');
  const objectItemDataDescription = jResp.stringOf('object.item_data.description');
  const objectItemDataCategoryId = jResp.stringOf('object.item_data.category_id');
  let i = 0;
  let countI = jResp.sizeOfArray('object.item_data.tax_ids');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('object.item_data.tax_ids[i]');
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('object.item_data.variations');
  while (i < countI) {
    jResp.i = i;
    vType = jResp.stringOf('object.item_data.variations[i].type');
    id = jResp.stringOf('object.item_data.variations[i].id');
    updatedAt = jResp.stringOf('object.item_data.variations[i].updated_at');
    version = jResp.intOf('object.item_data.variations[i].version');
    jResp.boolOf('object.item_data.variations[i].is_deleted');
    jResp.boolOf('object.item_data.variations[i].present_at_all_locations');
    itemVariationDataItemId = jResp.stringOf('object.item_data.variations[i].item_variation_data.item_id');
    itemVariationDataName = jResp.stringOf('object.item_data.variations[i].item_variation_data.name');
    itemVariationDataOrdinal = jResp.intOf('object.item_data.variations[i].item_variation_data.ordinal');
    itemVariationDataPricingType = jResp.stringOf('object.item_data.variations[i].item_variation_data.pricing_type');
    itemVariationDataPriceMoneyAmount = jResp.intOf('object.item_data.variations[i].item_variation_data.price_money.amount');
    itemVariationDataPriceMoneyCurrency = jResp.stringOf('object.item_data.variations[i].item_variation_data.price_money.currency');
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('related_objects');
  while (i < countI) {
    jResp.i = i;
    vType = jResp.stringOf('related_objects[i].type');
    id = jResp.stringOf('related_objects[i].id');
    updatedAt = jResp.stringOf('related_objects[i].updated_at');
    version = jResp.intOf('related_objects[i].version');
    jResp.boolOf('related_objects[i].is_deleted');
    jResp.boolOf('related_objects[i].present_at_all_locations');
    categoryDataName = jResp.stringOf('related_objects[i].category_data.name');
    taxDataName = jResp.stringOf('related_objects[i].tax_data.name');
    taxDataCalculationPhase = jResp.stringOf('related_objects[i].tax_data.calculation_phase');
    taxDataInclusionType = jResp.stringOf('related_objects[i].tax_data.inclusion_type');
    taxDataPercentage = jResp.stringOf('related_objects[i].tax_data.percentage');
    jResp.boolOf('related_objects[i].tax_data.enabled');
    i++;
  }
}