Skip to content

Get User Kit

Returns the product list currently assigned to the user.

When the user_product_kit site feature is enabled, each user can have an individually configured product list. When the feature is disabled, the user falls back to the partner-level kit.

The {user} path parameter is the internal user id (use Find User by Email to look it up).

HeaderRequiredValue
api-keyyesImport API key

HTTP 200 OK

{
"success": true,
"kit": [
{
"user_id": 42,
"product_id": 7,
"quantity": 2,
"mandatory": true,
"product": {
"id": 7,
"product_name": "Rain Jacket"
},
"channel": "app"
}
]
}
FieldTypeDescription
user_idintUser ID
product_idintProduct ID
quantityintRequired quantity for this user
mandatoryboolWhether this product is mandatory
productobjectProduct snapshot (id and product_name)
channelstring | nullHow the product was assigned to the user: app (assigned by partner/admin staff via the rider app), eshop (self-checkout on the public eshop), or oms (imported from the external order management system). null if the user hasn’t actually been assigned any quantity of this product yet.
StatusDescription
401Missing api-key header
403Invalid api-key value
404User not found