(Node.js) 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.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var sbUrl = new chilkat.StringBuilder();
    var success = sbUrl.Append("https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping");
    var numReplaced = sbUrl.Replace("{purchaseOrderId}","1111691995111");

    var 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.
    var authUtil = new chilkat.AuthUtil();

    var wmConsumerId = "WALMART_CONSUMER_ID";
    var wmPrivateKey = "WALMART_PRIVATE_KEY";
    var jsonStr = authUtil.WalmartSignature(sbUrl.GetAsString(),wmConsumerId,wmPrivateKey,requestMethod);
    if (authUtil.LastMethodSuccess !== true) {
        console.log(authUtil.LastErrorText);
        return;
    }

    // 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
    var json = new chilkat.JsonObject();
    json.Load(jsonStr);

    var http = new chilkat.Http();
    http.SetRequestHeader("WM_SVC.NAME","Walmart Marketplace");
    http.SetRequestHeader("WM_QOS.CORRELATION_ID",json.StringOf("correlation_id"));
    http.SetRequestHeader("WM_SEC.TIMESTAMP",json.StringOf("timestamp"));
    http.SetRequestHeader("WM_SEC.AUTH_SIGNATURE",json.StringOf("signature"));
    http.SetRequestHeader("WM_CONSUMER.ID",wmConsumerId);
    http.SetRequestHeader("WM_CONSUMER.CHANNEL.TYPE","WALMART_CHANNEL_TYPE");
    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:
    var lineNumber = 1;
    var shippingStatus = "Shipped";
    var quantity = 1;
    var carrier = "USPS";
    var shippingMethod = "Standard";
    var trackingNumber = "9999869903501929298999";

    var dtNow = new chilkat.CkDateTime();
    dtNow.SetFromCurrentSystemTime();
    var shipDateTime = dtNow.GetAsTimestamp(false);

    var xmlBody = new chilkat.Xml();
    xmlBody.Tag = "ns2:orderShipment";
    xmlBody.AddAttribute("xmlns:ns2","http://walmart.com/mp/v3/orders");
    xmlBody.AddAttribute("xmlns:ns3","http://walmart.com/");
    xmlBody.UpdateChildContentInt("ns2:orderLines|ns2:orderLine|ns2:lineNumber",lineNumber);

    // orderLine: Xml
    var orderLine = xmlBody.GetChildWithTag("ns2:orderLines|ns2:orderLine");
    orderLine.UpdateChildContent("ns2:orderLineStatuses|ns2:orderLineStatus|ns2:status",shippingStatus);

    // orderLineStatus: Xml
    var orderLineStatus = orderLine.GetChildWithTag("ns2:orderLineStatuses|ns2:orderLineStatus");
    orderLineStatus.UpdateChildContent("ns2:statusQuantity|ns2:unitOfMeasurement","Each");
    orderLineStatus.UpdateChildContentInt("ns2:statusQuantity|ns2:amount",quantity);
    orderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:shipDateTime",shipDateTime);
    orderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:carrierName|ns2:carrier",carrier);
    orderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:methodCode",shippingMethod);
    orderLineStatus.UpdateChildContent("ns2:trackingInfo|ns2:trackingNumber",trackingNumber);

    console.log("POST request body:");
    console.log(xmlBody.GetXml());
    console.log("--");

    // 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.
    http.SetRequestHeader("Content-Type","application/xml");
    // resp: HttpResponse
    var resp = http.PostXml(sbUrl.GetAsString(),xmlBody.GetXml(),"utf-8");
    if (http.LastMethodSuccess !== true) {
        console.log(http.LastErrorText);
        return;
    }

    var xml = new chilkat.Xml();
    xml.LoadXml(resp.BodyStr);

    // A successful response should have a 200 response status
    if (resp.StatusCode !== 200) {
        console.log(xml.GetXml());
        console.log("Response Status Code: " + resp.StatusCode);
        console.log("Failed.");

        return;
    }

    // Show the XML response..
    console.log(xml.GetXml());
    console.log("--");
    console.log("Success!");

}

chilkatExample();