PureBasic

Upsert Catalog Object

See more Square Examples

Creates or updates the target CatalogObject. PureBasic

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/object \
    ;   -X POST \
    ;   -H 'Square-Version: 2020-07-22' \
    ;   -H 'Authorization: Bearer ACCESS_TOKEN' \
    ;   -H 'Content-Type: application/json' \
    ;   -d '{
    ;     "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
    ;     "object": {
    ;       "type": "ITEM",
    ;       "id": "#Cocoa",
    ;       "item_data": {
    ;         "name": "Cocoa",
    ;         "description": "Hot chocolate",
    ;         "abbreviation": "Ch"
    ;       }
    ;     }
    ;   }'

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

    ; {
    ;   "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
    ;   "object": {
    ;     "type": "ITEM",
    ;     "id": "#Cocoa",
    ;     "item_data": {
    ;       "name": "Cocoa",
    ;       "description": "Hot chocolate",
    ;       "abbreviation": "Ch"
    ;     }
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"idempotency_key","af3d1afc-7212-4300-b463-0bfc5314a5ae")
    CkJsonObject::ckUpdateString(json,"object.type","ITEM")
    CkJsonObject::ckUpdateString(json,"object.id","#Cocoa")
    CkJsonObject::ckUpdateString(json,"object.item_data.name","Cocoa")
    CkJsonObject::ckUpdateString(json,"object.item_data.description","Hot chocolate")
    CkJsonObject::ckUpdateString(json,"object.item_data.abbreviation","Ch")

    ; 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/object",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)

    ; {
    ;   "catalog_object": {
    ;     "type": "ITEM",
    ;     "id": "7SB3ZQYJ5GDMVFL7JK46JCHT",
    ;     "updated_at": "2016-11-16T22:32:42.996Z",
    ;     "version": 1479335562996,
    ;     "is_deleted": false,
    ;     "item_data": {
    ;       "name": "Cocoa",
    ;       "description": "Hot chocolate",
    ;       "abbreviation": "Ch"
    ;     }
    ;   },
    ;   "id_mappings": [
    ;     {
    ;       "client_object_id": "#Cocoa",
    ;       "object_id": "7SB3ZQYJ5GDMVFL7JK46JCHT"
    ;     }
    ;   ]
    ; }

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

    client_object_id.s
    object_id.s

    catalog_objectType.s = CkJsonObject::ckStringOf(jResp,"catalog_object.type")
    catalog_objectId.s = CkJsonObject::ckStringOf(jResp,"catalog_object.id")
    catalog_objectUpdated_at.s = CkJsonObject::ckStringOf(jResp,"catalog_object.updated_at")
    catalog_objectVersion.i = CkJsonObject::ckIntOf(jResp,"catalog_object.version")
    catalog_objectIs_deleted.i = CkJsonObject::ckBoolOf(jResp,"catalog_object.is_deleted")
    catalog_objectItem_dataName.s = CkJsonObject::ckStringOf(jResp,"catalog_object.item_data.name")
    catalog_objectItem_dataDescription.s = CkJsonObject::ckStringOf(jResp,"catalog_object.item_data.description")
    catalog_objectItem_dataAbbreviation.s = CkJsonObject::ckStringOf(jResp,"catalog_object.item_data.abbreviation")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"id_mappings")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        client_object_id = CkJsonObject::ckStringOf(jResp,"id_mappings[i].client_object_id")
        object_id = CkJsonObject::ckStringOf(jResp,"id_mappings[i].object_id")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkHttpResponse::ckDispose(resp)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure