Wholesale Inspector logo
Wholesale
Inspector

Introduction

The Wholesale Inspector API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

The Wholesale Inspector API uses access tokens to authenticate requests. You can view and manage your access tokens in the Integrations Dashboard.

Use your access token by setting it in the Authorization header as the Bearer value.

API requests without authentication will fail.

GET
/api/v2/progress
curl --request GET \
--url 'https://app.wholesaleinspector.com/api/v2/progress' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'

Files

Files are one of the cornerstones of Wholesale Inspector. Here you can upload a new file for analysis, view the progress of any files that are currently running, or pull data on your previously run files.

Endpoints
POST
/api/v2/file
GET
/api/v2/progress
GET
/api/v2/completed
GET
/api/v2/csv_results_url

Upload a file

Parameters

marketplace_id required

Which marketplace to run the analysis on. 1 for US, 6 for Canada, 11 for Mexico. UK + EU support coming soon

file[0] required

The CSV file to upload

Returns

200: Upload accepted
402: Inactive account (either trial expired or subscription ran out)
412: No file map found for this file. File maps aren't yet supported via the API. Upload the file once through the web UI to create a file map, then retry your upload via the API
422: File contains more than the 250k item limit
429: Maximum in progress files reached. Wait for some of your existing files to finish
500: Either no valid products were found or something went wrong
POST
/api/v2/file
curl --request POST \
--url 'https://app.wholesaleinspector.com/api/v2/file' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN' \
--form "file[0]=@/file.csv" \
--form "marketplace_id=1"
RESPONSE
{
  link: "string",
  status: "success"
}

Retrieve progress of files

Parameters

No parameters

Returns

200: An array of the progress for all of your running files
GET
/api/v2/progress
curl --request GET \
--url 'https://app.wholesaleinspector.com/api/v2/progress' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
{
  "data": [
    {
      "id": 1,
      "user_id": 123,
      "filename": "my supplier file.csv",
      "lines": 10000,
      "progress": 54.32,
      "speed": 0,
      "start": 0,
      "eta": 0,
      "upload_path": "string"
    }
  ],
  "meta": {
    "count": 0
  }
}

Retrieve completed files

Parameters

query optional

Optional filename search

page optional

Page to use for pagination

per_page optional

How many items to return

Returns

