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
interface UploadRequest { mapping: { // All values in the mapping object are column numbers, 0-indexed. id: number;, cost: number;, supplier_sku?: number, supplier_image?: number, supplier_pack_quantity?: number, map?: number, stock_quantity?: number, // an array of any custom columns you want to pass through custom_columns: number[], discount_per_product?: number, }; options: { // one of "US", "CA", "DE", etc. Requires that your seller account have access to the given marketplace marketplace_id: string; // a name for your scan name: string; discount_supplier?: number; custom_columns?: string[]; header?: boolean; multipack_prep_cost?: { enabled: boolean; firstN: number; costForFirstN: number; costForRest: number; }; prep_cost?: number; multipack_override?: boolean; multipack_override_quantity?: number; pull_historical_data?: boolean; }; }
The most simple upload payload would look like the below JSON. This assumes that your identifiers are in the first column and your costs are in the second.
{ "mapping": { "id": 0, "cost": 1, }, "options": { "marketplace_id": "US", "name": "My Scan" } }
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 }
Deletes a scan by it's id.
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 between different product identifiers (UPC, EAN, ASIN, etc.)
Returns all the product identifiers (UPC, EAN, etc.) for the specified ASINss.
Request Format
Field | Type | Description | Constraints |
---|---|---|---|
marketplace | String | The marketplace code (e.g., "US", "UK", "CA") | Required |
asins | Array of Strings | List of ASINs to convert | Min: 1, Max: 1,000 items |
{ "marketplace": "US", "asins": [ "B001GRWOZ0", "B001GRWOZ9" ] }
Response Format
The response is a map where:
{ "B001GRWOZ0": { "upc": ["0385086954"], "ean": ["9780385086950"], "isbn": ["1501142976"] }, "B001GRWOZ9": { "upc": ["0385086954"], "ean": ["9780385086950"], "isbn": ["1501142976"] } }