PureBasic
PureBasic
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat PureBasic Downloads
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
success.i = 0
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Implements the following CURL command:
; curl https://connect.squareup.com/v2/catalog/batch-retrieve \
; -X POST \
; -H 'Square-Version: 2020-07-22' \
; -H 'Authorization: Bearer ACCESS_TOKEN' \
; -H 'Content-Type: application/json' \
; -d '{
; "object_ids": [
; "W62UWFY35CWMYGVWK6TWJDNI",
; "AA27W3M2GGTF3H6AVPNB77CK"
; ],
; "include_related_objects": true
; }'
; Use the following online tool to generate HTTP code from a CURL command
; Convert a cURL Command to HTTP Source Code
; Use this online tool to generate code from sample JSON:
; Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "object_ids": [
; "W62UWFY35CWMYGVWK6TWJDNI",
; "AA27W3M2GGTF3H6AVPNB77CK"
; ],
; "include_related_objects": true
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
i.i = 0
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"object_ids[i]","W62UWFY35CWMYGVWK6TWJDNI")
i = i + 1
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"object_ids[i]","AA27W3M2GGTF3H6AVPNB77CK")
CkJsonObject::ckUpdateBool(json,"include_related_objects",1)
; Adds the "Authorization: Bearer ACCESS_TOKEN" header.
CkHttp::setCkAuthToken(http, "ACCESS_TOKEN")
CkHttp::ckSetRequestHeader(http,"Square-Version","2020-07-22")
; This example uses the sandbox: connect.squareupsandbox.com
; Production should use connect.squareup.com
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://connect.squareupsandbox.com/v2/catalog/batch-retrieve",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "objects": [
; {
; "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"
; }
; }
; }
; ]
; }
; },
; {
; "type": "ITEM",
; "id": "AA27W3M2GGTF3H6AVPNB77CK",
; "updated_at": "2016-11-16T22:25:24.878Z",
; "version": 1479335124878,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_data": {
; "name": "Coffee",
; "description": "Hot Bean Juice",
; "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
; "tax_ids": [
; "HURXQOOAIC4IZSI2BEXQRYFY"
; ],
; "variations": [
; {
; "type": "ITEM_VARIATION",
; "id": "LBTYIHNHU52WOIHWT7SNRIYH",
; "updated_at": "2016-11-16T22:25:24.878Z",
; "version": 1479335124878,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_variation_data": {
; "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
; "name": "Regular",
; "ordinal": 0,
; "pricing_type": "FIXED_PRICING",
; "price_money": {
; "amount": 250,
; "currency": "USD"
; }
; }
; },
; {
; "type": "ITEM_VARIATION",
; "id": "PKYIC7HGGKW5CYVSCVDEIMHY",
; "updated_at": "2016-11-16T22:25:24.878Z",
; "version": 1479335124878,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_variation_data": {
; "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
; "name": "Large",
; "ordinal": 1,
; "pricing_type": "FIXED_PRICING",
; "price_money": {
; "amount": 350,
; "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
v_type.s
id.s
updated_at.s
version.i
is_deleted.i
present_at_all_locations.i
item_dataName.s
item_dataDescription.s
item_dataCategory_id.s
j.i
count_j.i
strVal.s
item_variation_dataItem_id.s
item_variation_dataName.s
item_variation_dataOrdinal.i
item_variation_dataPricing_type.s
item_variation_dataPrice_moneyAmount.i
item_variation_dataPrice_moneyCurrency.s
category_dataName.s
tax_dataName.s
tax_dataCalculation_phase.s
tax_dataInclusion_type.s
tax_dataPercentage.s
tax_dataEnabled.i
i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"objects")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_type = CkJsonObject::ckStringOf(jResp,"objects[i].type")
id = CkJsonObject::ckStringOf(jResp,"objects[i].id")
updated_at = CkJsonObject::ckStringOf(jResp,"objects[i].updated_at")
version = CkJsonObject::ckIntOf(jResp,"objects[i].version")
is_deleted = CkJsonObject::ckBoolOf(jResp,"objects[i].is_deleted")
present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"objects[i].present_at_all_locations")
item_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.name")
item_dataDescription = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.description")
item_dataCategory_id = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.category_id")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"objects[i].item_data.tax_ids")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.tax_ids[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"objects[i].item_data.variations")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
v_type = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].type")
id = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].id")
updated_at = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].updated_at")
version = CkJsonObject::ckIntOf(jResp,"objects[i].item_data.variations[j].version")
is_deleted = CkJsonObject::ckBoolOf(jResp,"objects[i].item_data.variations[j].is_deleted")
present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"objects[i].item_data.variations[j].present_at_all_locations")
item_variation_dataItem_id = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.item_id")
item_variation_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.name")
item_variation_dataOrdinal = CkJsonObject::ckIntOf(jResp,"objects[i].item_data.variations[j].item_variation_data.ordinal")
item_variation_dataPricing_type = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.pricing_type")
item_variation_dataPrice_moneyAmount = CkJsonObject::ckIntOf(jResp,"objects[i].item_data.variations[j].item_variation_data.price_money.amount")
item_variation_dataPrice_moneyCurrency = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.price_money.currency")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"related_objects")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_type = CkJsonObject::ckStringOf(jResp,"related_objects[i].type")
id = CkJsonObject::ckStringOf(jResp,"related_objects[i].id")
updated_at = CkJsonObject::ckStringOf(jResp,"related_objects[i].updated_at")
version = CkJsonObject::ckIntOf(jResp,"related_objects[i].version")
is_deleted = CkJsonObject::ckBoolOf(jResp,"related_objects[i].is_deleted")
present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"related_objects[i].present_at_all_locations")
category_dataName = CkJsonObject::ckStringOf(jResp,"related_objects[i].category_data.name")
tax_dataName = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.name")
tax_dataCalculation_phase = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.calculation_phase")
tax_dataInclusion_type = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.inclusion_type")
tax_dataPercentage = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.percentage")
tax_dataEnabled = CkJsonObject::ckBoolOf(jResp,"related_objects[i].tax_data.enabled")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure