latestOpenAPI 3.0.02026-08-105585620.8 KB
18e2f2e178dd
Ecommerce Platform Sync API
Get list of Sync Products
Returns list of Sync Product objects from your store.
get/sync/products
Query parameters
searchstring
Product search needle
offsetinteger
Result set offset
limitinteger
Number of items per page (max 100)
status'all' | 'synced' | 'unsynced' | 'ignored' | 'imported' | 'discontinued' | 'out_of_stock'
Parameter used to filter results by status/group of Sync Products
Headers
X-PF-Store-Idstring
Use this to specify which store you want to use (required only for account level token).
The store IDs can be retrieved with the Get basic information about stores endpoint.
Response
OK
Example response
{
"code": 200,
"paging": {
"total": 100,
"offset": 10,
"limit": 100
},
"result": [
{
"id": 13,
"external_id": "4235234213",
"name": "T-shirt",
"variants": 10,
"synced": 10,
"thumbnail": "http://your-domain.com/path/to/thumbnail.png",
"thumbnail_url": "https://your-domain.com/path/to/image.png"
}
]
}