(SQL Server) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @sTmp1 nvarchar(4000)
    -- ---------------------------------------------------------------------------------------------------------
    -- 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

    DECLARE @sbUrl int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbUrl OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @sbUrl, 'Append', @success OUT, 'https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping'
    DECLARE @numReplaced int
    EXEC sp_OAMethod @sbUrl, 'Replace', @numReplaced OUT, '{purchaseOrderId}', '1111691995111'

    DECLARE @requestMethod nvarchar(4000)
    SELECT @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.
    DECLARE @authUtil int
    -- Use "Chilkat_9_5_0.AuthUtil" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.AuthUtil', @authUtil OUT

    DECLARE @wmConsumerId nvarchar(4000)
    SELECT @wmConsumerId = 'WALMART_CONSUMER_ID'
    DECLARE @wmPrivateKey nvarchar(4000)
    SELECT @wmPrivateKey = 'WALMART_PRIVATE_KEY'
    DECLARE @jsonStr nvarchar(4000)
    EXEC sp_OAMethod @sbUrl, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @authUtil, 'WalmartSignature', @jsonStr OUT, @sTmp0, @wmConsumerId, @wmPrivateKey, @requestMethod
    EXEC sp_OAGetProperty @authUtil, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @authUtil, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbUrl
        EXEC @hr = sp_OADestroy @authUtil
        RETURN
      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
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'Load', @success OUT, @jsonStr

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'WM_SVC.NAME', 'Walmart Marketplace'
    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'correlation_id'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'WM_QOS.CORRELATION_ID', @sTmp0
    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'timestamp'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'WM_SEC.TIMESTAMP', @sTmp0
    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'signature'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'WM_SEC.AUTH_SIGNATURE', @sTmp0
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'WM_CONSUMER.ID', @wmConsumerId
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'WM_CONSUMER.CHANNEL.TYPE', 'WALMART_CHANNEL_TYPE'
    EXEC sp_OASetProperty @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:
    DECLARE @lineNumber int
    SELECT @lineNumber = 1
    DECLARE @shippingStatus nvarchar(4000)
    SELECT @shippingStatus = 'Shipped'
    DECLARE @quantity int
    SELECT @quantity = 1
    DECLARE @carrier nvarchar(4000)
    SELECT @carrier = 'USPS'
    DECLARE @shippingMethod nvarchar(4000)
    SELECT @shippingMethod = 'Standard'
    DECLARE @trackingNumber nvarchar(4000)
    SELECT @trackingNumber = '9999869903501929298999'

    DECLARE @dtNow int
    -- Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.CkDateTime', @dtNow OUT

    EXEC sp_OAMethod @dtNow, 'SetFromCurrentSystemTime', @success OUT
    DECLARE @shipDateTime nvarchar(4000)
    EXEC sp_OAMethod @dtNow, 'GetAsTimestamp', @shipDateTime OUT, 0

    DECLARE @xmlBody int
    -- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xmlBody OUT

    EXEC sp_OASetProperty @xmlBody, 'Tag', 'ns2:orderShipment'
    EXEC sp_OAMethod @xmlBody, 'AddAttribute', @success OUT, 'xmlns:ns2', 'http://walmart.com/mp/v3/orders'
    EXEC sp_OAMethod @xmlBody, 'AddAttribute', @success OUT, 'xmlns:ns3', 'http://walmart.com/'
    EXEC sp_OAMethod @xmlBody, 'UpdateChildContentInt', NULL, 'ns2:orderLines|ns2:orderLine|ns2:lineNumber', @lineNumber

    DECLARE @orderLine int
    EXEC sp_OAMethod @xmlBody, 'GetChildWithTag', @orderLine OUT, 'ns2:orderLines|ns2:orderLine'
    EXEC sp_OAMethod @orderLine, 'UpdateChildContent', NULL, 'ns2:orderLineStatuses|ns2:orderLineStatus|ns2:status', @shippingStatus
    EXEC @hr = sp_OADestroy @orderLine

    DECLARE @orderLineStatus int
    EXEC sp_OAMethod @orderLine, 'GetChildWithTag', @orderLineStatus OUT, 'ns2:orderLineStatuses|ns2:orderLineStatus'
    EXEC sp_OAMethod @orderLineStatus, 'UpdateChildContent', NULL, 'ns2:statusQuantity|ns2:unitOfMeasurement', 'Each'
    EXEC sp_OAMethod @orderLineStatus, 'UpdateChildContentInt', NULL, 'ns2:statusQuantity|ns2:amount', @quantity
    EXEC sp_OAMethod @orderLineStatus, 'UpdateChildContent', NULL, 'ns2:trackingInfo|ns2:shipDateTime', @shipDateTime
    EXEC sp_OAMethod @orderLineStatus, 'UpdateChildContent', NULL, 'ns2:trackingInfo|ns2:carrierName|ns2:carrier', @carrier
    EXEC sp_OAMethod @orderLineStatus, 'UpdateChildContent', NULL, 'ns2:trackingInfo|ns2:methodCode', @shippingMethod
    EXEC sp_OAMethod @orderLineStatus, 'UpdateChildContent', NULL, 'ns2:trackingInfo|ns2:trackingNumber', @trackingNumber
    EXEC @hr = sp_OADestroy @orderLineStatus


    PRINT 'POST request body:'
    EXEC sp_OAMethod @xmlBody, 'GetXml', @sTmp0 OUT
    PRINT @sTmp0

    PRINT '--'

    -- 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.
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/xml'
    DECLARE @resp int
    EXEC sp_OAMethod @sbUrl, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @xmlBody, 'GetXml', @sTmp1 OUT
    EXEC sp_OAMethod @http, 'PostXml', @resp OUT, @sTmp0, @sTmp1, 'utf-8'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbUrl
        EXEC @hr = sp_OADestroy @authUtil
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @dtNow
        EXEC @hr = sp_OADestroy @xmlBody
        RETURN
      END

    DECLARE @xml int
    -- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT

    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @xml, 'LoadXml', @success OUT, @sTmp0

    -- A successful response should have a 200 response status
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN
        EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
        PRINT @sTmp0

        EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
        PRINT 'Response Status Code: ' + @iTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @sbUrl
        EXEC @hr = sp_OADestroy @authUtil
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @dtNow
        EXEC @hr = sp_OADestroy @xmlBody
        EXEC @hr = sp_OADestroy @xml
        RETURN
      END

    EXEC @hr = sp_OADestroy @resp

    -- Show the XML response..
    EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
    PRINT @sTmp0

    PRINT '--'

    PRINT 'Success!'

    EXEC @hr = sp_OADestroy @sbUrl
    EXEC @hr = sp_OADestroy @authUtil
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @dtNow
    EXEC @hr = sp_OADestroy @xmlBody
    EXEC @hr = sp_OADestroy @xml


END
GO