v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB

Products

List products

Scopes: products.read <br>Guide: <a href="https://api-docs.omnisend.com/docs/how-to-sync-products-catalog-categories" target="_blank">Sync products catalog, categories</a> <br><a href="https://www.postman.com/omnisend-api/workspace/omnisend/overview" target="_blank">Open Postman collection</a>

get/products

Query parameters

offsetinteger

Offset

limitinteger

Limit

sort'date' | 'updatedAt' | 'createdAt'

Sort by

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

List of products

Example response

{
  "paging": {
    "limit": 100,
    "next": "https://api.omnisend.com/api/batches?limit=100&offset=105",
    "offset": 5,
    "previous": "https://api.omnisend.com/api/batches?limit=100&offset=5"
  },
  "products": [
    {
      "categoryIDs": [
        "1234567890",
        "99934567890"
      ],
      "createdAt": "2021-01-01T00:00:00Z",
      "currency": "USD",
      "defaultImageUrl": "https://example.com/image.jpg",
      "description": "My product description",
      "id": "1234567890",
      "images": [
        "https://example.com/image.jpg",
        "https://example.com/image2.jpg"
      ],
      "status": "inStock",
      "tags": [
        "tag1",
        "tag2",
        "tag3"
      ],
      "title": "My Product",
      "type": "Super Product",
      "updatedAt": "2021-01-01T00:00:00Z",
      "url": "https://example.com/product",
      "variants": [
        {
          "defaultImageUrl": "https://example.com/variantImage.jpg",
          "description": "My variant description",
          "id": "1234567890",
          "images": [
            "https://example.com/variant/image.jpg",
            "https://example.com/variant/image2.jpg"
          ],
          "price": 9.99,
          "sku": "SKU1234567890",
          "status": "inStock",
          "strikeThroughPrice": 19.99,
          "title": "My Variant",
          "url": "https://example.com/variant"
        }
      ],
      "vendor": "My Vendor"
    }
  ]
}