(Tcl) Walmart - Get a FeedItem's Status

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

Note: This is an older example for the Walmart v2 API. You should instead use the Walmart v3 API.

Demonstrates how to get a Walmart feedItem's status.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# --------------------------------------------------------------------
# This example is for the older and deprecated Walmart v2 API.
# 
# Use the v3 API instead: Walmart v3 Get Feed Status
# --------------------------------------------------------------------

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

# Sends the following GET request:
# GET https://marketplace.walmartapis.com/v2/feeds/feeditems/{feedId}?includeDetails={includeDetails}&limit={limit}

set sbUrl [new_CkStringBuilder]

set success [CkStringBuilder_Append $sbUrl "https://marketplace.walmartapis.com/v2/feeds/feeditems/{feedId}?includeDetails={includeDetails}&limit={limit}"]
set numReplaced [CkStringBuilder_Replace $sbUrl "{feedId}" "AAAA7F0345E9403C91223F7139FFC341@AQsBAQA"]
set numReplaced [CkStringBuilder_Replace $sbUrl "{includeDetails}" "true"]
set numReplaced [CkStringBuilder_ReplaceI $sbUrl "{limit}" 3]

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 {[CkAuthUtil_get_LastMethodSuccess $authUtil] != 1} then {
    puts [CkAuthUtil_lastErrorText $authUtil]
    delete_CkStringBuilder $sbUrl
    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
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 {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sbUrl
    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 {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkXml_getXml $xml]
    puts "Response Status Code: [CkHttp_get_LastStatus $http]"
    puts "Failed."
    delete_CkStringBuilder $sbUrl
    delete_CkAuthUtil $authUtil
    delete_CkJsonObject $json
    delete_CkHttp $http
    delete_CkXml $xml
    exit
}

# A sample XML response is shown below..
puts [CkXml_getXml $xml]
puts "--"

# To iterate over the ingestion statuses:
set numIngestionStatuses [CkXml_NumChildrenAt $xml "ns2:elements|ns2:itemDetails"]
set i 0
while {$i < $numIngestionStatuses} {
    CkXml_put_I $xml $i

    puts "sku: [CkXml_getChildContent $xml {ns2:elements|ns2:itemDetails|ns2:itemIngestionStatus[i]|ns2:sku}]"
    puts "status: [CkXml_getChildContent $xml {ns2:elements|ns2:itemDetails|ns2:itemIngestionStatus[i]|ns2:ingestionStatus}]"
    puts "--"

    set i [expr $i + 1]
}

puts "Success."

# ---------------------------------------
# Sample XML response
# ---------------------------------------

# <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
# <ns2:ItemStatusDetail xmlns:ns2="http://walmart.com/">
#     <ns2:meta>
#         <ns2:feedId>AAAAF0345E9403C91223F7139FFC341@AQsBAQA</ns2:feedId>
#         <ns2:feedStatus>PROCESSED</ns2:feedStatus>
#         <ns2:ingestionErrors />
#         <ns2:itemsReceived>130088</ns2:itemsReceived>
#         <ns2:itemsSucceeded>113154</ns2:itemsSucceeded>
#         <ns2:itemsFailed>16934</ns2:itemsFailed>
#         <ns2:itemsProcessing>0</ns2:itemsProcessing>
#         <ns2:limit>3</ns2:limit>
#         <ns2:totalCount>3</ns2:totalCount>
#         <ns2:nextCursor>includeDetails=true&amp;limit=3&amp;skuOffset=ENC%28%2F8D%2FyDen1ByXGA7EsWkArA%3D%3D%29</ns2:nextCursor>
#     </ns2:meta>
#     <ns2:elements>
#         <ns2:itemDetails>
#             <ns2:itemIngestionStatus>
#                 <ns2:martId>0</ns2:martId>
#                 <ns2:sku>0000~0~00141</ns2:sku>
#                 <ns2:index>0</ns2:index>
#                 <ns2:ingestionStatus>DATA_ERROR</ns2:ingestionStatus>
#                 <ns2:ingestionErrors>
#                     <ns2:ingestionError>
#                         <ns2:type>DATA_ERROR</ns2:type>
#                         <ns2:code>PIVI_021</ns2:code>
#                         <ns2:description>No item found with the given SKU.</ns2:description>
#                     </ns2:ingestionError>
#                 </ns2:ingestionErrors>
#             </ns2:itemIngestionStatus>
#             <ns2:itemIngestionStatus>
#                 <ns2:martId>0</ns2:martId>
#                 <ns2:sku>0000~0~03472</ns2:sku>
#                 <ns2:index>1</ns2:index>
#                 <ns2:ingestionStatus>SUCCESS</ns2:ingestionStatus>
#                 <ns2:ingestionErrors />
#             </ns2:itemIngestionStatus>
#             <ns2:itemIngestionStatus>
#                 <ns2:martId>0</ns2:martId>
#                 <ns2:sku>0000~0~08540</ns2:sku>
#                 <ns2:index>2</ns2:index>
#                 <ns2:ingestionStatus>SUCCESS</ns2:ingestionStatus>
#                 <ns2:ingestionErrors />
#             </ns2:itemIngestionStatus>
#         </ns2:itemDetails>
#     </ns2:elements>
# </ns2:ItemStatusDetail>

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