(Tcl) Walmart - Send Shipping Notification

Note: This example uses classes, properties, or methods discontinued in Chilkat v11.0.0 or greater.

See Shipping notifications/updates for more information about this call.

Note: This example requires Chilkat v9.5.0.67 or greater.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# ---------------------------------------------------------------------------------------------------------
# Note: This example is deprecated.  The Walmart API no longer uses the Signature method of authenticating.
# Walmart now uses OAuth2.  
# ---------------------------------------------------------------------------------------------------------

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

# Sends the following POST request:
# POST https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping

set sbUrl [new_CkStringBuilder]

set success [CkStringBuilder_Append $sbUrl "https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping"]
set numReplaced [CkStringBuilder_Replace $sbUrl "{purchaseOrderId}" "1111691995111"]

set requestMethod "POST"

# First we need to generate a signature for our request.
# The signature needs to be re-generated for each new Walmart HTTP request.
set authUtil [new_CkAuthUtil]

set wmConsumerId "WALMART_CONSUMER_ID"
set wmPrivateKey "WALMART_PRIVATE_KEY"
set jsonStr [CkAuthUtil_walmartSignature $authUtil [CkStringBuilder_getAsString $sbUrl] $wmConsumerId $wmPrivateKey $requestMethod]
if {[CkAuthUtil_get_LastMethodSuccess $authUtil] != 1} then {
    puts [CkAuthUtil_lastErrorText $authUtil]
    delete_CkStringBuilder $sbUrl
    delete_CkAuthUtil $authUtil
    exit
}

# The JSON returned by WalmartSignature contains the values to be used in the following
# header fields: WM_SEC.AUTH_SIGNATURE, WM_SEC.TIMESTAMP, and WM_QOS.CORRELATION_ID
set json [new_CkJsonObject]

CkJsonObject_Load $json $jsonStr

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "WM_SVC.NAME" "Walmart Marketplace"
CkHttp_SetRequestHeader $http "WM_QOS.CORRELATION_ID" [CkJsonObject_stringOf $json "correlation_id"]
CkHttp_SetRequestHeader $http "WM_SEC.TIMESTAMP" [CkJsonObject_stringOf $json "timestamp"]
CkHttp_SetRequestHeader $http "WM_SEC.AUTH_SIGNATURE" [CkJsonObject_stringOf $json "signature"]
CkHttp_SetRequestHeader $http "WM_CONSUMER.ID" $wmConsumerId
CkHttp_SetRequestHeader $http "WM_CONSUMER.CHANNEL.TYPE" "WALMART_CHANNEL_TYPE"
CkHttp_put_Accept $http "application/xml"

# Note: Do not explicitly set the "Host" header.  Chilkat will set it automatically.

# The body of the POST request will be XML that looks something like this:

# 	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
# 	<ns2:orderShipment
# 	    xmlns:ns2="http://walmart.com/mp/v3/orders"
# 	    xmlns:ns3="http://walmart.com/">
# 	    <ns2:orderLines>
# 	        <ns2:orderLine>
# 	            <ns2:lineNumber>2</ns2:lineNumber>
# 	            <ns2:orderLineStatuses>
# 	                <ns2:orderLineStatus>
# 	                    <ns2:status>Shipped</ns2:status>
# 	                    <ns2:statusQuantity>
# 	                        <ns2:unitOfMeasurement>Each</ns2:unitOfMeasurement>
# 	                        <ns2:amount>1</ns2:amount>
# 	                    </ns2:statusQuantity>
# 	                    <ns2:trackingInfo>
# 	                        <ns2:shipDateTime>2016-06-27T05:30:15.000Z</ns2:shipDateTime>
# 	                        <ns2:carrierName>
# 	                            <ns2:carrier>FedEx</ns2:carrier>
# 	                        </ns2:carrierName>
# 	                        <ns2:methodCode>Standard</ns2:methodCode>
# 	                        <ns2:trackingNumber>12333634122</ns2:trackingNumber>
# 	                    </ns2:trackingInfo>
# 	                </ns2:orderLineStatus>
# 	            </ns2:orderLineStatuses>
# 	        </ns2:orderLine>
# 	    </ns2:orderLines>
# 	</ns2:orderShipment>

