GET /reports/sales/sale/{id}

Updated on
 
Request an saleItem by its ID.  See saleItem element definition in WSDL/XSD
This resource requires connectid, nonce, date and signature for authentication. See Authentication documentation for REST and SOAP. Passing authentication information as query parameters for REST is supported.

Resource URL

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

Parameters

id
required

URL path parameter. The ID of the requested sale.
The id should consist of lowercase characters, the same way it is returned in the get sales by date call.

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/leads/lead/91e422a5-0047-4444-aaaa-5f52069f37b7

Example Response

<GetSalesResponse xmlns="http://api.zanox.com/namespace/2011-03-01/">
    <page>0</page>
    <items>1</items>
    <total>1</total>
    <saleItems>
        <saleItem id="91e422a5-0047-4444-aaaa-5f52069f37b7">
            <reviewState>confirmed</reviewState>
            <trackingDate>2012-08-05T18:27:09.373+02:00</trackingDate>
            <modifiedDate>2012-08-20T10:04:18.417+02:00</modifiedDate>
            <clickDate>2012-08-05T18:22:48.977+02:00</clickDate>
            <adspace id="12345">AdSpace name</adspace>
            <admedium id="654321">Affiliate link name</admedium>
            <program id="1234">Advertiser program</program>
            <clickId>17995036542191361</clickId>
            <clickInId>0</clickInId>
            <amount>10.00</amount>
            <commission>1.00</commission>
            <currency>EUR</currency>
            <gpps>
                <gpp id="zpar0">1227247</gpp>
                <gpp id="zpar1">ABCHDE</gpp>
                <gpp id="zpar2">102.01</gpp>
                <gpp id="zpar3">TopBannerA</gpp>
            </gpps>
            <reviewNote>confirmed</reviewNote>
            <trackingCategory id="98765">Tracking category name</trackingCategory>
        </saleItem>
    </saleItems>
</GetSalesResponse>

 

Resource Information

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