GET /external/api/products

GET /external/api/products
Authorization key

Query parameters

  • modifiedAfter string(date-time)
  • storeId string
  • PageNumber integer(int32)

    Minimum value is 1, maximum value is 2147483647.

  • PageSize integer(int32)

    Minimum value is 1, maximum value is 250.

Responses

  • 200

    Success

    Hide response attributes Show response attributes object
    • id string | null
    • name string | null
    • description string | null
    • handle string | null
    • vendor string | null
    • active boolean
    • isWeight boolean
    • isVending boolean
    • isShoppingBag boolean
    • isBehindCounter boolean
    • isImported boolean
    • isNotDiscountable boolean
    • sortIndex integer(int32) | null
    • modifiedAt string(date-time)
    • images array[object] | null
      Hide images attributes Show images attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • dimensions array[object] | null
      Hide dimensions attributes Show dimensions attributes object
      • id string | null
      • name string | null
      • barcode string | null
      • articleNumber string | null
      • prices array[object] | null
        Hide prices attributes Show prices attributes object
        • amount integer(int32)
        • taxPercent integer(int32)
        • currencyCode string | null
    Hide response attributes Show response attributes object
    • id string | null
    • name string | null
    • description string | null
    • handle string | null
    • vendor string | null
    • active boolean
    • isWeight boolean
    • isVending boolean
    • isShoppingBag boolean
    • isBehindCounter boolean
    • isImported boolean
    • isNotDiscountable boolean
    • sortIndex integer(int32) | null
    • modifiedAt string(date-time)
    • images array[object] | null
      Hide images attributes Show images attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • dimensions array[object] | null
      Hide dimensions attributes Show dimensions attributes object
      • id string | null
      • name string | null
      • barcode string | null
      • articleNumber string | null
      • prices array[object] | null
        Hide prices attributes Show prices attributes object
        • amount integer(int32)
        • taxPercent integer(int32)
        • currencyCode string | null
    Hide response attributes Show response attributes object
    • id string | null
    • name string | null
    • description string | null
    • handle string | null
    • vendor string | null
    • active boolean
    • isWeight boolean
    • isVending boolean
    • isShoppingBag boolean
    • isBehindCounter boolean
    • isImported boolean
    • isNotDiscountable boolean
    • sortIndex integer(int32) | null
    • modifiedAt string(date-time)
    • images array[object] | null
      Hide images attributes Show images attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • dimensions array[object] | null
      Hide dimensions attributes Show dimensions attributes object
      • id string | null
      • name string | null
      • barcode string | null
      • articleNumber string | null
      • prices array[object] | null
        Hide prices attributes Show prices attributes object
        • amount integer(int32)
        • taxPercent integer(int32)
        • currencyCode string | null
GET /external/api/products 
curl \
 --request GET 'http://test.api.fygi.store/external/api/products' \
 --header "authorization: $API_KEY"
Response examples (200) 
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "handle": "string",
    "vendor": "string",
    "active": true,
    "isWeight": true,
    "isVending": true,
    "isShoppingBag": true,
    "isBehindCounter": true,
    "isImported": true,
    "isNotDiscountable": true,
    "sortIndex": 42,
    "modifiedAt": "2025-05-04T09:42:00Z",
    "images": [
      {
        "id": "string",
        "fileName": "string",
        "url": "string",
        "externalImageId": "string",
        "sizes": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        }
      }
    ],
    "dimensions": [
      {
        "id": "string",
        "name": "string",
        "barcode": "string",
        "articleNumber": "string",
        "prices": [
          {
            "amount": 42,
            "taxPercent": 42,
            "currencyCode": "string"
          }
        ]
      }
    ]
  }
]
Response examples (200) 
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "handle": "string",
    "vendor": "string",
    "active": true,
    "isWeight": true,
    "isVending": true,
    "isShoppingBag": true,
    "isBehindCounter": true,
    "isImported": true,
    "isNotDiscountable": true,
    "sortIndex": 42,
    "modifiedAt": "2025-05-04T09:42:00Z",
    "images": [
      {
        "id": "string",
        "fileName": "string",
        "url": "string",
        "externalImageId": "string",
        "sizes": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        }
      }
    ],
    "dimensions": [
      {
        "id": "string",
        "name": "string",
        "barcode": "string",
        "articleNumber": "string",
        "prices": [
          {
            "amount": 42,
            "taxPercent": 42,
            "currencyCode": "string"
          }
        ]
      }
    ]
  }
]