GET /reports/sales/sale/{id}/basket

Updated on
 
Returns the basket contents for a specified sale. The return type basketItem contains product position in the basket, product information (name and number), tracking category ID and commission information (total, fixed amount and percentage). Tracking category ID can be mapped to a tracking category, returned by the trackingcategories resource.
This resource requires sale id as URL path parameter to identify the sale and connectid, nonce, date and signature for authentication. See Authentication documentation for REST. Passing authentication information as query parameters for REST is also supported.
 
This method is only available in REST.

Resource URL

XML:   http://api.zanox.com/xml/2011-03-01/reports/sales/sale/{id}/basket
JSON: http://api.zanox.com/json/2011-03-01/reports/sales/sale/{id}/basket

Parameters

id
required

URL path parameter. The ID of the requested sale.

Value Type: String sale ID.
Example Value

Example Request

REST authentication information must be included in request headers or added as query parameters

Get details of the sale with ID "91E422A5-0047-4444-AAAA-5F52069F37B7": http://api.zanox.com/xml/2011-03-01/reports/sales/sale/91E422A5-0047-4444-AAAA-5F52069F37B7/basket

Example Response

<GetBasketResponse>
<page>0</page>
<items>2</items>
<total>2</total>
<basketItems>
  <basketItem>
   <posId>1</posId>
   <productName>Slippers</productName>
   <productNumber>123456789</productNumber>
   <productPrice>6.07</productPrice>
   <quantity>1</quantity>
   <trackingCategoryId>654321</trackingCategoryId>
   <commission>0.2428</commission>
   <commissionAmount>0.0</commissionAmount>
   <commissionPercent>4.0</commissionPercent>
  </basketItem>
  <basketItem>
   <posId>2</posId>
   <productName>Socks</productName>
   <productNumber>123456790</productNumber>
   <productPrice>6.07</productPrice>
   <quantity>1</quantity>
   <trackingCategoryId>654322</trackingCategoryId>
   <commission>0.2428</commission>
   <commissionAmount>0.0</commissionAmount>
   <commissionPercent>4.0</commissionPercent>
  </basketItem>
</basketItems>
</GetBasketResponse>

 

Resource Information

Rate Limited? No
Authentication Requires signature. See
REST Authentication
Response Formats json, xml
HTTP Methods GET
Resource family Sales
Response Object BasketItem
API Version 2011-03-01