V1 APIs Products
Use the Omnivore V1 API to download product feeds.
This resource is for existing V1 API customers, if you're not using our APIs yet, please use the Omnivore V2 APIs.
Download the latest product feed for the specified retailer and marketplace.
Request
Parameters
$id - unique retailer ID
$marketplace - unique marketplace ID
Example request
Not applicable
Example URL
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/products/ebay
Response
Permitted response codes
GET: 200 OK, 404 Not found (e.g. bad retailer ID)
POST: 405 Method Not Allowed
PUT: 405 Method Not Allowed
DELETE: 405 Method Not Allowed
Example response
See Product Feed payload
v1/retailers/$id/jobs/all_products
Upload a full product feed for the specified retailer. NOTE: this will erase all products previously uploaded.
Request
Parameters
$id - unique retailer ID
Example request
See Product Feed payload
Example URL
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/all_products
Response
Permitted response codes
GET: 405 Method Not Allowed
POST: 202 OK, 404 Not found (e.g. bad retailer ID), 403 Forbidden (if more than 15 uploads are already queued for this retailer), 503 Service Unavailable (if system failed to store feed file, safe to retry)
PUT: 405 Method Not Allowed
DELETE: 405 Method Not Allowed
Example response
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status
v1/retailers/$id/jobs/products
Upload a partial/delta product feed for the specified retailer. Previously uploaded products will NOT be purged by this call.
Request
Parameters
$id - unique retailer ID
Example request
See Product Feed payload
Example URL
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/products
Response
Permitted response codes
GET: 405 Method Not Allowed
POST: 202 OK, 404 Not found (e.g. bad retailer ID), 403 Forbidden (if more than 15 uploads are already queued for this retailer), 503 Service Unavailable (if system failed to store feed file, safe to retry)
PUT: 405 Method Not Allowed
DELETE: 405 Method Not Allowed
Example response
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status
v1/retailers/$id/jobs/product_inventory
Upload an inventory feed for the specified retailer. Previously uploaded products will NOT be purged by this call.
Request
Parameters
$id - unique retailer ID
Example request
See Product Feed payload
Example URL
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/product_inventory
Response
Permitted response codes
GET: 405 Method Not Allowed
POST: 202 OK, 404 Not found (e.g. bad retailer ID), 403 Forbidden (if more than 15 uploads are already queued for this retailer), 503 Service Unavailable (if system failed to store feed file, safe to retry)
PUT: 405 Method Not Allowed
DELETE: 405 Method Not Allowed
Example response
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status
/v1/retailers/$id/jobs/$job/status
Get the status of the upload job returned in the response body of one of the calls above.
Request
Parameters
$id - unique retailer ID
$job - unique job ID
Example request
Not applicable
Example URL
https://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status
Response
Permitted response codes
GET: 200 OK, 404 Not found (e.g. bad retailer ID)
POST: 405 Method Not Allowed
PUT: 405 Method Not Allowed
DELETE: 405 Method Not Allowed
Example response
See Product Feed payload
Inventory Feed Payload
The following represents an inventory update.
Product Feed Payload
The following represents a product in the Omnivore XML format.