Sample code for 30+ languages & platforms
Java Requires Chilkat v11.0.0+

Walmart v3 Ship Order Lines

See more Walmart v3 Examples

Updates the status of order lines to Shipped and trigger the charge to the customer. The response to a successful call contains the order with the shipped line items.

Chilkat Java Downloads

Chilkat2 Java
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example assumes the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Http http = new Http();

        http.setRequestHeader("WM_QOS.CORRELATION_ID", "b3261d2d-028a-4ef7-8602-633c23200af6");
        http.setRequestHeader("WM_SEC.ACCESS_TOKEN", "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....");
        http.setRequestHeader("Accept", "application/json");
        http.setRequestHeader("WM_SVC.NAME", "Walmart Marketplace");

        // Send the following in the request body:

        // {
        //   "orderShipment": {
        //     "orderLines": {
        //       "orderLine": [
        //         {
        //           "lineNumber": "1",
        //           "intentToCancelOverride": false,
        //           "sellerOrderId": "92344",
        //           "orderLineStatuses": {
        //             "orderLineStatus": [
        //               {
        //                 "status": "Shipped",
        //                 "statusQuantity": {
        //                   "unitOfMeasurement": "EACH",
        //                   "amount": "1"
        //                 },
        //                 "trackingInfo": {
        //                   "shipDateTime": 1580821866000,
        //                   "carrierName": {
        //                     "carrier": "UPS"
        //                   },
        //                   "methodCode": "Standard",
        //                   "trackingNumber": "22344",
        //                   "trackingURL": "http://walmart/tracking/ups?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92345"
        //                 },
        //                 "returnCenterAddress": {
        //                   "name": "walmart",
        //                   "address1": "walmart store 2",
        //                   "city": "Huntsville",
        //                   "state": "AL",
        //                   "postalCode": "35805",
        //                   "country": "USA",
        //                   "dayPhone": "12344",
        //                   "emailId": "walmart@walmart.com"
        //                 }
        //               }
        //             ]
        //           }
        //         },
        //         {
        //           "lineNumber": "2",
        //           "sellerOrderId": "92344",
        //           "orderLineStatuses": {
        //             "orderLineStatus": [
        //               {
        //                 "status": "Shipped",
        //                 "statusQuantity": {
        //                   "unitOfMeasurement": "EACH",
        //                   "amount": "1"
        //                 },
        //                 "trackingInfo": {
        //                   "shipDateTime": 1580821866000,
        //                   "carrierName": {
        //                     "carrier": "FedEx"
        //                   },
        //                   "methodCode": "Express",
        //                   "trackingNumber": "22344",
        //                   "trackingURL": "http://walmart/tracking/fedEx?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92344"
        //                 },
        //                 "returnCenterAddress": {
        //                   "name": "walmart",
        //                   "address1": "walmart store 2",
        //                   "city": "Huntsville",
        //                   "state": "AL",
        //                   "postalCode": "35805",
        //                   "country": "USA",
        //                   "dayPhone": "12344",
        //                   "emailId": "walmart@walmart.com"
        //                 }
        //               }
        //             ]
        //           }
        //         }
        //       ]
        //     }
        //   }
        // }

        JsonObject json = new JsonObject();
        int orderLineIndex = 0;
        int statusIndex = 0;
        json.setI(orderLineIndex);
        json.setJ(statusIndex);
        json.updateString("orderShipment.orderLines.orderLine[i].lineNumber", "1");
        json.updateBool("orderShipment.orderLines.orderLine[i].intentToCancelOverride", false);
        json.updateString("orderShipment.orderLines.orderLine[i].sellerOrderId", "92344");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].status", "Shipped");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].statusQuantity.unitOfMeasurement", "EACH");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].statusQuantity.amount", "1");
        json.updateInt("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.shipDateTime", 123);
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.carrierName.carrier", "UPS");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.methodCode", "Standard");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingNumber", "22344");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingURL", "http://walmart/tracking/ups?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92345");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.name", "walmart");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.address1", "walmart store 2");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.city", "Huntsville");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.state", "AL");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.postalCode", "35805");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.country", "USA");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.dayPhone", "12344");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.emailId", "walmart@walmart.com");

        orderLineIndex = orderLineIndex + 1;
        statusIndex = 0;
        json.setI(orderLineIndex);
        json.setJ(statusIndex);
        json.updateString("orderShipment.orderLines.orderLine[i].lineNumber", "2");
        json.updateString("orderShipment.orderLines.orderLine[i].sellerOrderId", "92344");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].status", "Shipped");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].statusQuantity.unitOfMeasurement", "EACH");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].statusQuantity.amount", "1");
        json.updateInt("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.shipDateTime", 123);
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.carrierName.carrier", "FedEx");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.methodCode", "Express");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingNumber", "22344");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingURL", "http://walmart/tracking/fedEx?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92344");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.name", "walmart");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.address1", "walmart store 2");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.city", "Huntsville");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.state", "AL");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.postalCode", "35805");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.country", "USA");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.dayPhone", "12344");
        json.updateString("orderShipment.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.emailId", "walmart@walmart.com");

        HttpResponse resp = new HttpResponse();
        try {
            http.httpJson("POST", "https://api-gateway.walmart.com/v3/orders/{purchaseOrderId}/shipping", json, "application/json", resp);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Response status code: " + resp.getStatusCode());

        resp.getBodyJson(json);

        // A sample JSON response:

        // {
        //   "order": {
        //     "purchaseOrderId": "1234567891234",
        //     "customerOrderId": "9876543212345",
        //     "sellerOrderId": "13233454564657",
        //     "customerEmailId": "customer@walmartlabs.com",
        //     "orderDate": 1478284060000,
        //     "shippingInfo": {
        //       "phone": "6501234567",
        //       "estimatedDeliveryDate": 1479798000000,
        //       "estimatedShipDate": 1478674800000,
        //       "methodCode": "Value",
        //       "postalAddress": {
        //         "name": "Jane Doe",
        //         "address1": "123 Main street",
        //         "city": "Sunnyvale",
        //         "state": "CA",
        //         "postalCode": "94086",
        //         "country": "USA",
        //         "addressType": "OFFICE"
        //       }
        //     },
        //     "orderLines": {
        //       "orderLine": [
        //         {
        //           "lineNumber": "1",
        //           "item": {
        //             "productName": "Kenmore CF-1 or 20-86883 Canister Secondary Filter Generic 2 Pack",
        //             "sku": "wei-ASSET-675gku675"
        //           },
        //           "charges": {
        //             "charge": [
        //               {
        //                 "chargeType": "PRODUCT",
        //                 "chargeName": "ItemPrice",
        //                 "chargeAmount": {
        //                   "currency": "USD",
        //                   "amount": 555
        //                 },
        //                 "tax": {
        //                   "taxName": "Tax1",
        //                   "taxAmount": {
        //                     "currency": "USD",
        //                     "amount": 48.56
        //                   }
        //                 }
        //               }
        //             ]
        //           },
        //           "orderLineQuantity": {
        //             "unitOfMeasurement": "EACH",
        //             "amount": "1"
        //           },
        //           "statusDate": 1478297929000,
        //           "orderLineStatuses": {
        //             "orderLineStatus": [
        //               {
        //                 "status": "Shipped",
        //                 "statusQuantity": {
        //                   "unitOfMeasurement": "EACH",
        //                   "amount": "1"
        //                 },
        //                 "trackingInfo": {
        //                   "shipDateTime": 1438163400000,
        //                   "carrierName": {
        //                     "carrier": "FedEx"
        //                   },
        //                   "methodCode": "Value",
        //                   "trackingNumber": "911001572321619861",
        //                   "trackingURL": "http://www.fedex.com/Tracking?action=track=english=us=x=911001572321619861"
        //                 },
        //                 "returnCenterAddress": {
        //                   "name": "ABC",
        //                   "address1": "123 Bridge street",
        //                   "city": "Huntsville",
        //                   "state": "AL",
        //                   "postalCode": "35805",
        //                   "country": "USA",
        //                   "dayPhone": "6501234567",
        //                   "emailId": "RCemailaddress@company.com"
        //                 }
        //               }
        //             ]
        //           }
        //         }
        //       ]
        //     }
        //   }
        // }

        json.setEmitCompact(false);
        System.out.println("Response JSON:");
        System.out.println(json.emit());

        // Insert code here to load the above JSON into the json object.

        String lineNumber = "";
        String ProductName = "";
        String Sku = "";
        String UnitOfMeasurement = "";
        String Amount = "";
        int statusDate = 0;
        int count_j = 0;
        String chargeType = "";
        String chargeName = "";
        String v_Currency = "";
        int chargeAmountAmount = 0;
        String TaxName = "";
        String TaxAmountCurrency = "";
        String TaxAmountAmount = "";
        String status = "";
        String statusQuantityUnitOfMeasurement = "";
        String statusQuantityAmount = "";
        int ShipDateTime = 0;
        String Carrier = "";
        String trackingInfoMethodCode = "";
        String TrackingNumber = "";
        String TrackingURL = "";
        String returnCenterAddressName = "";
        String returnCenterAddressAddress1 = "";
        String returnCenterAddressCity = "";
        String returnCenterAddressState = "";
        String returnCenterAddressPostalCode = "";
        String returnCenterAddressCountry = "";
        String DayPhone = "";
        String EmailId = "";

        String PurchaseOrderId = json.stringOf("order.purchaseOrderId");
        String CustomerOrderId = json.stringOf("order.customerOrderId");
        String SellerOrderId = json.stringOf("order.sellerOrderId");
        String CustomerEmailId = json.stringOf("order.customerEmailId");
        int OrderDate = json.intOf("order.orderDate");
        String Phone = json.stringOf("order.shippingInfo.phone");
        int EstimatedDeliveryDate = json.intOf("order.shippingInfo.estimatedDeliveryDate");
        int EstimatedShipDate = json.intOf("order.shippingInfo.estimatedShipDate");
        String MethodCode = json.stringOf("order.shippingInfo.methodCode");
        String Name = json.stringOf("order.shippingInfo.postalAddress.name");
        String Address1 = json.stringOf("order.shippingInfo.postalAddress.address1");
        String City = json.stringOf("order.shippingInfo.postalAddress.city");
        String State = json.stringOf("order.shippingInfo.postalAddress.state");
        String PostalCode = json.stringOf("order.shippingInfo.postalAddress.postalCode");
        String Country = json.stringOf("order.shippingInfo.postalAddress.country");
        String AddressType = json.stringOf("order.shippingInfo.postalAddress.addressType");
        int i = 0;
        int j = 0;
        int count_i = json.sizeOfArray("order.orderLines.orderLine");
        while (i < count_i) {
            json.setI(i);
            lineNumber = json.stringOf("order.orderLines.orderLine[i].lineNumber");
            ProductName = json.stringOf("order.orderLines.orderLine[i].item.productName");
            Sku = json.stringOf("order.orderLines.orderLine[i].item.sku");
            UnitOfMeasurement = json.stringOf("order.orderLines.orderLine[i].orderLineQuantity.unitOfMeasurement");
            Amount = json.stringOf("order.orderLines.orderLine[i].orderLineQuantity.amount");
            statusDate = json.intOf("order.orderLines.orderLine[i].statusDate");
            j = 0;
            count_j = json.sizeOfArray("order.orderLines.orderLine[i].charges.charge");
            while (j < count_j) {
                json.setJ(j);
                chargeType = json.stringOf("order.orderLines.orderLine[i].charges.charge[j].chargeType");
                chargeName = json.stringOf("order.orderLines.orderLine[i].charges.charge[j].chargeName");
                v_Currency = json.stringOf("order.orderLines.orderLine[i].charges.charge[j].chargeAmount.currency");
                chargeAmountAmount = json.intOf("order.orderLines.orderLine[i].charges.charge[j].chargeAmount.amount");
                TaxName = json.stringOf("order.orderLines.orderLine[i].charges.charge[j].tax.taxName");
                TaxAmountCurrency = json.stringOf("order.orderLines.orderLine[i].charges.charge[j].tax.taxAmount.currency");
                TaxAmountAmount = json.stringOf("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.setJ(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");
                ShipDateTime = json.intOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.shipDateTime");
                Carrier = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.carrierName.carrier");
                trackingInfoMethodCode = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.methodCode");
                TrackingNumber = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingNumber");
                TrackingURL = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].trackingInfo.trackingURL");
                returnCenterAddressName = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.name");
                returnCenterAddressAddress1 = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.address1");
                returnCenterAddressCity = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.city");
                returnCenterAddressState = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.state");
                returnCenterAddressPostalCode = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.postalCode");
                returnCenterAddressCountry = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.country");
                DayPhone = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.dayPhone");
                EmailId = json.stringOf("order.orderLines.orderLine[i].orderLineStatuses.orderLineStatus[j].returnCenterAddress.emailId");
                j = j + 1;
            }

            i = i + 1;
        }
    }
}