200: An array of your completed files
GET
/api/v2/completed
curl --request GET \
--url 'https://app.wholesaleinspector.com/api/v2/completed' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
{
  "current_page": 1,
  "first_page_url": "string",
  "from": 1,
  "last_page": 0,
  "last_page_url": "string",
  "next_page_url": "string",
  "path": "string",
  "per_page": 10,
  "prev_page_url": "string",
  "to": 10,
  "total": 30,
  "data": [
    {
      "id": 1,
      "name": "my supplier file.csv",
      "status": 0,
      "conversion_strategy_id": 0,
      "marketplace_id": 0,
      "lines": 0,
      "run_time": 0,
      "upload_location": "string",
      "csv_results": "string",
      "result_location": "string",
      "option": {
        "adjust_spm_for_amz": true,
        "amz_sell_rate": 0,
        "exclude_oos": true,
        "fallback_pack_quantity_from_title": true,
        "inbound_shipping_rate": 0,
        "lead_time_days": 0,
        "min_roi": 0,
        "pull_current_buybox": true,
        "pull_historical": true,
        "pull_reviews": true,
        "remove_duplicates": true,
        "run_with_no_cost": true,
        "show_unprofitable": true,
        "turn_rate_days": 0,
        "unit_prep_cost": 0,
        "upcharge": 0,
        "use_average_bsr": 0,
        "use_average_price": 0
      },
      "deleted_at": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

Download CSV results

The CSV results url can be pulled from the csv_results field in the /completed call. Issue a get request to download the resultant file.

NOTE:

- all monetary values are stored in cents. A profit of 123 in the results file will represent a profit of $1.23.

- all percentage values (roi, margin, etc) are stored in basis points. A roi of 1567 in the results file will represent a roi of 15.67%

Parameters

No parameters

Returns

200: A CSV file of the results.
GET
<csv_results_url>
curl --request GET \
--url '<csv_results_url>' \
--output my_csv_results.csv
RESPONSE
null

Products

Products are how you can sort and filter through the results of your file runs.

Endpoints
GET
/api/v2/file/:id/results

The product object

Attributes

amazon_title
string
The listing title on Amazon.
asin
string
The Amazon Standard Identification Number. A unique, alphanumeric string used to identify products on Amazon.
total_cost
number
The total cost you can expect to pay to purchase one unit on Amazon. Typically this value will be equal to your Cost, but will differ if the Supplier Pack Quantity or Amazon Pack Quantity are not both set to 1 (typically in the case of multipacks)
buybox_price
number
The current price the product is selling at
average_buybox_price_(30d)
number
The average price the product has been selling at over the past 30 days
profit
number
The estimated profit using either the current or historical price, depending on your Use Average Price option
roi
number
The estimated Return on Investment at the current selling price
margin
number
The estimated margin at the current selling price
bsr
number
The current ranking of the product
average_bsr_(30d)
number
The average BSR over the past 30 days
sales_rank_drops_(30d)
number
The number of sales rank drops seen in the past 30 days. This number can generally be used as the minimum number of units that have sold during this period.
category
string
The category this product is in.
percentage_time_profitable_(30d)
number
The percentage of the time, over the past 30 days, that the product has been selling profitably
percentage_time_roi_>=_15%_(30d)
number
The percentage of time, over the past 30 days, that the product has been selling at an ROI greater than or equal to 15%
number_of_sellers
number
The number of sellers currently selling this item
amazon_in_stock_rate_(30d)
number
The percentage of the time, over the past 30 days, that Amazon has been in stock
estimated_sales_per_month
number
The estimated number of units sold per month
competitive_sellers
number
The number of sellers that are priced competitively. These are sellers that are priced close enough to the current Buybox price that Wholesale Inspector believes them to be eligible for the Buybox
share_of_units_per_month
number
The estimated number of units per month you will sell if you start selling this product
share_of_profit_per_month
number
The estimated total profit per month you will sell if you start selling this product and the current price remains the same

More Attributes

id
number
identifier
string
cost
number
supplier_sku
string
supplier_title
string
stock
number
map
number
custom1
string
custom2
string
custom3
string
supplier_discount
number
supplier_pack_quantity
number
amazon_pack_quantity
number
brand
string
color
string
size
string
ip_complaints
boolean
meltable
boolean
image
string
average_buybox_price_(60d)
number
average_buybox_price_(90d)
number
average_buybox_price_(180d)
number
lowest_fba
number
lowest_fbm
number
average_bsr_(60d)
number
average_bsr_(90d)
number
average_bsr_(180d)
number
lowest_bsr_(30d)
number
lowest_bsr_(60d)
number
lowest_bsr_(90d)
number
lowest_bsr_(180d)
number
sales_rank_drops_(60d)
number
sales_rank_drops_(90d)
number
sales_rank_drops_(180d)
number
is_top_level_category
boolean
percentage_time_profitable_(60d)
number
percentage_time_profitable_(90d)
number
percentage_time_profitable_(180d)
number
percentage_time_roi_>=_15%_(60d)
number
percentage_time_roi_>=_15%_(90d)
number
percentage_time_roi_>=_15%_(180d)
number
number_of_variations
number
parent_asin
string
amazon_in_stock_rate_(60d)
number
amazon_in_stock_rate_(90d)
number
amazon_only
number
share_of_sales_per_month
number
number_of_reviews
number
average_review
number
weight
number
length
number
height
number
width
number
size_tier
string
inbound_shipping
number
prep_cost
number
storage_fees
number
fba_fees
number
referral_fees
number
net_revenue
number
add_to_seller_central
string
flags
string
created_at
string
updated_at
string
mismatch
boolean
purchase_order_item_id
number
purchase_order_item_quantity
number
THE PRODUCT OBJECT
{
  "id": 67,
  "identifier": "799872818010",
  "cost": 4.95,
  "supplier_sku": "",
  "supplier_title": "Munio Self Defense Keychain Butterfly Glass",
  "stock": 0,
  "map": 9.95,
  "custom1": "",
  "custom2": "",
  "custom3": "",
  "supplier_discount": 0,
  "supplier_pack_quantity": 1,
  "amazon_pack_quantity": 1,
  "brand": "MUNIO",
  "color": "Butterfly Glass Turquoise",
  "size": "One Size",
  "ip_complaints": 0,
  "meltable": 0,
  "image": "https://m.media-amazon.com/images/I/51lwS8jWBQL._SL500_.jpg",
  "amazon_title": "MUNIO Self Defense Kubaton Keychain with Ebook (Butterfly Glass)",
  "asin": "B00FPOTVHE",
  "total_cost": 4.95,
  "buybox_price": 9.94,
  "average_buybox_price_(30d)": 9.95,
  "average_buybox_price_(60d)": 9.95,
  "average_buybox_price_(90d)": 9.95,
  "average_buybox_price_(180d)": 9.95,
  "lowest_fba": 9.95,
  "lowest_fbm": -1,
  "profit": 0.6,
  "roi": 12.06,
  "margin": 6.01,
  "bsr": 204584,
  "average_bsr_(30d)": 199749,
  "average_bsr_(60d)": 109509,
  "average_bsr_(90d)": 78817,
  "average_bsr_(180d)": 45250,
  "lowest_bsr_(30d)": 17529,
  "lowest_bsr_(60d)": 14625,
  "lowest_bsr_(90d)": 10881,
  "lowest_bsr_(180d)": 5125,
  "sales_rank_drops_(30d)": 19,
  "sales_rank_drops_(60d)": 0,
  "sales_rank_drops_(90d)": 59,
  "sales_rank_drops_(180d)": 163,
  "category": "Clothing, Shoes & Jewelry",
  "is_top_level_category": 1,
  "percentage_time_profitable_(30d)": 1,
  "percentage_time_profitable_(60d)": 1,
  "percentage_time_profitable_(90d)": 1,
  "percentage_time_profitable_(180d)": 1,
  "percentage_time_roi_>=_15%_(30d)": 0,
  "percentage_time_roi_>=_15%_(60d)": 0,
  "percentage_time_roi_>=_15%_(90d)": 0,
  "percentage_time_roi_>=_15%_(180d)": 0,
  "buybox_seller": "",
  "number_of_variations": 1,
  "parent_asin": "",
  "number_of_sellers": 1,
  "amazon_in_stock_rate_(30d)": 0,
  "amazon_in_stock_rate_(60d)": 0,
  "amazon_in_stock_rate_(90d)": 0,
  "amazon_only": 0,
  "estimated_sales_per_month": 60,
  "competitive_sellers": 1,
  "share_of_units_per_month": 30,
  "share_of_sales_per_month": 298.2,
  "share_of_profit_per_month": 17.91,
  "number_of_reviews": 386,
  "average_review": 4.4,
  "weight": 0.05,
  "length": 5,
  "height": 0.5,
  "width": 3.2,
  "size_tier": "Small Standard",
  "inbound_shipping": 0,
  "prep_cost": 0,
  "storage_fees": 0,
  "fba_fees": 2.7,
  "referral_fees": 1.69,
  "net_revenue": 5.55,
  "add_to_seller_central": "https://sellercentral.amazon.com/abis/Display/ItemSelected?asin=B00FPOTVHE",
  "flags": "",
  "created_at": "2021-08-18 08:00:32",
  "updated_at": "2021-08-18 08:00:32",
  "mismatch": null,
  "purchase_order_item_id": null,
  "purchase_order_item_quantity": null
}

List all products

List all products in a file run

Parameters

sort optional

The field to sort on. Defaults to ascending order. Prefix with "-" to sort in descending order ("-profit" to sort by profit in descending order, "profit" to sort by profit in ascending order).

page optional

Page to use for pagination

filters optional

Filters to use. A hash of objects, keyed by the field name, containing the operator and it's value.

Operators can be >, >=, <, <=, =, or !=. Up to two operators can be specified per field. They will be

combined with an AND clause.

Example: {"profit": {">=": 1.00}} -> only show products with a profit greater than or equal to $1.00

Example: {"profit": {">": 1.00, "<":10.00}} -> only show products with a profit greater than $1.00 and less than $10.00

Returns

200: Success
GET
/api/v2/file/:id/results
curl --request GET \
--url 'https://app.wholesaleinspector.com/api/v2/file/123/results' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
{
    "data": [
        {
            "id": 18,
            "identifier": "796430380002",
            "cost": 95.96,
            "supplier_sku": "",
            "supplier_title": "TASER Strikelight Flashlight Stun Gun",
            "stock": 30,
            "map": 129.99,
            "custom1": "",
            "custom2": "",
            "custom3": "",
            "supplier_discount": 0,
            "supplier_pack_quantity": 1,
            "amazon_pack_quantity": 1,
            "brand": "Taser",
            "color": "Black",
            "size": "Small",
            "ip_complaints": 0,
            "meltable": 0,
            "image": "https://m.media-amazon.com/images/I/31KJmhg-WGL._SL500_.jpg",
            "amazon_title": "TASER StrikeLight Rechargeable Self-Defense Flashlight Stun Baton",
            "asin": "B00DUZ0UNE",
            "total_cost": 95.96,
            "buybox_price": 130,
            "average_buybox_price_(30d)": 130,
            "average_buybox_price_(60d)": 129.99,
            "average_buybox_price_(90d)": 130,
            "average_buybox_price_(180d)": 130,
            "lowest_fba": -1,
            "lowest_fbm": -1,
            "profit": 9.44,
            "roi": 9.84,
            "margin": 7.26,
            "bsr": 99079,
            "average_bsr_(30d)": 73793,
            "average_bsr_(60d)": 79372,
            "average_bsr_(90d)": 83650,
            "average_bsr_(180d)": 84908,
            "lowest_bsr_(30d)": 31348,
            "lowest_bsr_(60d)": 31348,
            "lowest_bsr_(90d)": 31348,
            "lowest_bsr_(180d)": 31348,
            "sales_rank_drops_(30d)": 57,
            "sales_rank_drops_(60d)": 0,
            "sales_rank_drops_(90d)": 163,
            "sales_rank_drops_(180d)": 275,
            "category": "Sports & Outdoors",
            "is_top_level_category": 1,
            "percentage_time_profitable_(30d)": 1,
            "percentage_time_profitable_(60d)": 1,
            "percentage_time_profitable_(90d)": 1,
            "percentage_time_profitable_(180d)": 0.98,
            "percentage_time_roi_>=_15%_(30d)": 0,
            "percentage_time_roi_>=_15%_(60d)": 0,
            "percentage_time_roi_>=_15%_(90d)": 0,
            "percentage_time_roi_>=_15%_(180d)": 0,
            "buybox_seller": "",
            "number_of_variations": 1,
            "parent_asin": "",
            "number_of_sellers": 1,
            "amazon_in_stock_rate_(30d)": 0,
            "amazon_in_stock_rate_(60d)": 0,
            "amazon_in_stock_rate_(90d)": 0,
            "amazon_only": 0,
            "estimated_sales_per_month": 60,
            "competitive_sellers": 0,
            "share_of_units_per_month": 60,
            "share_of_sales_per_month": 7800,
            "share_of_profit_per_month": 566.59,
            "number_of_reviews": 0,
            "average_review": 0,
            "weight": 1.15,
            "length": 11.3,
            "height": 1.6,
            "width": 5.1,
            "size_tier": "Large Standard",
            "inbound_shipping": 0,
            "prep_cost": 0,
            "storage_fees": 0.04,
            "fba_fees": 5.06,
            "referral_fees": 19.5,
            "net_revenue": 105.44,
            "add_to_seller_central": "https://sellercentral.amazon.com/abis/Display/ItemSelected?asin=B00DUZ0UNE",
            "flags": "",
            "created_at": "2021-08-18 08:00:32",
            "updated_at": "2021-08-18 08:00:32",
            "mismatch": null,
            "purchase_order_item_id": null,
            "purchase_order_item_quantity": null
        },
        {
            "id": 67,
            "identifier": "799872818010",
            "cost": 4.95,
            "supplier_sku": "",
            "supplier_title": "Munio Self Defense Keychain Butterfly Glass",
            "stock": 0,
            "map": 9.95,
            "custom1": "",
            "custom2": "",
            "custom3": "",
            "supplier_discount": 0,
            "supplier_pack_quantity": 1,
            "amazon_pack_quantity": 1,
            "brand": "MUNIO",
            "color": "Butterfly Glass Turquoise",
            "size": "One Size",
            "ip_complaints": 0,
            "meltable": 0,
            "image": "https://m.media-amazon.com/images/I/51lwS8jWBQL._SL500_.jpg",
            "amazon_title": "MUNIO Self Defense Kubaton Keychain with Ebook (Butterfly Glass)",
            "asin": "B00FPOTVHE",
            "total_cost": 4.95,
            "buybox_price": 9.94,
            "average_buybox_price_(30d)": 9.95,
            "average_buybox_price_(60d)": 9.95,
            "average_buybox_price_(90d)": 9.95,
            "average_buybox_price_(180d)": 9.95,
            "lowest_fba": 9.95,
            "lowest_fbm": -1,
            "profit": 0.6,
            "roi": 12.06,
            "margin": 6.01,
            "bsr": 204584,
            "average_bsr_(30d)": 199749,
            "average_bsr_(60d)": 109509,
            "average_bsr_(90d)": 78817,
            "average_bsr_(180d)": 45250,
            "lowest_bsr_(30d)": 17529,
            "lowest_bsr_(60d)": 14625,
            "lowest_bsr_(90d)": 10881,
            "lowest_bsr_(180d)": 5125,
            "sales_rank_drops_(30d)": 19,
            "sales_rank_drops_(60d)": 0,
            "sales_rank_drops_(90d)": 59,
            "sales_rank_drops_(180d)": 163,
            "category": "Clothing, Shoes & Jewelry",
            "is_top_level_category": 1,
            "percentage_time_profitable_(30d)": 1,
            "percentage_time_profitable_(60d)": 1,
            "percentage_time_profitable_(90d)": 1,
            "percentage_time_profitable_(180d)": 1,
            "percentage_time_roi_>=_15%_(30d)": 0,
            "percentage_time_roi_>=_15%_(60d)": 0,
            "percentage_time_roi_>=_15%_(90d)": 0,
            "percentage_time_roi_>=_15%_(180d)": 0,
            "buybox_seller": "",
            "number_of_variations": 1,
            "parent_asin": "",
            "number_of_sellers": 1,
            "amazon_in_stock_rate_(30d)": 0,
            "amazon_in_stock_rate_(60d)": 0,
            "amazon_in_stock_rate_(90d)": 0,
            "amazon_only": 0,
            "estimated_sales_per_month": 60,
            "competitive_sellers": 1,
            "share_of_units_per_month": 30,
            "share_of_sales_per_month": 298.2,
            "share_of_profit_per_month": 17.91,
            "number_of_reviews": 386,
            "average_review": 4.4,
            "weight": 0.05,
            "length": 5,
            "height": 0.5,
            "width": 3.2,
            "size_tier": "Small Standard",
            "inbound_shipping": 0,
            "prep_cost": 0,
            "storage_fees": 0,
            "fba_fees": 2.7,
            "referral_fees": 1.69,
            "net_revenue": 5.55,
            "add_to_seller_central": "https://sellercentral.amazon.com/abis/Display/ItemSelected?asin=B00FPOTVHE",
            "flags": "",
            "created_at": "2021-08-18 08:00:32",
            "updated_at": "2021-08-18 08:00:32",
            "mismatch": null,
            "purchase_order_item_id": null,
            "purchase_order_item_quantity": null
        },
    ],
    "links": {
        "first": "http://rocket-analysis.test/api/v2/file/3/results?page=1",
        "last": "http://rocket-analysis.test/api/v2/file/3/results?page=1",
        "prev": null,
        "next": null,
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://rocket-analysis.test/api/v2/file/3/results",
        "per_page": 100,
        "to": 2,
        "total": 2
    }
}

Brand Blocklist

The brand blocklist allows you to automatically remove products with certain brands from your results.

Endpoints
GET
/api/v2/brand-blocklist
POST
/api/v2/brand-blocklist
DELETE
/api/v2/brand-blocklist/:id

The blocked brand object

Attributes

id
integer
Unique identifier for the object
brand
string
The name of the brand

More Attributes

created_at
string
updated_at
string
THE BLOCKED BRAND OBJECT
{
    "id": 1,
    "brand": "Nike",
    "created_at": "2021-08-21T22:41:48.000000Z",
    "updated_at": "2021-08-21T22:41:48.000000Z",
},

List all blocked brands

A list of all your blocked brands

Parameters

query optional

Optional brand search

page optional

Page to use for pagination

per_page optional

How many items to return

Returns

200: Success
GET
/api/v2/brand-blocklist
curl --request GET \
--url 'https://app.wholesaleinspector.com/api/v2/brand-blocklist' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
{
  "data": [
    {
      "id": 1,
      "user_id": 2,
      "brand": "Nike",
      "created_at": "2021-08-21T20:20:13.000000Z",
      "updated_at": "2021-08-21T20:20:13.000000Z"
    },
    {
      "id": 2,
      "user_id": 2,
      "brand": "Adidas",
      "created_at": "2021-08-21T20:20:13.000000Z",
      "updated_at": "2021-08-21T20:20:13.000000Z"
    },
    {
      "id": 3,
      "user_id": 2,
      "brand": "test123",
      "created_at": "2021-08-21T20:20:20.000000Z",
      "updated_at": "2021-08-21T20:20:20.000000Z"
    },
    {
      "id": 5,
      "user_id": 2,
      "brand": "test12345",
      "created_at": "2021-08-21T20:20:24.000000Z",
      "updated_at": "2021-08-21T20:20:24.000000Z"
    },
    {
      "id": 6,
      "user_id": 2,
      "brand": "test1234",
      "created_at": "2021-08-21T20:36:38.000000Z",
      "updated_at": "2021-08-21T20:36:38.000000Z"
    }
  ],
  "links": {
       "first": "https://wholesaleinspector.com/api/v2/brand-blocklist?page=1",
       "last": "https://wholesaleinspector.com/api/v2/brand-blocklist?page=1",
       "prev": null,
       "next": null
  },
  "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 1,
      "path": "https://wholesaleinspector.com/api/v2/brand-blocklist",
      "per_page": 10,
      "to": 5,
      "total": 5
  }
}

Create a blocked brand

Creates one or more blocked brands

Parameters

brands required

An array of brands

Returns

200: Success
POST
/api/v2/brand-blocklist
curl --request POST \
--data '{"brands": ["Nike","Adidas"]}'
--url 'https://app.wholesaleinspector.com/api/v2/brand-blocklist' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
[]

Delete a blocked brand

Deletes a blocked brand

Parameters

No parameters

Returns

200: Success
DELETE
/api/v2/brand-blocklist/:id
curl --request DELETE \
--url 'https://app.wholesaleinspector.com/api/v2/brand-blocklist/123' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
[]

Asin Blocklist

The asin blocklist allows you to automatically remove products with certain asins from your results.

Endpoints
GET
/api/v2/asin-blocklist
POST
/api/v2/asin-blocklist
DELETE
/api/v2/asin-blocklist/:id

The blocked asin object

Attributes

id
integer
Unique identifier for the object
asin
string
ASIN of the product
marketplace
string
The two character, ISO-3611 country code ("US", "CA", etc)

More Attributes

created_at
string
updated_at
string
THE BLOCKED ASIN OBJECT
{
    "id": 1,
    "asin": "ASINASIN10",
    "marketplace": "US"
    "created_at": "2021-08-21T22:41:48.000000Z",
    "updated_at": "2021-08-21T22:41:48.000000Z",
},

List all blocked asins

A list of all your blocked asin

Parameters

marketplace required

The ISO-3166 two-character country code. Either US, CA, or MX at this time.

query optional

Optional asin search

page optional

Page to use for pagination

per_page optional

How many items to return

Returns

200: Success
GET
/api/v2/asin-blocklist
curl --request GET \
--url 'https://app.wholesaleinspector.com/api/v2/asin-blocklist' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
{
    "data": [
        {
            "id": 1,
            "asin": "ASINASIN10",
            "marketplace": "US"
            "created_at": "2021-08-21T22:41:48.000000Z",
            "updated_at": "2021-08-21T22:41:48.000000Z",
        },
        {
            "id": 2,
            "asin": "ASINASIN20",
            "marketplace": "US"
            "created_at": "2021-08-21T22:41:48.000000Z",
            "updated_at": "2021-08-21T22:41:48.000000Z",
        }
    ],
    "links": {
        "first": "https://wholesaleinspector.com/api/v2/asin-blocklist?page=1",
        "last": "https://wholesaleinspector.com/api/v2/asin-blocklist?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://wholesaleinspector.com/api/v2/asin-blocklist",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Create a blocked asin

Creates one or more blocked asins

Parameters

marketplace required

The ISO-3166 two-character country code. Either US, CA, or MX at this time.

asins required

An array of asins

Returns

200: Success
POST
/api/v2/asin-blocklist
curl --request POST \
--data '{"marketplace": "US", "asins": ["ASINASIN10","ASINASIN10"]}'
--url 'https://app.wholesaleinspector.com/api/v2/asin-blocklist' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
[]

Delete a blocked asin

Deletes a blocked asin

Parameters

No parameters

Returns

200: Success
DELETE
/api/v2/asin-blocklist/:id
curl --request DELETE \
--url 'https://app.wholesaleinspector.com/api/v2/asin-blocklist/123' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
[]

Multipacks

Multipack corrections serve as overrides that Wholesale Inspector will always use as the Amazon pack quantity any time the asin is enncountered in your account.

Endpoints
GET
/api/v2/multipacks
POST
/api/v2/multipacks
DELETE
/api/v2/multipacks/:id

The multipack object

Attributes

id
integer
Unique identifier for the object
asin
string
ASIN of the product
pack_quantity
integer
The multipack quantity for the product
marketplace
string
The two character, ISO-3611 country code ("US", "CA", etc)

More Attributes

created_at
string
updated_at
string
THE MULTIPACK OBJECT
{
    "id": 1,
    "asin": "ASINASIN10",
    "pack_quantity": 2,
    "marketplace": "US"
    "created_at": "2021-08-21T22:41:48.000000Z",
    "updated_at": "2021-08-21T22:41:48.000000Z",
},

List all multipacks

List all multipack corrections

Parameters

marketplace required

The ISO-3166 two-character country code. Either US, CA, or MX at this time.

query optional

Optional asin search

page optional

Page to use for pagination

per_page optional

How many items to return

Returns

200: Success
GET
/api/v2/multipacks
curl --request GET \
--url 'https://app.wholesaleinspector.com/api/v2/multipacks' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
{
    "data": [
        {
            "id": 1,
            "asin": "ASINASIN10",
            "pack_quantity": 2,
            "marketplace": "US"
            "created_at": "2021-08-21T22:41:48.000000Z",
            "updated_at": "2021-08-21T22:41:48.000000Z",
        },
        {
            "id": 2,
            "asin": "ASINASIN20",
            "pack_quantity": 3,
            "marketplace": "US"
            "created_at": "2021-08-21T22:41:48.000000Z",
            "updated_at": "2021-08-21T22:41:48.000000Z",
        }
    ],
    "links": {
        "first": "https://wholesaleinspector.com/api/v2/multipacks?page=1",
        "last": "https://wholesaleinspector.com/api/v2/multipacks?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://wholesaleinspector.com/api/v2/multipacks",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Create a multipack

Creates a multipack correction.

Multipack corrections can be added in bulk. Limit 100 per request.

Create requests for existing marketplace and asin combinations will update the pack quantity.

Parameters

marketplace required

The ISO-3166 two-character country code. Either US, CA, or MX at this time.

multipacks required

Multipacks to create. An array of objects containing asin and pack_quantity attributes.

Returns

200: Success
POST
/api/v2/multipacks
curl --request POST \
--data '{"marketplace": "US", "multipacks": [{"asin": "ASINASIN10", "pack_quantity": 2}, {"asin": "ASINASIN10", "pack_quantity": 3}]}'
--url 'https://app.wholesaleinspector.com/api/v2/multipacks' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
[]

Delete a multipack

Delete a multipack correction

Parameters

No parameters

Returns

200: Success
DELETE
/api/v2/multipacks/:id
curl --request DELETE \
--url 'https://app.wholesaleinspector.com/api/v2/multipacks/123' \
--header 'Authorization: Bearer $YOUR_ACCESS_TOKEN'
RESPONSE
[]