List products 📚

GET /products/{segment_key}

Returns the list of products available to your corporation for a given segment, or for all segments at once (leave segment_key empty in that case)

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

The segment key of the product, as returned by list products endpoint. Leave empty for all segments

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.

Query parameters

updated_after string

Product last update cutoff date, in format YYYY-MM-DD or YYYY-MM-DD HH:MM:SS

Responses

200 application/json

Successfully returned products
Hide response attributes Show response attributes object
- status string
- result object
  
  Additional properties are allowed.
  
  Hide result attribute Show result attribute object
  
  products array[object]
  
  Hide products attributes Show products attributes 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
  
  manufacturer string
  
  The manufacturer key for 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
  
  parent_id string
  
  The id of the parent product (if level is "variant")
  
  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
  
  pim_status string
  
  The status of the product in the PIM. It is only available on products on which your are the owner
  
  Values are draft, ready, or archived.
404 application/json

Unknown segment key
Hide response attributes Show response attributes object
- status string
- message string
403 application/json

Unauthorized segment
Hide response attributes Show response attributes object
- status string
- message string

GET /products/{segment_key}

curl \
 -X GET https://api.ppe-analytics.com/api/v1/products/surface-cleaning \
 -H "PPEApiKey: $API_KEY"

Response examples (200)

{
  "status": "OK",
  "result": {
    "products": [
      {
        "id": "f50938a24830edb8b1c2ecc3f7dd88a3",
        "name": "Apollo 1027",
        "level": "single",
        "pim_status": "ready",
        "segment_key": "surface-cleaning",
        "manufacturer": "spontex",
        "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"
      },
      {
        "id": "89e6848c8f1f91404c224393340b1fad",
        "name": "Ariane Ultra 1212",
        "level": "parent",
        "pim_status": "draft",
        "segment_key": "surface-cleaning",
        "manufacturer": "spontex",
        "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"
      },
      {
        "id": "79e6848c8f1f91404c224393340b1fad",
        "name": "Ariane Ultra 1212 RED",
        "level": "variant",
        "parent_id": "89e6848c8f1f91404c224393340b1fad",
        "pim_status": "archived",
        "segment_key": "surface-cleaning",
        "manufacturer": "spontex",
        "last_modified": "2024-01-09 07:34:02 +0200",
        "api_get_product": "/api/v1/product/surface-cleaning/79e6848c8f1f91404c224393340b1fad",
        "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/79e6848c8f1f91404c224393340b1fad.jpg"
      }
    ]
  }
}

Response examples (404)

{
  "status": "ERROR",
  "message": "Unknown segment key 'book-protection'"
}

Response examples (403)

{
  "status": "ERROR",
  "message": "Unauthorized access to segment 'secret-agent'"
}