Please note!
There will be some churn and backwards breaking changes here as we stabilize the API and smooth out the rough corners.
A few current rough edges:
Your API key should be passed through as a bearer token. So your Authorization header will contain a value of
Bearer: <YOUR TOKEN>
All requests should be made to
https://app.rocketsource.io
Example:
curl -H "Authorization: Bearer YOUR_TOKEN" "https://app.rocketsource.io/api/v3/scans"
Fetches all completed scans.
Params:
Uploads a new scan. Accepts a multipart form upload with the following params:
Attributes schema
{ // All values in the mapping object are nullable ints. The int values should // be the corresponding column number, 0-indexed. mapping: { id, // required cost, // required supplier_sku, supplier_image, supplier_pack_quantity, map, stock_quantity, custom_columns => [], // an array of any custom columns you want to pass through discount_per_product, }, options: { marketplace_id, // required - string - one of US, CA, MX, etc. Requires that your seller account have access to the given marketplace name, // required - string - a name for your scan discount_supplier, custom_columns, header, multipack_prep_cost => [ enabled, firstN, costForFirstN, costForRest, ], prep_cost, multipack_override, multipack_override_quantity, } }
Returns the result data for a given scan id.
Accepts JSON requests with the following params:
Filter items are JSON objects with the following structure:
{ "name": "profit", "operator": ">", "value": 10 }
Download a CSV file of your resulting data
Download a XLSX file of your resulting data
Exports your scan results to Google Sheets. Requires the Google Sheets integration to be set up.
Converts the given numeric identifiers (UPCs, EAN,s or ISBNs) to a list of ASINs.
Expects a JSON payload in the following format:
{ "marketplace": "US", "ids": [ "9781501142970", "9780385086950" ] }
Where marketplace is the ISO-8601 country code and ids is an array of strings representing the product identifiers you wish to convert to ASINs.
Notes
Returns the following JSON object, keyed by your ids with each value being an array of ASINs that are tied to that id.
{ "9780385086950": [ "0385086954", "B001GRWOZ0" ], "9781501142970": [ "1501142976" ] }