Export product data 📑

View as Markdown
GET /export/products/{template_uuid}
Api key

Export product-level data based on the definition of a Deck column template.

Data is returned as json, paginated in product slices.

Path parameters

  • template_uuid string Required

    The uuid of the column template in Deck.

    As it is a product dedicated endpoint, no SKU information must be requested in this export, they will simply be ignored.

    The keys in the response will use the english column name by default. To avoid breaking keys, please configure explicit slugs in the column templates.

Query parameters

  • slice_number integer

    The number of the slice to request (default to 1)

  • slice_size integer

    The size of each slice of products (default to 25, max 100)

  • modified_after date

    When you only want to export data on products modified after a given date, use this to specify the cutoff day (in YYYY-MM-DD format)

Responses

  • 200 application/json

    Successfully returned one slice of product data

    Hide response attributes Show response attributes object
    • status string
    • result object
      Hide result attributes Show result attributes object
      • rows array[object]
        Hide rows attributes Show rows attributes object
        • product_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.

        • product_id string

          Id to identify the product, unique segment-wise

        • values object

          Property values attached to this object

          Hide values attributes Show values attributes object
          • property_key string

            To be replaced with the property key of the property

          • value string

            The value for this property can be:

            • a value_key for enum
            • an array of value_key for enum_list
            • a string otherwise
      • pagination object
        Hide pagination attributes Show pagination attributes object
        • slice_size integer

          The size of the current slice

        • slice_number integer

          The number of the current slice

        • max_slice_number integer

          The max number of slices for this dataset & slice size

        • total_count integer

          The total number of items in the dataset

        • modified_after date

          The "modified_after" day, if provided. It must be provided in pagination request to preserve the product population

        • api_get_next_slice url

          The url to call in order to get the next slice
GET /export/products/{template_uuid} 
curl \
 --request GET 'https://api.ppe-analytics.com/api/v1/export/products/{template_uuid}' \
 --header "PPEApiKey: $API_KEY"
Response examples (200) 
{
  "status": "OK",
  "result": {
    "rows": [
      {
        "values": {
          "col1": 123,
          "col2": "foo",
          "My col 3": "bar"
        },
        "product_id": "123456789",
        "segment_key": "head-protection"
      },
      {
        "values": {
          "col1": 23,
          "col2": "foo2",
          "My col 3": "bar2"
        },
        "product_id": "9123456789",
        "segment_key": "head-protection"
      }
    ],
    "pagination": {
      "slice_size": 25,
      "total_count": 2457,
      "slice_number": 1,
      "modified_after": "2025-12-07",
      "max_slice_number": 14,
      "api_get_next_slice": "/api/v1/export/products/abb230c2-2753-473c-b298-88fab2bc7c8c-0?slice_size=25&slice_number=2&language_code=en&modified_after=2025-12-07"
    }
  }
}