(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_SbUrl
integer li_Success
integer li_NumReplaced
string ls_RequestMethod
oleobject loo_AuthUtil
string ls_WmConsumerId
string ls_WmPrivateKey
string ls_JsonStr
oleobject loo_Json
oleobject loo_Http
integer li_LineNumber
string ls_ShippingStatus
integer li_Quantity
string ls_Carrier
string ls_ShippingMethod
string ls_TrackingNumber
oleobject loo_DtNow
string ls_ShipDateTime
oleobject loo_XmlBody
oleobject loo_OrderLine
oleobject loo_OrderLineStatus
oleobject loo_Resp
oleobject loo_Xml

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

loo_SbUrl = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbUrl.ConnectToNewObject("Chilkat.StringBuilder")
if li_rc < 0 then
    destroy loo_SbUrl
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_SbUrl.Append("https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping")
li_NumReplaced = loo_SbUrl.Replace("{purchaseOrderId}","1111691995111")

ls_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.
loo_AuthUtil = create oleobject
// Use "Chilkat_9_5_0.AuthUtil" for versions of Chilkat < 10.0.0
li_rc = loo_AuthUtil.ConnectToNewObject("Chilkat.AuthUtil")

ls_WmConsumerId = "WALMART_CONSUMER_ID"
ls_WmPrivateKey = "WALMART_PRIVATE_KEY"
ls_JsonStr = loo_AuthUtil.WalmartSignature(loo_SbUrl.GetAsString(),ls_WmConsumerId,ls_WmPrivateKey,ls_RequestMethod)
if loo_AuthUtil.LastMethodSuccess <> 1 then
    Write-Debug loo_AuthUtil.LastErrorText
    destroy loo_SbUrl
    destroy loo_AuthUtil
    return
end if

// 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
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(ls_JsonStr)

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")

loo_Http.SetRequestHeader("WM_SVC.NAME","Walmart Marketplace")
loo_Http.SetRequestHeader("WM_QOS.CORRELATION_ID",loo_Json.StringOf("correlation_id"))
loo_Http.SetRequestHeader("WM_SEC.TIMESTAMP",loo_Json.StringOf("timestamp"))
loo_Http.SetRequestHeader("WM_SEC.AUTH_SIGNATURE",loo_Json.StringOf("signature"))
loo_Http.SetRequestHeader("WM_CONSUMER.ID",ls_WmConsumerId)
loo_Http.SetRequestHeader("WM_CONSUMER.CHANNEL.TYPE","WALMART_CHANNEL_TYPE")
loo_Http.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:
li_LineNumber = 1
ls_ShippingStatus = "Shipped"
li_Quantity = 1
ls_Carrier = "USPS"
ls_ShippingMethod = "Standard"
ls_TrackingNumber = "9999869903501929298999"

loo_DtNow = create oleobject
// Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
li_rc = loo_DtNow.ConnectToNewObject("Chilkat.CkDateTime")

loo_DtNow.SetFromCurrentSystemTime()
ls_ShipDateTime = loo_DtNow.GetAsTimestamp(0)

loo_XmlBody = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_XmlBody.ConnectToNewObject("Chilkat.Xml")

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

loo_OrderLine = loo_XmlBody.GetChildWithTag("ns2:orderLines|ns2:orderLine")
loo_OrderLine.UpdateChildContent("ns2:orderLineStatuses|ns2:orderLineStatus|ns2:status",ls_ShippingStatus)
destroy loo_OrderLine

loo_OrderLineStatus = loo_OrderLine.GetChildWithTag("ns2:orderLineStatuses|ns2:orderLineStatus")
loo_OrderLineStatus.UpdateChildContent("ns2:statusQuantity|ns2:unitOfMeasurement","Each")
loo_OrderLineStatus.UpdateChildContentInt("ns2:statusQuantity|ns2:amount",li_Quantity)
loo_OrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:shipDateTime",ls_ShipDateTime)
loo_OrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:carrierName|ns2:carrier",ls_Carrier)
loo_OrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:methodCode",ls_ShippingMethod)
loo_OrderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:trackingNumber",ls_TrackingNumber)
destroy loo_OrderLineStatus

Write-Debug "POST request body:"
Write-Debug loo_XmlBody.GetXml()
Write-Debug "--"

// 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.
loo_Http.SetRequestHeader("Content-Type","application/xml")
loo_Resp = loo_Http.PostXml(loo_SbUrl.GetAsString(),loo_XmlBody.GetXml(),"utf-8")
if loo_Http.LastMethodSuccess <> 1 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_SbUrl
    destroy loo_AuthUtil
    destroy loo_Json
    destroy loo_Http
    destroy loo_DtNow
    destroy loo_XmlBody
    return
end if

loo_Xml = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

loo_Xml.LoadXml(loo_Resp.BodyStr)

// A successful response should have a 200 response status
if loo_Resp.StatusCode <> 200 then
    Write-Debug loo_Xml.GetXml()
    Write-Debug "Response Status Code: " + string(loo_Resp.StatusCode)
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_SbUrl
    destroy loo_AuthUtil
    destroy loo_Json
    destroy loo_Http
    destroy loo_DtNow
    destroy loo_XmlBody
    destroy loo_Xml
    return
end if

destroy loo_Resp

// Show the XML response..
Write-Debug loo_Xml.GetXml()
Write-Debug "--"
Write-Debug "Success!"


destroy loo_SbUrl
destroy loo_AuthUtil
destroy loo_Json
destroy loo_Http
destroy loo_DtNow
destroy loo_XmlBody
destroy loo_Xml