Authentication

Get your API key from the Integrations page in the API Access section.

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"

Endpoints

Fetches all completed scans.

Params:

• pageoptional int - the page to load, default 1

Uploads a new scan. Accepts a multipart form upload with the following params:

• filerequired file. Either a csv or xlsx file
• attributesJSON object, required. See schema below

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:

• per_pageoptional int - the number of products per page, default 50, max 100
• pageoptional int - the page of results, used to paginate, default 0
• tableTypeoptional enum - either products or errors, default products
• sortoptional string - column to sort on, ie profit or -profit for descending order
• filteroptional array of Filter items

Filter items are JSON objects with the following structure:

[
  {
    "name": "financials.profit",
    "operator": ">",
    "value": 5
  }
]

See the Filters section for complete documentation on available fields, operators, and nested field syntax.

Build filters to narrow down scan results. Select a field, operator, and value to generate the JSON filter object.

[
  {
    "name": "financials.roi",
    "operator": ">",
    "value": 0.25
  }
]

Notes

• Prices: Use dollars (e.g., 5 for $5.00)
• Percentages: Use decimals (e.g., 0.25 for 25% ROI)
• String comparisons are case-insensitive
• Historical periods: d30, d60, d90, d180

Deletes a scan by it's id.

Download a CSV file of your resulting data

Download a XLSX file of your resulting data

Download your scan results as a JSON file. Returns an array of product objects with all available data fields.

Request Format (optional - omit for all results)

Request Example

{
  "filter": [
    {
      "name": "profit",
      "operator": ">",
      "value": 500
    },
    {
      "name": "roi",
      "operator": ">=",
      "value": 30
    }
  ],
  "sort": "-profit",
  "page": 1,
  "per_page": 100
}

Response Format

Returns an array of product objects. All monetary values are in cents. Percentages (margin, ROI) are in basis points (30% = 3000).

[
  {
    "id": 12345,
    "asin": "B001GRWOZ0",
    "amazon_title": "Example Product Title",
    "brand": "Example Brand",
    "category": "Electronics",
    "rank": 5432,
    "buybox_price": 2999,
    "inputs": {
      "identifier": "123456789012",
      "cost": 1500,
      "stock": 100,
      "supplier_sku": "SKU-123",
      "supplier_pack_quantity": 1
    },
    "financials": {
      "profit": 850,
      "margin": 2833,
      "roi": 5667,
      "prep_cost": 50,
      "inbound_shipping": 100,
      "net_revenue": 2500
    },
    "amazon_fees": {
      "referral_fee": 450,
      "fba_fees": 354,
      "per_item_fee": null,
      "variable_closing_fee": null
    },
    "dimensions": {
      "package_dimensions": {
        "length": 10.5,
        "width": 8.0,
        "height": 3.0,
        "weight": 1.2
      },
      "item_dimensions": {
        "length": 9.0,
        "width": 7.0,
        "height": 2.5,
        "weight": 0.8
      }
    },
    "identifiers": {
      "upc": ["123456789012"],
      "ean": ["1234567890123"]
    },
    "size_tier": "Small Standard",
    "lowest_price_new_fba": 2899,
    "lowest_price_new_fbm": 2799,
    "new_fba_offers_count": 5,
    "new_fbm_offers_count": 12,
    "total_offers_count": 17,
    "competitive_sellers": 8,
    "is_hazmat": false,
    "is_meltable": false,
    "is_adult": false,
    "small_and_light_eligible": true,
    "inbound_eligibility": {
      "eligible": true,
      "updated_at": 1704067200,
      "ineligible_codes": []
    }
  }
]

Key Response Fields

Cancels an ongoing scan by its id.

Exports your scan results to Google Sheets. Requires the Google Sheets integration to be set up.

Convert Universal Product Codes (UPC) to find matching ASINs. Returns ASIN and other identifiers.

Note: Items without a matching ASIN will be omitted from the response.

Request Format

Request Example

{
  "marketplace": "US",
  "ids": [
    "0385086954",
    "0062316095"
  ]
}

Response Example (ASIN first, followed by other identifiers)

{
  "0385086954": [
    "B001GRWOZ0",
    "9780385086950"
  ],
  "0062316095": [
    "B00ABC1234",
    "9780062316098"
  ]
}

Convert European Article Numbers (EAN) to find matching ASINs. Returns ASIN and other identifiers.

Note: Items without a matching ASIN will be omitted from the response.

Request Format

Request Example

{
  "marketplace": "DE",
  "ids": [
    "9780385086950",
    "5901234123457"
  ]
}

Response Example (ASIN first, followed by other identifiers)

{
  "9780385086950": [
    "B001GRWOZ0",
    "0385086954"
  ],
  "5901234123457": [
    "B00XYZ789AB"
  ]
}

Convert International Standard Book Numbers (ISBN) to find matching ASINs. Returns ASIN and other identifiers.

Note: Items without a matching ASIN will be omitted from the response.

Request Format

Request Example

{
  "marketplace": "US",
  "ids": [
    "1501142976",
    "0062316095"
  ]
}

Response Example (ASIN first, followed by other identifiers)

{
  "1501142976": [
    "B00ISBN123",
    "9781501142970"
  ],
  "0062316095": [
    "B00ISBN456",
    "9780062316098"
  ]
}

Returns all the product identifiers (UPC, EAN, etc.) for the specified ASINss.

Request Format

{
  "marketplace": "US",
  "asins": [
    "B001GRWOZ0",
    "B001GRWOZ9"
  ]
}

Response Format

The response is a map where:

• Keys are the input ASINs
• Values are objects containing various identifier types (UPC, EAN, ISBN, etc.)
• ASINs without corresponding identifiers will not be included in the response

{
  "B001GRWOZ0": {
    "upc": ["0385086954"],
    "ean": ["9780385086950"],
    "isbn": ["1501142976"]
  },
  "B001GRWOZ9": {
    "upc": ["0385086954"],
    "ean": ["9780385086950"],
    "isbn": ["1501142976"]
  }
}

JSON Schema Reference

Complete reference for the JSON export response schema. Each product in the response array contains the following structure.

Product Object

inputs Object

financials Object

amazon_fees Object

dimensions Object

identifiers Object

inbound_eligibility Object