---
title: "product.list"
method: GET
path: "/product.list.json"
tags: ["product"]
---

# product.list

`GET /product.list.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/product.list.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Get list of products from your store. Returns 10 products by default.

## Query parameters

- `start` integer
- `count` integer
- `page_cursor` string
- `product_ids` string
- `since_id` string
- `categories_ids` string
- `category_id` string
- `store_id` string
- `vendor_id` string
- `lang_id` string
- `currency_id` string
- `avail_view` boolean
- `avail_sale` boolean
- `is_partial_or_full_out_of_stock` boolean
- `created_from` string
- `created_to` string
- `modified_from` string
- `modified_to` string
- `sku` string
- `brand_name` string
- `product_attributes` string[]
- `manufacturer_id` string
- `status` string
- `type` string
- `visible` string
- `find_value` string
- `find_where` string
- `return_global` boolean
- `params` string
- `response_fields` string
- `exclude` string
- `sort_by` string
- `sort_direction` string
- `report_request_id` string
- `disable_cache` boolean
- `disable_report_cache` boolean
- `use_latest_api_version` boolean
- `product_type` string

## Response `200`

successful operation

- ModelResponseProductList
  - `return_code` integer, nullable
  - `return_message` string, nullable
  - `pagination` Pagination
    - `previous` string, nullable
    - `next` string, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `result` ResponseProductListResult
    - `products_count` integer, nullable
    - `product` Product[]
      - `id` string
      - `type` string, nullable
      - `u_model` string, nullable
      - `u_sku` string, nullable
      - `name` string, nullable
      - `description` string, nullable
      - `short_description` string, nullable
      - `price` number, nullable
      - `advanced_price` ProductAdvancedPrice[]
        - `id` string
        - `value` number
        - `avail` boolean, nullable
        - `group_id` string, nullable
        - `quantity_from` number, nullable
        - `start_time` A2CDateTime
          - `value` string, nullable
          - `format` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `expire_time` A2CDateTime
          - `value` string, nullable
          - `format` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `cost_price` number, nullable
      - `unit_price` number, nullable
      - `measure_unit` string, nullable
      - `quantity` number, nullable
      - `inventory` ProductInventory[]
        - `warehouse_id` string
        - `quantity` number
        - `in_stock` boolean, nullable
        - `priority` integer, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `group_items` ProductGroupItem[]
        - `child_item_id` string, nullable
        - `product_id` string
        - `default_qty_in_pack` number
        - `is_qty_in_pack_fixed` boolean, nullable
        - `price` number, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `u_brand_id` string, nullable
      - `u_brand` string, nullable
      - `categories_ids` string[]
      - `stores_ids` string[]
      - `url` string, nullable
      - `seo_url` string, nullable
      - `meta_title` string, nullable
      - `meta_keywords` string, nullable
      - `meta_description` string, nullable
      - `avail_sale` boolean, nullable
      - `avail_view` boolean, nullable
      - `is_virtual` boolean, nullable
      - `is_downloadable` boolean, nullable
      - `weight` number, nullable
      - `weight_unit` string, nullable
      - `sort_order` integer, nullable
      - `in_stock` boolean, nullable
      - `backorders` string, nullable
      - `manage_stock` string, nullable
      - `is_stock_managed` boolean, nullable
      - `on_sale` boolean, nullable
      - `create_at` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `modified_at` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `tax_class_id` string, nullable
      - `special_price` SpecialPrice
        - `value` number
        - `avail` boolean
        - `created_at` A2CDateTime
          - `value` string, nullable
          - `format` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `modified_at` A2CDateTime
          - `value` string, nullable
          - `format` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `expired_at` A2CDateTime
          - `value` string, nullable
          - `format` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `tier_price` ProductTierPrice[]
        - `qty` number
        - `price` number
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `group_price` ProductGroupPrice[]
        - `id` string, nullable
        - `group_id` string
        - `price` number
        - `store_id` string, nullable
        - `quantity` number, nullable
        - `start_time` string, nullable
        - `expire_time` string, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `images` Image[]
        - `id` string, nullable
        - `http_path` string
        - `file_name` string, nullable
        - `mime-type` string, nullable
        - `size` integer, nullable
        - `create_at` A2CDateTime
          - `value` string, nullable
          - `format` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `modified_at` A2CDateTime
          - `value` string, nullable
          - `format` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `alt` string, nullable
        - `avail` boolean
        - `sort_order` integer, nullable
        - `type` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `product_options` ProductOption[]
        - `id` string
        - `product_option_id` string, nullable
        - `name` string
        - `description` string, nullable
        - `sort_order` integer, nullable
        - `type` string
        - `required` boolean, nullable
        - `available` boolean, nullable
        - `used_in_combination` boolean, nullable
        - `option_items` ProductOptionItem[]
          - `id` string
          - `product_option_item_id` string, nullable
          - `name` string
          - `sort_order` integer, nullable
          - `price` number, nullable
          - `weight` number, nullable
          - `quantity` integer, nullable
          - `type_price` string, nullable
          - `sku` string, nullable
          - `is_default` boolean, nullable
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `u_upc` string, nullable
      - `u_mpn` string, nullable
      - `u_gtin` string, nullable
      - `u_isbn` string, nullable
      - `u_ean` string, nullable
      - `related_products_ids` string[]
      - `up_sell_products_ids` string[]
      - `cross_sell_products_ids` string[]
      - `dimensions_unit` string, nullable
      - `width` number, nullable
      - `height` number, nullable
      - `length` number, nullable
      - `discounts` Discount[]
        - `id` string
        - `name` string
        - `modifier_type` string
        - `value` number
        - `from_time` string, nullable
        - `to_time` string, nullable
        - `customer_group_ids` string, nullable
        - `sort_order` integer, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)