(PureBasic) Amazon Pay - Create Delivery Tracker

See more Amazon Pay Examples

Create a Delivery Tracker once an order has been shipped and a tracking code has been generated.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/delivery-tracker.html#button_widget_other

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPrivateKey.pb"

Procedure ChilkatExample()

    ; 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

    success.i

    ; Implements the following POST:

    ; POST /:version/deliveryTrackers HTTP/1.1
    ; Host: pay-api.amazon.com
    ; Accept: application/json
    ; Authorization: AMZN-PAY-RSASSA-PSS PublicKeyId=f4fc06fc-c5a7-11e7-abc4-cec278b6b50a, SignedHeaders=content-type;x-amz-pay-date, Signature=4164128ec5d1b9da1700167ab2ccda8125f472c8bb9de447cebf5d741ee317c8       
    ; X-Amz-Pay-Date: 20190305T024410Z
    ; Content-type: application/json
    ; 
    ; {
    ;     "amazonOrderReferenceId" : "P00-0000000-0000000",
    ;     "deliveryDetails" : [{
    ;     "trackingNumber" : "1Z999AA10123456784",
    ;     "carrierCode" : "UPS"
    ;   }]
    ; }

    ; Use the following online tool to generate HTTP code from a CURL command
    ; Convert a Raw HTTP Request to 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.

    ; {
    ;     "amazonOrderReferenceId" : "P00-0000000-0000000",
    ;     "deliveryDetails" : [{
    ;     "trackingNumber" : "1Z999AA10123456784",
    ;     "carrierCode" : "UPS"
    ;   }]
    ; }

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

    CkJsonObject::ckUpdateString(json,"amazonOrderReferenceId","P00-0000000-0000000")
    CkJsonObject::ckUpdateString(json,"deliveryDetails[0].trackingNumber","1Z999AA10123456784")
    CkJsonObject::ckUpdateString(json,"deliveryDetails[0].carrierCode","UPS")

    ; Load your Amazon Pay private key.  
    ; There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
    ; or from in-memory strings or bytes.
    privKey.i = CkPrivateKey::ckCreate()
    If privKey.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkPrivateKey::ckLoadPemFile(privKey,"C:/someDir/myAmazonPayPrivateKey.pem")
    If success = 0
        Debug CkPrivateKey::ckLastErrorText(privKey)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkPrivateKey::ckDispose(privKey)
        ProcedureReturn
    EndIf

    ; Provide your Amazon Pay private key and Public Key ID 
    ; Use your public key ID here.  It must be the one associated with the private key.
    ; Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
    publicKeyId.s = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
    success = CkHttp::ckSetAuthPrivateKey(http,publicKeyId,privKey)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkPrivateKey::ckDispose(privKey)
        ProcedureReturn
    EndIf

    ; Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
    ; and will also sign the request.  Nothing more is needed.
    ; Chilkat automatically generates and adds the following headers:
    ; 
    ; x-amz-pay-date
    ; x-amz-pay-host
    ; x-amz-pay-region
    ; x-amz-pay-idempotency-key
    ; Authorization

    CkHttp::setCkAccept(http, "application/json")

    ; To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
    ; Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
    resp.i = CkHttp::ckPostJson3(http,"https://pay-api.amazon.eu/sandbox/v2/deliveryTrackers","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkPrivateKey::ckDispose(privKey)
        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)

    ; If the status code is not equal to 200, this will display error information.
    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode <> 200
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkPrivateKey::ckDispose(privKey)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;     "amazonOrderReferenceId": "P00-0000000-0000000",
    ;     "deliveryDetails": [{
    ;         "trackingNumber": "1Z999AA10123456784",
    ;         "carrierCode": "UPS"
    ;     }]
    ; }

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

    trackingNumber.s
    carrierCode.s

    amazonOrderReferenceId.s = CkJsonObject::ckStringOf(jResp,"amazonOrderReferenceId")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"deliveryDetails")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        trackingNumber = CkJsonObject::ckStringOf(jResp,"deliveryDetails[i].trackingNumber")
        carrierCode = CkJsonObject::ckStringOf(jResp,"deliveryDetails[i].carrierCode")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkPrivateKey::ckDispose(privKey)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure