(Lianja) Walmart - Send Shipping Notification

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

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

// ---------------------------------------------------------------------------------------------------------
// 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

loSbUrl = createobject("CkStringBuilder")
llSuccess = loSbUrl.Append("https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping")
lnNumReplaced = loSbUrl.Replace("{purchaseOrderId}","1111691995111")

lcRequestMethod = "POST"

// First we need to generate a signature for our request.
// The signature needs to be re-generated for each new Walmart HTTP request.
loAuthUtil = createobject("CkAuthUtil")

lcWmConsumerId = "WALMART_CONSUMER_ID"
lcWmPrivateKey = "WALMART_PRIVATE_KEY"
lcJsonStr = loAuthUtil.WalmartSignature(loSbUrl.GetAsString(),lcWmConsumerId,lcWmPrivateKey,lcRequestMethod)
if (loAuthUtil.LastMethodSuccess <> .T.) then
    ? loAuthUtil.LastErrorText
    release loSbUrl
    release loAuthUtil
    return
endif

// 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
loJson = createobject("CkJsonObject")
loJson.Load(lcJsonStr)

loHttp = createobject("CkHttp")
loHttp.SetRequestHeader("WM_SVC.NAME","Walmart Marketplace")
loHttp.SetRequestHeader("WM_QOS.CORRELATION_ID",loJson.StringOf("correlation_id"))
loHttp.SetRequestHeader("WM_SEC.TIMESTAMP",loJson.StringOf("timestamp"))
loHttp.SetRequestHeader("WM_SEC.AUTH_SIGNATURE",loJson.StringOf("signature"))
loHttp.SetRequestHeader("WM_CONSUMER.ID",lcWmConsumerId)
loHttp.SetRequestHeader("WM_CONSUMER.CHANNEL.TYPE","WALMART_CHANNEL_TYPE")
loHttp.Accept = "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:
lnLineNumber = 1
lcShippingStatus = "Shipped"
lnQuantity = 1
lcCarrier = "USPS"
lcShippingMethod = "Standard"
lcTrackingNumber = "9999869903501929298999"

loDtNow = createobject("CkDateTime")
loDtNow.SetFromCurrentSystemTime()
lcShipDateTime = loDtNow.GetAsTimestamp(.F.)

loXmlBody = createobject("CkXml")
loXmlBody.Tag = "ns2:orderShipment"
loXmlBody.AddAttribute("xmlns:ns2","http://walmart.com/mp/v3/orders")
loXmlBody.AddAttribute("xmlns:ns3","http://walmart.com/")
loXmlBody.UpdateChildContentInt("ns2:orderLines|ns2:orderLine|ns2:lineNumber",lnLineNumber)

loOrderLine = loXmlBody.GetChildWithTag("ns2:orderLines|ns2:orderLine")
loOrderLine.UpdateChildContent("ns2:orderLineStatuses|ns2:orderLineStatus|ns2:status",lcShippingStatus)
release loOrderLine

loOrderLineStatus = loOrderLine.GetChildWithTag("ns2:orderLineStatuses|ns2:orderLineStatus")
loOrderLineStatus.UpdateChildContent("ns2:statusQuantity|ns2:unitOfMeasurement","Each")
loOrderLineStatus.UpdateChildContentInt("ns2:statusQuantity|ns2:amount",lnQuantity)
loOrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:shipDateTime",lcShipDateTime)
loOrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:carrierName|ns2:carrier",lcCarrier)
loOrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:methodCode",lcShippingMethod)
loOrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:trackingNumber",lcTrackingNumber)
release loOrderLineStatus

? "POST request body:"
? loXmlBody.GetXml()
? "--"

// 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.
loHttp.SetRequestHeader("Content-Type","application/xml")
loResp = loHttp.PostXml(loSbUrl.GetAsString(),loXmlBody.GetXml(),"utf-8")
if (loHttp.LastMethodSuccess <> .T.) then
    ? loHttp.LastErrorText
    release loSbUrl
    release loAuthUtil
    release loJson
    release loHttp
    release loDtNow
    release loXmlBody
    return
endif

loXml = createobject("CkXml")
loXml.LoadXml(loResp.BodyStr)

// A successful response should have a 200 response status
if (loResp.StatusCode <> 200) then
    ? loXml.GetXml()
    ? "Response Status Code: " + str(loResp.StatusCode)
    ? "Failed."
    release loResp
    release loSbUrl
    release loAuthUtil
    release loJson
    release loHttp
    release loDtNow
    release loXmlBody
    release loXml
    return
endif

release loResp

// Show the XML response..
? loXml.GetXml()
? "--"
? "Success!"


release loSbUrl
release loAuthUtil
release loJson
release loHttp
release loDtNow
release loXmlBody
release loXml