List products 📚

GET /products/{segment_key}
Api key

Returns the list of products available to your corporation for a given segment.

Only basic product information is provided by this endpoint, including product id. Full information is available through the Fetch product information endpoint

Path parameters

  • segment_key string Required

    The segment key of the product, as returned by list products endpoint.

    Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

Responses

  • • 200 object

    Successfully returned products

    • status string
    • result object
      • products array[object]
        • segment_key string

          Unique slug to identify the segment

          Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

        • id string

          Id to identify the product, unique segment-wise

        • name string

          The name of the product

        • level string

          The level of the product in the product hierarchy. Products which are not part of any hierarchy are marked as 'single'

          Values are single, parent, or variant.

        • last_modified date

          Date of last modification on product

        • api_get_product url

          The API endpoint to get all information on the product

        • main_picture_url url

          The URL of the main picture for the product

        • product_page_url url

          The URL of the public product page

  • • 404 object

    Unknown segment key

  • • 403 object

    Unauthorized segment

GET /products/{segment_key} 
curl \
 -X GET https://api.ppe-analytics.com/api/v1/products/surface-cleaning \
 -H "PPEApiKey: $API_KEY"
Response example (200) 
{
  "status": "OK",
  "result": {
    "products": [
      {
        "segment_key": "surface-cleaning",
        "id": "f50938a24830edb8b1c2ecc3f7dd88a3",
        "name": "Apollo 1027",
        "level": "single",
        "last_modified": "2022-06-24 17:14:46 +0200",
        "api_get_product": "/api/v1/product/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3",
        "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg"
      },
      {
        "segment_key": "surface-cleaning",
        "id": "89e6848c8f1f91404c224393340b1fad",
        "name": "Ariane Ultra 1212",
        "level": "parent",
        "last_modified": "2022-06-22 10:04:02 +0200",
        "api_get_product": "/api/v1/product/surface-cleaning/89e6848c8f1f91404c224393340b1fad",
        "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/89e6848c8f1f91404c224393340b1fad.jpg"
      }
    ]
  }
}
Response example (404) 
{
  "status": "ERROR",
  "message": "Unknown segment key 'book-protection'"
}
Response example (403) 
{
  "status": "ERROR",
  "message": "Unauthorized access to segment 'secret-agent'"
}