Get Products
Return a list (or a subset) of Products the user has access to.
Verb | POST |
---|---|
Endpoint | {base-url}/products |
Max Page Size | 100 |
Request Body
{
"requestFilter": {
"organizationIds": [],
"productIds": []
},
"routeFilter": {
"isACommonProduct": null,
"includeDeleted": false
}
}
Filters Honored
- RequestFilter
- organizationIds
- productIds
- ProductsFilter
- isACommonProduct
- includeDeleted
Returns
On Success
The requested set of products.
Response Body
[
{
"id": 4079,
"manufacturer": "Acme Foods",
"brand": "Anvil Pork",
"name": "BBQ Pork Rinds",
"customData": null,
"size": 2.0,
"unitsForSize": "oz.",
"container": "unknown",
"upc": null,
"productImage": null,
"nutritionImage": null,
"cost": 0.0,
"defaultPrice": 0.0,
"isACommonProduct": true,
"vendSize": "unknown",
"calories": 3720,
"productGroup": "Other",
"organizationId": 0,
"number": null,
"customField1": null,
"customField2": null,
"customField3": null,
"customField4": null,
"customField5": null,
"customField6": null,
"customField7": null,
"customField8": null,
"customField9": null,
"customField10": null,
"customField11": null,
"customField12": null,
"customField13": null,
"customField14": null,
"customField15": null,
"isDeleted": false
}
]