(Objective-C) Walmart - Send Shipping Notification

Note: This example uses classes, properties, or methods discontinued in Chilkat v11.0.0 or greater.

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

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

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoStringBuilder.h>
#import <NSString.h>
#import <CkoAuthUtil.h>
#import <CkoJsonObject.h>
#import <CkoHttp.h>
#import <CkoDateTime.h>
#import <CkoXml.h>
#import <CkoHttpResponse.h>

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

CkoStringBuilder *sbUrl = [[CkoStringBuilder alloc] init];
BOOL success = [sbUrl Append: @"https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping"];
int numReplaced = [[sbUrl Replace: @"{purchaseOrderId}" replacement: @"1111691995111"] intValue];

NSString *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.
CkoAuthUtil *authUtil = [[CkoAuthUtil alloc] init];

NSString *wmConsumerId = @"WALMART_CONSUMER_ID";
NSString *wmPrivateKey = @"WALMART_PRIVATE_KEY";
NSString *jsonStr = [authUtil WalmartSignature: [sbUrl GetAsString] consumerId: wmConsumerId privateKey: wmPrivateKey requestMethod: requestMethod];
if (authUtil.LastMethodSuccess != YES) {
    NSLog(@"%@",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
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json Load: jsonStr];

CkoHttp *http = [[CkoHttp alloc] init];
[http SetRequestHeader: @"WM_SVC.NAME" value: @"Walmart Marketplace"];
[http SetRequestHeader: @"WM_QOS.CORRELATION_ID" value: [json StringOf: @"correlation_id"]];
[http SetRequestHeader: @"WM_SEC.TIMESTAMP" value: [json StringOf: @"timestamp"]];
[http SetRequestHeader: @"WM_SEC.AUTH_SIGNATURE" value: [json StringOf: @"signature"]];
[http SetRequestHeader: @"WM_CONSUMER.ID" value: wmConsumerId];
[http SetRequestHeader: @"WM_CONSUMER.CHANNEL.TYPE" value: @"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:
int lineNumber = 1;
NSString *shippingStatus = @"Shipped";
int quantity = 1;
NSString *carrier = @"USPS";
NSString *shippingMethod = @"Standard";
NSString *trackingNumber = @"9999869903501929298999";

CkoDateTime *dtNow = [[CkoDateTime alloc] init];
[dtNow SetFromCurrentSystemTime];
NSString *shipDateTime = [dtNow GetAsTimestamp: NO];

CkoXml *xmlBody = [[CkoXml alloc] init];
xmlBody.Tag = @"ns2:orderShipment";
[xmlBody AddAttribute: @"xmlns:ns2" value: @"http://walmart.com/mp/v3/orders"];
[xmlBody AddAttribute: @"xmlns:ns3" value: @"http://walmart.com/"];
[xmlBody UpdateChildContentInt: @"ns2:orderLines|ns2:orderLine|ns2:lineNumber" value: [NSNumber numberWithInt: lineNumber]];

CkoXml *orderLine = [xmlBody GetChildWithTag: @"ns2:orderLines|ns2:orderLine"];
[orderLine UpdateChildContent: @"ns2:orderLineStatuses|ns2:orderLineStatus|ns2:status" value: shippingStatus];

CkoXml *orderLineStatus = [orderLine GetChildWithTag: @"ns2:orderLineStatuses|ns2:orderLineStatus"];
[orderLineStatus UpdateChildContent: @"ns2:statusQuantity|ns2:unitOfMeasurement" value: @"Each"];
[orderLineStatus UpdateChildContentInt: @"ns2:statusQuantity|ns2:amount" value: [NSNumber numberWithInt: quantity]];
[orderLineStatus UpdateChildContent: @"ns2:trackingInfo|ns2:shipDateTime" value: shipDateTime];
[orderLineStatus UpdateChildContent: @"ns2:trackingInfo|ns2:carrierName|ns2:carrier" value: carrier];
[orderLineStatus UpdateChildContent: @"ns2:trackingInfo|ns2:methodCode" value: shippingMethod];
[orderLineStatus UpdateChildContent: @"ns2:trackingInfo|ns2:trackingNumber" value: trackingNumber];

NSLog(@"%@",@"POST request body:");
NSLog(@"%@",[xmlBody GetXml]);
NSLog(@"%@",@"--");

// 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" value: @"application/xml"];
CkoHttpResponse *resp = [http PostXml: [sbUrl GetAsString] xmlDoc: [xmlBody GetXml] charset: @"utf-8"];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoXml *xml = [[CkoXml alloc] init];
[xml LoadXml: resp.BodyStr];

// A successful response should have a 200 response status
if ([resp.StatusCode intValue] != 200) {
    NSLog(@"%@",[xml GetXml]);
    NSLog(@"%@%d",@"Response Status Code: ",[resp.StatusCode intValue]);
    NSLog(@"%@",@"Failed.");

    return;
}

// Show the XML response..
NSLog(@"%@",[xml GetXml]);
NSLog(@"%@",@"--");
NSLog(@"%@",@"Success!");