# Build the XML request body:
set lineNumber 1
set shippingStatus "Shipped"
set quantity 1
set carrier "USPS"
set shippingMethod "Standard"
set trackingNumber "9999869903501929298999"

set dtNow [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dtNow
set shipDateTime [CkDateTime_getAsTimestamp $dtNow 0]

set xmlBody [new_CkXml]

CkXml_put_Tag $xmlBody "ns2:orderShipment"
CkXml_AddAttribute $xmlBody "xmlns:ns2" "http://walmart.com/mp/v3/orders"
CkXml_AddAttribute $xmlBody "xmlns:ns3" "http://walmart.com/"
CkXml_UpdateChildContentInt $xmlBody "ns2:orderLines|ns2:orderLine|ns2:lineNumber" $lineNumber

# orderLine is a CkXml
set orderLine [CkXml_GetChildWithTag $xmlBody "ns2:orderLines|ns2:orderLine"]
CkXml_UpdateChildContent $orderLine "ns2:orderLineStatuses|ns2:orderLineStatus|ns2:status" $shippingStatus
delete_CkXml $orderLine

# orderLineStatus is a CkXml
set orderLineStatus [CkXml_GetChildWithTag $orderLine "ns2:orderLineStatuses|ns2:orderLineStatus"]
CkXml_UpdateChildContent $orderLineStatus "ns2:statusQuantity|ns2:unitOfMeasurement" "Each"
CkXml_UpdateChildContentInt $orderLineStatus "ns2:statusQuantity|ns2:amount" $quantity
CkXml_UpdateChildContent $orderLineStatus "ns2:trackingInfo|ns2:shipDateTime" $shipDateTime
CkXml_UpdateChildContent $orderLineStatus "ns2:trackingInfo|ns2:carrierName|ns2:carrier" $carrier
CkXml_UpdateChildContent $orderLineStatus "ns2:trackingInfo|ns2:methodCode" $shippingMethod
CkXml_UpdateChildContent $orderLineStatus "ns2:trackingInfo|ns2:trackingNumber" $trackingNumber
delete_CkXml $orderLineStatus

puts "POST request body:"
puts [CkXml_getXml $xmlBody]
puts "--"

# This is a simple POST that can be sent w/ the PostXml method.
# Explicitly set the Content-Type header, otherwise "text/xml" will be used.
CkHttp_SetRequestHeader $http "Content-Type" "application/xml"
# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http [CkStringBuilder_getAsString $sbUrl] [CkXml_getXml $xmlBody] "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sbUrl
    delete_CkAuthUtil $authUtil
    delete_CkJsonObject $json
    delete_CkHttp $http
    delete_CkDateTime $dtNow
    delete_CkXml $xmlBody
    exit
}

set xml [new_CkXml]

CkXml_LoadXml $xml [CkHttpResponse_bodyStr $resp]

# A successful response should have a 200 response status
if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts [CkXml_getXml $xml]
    puts "Response Status Code: [CkHttpResponse_get_StatusCode $resp]"
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkStringBuilder $sbUrl
    delete_CkAuthUtil $authUtil
    delete_CkJsonObject $json
    delete_CkHttp $http
    delete_CkDateTime $dtNow
    delete_CkXml $xmlBody
    delete_CkXml $xml
    exit
}

delete_CkHttpResponse $resp

# Show the XML response..
puts [CkXml_getXml $xml]
puts "--"
puts "Success!"

delete_CkStringBuilder $sbUrl
delete_CkAuthUtil $authUtil
delete_CkJsonObject $json
delete_CkHttp $http
delete_CkDateTime $dtNow
delete_CkXml $xmlBody
delete_CkXml $xml