(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, CkDateTime, HttpResponse, AuthUtil, StringBuilder, JsonObject, Xml, Http;

...

procedure TForm1.Button1Click(Sender: TObject);
var
sbUrl: HCkStringBuilder;
success: Boolean;
numReplaced: Integer;
requestMethod: PWideChar;
authUtil: HCkAuthUtil;
wmConsumerId: PWideChar;
wmPrivateKey: PWideChar;
jsonStr: PWideChar;
json: HCkJsonObject;
http: HCkHttp;
lineNumber: Integer;
shippingStatus: PWideChar;
quantity: Integer;
carrier: PWideChar;
shippingMethod: PWideChar;
trackingNumber: PWideChar;
dtNow: HCkDateTime;
shipDateTime: PWideChar;
xmlBody: HCkXml;
orderLine: HCkXml;
orderLineStatus: HCkXml;
resp: HCkHttpResponse;
xml: HCkXml;

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

sbUrl := CkStringBuilder_Create();
success := CkStringBuilder_Append(sbUrl,'https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping');
numReplaced := CkStringBuilder_Replace(sbUrl,'{purchaseOrderId}','1111691995111');

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.
authUtil := CkAuthUtil_Create();

wmConsumerId := 'WALMART_CONSUMER_ID';
wmPrivateKey := 'WALMART_PRIVATE_KEY';
jsonStr := CkAuthUtil__walmartSignature(authUtil,CkStringBuilder__getAsString(sbUrl),wmConsumerId,wmPrivateKey,requestMethod);
if (CkAuthUtil_getLastMethodSuccess(authUtil) <> True) then
  begin
    Memo1.Lines.Add(CkAuthUtil__lastErrorText(authUtil));
    Exit;
  end;

// 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
json := CkJsonObject_Create();
CkJsonObject_Load(json,jsonStr);

http := CkHttp_Create();
CkHttp_SetRequestHeader(http,'WM_SVC.NAME','Walmart Marketplace');
CkHttp_SetRequestHeader(http,'WM_QOS.CORRELATION_ID',CkJsonObject__stringOf(json,'correlation_id'));
CkHttp_SetRequestHeader(http,'WM_SEC.TIMESTAMP',CkJsonObject__stringOf(json,'timestamp'));
CkHttp_SetRequestHeader(http,'WM_SEC.AUTH_SIGNATURE',CkJsonObject__stringOf(json,'signature'));
CkHttp_SetRequestHeader(http,'WM_CONSUMER.ID',wmConsumerId);
CkHttp_SetRequestHeader(http,'WM_CONSUMER.CHANNEL.TYPE','WALMART_CHANNEL_TYPE');
CkHttp_putAccept(http,'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:
lineNumber := 1;
shippingStatus := 'Shipped';
quantity := 1;
carrier := 'USPS';
shippingMethod := 'Standard';
trackingNumber := '9999869903501929298999';

dtNow := CkDateTime_Create();
CkDateTime_SetFromCurrentSystemTime(dtNow);
shipDateTime := CkDateTime__getAsTimestamp(dtNow,False);

xmlBody := CkXml_Create();
CkXml_putTag(xmlBody,'ns2:orderShipment');
CkXml_AddAttribute(xmlBody,'xmlns:ns2','http://walmart.com/mp/v3/orders');
CkXml_AddAttribute(xmlBody,'xmlns:ns3','http://walmart.com/');
CkXml_UpdateChildContentInt(xmlBody,'ns2:orderLines|ns2:orderLine|ns2:lineNumber',lineNumber);

orderLine := CkXml_GetChildWithTag(xmlBody,'ns2:orderLines|ns2:orderLine');
CkXml_UpdateChildContent(orderLine,'ns2:orderLineStatuses|ns2:orderLineStatus|ns2:status',shippingStatus);
CkXml_Dispose(orderLine);

orderLineStatus := CkXml_GetChildWithTag(orderLine,'ns2:orderLineStatuses|ns2:orderLineStatus');
CkXml_UpdateChildContent(orderLineStatus,'ns2:statusQuantity|ns2:unitOfMeasurement','Each');
CkXml_UpdateChildContentInt(orderLineStatus,'ns2:statusQuantity|ns2:amount',quantity);
CkXml_UpdateChildContent(orderLineStatus,'ns2:trackingInfo|ns2:shipDateTime',shipDateTime);
CkXml_UpdateChildContent(orderLineStatus,'ns2:trackingInfo|ns2:carrierName|ns2:carrier',carrier);
CkXml_UpdateChildContent(orderLineStatus,'ns2:trackingInfo|ns2:methodCode',shippingMethod);
CkXml_UpdateChildContent(orderLineStatus,'ns2:trackingInfo|ns2:trackingNumber',trackingNumber);
CkXml_Dispose(orderLineStatus);

Memo1.Lines.Add('POST request body:');
Memo1.Lines.Add(CkXml__getXml(xmlBody));
Memo1.Lines.Add('--');

// 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.
CkHttp_SetRequestHeader(http,'Content-Type','application/xml');
resp := CkHttp_PostXml(http,CkStringBuilder__getAsString(sbUrl),CkXml__getXml(xmlBody),'utf-8');
if (CkHttp_getLastMethodSuccess(http) <> True) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

xml := CkXml_Create();
CkXml_LoadXml(xml,CkHttpResponse__bodyStr(resp));

// A successful response should have a 200 response status
if (CkHttpResponse_getStatusCode(resp) <> 200) then
  begin
    Memo1.Lines.Add(CkXml__getXml(xml));
    Memo1.Lines.Add('Response Status Code: ' + IntToStr(CkHttpResponse_getStatusCode(resp)));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;

CkHttpResponse_Dispose(resp);

// Show the XML response..
Memo1.Lines.Add(CkXml__getXml(xml));
Memo1.Lines.Add('--');
Memo1.Lines.Add('Success!');

CkStringBuilder_Dispose(sbUrl);
CkAuthUtil_Dispose(authUtil);
CkJsonObject_Dispose(json);
CkHttp_Dispose(http);
CkDateTime_Dispose(dtNow);
CkXml_Dispose(xmlBody);
CkXml_Dispose(xml);

end;