Export SKU data 📦

View as Markdown

GET /export/skus/{template_uuid}

Api key

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

Data is returned as json, paginated in SKU slices.

Path parameters

template_uuid string Required

The uuid of the column template in Deck.

Even if it is a SKU dedicated endpoint, product information will be included in the slice: it will simply use product data of the product related to each SKU.

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 (default to 25, max 100)
modified_after date

When you only want to export data on SKUs that have modified after a given date, use this to specify the cutoff day (in YYYY-MM-DD format) Note that if one SKU of a product has been modified after this date, all other SKUs of this product will also be in the response.
sku_type string

If you have more than one SKU type in your corporation, you can specify the key of the one you want. Otherwise the default one will be used.

Responses

200 application/json

Successfully returned one slice of SKU 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
  
  sku_code string
  
  The unique code of the SKU
  
  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/skus/{template_uuid}

curl \
 --request GET 'https://api.ppe-analytics.com/api/v1/export/skus/{template_uuid}' \
 --header "PPEApiKey: $API_KEY"

Response examples (200)

{
  "status": "OK",
  "result": {
    "rows": [
      {
        "values": {
          "col1": 123,
          "col2": "foo",
          "My col 3": "bar"
        },
        "sku_code": "AB-1234Z"
      },
      {
        "values": {
          "col1": 23,
          "col2": "foo2",
          "My col 3": "bar2"
        },
        "sku_code": "BX-9990X"
      }
    ],
    "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/skus/abb230c2-2753-473c-b298-88fab2bc7c8c-0?slice_size=25&slice_number=2&language_code=en&modified_after=2025-12-07"
    }
  }
}