(Node.js) Walmart - Acknowledge Order

See Acknowledge Orders for more information about this call.

Acknowledges an entire order, including all of its order lines. Walmart requires a seller to acknowledge orders within four hours of receipt of the order, except in extenuating circumstances.

The response to a successful call contains the acknowledged order.

In general, only orders that are in a “Created” state should be acknowledged. As a good practice, acknowledge your orders to avoid underselling. Orders that are in an “Acknowledged” state can be re-acknowledged, possibly in response to an error response from an earlier call to acknowledge order. Orders with line items that are shipped or canceled should not be re-acknowledged.

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

    var sbUrl = new chilkat.StringBuilder();
    var success = sbUrl.Append("https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/acknowledge");
    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);
    // Note: Make sure to replace "WALMART_CHANNEL_TYPE" with the actual value for your seller account...
    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.

    // Walmart provides the option to send/receive JSON or XML.  This example will use JSON.
    // Note: Please see the online JSON/XML code generation tools at https://tools.chilkat.io/
    // The online tools generate code to create/parse XML or JSON.  (You copy sample JSON/XML into the online format,
    // and generate code in your selected programming language.  It's a big time saver.)

    http.SetRequestHeader("Accept","application/json");
    // The body of this particular POST request contains just "{}". (The order ID is already in the URL path.)
    // resp: HttpResponse
    var resp = http.PostJson2(sbUrl.GetAsString(),"application/json","{}");
    if (http.LastMethodSuccess !== true) {
        console.log(http.LastErrorText);
        return;
    }

    // Get the JSON response body, which could contain an error, or if successful contains
    // the acknowledged order.
    var sbBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbBody);

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

        return;
    }

    // Parse the JSON response.
    // A sample response is shown below this code.  (The online tools at https://tools.chilkat.io were used to generate the 
    // fragment of code below using the sample response data at 
    // https://developer.walmart.com/#/apicenter/marketPlace/latest?country=us#acknowledgingOrders

    json.LoadSb(sbBody);
    var orderPurchaseOrderId;
    var orderCustomerOrderId;
    var orderCustomerEmailId;
    var orderOrderDate;
    var orderShippingInfoPhone;
    var orderShippingInfoEstimatedDeliveryDate;
    var orderShippingInfoEstimatedShipDate;
    var orderShippingInfoMethodCode;
    var orderShippingInfoPostalAddressName;
    var orderShippingInfoPostalAddressAddress1;
    var orderShippingInfoPostalAddressAddress2;
    var orderShippingInfoPostalAddressCity;
    var orderShippingInfoPostalAddressState;
    var orderShippingInfoPostalAddressPostalCode;
    var orderShippingInfoPostalAddressCountry;
    var orderShippingInfoPostalAddressAddressType;
    var i;
    var count_i;
    var lineNumber;
    var itemProductName;
    var itemSku;
    var orderLineQuantityUnitOfMeasurement;
    var orderLineQuantityAmount;
    var statusDate;
    var refundRefundId;
    var refundRefundComments;
    var j;
    var count_j;
    var chargeType;
    var chargeName;
    var chargeAmountCurrency;
    var chargeAmountAmount;
    var taxTaxName;
    var taxTaxAmountCurrency;
    var taxTaxAmountAmount;
    var status;
    var statusQuantityUnitOfMeasurement;
    var statusQuantityAmount;
    var cancellationReason;
    var trackingInfoShipDateTime;
    var trackingInfoCarrierNameOtherCarrier;
    var trackingInfoCarrierNameCarrier;
    var trackingInfoMethodCode;
    var trackingInfoTrackingNumber;
    var trackingInfoTrackingURL;
    var refundReason;
    var chargeChargeType;
    var chargeChargeName;
    var chargeChargeAmountCurrency;
    var chargeChargeAmountAmount;
    var chargeTax;

    orderPurchaseOrderId = json.StringOf("order.purchaseOrderId");
    orderCustomerOrderId = json.StringOf("order.customerOrderId");
    orderCustomerEmailId = json.StringOf("order.customerEmailId");
    orderOrderDate = json.IntOf("order.orderDate");
    orderShippingInfoPhone = json.StringOf("order.shippingInfo.phone");
    orderShippingInfoEstimatedDeliveryDate = json.IntOf("order.shippingInfo.estimatedDeliveryDate");
    orderShippingInfoEstimatedShipDate = json.IntOf("order.shippingInfo.estimatedShipDate");
    orderShippingInfoMethodCode = json.StringOf("order.shippingInfo.methodCode");
    orderShippingInfoPostalAddressName = json.StringOf("order.shippingInfo.postalAddress.name");
    orderShippingInfoPostalAddressAddress1 = json.StringOf("order.shippingInfo.postalAddress.address1");
    orderShippingInfoPostalAddressAddress2 = json.StringOf("order.shippingInfo.postalAddress.address2");
    orderShippingInfoPostalAddressCity = json.StringOf("order.shippingInfo.postalAddress.city");
    orderShippingInfoPostalAddressState = json.StringOf("order.shippingInfo.postalAddress.state");
    orderShippingInfoPostalAddressPostalCode = json.StringOf("order.shippingInfo.postalAddress.postalCode");
    orderShippingInfoPostalAddressCountry = json.StringOf("order.shippingInfo.postalAddress.country");
    orderShippingInfoPostalAddressAddressType = json.StringOf("order.shippingInfo.postalAddress.addressType");
    i = 0;
    count_i = json.SizeOfArray("order.orderLines.orderLine");
    while (i < count_i) {
        json.I = i;
        lineNumber = json.StringOf("order.orderLines.orderLine[i].lineNumber");
        itemProductName = json.StringOf("order.orderLines.orderLine[i].item.productName");
        itemSku = json.StringOf("order.orderLines.orderLine[i].item.sku");
        orderLineQuantityUnitOfMeasurement = json.StringOf("order.orderLines.orderLine[i].orderLineQuantity.unitOfMeasurement");
        orderLineQuantityAmount = json.StringOf("order.orderLines.orderLine[i].orderLineQuantity.amount");
        statusDate = json.IntOf("order.orderLines.orderLine[i].statusDate");
        refundRefundId = json.IsNullOf("order.orderLines.orderLine[i].refund.refundId");
        refundRefundComments = json.IsNullOf("order.orderLines.orderLine[i].refund.refundComments");
        j = 0;
        count_j = json.SizeOfArray("order.orderLines.orderLine[i].charges.charge");
        while (j < count_j) {
            json.J = j;
            chargeType = json.StringOf("order.orderLines.orderLine[i].charges.charge[j].chargeType");
            chargeName = json.StringOf("order.orderLines.orderLine[i].charges.charge[j].chargeName");
            chargeAmountCurrency = json.StringOf("order.orderLines.orderLine[i].charges.charge[j].chargeAmount.currency");
            chargeAmountAmount = json.IntOf("order.orderLines.orderLine[i].charges.charge[j].chargeAmount.amount");
            taxTaxName = json.StringOf("order.orderLines.orderLine[i].charges.charge[j].tax.taxName");
            taxTaxAmountCurrency = json.StringOf("order.orderLines.orderLine[i].charges.charge[j].tax.taxAmount.currency");
            taxTaxAmountAmount = json.IntOf("order.orderLines.orderLine[i].charges.charge[j].tax.taxAmount.amount");
            j = j+1;
        }

        j = 0;
        count_j = json.SizeOfArray("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus");
        while (j < count_j) {
            json.J = j;
            status = json.StringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].status");
            statusQuantityUnitOfMeasurement = json.StringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].statusQuantity.unitOfMeasurement");
            statusQuantityAmount = json.StringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].statusQuantity.amount");
            cancellationReason = json.IsNullOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].cancellationReason");
            trackingInfoShipDateTime = json.IntOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.shipDateTime");
            trackingInfoCarrierNameOtherCarrier = json.IsNullOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.carrierName.otherCarrier");
            trackingInfoCarrierNameCarrier = json.StringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.carrierName.carrier");
            trackingInfoMethodCode = json.StringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.methodCode");
            trackingInfoTrackingNumber = json.StringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingNumber");
            trackingInfoTrackingURL = json.StringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingURL");
            j = j+1;
        }

        j = 0;
        count_j = json.SizeOfArray("order.orderLines.orderLine[i].refund.refundCharges.refundCharge");
        while (j < count_j) {
            json.J = j;
            refundReason = json.StringOf("order.orderLines.orderLine[i].refund.refundCharges.refundCharge[j].refundReason");
            chargeChargeType = json.StringOf("order.orderLines.orderLine[i].refund.refundCharges.refundCharge[j].charge.chargeType");
            chargeChargeName = json.StringOf("order.orderLines.orderLine[i].refund.refundCharges.refundCharge[j].charge.chargeName");
            chargeChargeAmountCurrency = json.StringOf("order.orderLines.orderLine[i].refund.refundCharges.refundCharge[j].charge.chargeAmount.currency");
            chargeChargeAmountAmount = json.IntOf("order.orderLines.orderLine[i].refund.refundCharges.refundCharge[j].charge.chargeAmount.amount");
            chargeTax = json.IsNullOf("order.orderLines.orderLine[i].refund.refundCharges.refundCharge[j].charge.tax");
            j = j+1;
        }

        i = i+1;
    }

    console.log("Success!");

    // Sample Walmart Order Acknowledge Response:

    // {
    //   "order": {
    //     "purchaseOrderId": "1577684050862",
    //     "customerOrderId": "2861700797280",
    //     "customerEmailId": "jsanthanam@walmartlabs.com",
    //     "orderDate": 1484458949000,
    //     "shippingInfo": {
    //       "phone": "4151234567",
    //       "estimatedDeliveryDate": 1485586800000,
    //       "estimatedShipDate": 1484636400000,
    //       "methodCode": "Value",
    //       "postalAddress": {
    //         "name": "Asha  Chakre",
    //         "address1": "860 W California ave",
    //         "address2": null,
    //         "city": "Sunnyvale",
    //         "state": "CA",
    //         "postalCode": "94086",
    //         "country": "USA",
    //         "addressType": "RESIDENTIAL"
    //       }
    //     },
    //     "orderLines": {
    //       "orderLine": [
    //         {
    //           "lineNumber": "1",
    //           "item": {
    //             "productName": "Kellogg's Rice Krispies Cereal, 24 oz",
    //             "sku": "MGR_07_21_00100123"
    //           },
    //           "charges": {
    //             "charge": [
    //               {
    //                 "chargeType": "PRODUCT",
    //                 "chargeName": "ItemPrice",
    //                 "chargeAmount": {
    //                   "currency": "USD",
    //                   "amount": 19.99
    //                 },
    //                 "tax": {
    //                   "taxName": "Tax1",
    //                   "taxAmount": {
    //                     "currency": "USD",
    //                     "amount": 1.7
    //                   }
    //                 }
    //               }
    //             ]
    //           },
    //           "orderLineQuantity": {
    //             "unitOfMeasurement": "EACH",
    //             "amount": "1"
    //           },
    //           "statusDate": 1487888747000,
    //           "orderLineStatuses": {
    //             "orderLineStatus": [
    //               {
    //                 "status": "Shipped",
    //                 "statusQuantity": {
    //                   "unitOfMeasurement": "EACH",
    //                   "amount": "1"
    //                 },
    //                 "cancellationReason": null,
    //                 "trackingInfo": {
    //                   "shipDateTime": 1485549015000,
    //                   "carrierName": {
    //                     "otherCarrier": null,
    //                     "carrier": "FedEx"
    //                   },
    //                   "methodCode": "Value",
    //                   "trackingNumber": "3445435443441221",
    //                   "trackingURL": "http://walmart.narvar.com/walmart/tracking/Fedex?&type=MP&seller_id=801&promise_date=01/28/2017&dzip=94086&tracking_numbers=3445435443441221"
    //                 }
    //               }
    //             ]
    //           },
    //           "refund": {
    //             "refundId": null,
    //             "refundComments": null,
    //             "refundCharges": {
    //               "refundCharge": [
    //                 {
    //                   "refundReason": "ItemNotReceivedByCustomer",
    //                   "charge": {
    //                     "chargeType": "PRODUCT",
    //                     "chargeName": "Lost in Transit",
    //                     "chargeAmount": {
    //                       "currency": "USD",
    //                       "amount": -0.01
    //                     },
    //                     "tax": null
    //                   }
    //                 }
    //               ]
    //             }
    //           }
    //         }
    //       ]
    //     }
    //   }
    // }

}

chilkatExample();