Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PureBasic Web API Examples

Primary Categories

AWS Translate
Azure Maps
Azure OAuth2
Azure Storage Accounts
CardConnect
ClickBank
Cloudfare
Facebook
GeoOp
Jira
Magento
Microsoft Calendar
Microsoft Group

Microsoft Tasks and Plans
PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(PureBasic) Walmart - Get List of Orders

Demonstrates how to get a list of all orders.

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

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkAuthUtil.pb"
IncludeFile "CkStringBuilder.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; Demonstrates how to get a list of Walmart orders and parse the XML result.

    ; ---
    ; Note: The Walmart documentation indicates that the createdStartDate/createdEndDate query parameters are optional,
    ; however, this may not actually be the case.  It may be that at least one is required for getting a list of orders.
    ; ---

    ; The general format to get orders is as follows:
    ; GET https://marketplace.walmartapis.com/v3/orders?sku={sku}&customerOrderId={customerOrderId}&purchaseOrderId={purchaseOrderId}&status={status}&createdStartDate={createdStartDate}&createdEndDate={createdEndDate}&fromExpectedShipDate={fromExpectedShipDate}&toExpectedShipDate={toExpectedShipDate}&limit={limit} 

    ; Let's build a request to get all the orders in the last 7 days.
    sbUrl.i = CkStringBuilder::ckCreate()
    If sbUrl.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkStringBuilder::ckAppend(sbUrl,"https://marketplace.walmartapis.com/v3/orders?createdStartDate={createdStartDate}&limit={limit}")
    ; We'll just get 2 results so we can demonstrate iterating over the XML..
    numReplaced.i = CkStringBuilder::ckReplaceI(sbUrl,"{limit}",2)

    ; Get the current system date/time and add -7 days to get 1 week ago.
    dtStartDate.i = CkDateTime::ckCreate()
    If dtStartDate.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(dtStartDate)
    CkDateTime::ckAddDays(dtStartDate,-7)
    Debug "One week ago (GMT): " + CkDateTime::ckGetAsTimestamp(dtStartDate,0)

    numReplaced = CkStringBuilder::ckReplace(sbUrl,"{createdStartDate}",CkDateTime::ckGetAsTimestamp(dtStartDate,0))

    requestMethod.s = "GET"

    ; First we need to generate a signature for our request.
    ; The signature needs to be re-generated for each new Walmart HTTP request.
    authUtil.i = CkAuthUtil::ckCreate()
    If authUtil.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    wmConsumerId.s = "WALMART_CONSUMER_ID"
    wmPrivateKey.s = "WALMART_PRIVATE_KEY"
    jsonStr.s = CkAuthUtil::ckWalmartSignature(authUtil,CkStringBuilder::ckGetAsString(sbUrl),wmConsumerId,wmPrivateKey,requestMethod)
    If CkAuthUtil::ckLastMethodSuccess(authUtil) <> 1
        Debug CkAuthUtil::ckLastErrorText(authUtil)
        CkStringBuilder::ckDispose(sbUrl)
        CkDateTime::ckDispose(dtStartDate)
        CkAuthUtil::ckDispose(authUtil)
        ProcedureReturn
    EndIf

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,jsonStr)

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::ckSetRequestHeader(http,"WM_SVC.NAME","Walmart Marketplace")
    CkHttp::ckSetRequestHeader(http,"WM_QOS.CORRELATION_ID",CkJsonObject::ckStringOf(json,"correlation_id"))
    CkHttp::ckSetRequestHeader(http,"WM_SEC.TIMESTAMP",CkJsonObject::ckStringOf(json,"timestamp"))
    CkHttp::ckSetRequestHeader(http,"WM_SEC.AUTH_SIGNATURE",CkJsonObject::ckStringOf(json,"signature"))
    CkHttp::ckSetRequestHeader(http,"WM_CONSUMER.ID",wmConsumerId)
    ; Note: check to see what keyword you should use for your situation.
    ; The keyword "WALMART_CHANNEL_TYPE" is one option.  Another is "SWAGGER_CHANNEL_TYPE".
    CkHttp::ckSetRequestHeader(http,"WM_CONSUMER.CHANNEL.TYPE","WALMART_CHANNEL_TYPE")

    CkHttp::setCkAccept(http, "application/xml")

    ; Note: Do not explicitly set the "Host" header.  Chilkat will set it automatically.

    xmlStr.s = CkHttp::ckQuickGetStr(http,CkStringBuilder::ckGetAsString(sbUrl))
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkStringBuilder::ckDispose(sbUrl)
        CkDateTime::ckDispose(dtStartDate)
        CkAuthUtil::ckDispose(authUtil)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadXml(xml,xmlStr)

    ; A successful response should have a 200 response status
    If CkHttp::ckLastStatus(http) <> 200
        Debug CkXml::ckGetXml(xml)
        Debug "Response Status Code: " + Str(CkHttp::ckLastStatus(http))
        Debug "Failed."
        CkStringBuilder::ckDispose(sbUrl)
        CkDateTime::ckDispose(dtStartDate)
        CkAuthUtil::ckDispose(authUtil)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(xml)
        ProcedureReturn
    EndIf

    ; A sample XML response is shown below..

    ; Let's grab some information, and iterate over the XML..
    Debug "Total number of orders in last 7 days: " + Str(CkXml::ckGetChildIntValue(xml,"ns3:meta|ns3:totalCount"))

    ; The outermost loop loops over the orders.  
    ; The next inner loop loops over the order lines.
    ; The innermost loop loops over the order line statuses.
    i.i = 0
    numOrders.i = CkXml::ckNumChildrenAt(xml,"ns3:elements")
    While i < numOrders
        CkXml::setCkI(xml, i)
        Debug "---- order " + Str(i + 1) + " ----"

        order.i = CkXml::ckGetChildWithTag(xml,"ns3:elements|ns3:order[i]")
        Debug "purchaseOrderId: " + CkXml::ckGetChildContent(order,"ns3:purchaseOrderId")
        Debug "name: " + CkXml::ckGetChildContent(order,"ns3:shippingInfo|ns3:postalAddress|ns3:name")

        j.i = 0
        numOrderLines.i = CkXml::ckNumChildrenAt(order,"ns3:orderLines")
        While j < numOrderLines
            CkXml::setCkJ(order, j)
            orderLine.i = CkXml::ckGetChildWithTag(order,"ns3:orderLines|ns3:orderLine[j]")
            Debug "  productName: " + CkXml::ckGetChildContent(orderLine,"ns3:item|ns3:productName")

            k.i = 0
            numOrderLineStatuses.i = CkXml::ckNumChildrenAt(orderLine,"ns3:orderLineStatuses")
            While k < numOrderLineStatuses
                CkXml::setCkK(orderLine, k)
                Debug "    order line status: " + CkXml::ckGetChildContent(orderLine,"ns3:orderLineStatuses|ns3:orderLineStatus[k]|ns3:status")
                Debug "    order line carrier: " + CkXml::ckGetChildContent(orderLine,"ns3:orderLineStatuses|ns3:orderLineStatus[k]|ns3:trackingInfo|ns3:carrierName|ns3:carrier")
                k = k + 1
            Wend

            CkXml::ckDispose(orderLine)

            j = j + 1
        Wend
        CkXml::ckDispose(order)

        i = i + 1
    Wend

    Debug "Success."

    ; ---------------------------------------
    ; Sample XML response
    ; (The confidential information has been redacted or modified with fake data.
    ; ---------------------------------------

    ; <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    ; <ns3:list xmlns:ns2="http://walmart.com/mp/orders" xmlns:ns3="http://walmart.com/mp/v3/orders" xmlns:ns4="http://walmart.com/">
    ;     <ns3:meta>
    ;         <ns3:totalCount>239</ns3:totalCount>
    ;         <ns3:limit>2</ns3:limit>
    ;         <ns3:nextCursor>?limit=2&amp;hasMoreElements=true&amp;soIndex=239&amp;poIndex=1578652999055&amp;partnerId=10000999999&amp;sellerId=9999&amp;createdStartDate=2017-04-21T19:08:55Z&amp;createdEndDate=2017-04-28T19:08:58.464Z</ns3:nextCursor>
    ;     </ns3:meta>
    ;     <ns3:elements>
    ;         <ns3:order>
    ;             <ns3:purchaseOrderId>1111641944111</ns3:purchaseOrderId>
    ;             <ns3:customerOrderId>1111777852111</ns3:customerOrderId>
    ;             <ns3:customerEmailId>somebody@somewhere.com</ns3:customerEmailId>
    ;             <ns3:orderDate>2017-04-21T01:25:52.000Z</ns3:orderDate>
    ;             <ns3:shippingInfo>
    ;                 <ns3:phone>3175555555</ns3:phone>
    ;                 <ns3:estimatedDeliveryDate>2017-05-10T06:00:00.000Z</ns3:estimatedDeliveryDate>
    ;                 <ns3:estimatedShipDate>2017-04-29T06:00:00.000Z</ns3:estimatedShipDate>
    ;                 <ns3:methodCode>Value</ns3:methodCode>
    ;                 <ns3:postalAddress>
    ;                     <ns3:name>barry redacted</ns3:name>
    ;                     <ns3:address1>9999 redacted dr</ns3:address1>
    ;                     <ns3:city>Indianapolis</ns3:city>
    ;                     <ns3:state>IN</ns3:state>
    ;                     <ns3:postalCode>46227</ns3:postalCode>
    ;                     <ns3:country>USA</ns3:country>
    ;                     <ns3:addressType>RESIDENTIAL</ns3:addressType>
    ;                 </ns3:postalAddress>
    ;             </ns3:shippingInfo>
    ;             <ns3:orderLines>
    ;                 <ns3:orderLine>
    ;                     <ns3:lineNumber>1</ns3:lineNumber>
    ;                     <ns3:item>
    ;                         <ns3:productName>DPX DPx HEST 2.0 Mil-Spec Fixed Blade G10 Multi-Colored</ns3:productName>
    ;                         <ns3:sku>DPXG~DPHSX008~00317</ns3:sku>
    ;                     </ns3:item>
    ;                     <ns3:charges>
    ;                         <ns3:charge>
    ;                             <ns3:chargeType>PRODUCT</ns3:chargeType>
    ;                             <ns3:chargeName>ItemPrice</ns3:chargeName>
    ;                             <ns3:chargeAmount>
    ;                                 <ns3:currency>USD</ns3:currency>
    ;                                 <ns3:amount>125.00</ns3:amount>
    ;                             </ns3:chargeAmount>
    ;                         </ns3:charge>
    ;                     </ns3:charges>
    ;                     <ns3:orderLineQuantity>
    ;                         <ns3:unitOfMeasurement>EACH</ns3:unitOfMeasurement>
    ;                         <ns3:amount>1</ns3:amount>
    ;                     </ns3:orderLineQuantity>
    ;                     <ns3:statusDate>2017-04-28T18:09:26.000Z</ns3:statusDate>
    ;                     <ns3:orderLineStatuses>
    ;                         <ns3:orderLineStatus>
    ;                             <ns3:status>Shipped</ns3:status>
    ;                             <ns3:statusQuantity>
    ;                                 <ns3:unitOfMeasurement>EACH</ns3:unitOfMeasurement>
    ;                                 <ns3:amount>1</ns3:amount>
    ;                             </ns3:statusQuantity>
    ;                             <ns3:trackingInfo>
    ;                                 <ns3:shipDateTime>2017-04-24T20:57:52.000Z</ns3:shipDateTime>
    ;                                 <ns3:carrierName>
    ;                                     <ns3:carrier>USPS</ns3:carrier>
    ;                                 </ns3:carrierName>
    ;                                 <ns3:methodCode>Value</ns3:methodCode>
    ;                                 <ns3:trackingNumber>redacted</ns3:trackingNumber>
    ;                                 <ns3:trackingURL>http://walmart.narvar.com/walmart/tracking/usps?redacted</ns3:trackingURL>
    ;                             </ns3:trackingInfo>
    ;                         </ns3:orderLineStatus>
    ;                     </ns3:orderLineStatuses>
    ;                 </ns3:orderLine>
    ;             </ns3:orderLines>
    ;         </ns3:order>
    ;         <ns3:order>
    ;             <ns3:purchaseOrderId>1111652066111</ns3:purchaseOrderId>
    ;             <ns3:customerOrderId>1111778837111</ns3:customerOrderId>
    ;             <ns3:customerEmailId>somebody2@somewhere.com</ns3:customerEmailId>
    ;             <ns3:orderDate>2017-04-22T13:37:12.000Z</ns3:orderDate>
    ;             <ns3:shippingInfo>
    ;                 <ns3:phone>8435555555</ns3:phone>
    ;                 <ns3:estimatedDeliveryDate>2017-05-11T06:00:00.000Z</ns3:estimatedDeliveryDate>
    ;                 <ns3:estimatedShipDate>2017-05-02T06:00:00.000Z</ns3:estimatedShipDate>
    ;                 <ns3:methodCode>Value</ns3:methodCode>
    ;                 <ns3:postalAddress>
    ;                     <ns3:name>Doug Redacted</ns3:name>
    ;                     <ns3:address1>1111 redacted dr</ns3:address1>
    ;                     <ns3:city>Columbia</ns3:city>
    ;                     <ns3:state>SC</ns3:state>
    ;                     <ns3:postalCode>29527</ns3:postalCode>
    ;                     <ns3:country>USA</ns3:country>
    ;                     <ns3:addressType>RESIDENTIAL</ns3:addressType>
    ;                 </ns3:postalAddress>
    ;             </ns3:shippingInfo>
    ;             <ns3:orderLines>
    ;                 <ns3:orderLine>
    ;                     <ns3:lineNumber>1</ns3:lineNumber>
    ;                     <ns3:item>
    ;                         <ns3:productName>Rayovac Specialty Battery 123A 2PK, RL123A-2D</ns3:productName>
    ;                         <ns3:sku>RAYO~RL123A-2A~46270</ns3:sku>
    ;                     </ns3:item>
    ;                     <ns3:charges>
    ;                         <ns3:charge>
    ;                             <ns3:chargeType>PRODUCT</ns3:chargeType>
    ;                             <ns3:chargeName>ItemPrice</ns3:chargeName>
    ;                             <ns3:chargeAmount>
    ;                                 <ns3:currency>USD</ns3:currency>
    ;                                 <ns3:amount>12.92</ns3:amount>
    ;                             </ns3:chargeAmount>
    ;                         </ns3:charge>
    ;                     </ns3:charges>
    ;                     <ns3:orderLineQuantity>
    ;                         <ns3:unitOfMeasurement>EACH</ns3:unitOfMeasurement>
    ;                         <ns3:amount>1</ns3:amount>
    ;                     </ns3:orderLineQuantity>
    ;                     <ns3:statusDate>2017-04-28T17:18:51.000Z</ns3:statusDate>
    ;                     <ns3:orderLineStatuses>
    ;                         <ns3:orderLineStatus>
    ;                             <ns3:status>Shipped</ns3:status>
    ;                             <ns3:statusQuantity>
    ;                                 <ns3:unitOfMeasurement>EACH</ns3:unitOfMeasurement>
    ;                                 <ns3:amount>1</ns3:amount>
    ;                             </ns3:statusQuantity>
    ;                             <ns3:trackingInfo>
    ;                                 <ns3:shipDateTime>2017-04-28T16:50:53.000Z</ns3:shipDateTime>
    ;                                 <ns3:carrierName>
    ;                                     <ns3:carrier>USPS</ns3:carrier>
    ;                                 </ns3:carrierName>
    ;                                 <ns3:methodCode>Value</ns3:methodCode>
    ;                                 <ns3:trackingNumber>redacted</ns3:trackingNumber>
    ;                                 <ns3:trackingURL>http://walmart.narvar.com/walmart/tracking/usps?redacted</ns3:trackingURL>
    ;                             </ns3:trackingInfo>
    ;                         </ns3:orderLineStatus>
    ;                     </ns3:orderLineStatuses>
    ;                 </ns3:orderLine>
    ;                 <ns3:orderLine>
    ;                     <ns3:lineNumber>2</ns3:lineNumber>
    ;                     <ns3:item>
    ;                         <ns3:productName>Rayovac Specialty Battery 123A 2PK, RL123A-2D</ns3:productName>
    ;                         <ns3:sku>RAYO~RL123A-2A~46270</ns3:sku>
    ;                     </ns3:item>
    ;                     <ns3:charges>
    ;                         <ns3:charge>
    ;                             <ns3:chargeType>PRODUCT</ns3:chargeType>
    ;                             <ns3:chargeName>ItemPrice</ns3:chargeName>
    ;                             <ns3:chargeAmount>
    ;                                 <ns3:currency>USD</ns3:currency>
    ;                                 <ns3:amount>12.92</ns3:amount>
    ;                             </ns3:chargeAmount>
    ;                         </ns3:charge>
    ;                     </ns3:charges>
    ;                     <ns3:orderLineQuantity>
    ;                         <ns3:unitOfMeasurement>EACH</ns3:unitOfMeasurement>
    ;                         <ns3:amount>1</ns3:amount>
    ;                     </ns3:orderLineQuantity>
    ;                     <ns3:statusDate>2017-04-28T17:18:51.000Z</ns3:statusDate>
    ;                     <ns3:orderLineStatuses>
    ;                         <ns3:orderLineStatus>
    ;                             <ns3:status>Shipped</ns3:status>
    ;                             <ns3:statusQuantity>
    ;                                 <ns3:unitOfMeasurement>EACH</ns3:unitOfMeasurement>
    ;                                 <ns3:amount>1</ns3:amount>
    ;                             </ns3:statusQuantity>
    ;                             <ns3:trackingInfo>
    ;                                 <ns3:shipDateTime>2017-04-28T16:50:53.000Z</ns3:shipDateTime>
    ;                                 <ns3:carrierName>
    ;                                     <ns3:carrier>USPS</ns3:carrier>
    ;                                 </ns3:carrierName>
    ;                                 <ns3:methodCode>Value</ns3:methodCode>
    ;                                 <ns3:trackingNumber>redacted</ns3:trackingNumber>
    ;                                 <ns3:trackingURL>http://walmart.narvar.com/walmart/tracking/usps?redacted</ns3:trackingURL>
    ;                             </ns3:trackingInfo>
    ;                         </ns3:orderLineStatus>
    ;                     </ns3:orderLineStatuses>
    ;                 </ns3:orderLine>
    ;             </ns3:orderLines>
    ;         </ns3:order>
    ;     </ns3:elements>
    ; </ns3:list>


    CkStringBuilder::ckDispose(sbUrl)
    CkDateTime::ckDispose(dtStartDate)
    CkAuthUtil::ckDispose(authUtil)
    CkJsonObject::ckDispose(json)
    CkHttp::ckDispose(http)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.