Almost all Scalefast GET endpoints have some parameters to filter the result.
You can, therefore, easily filter the result using &PARAMETER=VALUE query string parameters.
NOTE: See each endpoints reference to see possible parameters.
Example: Get only physical products
curl --request GET \
--url 'https://api.scalefast.com/products?clientID=CLIENT_ID&access_token=ACCESS_TOKEN&type=PHYSICAL' \
--header 'accept: application/json'
If a non existing parameter is set the API will return an error like this:
Example: Get all products sending a parameter that does not exist
curl --request GET \
--url 'https://api.scalefast.com/products?clientID=CLIENT_ID&access_token=ACCESS_TOKEN&wrong_parameter=WRONG_VALUE' \
--header 'accept: application/json'
{
"result": {
"status": "ERROR",
"errcode": "-23",
"msg": "The parameter wrong_parameter must not be present in this request"
}
}
Some GET endpoints have a parameter called fields, this is a special parameter that filter the returned fields per resource.
Example: Get only productID and refID of all products
{
"result": {
"status": "OK",
"errcode": "0",
"msg": ""
},
"response_data": {
"count": "3423",
"objects": [
{
"productID": "...",
"refID": "..."
},
{
"productID": "...",
"refID": "..."
},
...
]
}
}