Search for product
Request
- Base URLhttps://api.c1st.com/api
- URLhttps://api.c1st.com/api/products
- AuthHTTP bearer
Query parameters
Cursor for pagination. If parameter is set, paginationStart will be ignored. Only allowed for default sorting or based on id.
Barcode. Matches exactly on the barcode (also with leading zeros/¤ trimmed). If nothing is found, alternative barcodes are searched as well.
Product title. Partial match.
Brand. Partial match.
Color. Partial match.
Size. Partial match.
Value of custom field 1. Partial match.
Value of custom field 2. Partial match.
Value of custom field 3. Partial match.
Value of custom field 4. Partial match.
Freetext search used to find what humans expect. NB this can change over time, don't use this in your integration on this.
The ID of the product.
Only retrieve products with one of these IDs. Must be sent with bracket syntax, ids[]=1&ids[]=2; repeated ids= parameters are not supported.
If true, the total number of matching products (ignoring pagination) is returned in count.
Include deleted products.
Only retrieve products that are not in stock (stock is zero or negative).
Only retrieve products with available stock (stock not reserved by sales orders or tickets).
Only retrieve products with stock reserved by sales orders or tickets (and with inventory tracking).
Exclude products that have been sold in POS and are no longer in stock.
Exclude products that have a serie-number.
Only retrieve products with a price greater than zero.
Only retrieve products that have a barcode.
Only retrieve products belonging to this style group.
Only retrieve products that are currently in stock.
Only retrieve products that needs to be ordered because of low stock.
Deprecated, use cursor instead. Determine the offset (in number of products) to fetch. This is usually a multiple of the pageLength. For legacy support pagination-start is also accepted.
Determine the number of products to fetch in one page. Default is 50. For legacy support pagination-pageLength is also accepted (the backend is case-sensitive).
Pipe separated list of product numbers.
Pipe separated list of style numbers.
Serie-number
Return products that has a serie-number
Return products that have a recommended retail price and the recommended retail price does not match the products price
Search in stocktransactionlist, this will only search on products that are a part of a stocktransactionlist with this id
Sorting order. If 1, products are retrieved in ascending order, if -1, in descending order.
Product column to sort by. Offset pagination has no guaranteed order unless sort-field or sort-order is given (sort-field then defaults to id). Special values instock_title, stockno, bikedeskpossales and costprice are also supported. Cursor pagination only supports id.
Name of the supplier. Has no effect.
Only retrieve products with this tag ID. Takes precedence over tags.
List of tag IDs to restrict the search to (any of them). Send as tags[]=1&tags[]=2.
Only retrieve products from the supplier with this ID.
List products for a partner store that shares product data with the current store. Responds 401 if the store does not share product data.
VAT mode
Get all products updated at or after the given date (Y-m-d H:i:s).
Get all products created at or before the given date (Y-m-d H:i:s).
Get all products updated at or before the given date (Y-m-d H:i:s).
Whether to include discountprice for the products
If given, only get products that has/has not syncproductdatawebshop set
Response
Ok
Example response
{
"content": [
{
"title": "Scott Scale 960",
"price": 100,
"pricewithoutvat": 80,
"costprice": 8.65,
"recommendedretailprice": 99.95,
"suppliers": [
{
"id": 1,
"name": "Johnson",
"email": "johnson@doe.com",
"address": "A place",
"city": "London",
"note": "Sells bike parts"
}
],
"tags": [
{
"position": 23.04
}
],
"updated_at": "2022-03-10 00:00:00"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.