v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB

Store Catalog

Get products

List products in the store catalog with pagination and optional filtering. Filter by IDs, SKUs, text search, or semantic search.

get/v1/products

Query parameters

pageIndexinteger

numResultsPerPageinteger

Example:100

searchstring nullable

Example:organic apples

idsstring nullable

Example:pro_123,pro_456

skusstring nullable

Example:SKU-001,SKU-002

Response

totalResultsinteger required

Example response

{
  "products": [
    {
      "externalIdentifier": "ext_001",
      "sku": "11111",
      "name": "Organic Bananas",
      "description": "Fresh organic bananas, perfect for smoothies and baking",
      "imageUrls": [
        "https://example.com/bananas1.jpg",
        "https://example.com/bananas2.jpg"
      ],
      "categories": [
        "Produce",
        "Fruits",
        "Organic"
      ],
      "weight": 0.5,
      "dimensions": {
        "depth": 10.5,
        "width": 5,
        "height": 15.2
      },
      "identifiers": [
        {
          "type": "UPC",
          "value": "123456789012"
        }
      ],
      "attributes": [
        "WEIGHTED"
      ],
      "details": {
        "weightedItemInfo": {
          "weightPerItem": 0.5,
          "weightUnit": "kg"
        },
        "sizeSpecification": {
          "value": 100,
          "description": "Large"
        },
        "packSizeSpecification": {
          "description": "Large"
        }
      },
      "providerConfigs": [
        {
          "categories": [
            "Produce",
            "Fruits",
            "Organic"
          ],
          "provider": "X",
          "serviceType": "pick_and_deliver"
        }
      ]
    }
  ]
}