List Products

The “List Products” API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information.

GET https://services.leadconnectorhq.com/products/

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

number

default:"20"

The maximum number of items to be included in a single page of results

number

default:"0"

The starting index of the page, indicating the position from which the results should be retrieved.

string

default:"3SwdhCu3svxI8AKsPJt6"

required

LocationId is the id of the account

string

default:"Awesome product"

The name of the product for searching.

string

Filter by product category Ids. Supports comma separated values

string

The slug value of the collection by which the collection would be searched

string[]

Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes

string[]

List of product ids to be fetched.

string

default:"3SwdhCu3svxI8AKsPJt6"

fetch and project products based on the storeId

boolean

default:"True"

Separate products by which are included in the store and which are not

boolean

default:"True"

If the product is included in the online store

string

default:"desc"

The order of sort which should be applied for the date

Respuestas

200 - Successful response

object[]

required

An array of products

Show cada item

string

default:"655b33a82209e60b6adb87a5"

required

The unique identifier for the product.

string

default:"This is a really awesome product"

product description

object[]

An array of variants for the product.

Show cada item

string

default:"38s63qmxfr4"

required

A unique identifier for the variant.

string

default:"Size"

required

The name of the variant.

object[]

required

An array of options for the variant.

Show cada item

string

default:"h4z7u0im2q8"

required

The unique identifier for the option.

string

default:"XL"

required

The name of the option.

string

default:"3SwdhCsvxI8Au3KsPJt6"

required

The unique identifier for the account.

string

default:"Awesome Product"

required

The name of the product.

string

default:"PHYSICAL"

required

The type of the product (e.g., PHYSICAL).

boolean

default:"True"

Indicates whether the product is available in-store.

string

default:"2023-11-20T10:23:36.515Z"

required

The creation timestamp of the product.

string

default:"2024-01-23T09:57:04.846Z"

required

The last update timestamp of the product.

string

default:"abcde"

The statement descriptor for the product.

string

The URL for the product image.

string[]

An array of category Ids for the product

boolean

default:"True"

The field indicates whether taxes are enabled for the product or not.

string[]

An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type ProductTaxDto. Please refer to the ProductTaxDto for additional details.

string

default:"65d71377c326ea78e1c47df5"

Tax category ID for Automatic taxes calculation.

object

The Product label details

string

default:"washing-machine"

The slug of the product by which the product will be navigated

object[]

required

list products status

Show cada item

number

default:"20"

required

Total number of products

{
  "products": [
    {
      "_id": "655b33a82209e60b6adb87a5",
      "description": "This is a really awesome product",
      "variants": [
        {}
      ],
      "locationId": "3SwdhCsvxI8Au3KsPJt6",
      "name": "Awesome Product",
      "productType": "PHYSICAL",
      "availableInStore": true,
      "createdAt": "2023-11-20T10:23:36.515Z",
      "updatedAt": "2024-01-23T09:57:04.846Z",
      "statementDescriptor": "abcde",
      "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
      "collectionIds": [
        "65d71377c326ea78e1c47df5",
        "65d71377c326ea78e1c47d34"
      ],
      "isTaxesEnabled": true,
      "taxes": [
        "654492a4e6bef380114de15a"
      ],
      "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
      "slug": "washing-machine"
    }
  ],
  "total": [
    {
      "total": 20
    }
  ]
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/products/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/products/', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/products/',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/products/');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo