Admin api products
List products
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
offset?integer
Pagination offset
Range
0 <= valuecount?integer
Number of results
Default
50Range
1 <= value <= 200minCreatedAt?string
Format
date-timemaxCreatedAt?string
Format
date-timeminUpdatedAt?string
Format
date-timemaxUpdatedAt?string
Format
date-timesort?string
Sort key, default to id
Default
"id"Value in
"createdAt" | "name" | "price" | "quantity" | "id"direction?string
Sort direction, default to asc
Default
"asc"Value in
"asc" | "desc"id?array<>
Filter by id(s)
name?array<>
Filter by name(s)
barcode?array<>
Filter by barcode(s)
externalId?array<>
Filter by externalId(s)
invalidThumbnail?boolean
Filter by invalidThumbnail
priceMin?number
Filter by price (NOTE: does not apply to store-specific prices)
Range
0 <= valuepriceMax?number
Filter by price (NOTE: does not apply to store-specific prices)
Range
0 <= valuequantityMin?integerDeprecated
Filter by quantity
Range
0 <= valuequantityMax?integerDeprecated
Filter by quantity
Range
0 <= valuecategory?array<>Deprecated
Filter by category(categories)
sku?array<>Deprecated
Filter by sku(s)
location?array<>Deprecated
Filter by location(s)
Response Body
application/json
application/json
curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/products?minCreatedAt=2024-09-22T00%3A00%3A00.000Z&maxCreatedAt=2024-09-29T00%3A00%3A00.000Z&minUpdatedAt=2024-09-23T00%3A00%3A00.000Z&maxUpdatedAt=2024-09-30T00%3A00%3A00.000Z"{
"products": [
{
"id": "string",
"name": "string",
"price": "string",
"barcode": "string",
"category": "string",
"thumbnail": "string",
"invalidThumbnail": true,
"productId": 0,
"quantity": 0,
"weight": 0,
"sku": "string",
"inventoryItemId": 0,
"externalId": "string",
"restricted": true,
"taxCode": "string",
"storePrices": [
{
"storeId": "string",
"productId": "string",
"price": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"variants": [
{
"id": 0,
"name": "string",
"thumbnail": "string",
"invalidThumbnail": true,
"externalId": "string",
"weight": "string",
"barcodes": [
{
"isDefault": true,
"barcode": "string"
}
],
"isDefault": true,
"productId": 0
}
]
}
],
"pagination": {
"previous": {
"offset": 0,
"count": 0
},
"next": {
"offset": 0,
"count": 0
}
}
}Empty
{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?