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

Tcl Web API Examples

Primary Categories

CardConnect
Facebook
GeoOp
Jira
PayPal
Peoplevox
QuickBooks

Shopify
Stripe
SugarCRM
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(Tcl) 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 Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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.
set sbUrl [new_CkStringBuilder]

set success [CkStringBuilder_Append $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..
set numReplaced [CkStringBuilder_ReplaceI $sbUrl "{limit}" 2]

# Get the current system date/time and add -7 days to get 1 week ago.
set dtStartDate [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dtStartDate
CkDateTime_AddDays $dtStartDate -7
puts "One week ago (GMT): [CkDateTime_getAsTimestamp $dtStartDate 0]"

set numReplaced [CkStringBuilder_Replace $sbUrl "{createdStartDate}" [CkDateTime_getAsTimestamp $dtStartDate 0]]

set requestMethod "GET"

# First we need to generate a signature for our request.
# The signature needs to be re-generated for each new Walmart HTTP request.
set authUtil [new_CkAuthUtil]

set wmConsumerId "WALMART_CONSUMER_ID"
set wmPrivateKey "WALMART_PRIVATE_KEY"
set jsonStr [CkAuthUtil_walmartSignature $authUtil [CkStringBuilder_getAsString $sbUrl] $wmConsumerId $wmPrivateKey $requestMethod]
if {[expr [CkAuthUtil_get_LastMethodSuccess $authUtil] != 1]} then {
    puts [CkAuthUtil_lastErrorText $authUtil]
    delete_CkStringBuilder $sbUrl
    delete_CkDateTime $dtStartDate
    delete_CkAuthUtil $authUtil
    exit
}

# 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
set json [new_CkJsonObject]

CkJsonObject_Load $json $jsonStr

set http [new_CkHttp]

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
# 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_SetRequestHeader $http "WM_CONSUMER.CHANNEL.TYPE" "WALMART_CHANNEL_TYPE"

CkHttp_put_Accept $http "application/xml"

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

set xmlStr [CkHttp_quickGetStr $http [CkStringBuilder_getAsString $sbUrl]]
if {[expr [CkHttp_get_LastMethodSuccess $http] != 1]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sbUrl
    delete_CkDateTime $dtStartDate
    delete_CkAuthUtil $authUtil
    delete_CkJsonObject $json
    delete_CkHttp $http
    exit
}

set xml [new_CkXml]

CkXml_LoadXml $xml $xmlStr

# A successful response should have a 200 response status
if {[expr [CkHttp_get_LastStatus $http] != 200]} then {
    puts [CkXml_getXml $xml]
    puts "Response Status Code: [CkHttp_get_LastStatus $http]"
    puts "Failed."
    delete_CkStringBuilder $sbUrl
    delete_CkDateTime $dtStartDate
    delete_CkAuthUtil $authUtil
    delete_CkJsonObject $json
    delete_CkHttp $http
    delete_CkXml $xml
    exit
}

# A sample XML response is shown below..

# Let's grab some information, and iterate over the XML..
puts "Total number of orders in last 7 days: [CkXml_GetChildIntValue $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.
set i 0
set numOrders [CkXml_NumChildrenAt $xml "ns3:elements"]
while {[expr $i < $numOrders]} {
    CkXml_put_I $xml $i
    puts "---- order [expr $i + 1] ----"

    # order is a CkXml
    set order [CkXml_GetChildWithTag $xml "ns3:elements|ns3:order[i]"]
    puts "purchaseOrderId: [CkXml_getChildContent $order ns3:purchaseOrderId]"
    puts "name: [CkXml_getChildContent $order ns3:shippingInfo|ns3:postalAddress|ns3:name]"

    set j 0
    set numOrderLines [CkXml_NumChildrenAt $order "ns3:orderLines"]
    while {[expr $j < $numOrderLines]} {
        CkXml_put_J $order $j
        # orderLine is a CkXml
        set orderLine [CkXml_GetChildWithTag $order "ns3:orderLines|ns3:orderLine[j]"]
        puts "  productName: [CkXml_getChildContent $orderLine ns3:item|ns3:productName]"

        set k 0
        set numOrderLineStatuses [CkXml_NumChildrenAt $orderLine "ns3:orderLineStatuses"]
        while {[expr $k < $numOrderLineStatuses]} {
            CkXml_put_K $orderLine $k
            puts "    order line status: [CkXml_getChildContent $orderLine ns3:orderLineStatuses|ns3:orderLineStatus[k]|ns3:status]"
            puts "    order line carrier: [CkXml_getChildContent $orderLine ns3:orderLineStatuses|ns3:orderLineStatus[k]|ns3:trackingInfo|ns3:carrierName|ns3:carrier]"
            set k [expr $k + 1]
        }

        delete_CkXml $orderLine

        set j [expr $j + 1]
    }
    delete_CkXml $order

    set i [expr $i + 1]
}

puts "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>

delete_CkStringBuilder $sbUrl
delete_CkDateTime $dtStartDate
delete_CkAuthUtil $authUtil
delete_CkJsonObject $json
delete_CkHttp $http
delete_CkXml $xml

 

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