Inventory

List inventory

Changed on

Returns a cursor-paginated page of the units the token can see, ordered by id. A program owner's token returns every unit across its dealer network, including its own rooftop; a single dealership's token returns only its own. Archived and removed units are included, so a full sync can reconcile a removal. Year, make, model, category, and type describe the model rather than the unit, so they live on the always-present catalog_vehicle block rather than on the item itself.

get/inventory

Request

  • Base URL: https://api.ekho.com
  • URL: https://api.ekho.com/inventory
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size, 1 to 100.

Example:20
starting_afterstring

Return the page after this resource id (newest first).

account_idstring

One account within the token's reach. An id outside it returns an empty page, not a 403.

listing_status'live' | 'off' | 'reserved' | 'not_ready' | 'archived'

Filter the lead-generation lane to a single status.

online_sale_status'live' | 'off' | 'reserved' | 'not_ready' | 'archived'

Filter the online-sale lane to a single status. Only one status filter per request.

condition'new' | 'used' | 'consigned'
vinstring

Exact match.

stock_numberstring

Exact match.

expand[]string[]

Repeatable. Expand location for the rooftop holding the unit and who to contact about it.

Response

A page of inventory units.

has_moreboolean required

True when another page follows the returned one.

next_cursorstring nullable required

Pass as starting_after to fetch the next page; null when has_more is false.

Example response

{
  "data": [
    {
      "id": "Kj7Xp2mQvR4tLw9dZa3B",
      "odometer": {
        "unit": "mi"
      },
      "pricing": {
        "advertised": 14995,
        "compare_at": 16495
      }
    }
  ]
}

Changes

  • 78c545d96a34Revision changes
    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • info

      added the required property // to the response with the status

  • 2a0b497bcf22Revision changes
    • info

      endpoint added