---
title: "Response fields"
description: "Every field a listing object can return from the Eebz API, including trade-in and contract fields."
canonical_url: "https://www.eebz.com/support/api/response-fields"
---

Each listing object returned by [retailer listings](/support/api/retailer-listings) can hold the fields below. Use `fields` in the request to return only the ones you need.

## Listing fields

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        country
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Country code of the listing
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        reseller.name
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Retailer name
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        reseller.url
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Retailer URL
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.gtin
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      GTIN
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.alt_gtin
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Alternative GTIN
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.full_name
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Full SKU name
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.mpn
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Manufacturer part number
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.alt_mpn
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Alternative MPN
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.packaging
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Packaging type, such as <code>
        dvd
      </code>
      
      , <code>
        bundle
      </code>
      
       or <code>
        two_pack
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.attribute_id
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Attribute ID
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.product_name
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Product name
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.platform
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Platform
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.edition
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Edition
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.release_date
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Release date
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.importance
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Importance rating, <code>
        AAA
      </code>
      
       to <code>
        C
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.lifecycle
      </code>
    </td>
    
    <td>
      integer
    </td>
    
    <td>
      Lifecycle stage
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.market_name
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Market name
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.publisher_name
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Brand name
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.industry_name
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Industry name
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.prices
      </code>
    </td>
    
    <td>
      array
    </td>
    
    <td>
      Prices by territory (average, minimum, mode)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.sku_attributes
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      SKU attributes
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sku.product_attributes
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Product attributes
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        link
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      URL of the listing
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Current price in local currency
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        price_in_org_currency
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Current price in your organisation's currency
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        original_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Original price or RRP
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        original_price_in_org_currency
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Original price in your organisation's currency
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        timestamp
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      When the data was collected
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        availability
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Availability status
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        country_currency
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Currency code of the listing
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        condition
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Product condition
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        lifecycle
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Listing lifecycle stage
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        gtin
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      GTIN shown on the listing
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        canonical_url
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Canonical URL
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        mpn
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      MPN shown on the listing
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        supplier_name
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Supplier name
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        retailer_category
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Retailer's category
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        retailer_category_parent
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Parent category
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        retailer_category_grandparent
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Grandparent category
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        rank
      </code>
    </td>
    
    <td>
      integer
    </td>
    
    <td>
      Category rank
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        review_no
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Number of reviews
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        review_score
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Review score
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grade_a_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Trade-in grade A price (trade-in extracts only)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grade_b_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Trade-in grade B price (trade-in extracts only)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grade_c_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Trade-in grade C price (trade-in extracts only)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grade_d_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Trade-in grade D price (trade-in extracts only)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        extract_types
      </code>
    </td>
    
    <td>
      string<span>
        
      </span>
    </td>
    
    <td>
      <a href="/support/extract-types">
        Extract types
      </a>
      
       behind this result
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        contracts
      </code>
    </td>
    
    <td>
      array
    </td>
    
    <td>
      Contract tariffs (contracts product only)
    </td>
  </tr>
</tbody>
</table>

## Contract fields

`contracts` holds one object per tariff when the contracts product is switched on for your organisation.

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        provider
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Airtime provider
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        type
      </code>
    </td>
    
    <td>
      
    </td>
    
    <td>
      Contract type
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data_size
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Data allowance
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        minutes
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Call minutes
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        texts
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Texts
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        length
      </code>
    </td>
    
    <td>
      integer
    </td>
    
    <td>
      Contract length in months
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        device_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Device price
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        deposit_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Upfront deposit
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        monthly_price
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      Monthly price
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        timestamp
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      When the contract was checked
    </td>
  </tr>
</tbody>
</table>

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.