Custom product
A Custom Product is a product created by the application of a user's design to a Supplier Product. Users select Supplier Products from the Catalog and subsequently add their design in the Safsira Design Lab. The resulting Custom Product is linked to the user's account.
Getting Custom Products
Custom Products are accessible through the API on the following endpoint:
GET https://api.safsira.com/v1/custom-productsYou can also get a specific Custom Product by id:
GET https://api.safsira.com/v1/custom-products/{id}Filtering
You can filter Custom Products by the following parameters:
| Parameter | Type | Example | Description |
|---|---|---|---|
| tag__in | <str>,<str>,...,<str> | Team, Christmas | Comma separated string of tags |
Filtering by tags
You can filter Custom Products by tags using the tag__in query parameter. You can pass a comma separated string of tags to filter by. The Custom Product must have all the tags passed to be returned.
Example:
GET https://api.safsira.com/v1/custom-products?tag__in=Team,ChristmasOrdering
You can order Custom Products using the ordering query parameter. You can order via the following fields:
| Field | Description |
|---|---|
| id | Custom Product id |
| created_at | Date and time the Custom Product was created |
| name | Custom Product name |
Example:
To filter products by the date they were created in descending order (newest first), you can use the following query parameter:
GET https://api.safsira.com/v1/custom-products?ordering=-created_atSearch
You can search Custom Products by name using the search query parameter. You can pass a string to search by. The search will be performed over the name field.
Example:
GET https://api.safsira.com/v1/custom-products?search=Christmas