API Reference
Start typing to search…

List products

get
http://api-gateway-eu.phorest.com/third-party-api-server/api/business//branch//product

Get a list of products for the specified business id and branch id. List can be filtered by product type, DateTime of update, name and barcode and possibility to include archived products in the list or only to list archived, low in stock or out of stock products

Path Params
string
required
string
required
Query Params
string

type of product to filter by

string

query to search for a product by name or barcode

boolean

list only archived products

boolean

list only out of stock products

boolean

list only low in stock products

boolean

include archived products in the list

string

date-time from which the products has been updated onwards

string

date-time to which the products has been updated backwards

integer
Defaults to 20

number of products records to return, max is 100

integer
Defaults to 0

page number, default is 0 and is optional

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago