Inventory Export API Documentation
While we do not have any official API integrations outside of Amazon, we do have the below documentation which explains the authentication schema for SoStocked's API and contains details of extracting Customer Orders, Inventory and Warehouse reports.
Note: It is not officially available as a SoStocked product or service, and we do not provide support for it, but if you have someone technical that can work with this then they can create an API connection for you to download data.
You may also be interested in our Orders Export API documentation here.
Inventory Export API Documentation
This document outlines the details for exporting Inventory and Warehouse Reports via the API endpoint /product-inventories/export .
Endpoint
/product-inventories/export
Authorization
The Authorization header with a Bearer token is required for authenticating the API request. The bearer token is long-lived (1 year). The token can be extracted by inspecting the request. The Auth0Token header is not needed.
Request Details
Required Path Parameters
|
Parameter |
Description |
|---|---|
client_id |
Client identifier for authentication. |
client_secret |
Client secret key for authentication. |
account_id |
Account identifier for which orders are being exported. |
Required Headers
|
Header |
Description |
|---|---|
Authorization |
Bearer token for API authentication. Value: Bearer xxxx where xxxx is a long-lived token (1 year). The bearer token can be extracted by inspecting the request. |
Export Current View - Request Body
The request body must be obtained by inspecting the request made by the application. An example of the required body is provided below:
{
"page": 1,
"apply_custom_params": 1,
"view_id": 316582,
"columns": [
{
"id": "product_image",
"show": 1,
"params": [],
"text": "Product Image"
},
{
"id": "product_name",
"show": 1,
"params": [],
"text": "Product Name"
},
{
"id": "variations",
"show": 0,
"params": [],
"text": "Variations"
},
{
"id": "bundled",
"show": 0,
"params": [],
"text": "Number of items in bundle"
},
{
"id": "area_asins",
"show": 1,
"params": [],
"text": "ASIN"
},
{
"id": "area_skus",
"show": 1,
"params": [],
"text": "SKU"
},
{
"id": "area_fn_skus",
"show": 1,
"params": [],
"text": "FN SKU"
},
{
"id": "product_total_lost_sales",
"show": 0,
"params": [],
"text": "<span style=\"color: red; font-size:15px; font-weight: bold;\">2,456.41 </span> Total Lost Sales"
},
{
"id": "area_lost_sales",
"show": 0,
"params": [],
"text": "Lost Sales / Marketplace"
},
{
"id": "area_inv_stock",
"show": 1,
"params": [],
"text": "FBA Available Stock"
},
{
"id": "area_inv_reserved",
"show": 0,
"params": [],
"text": "FBA Reserved (FC's only)"
},
{
"id": "area_inv_stock_reserved",
"show": 0,
"params": [],
"text": "FBA Stock / Market or Region"
},
{
"id": "area_forecast_velocity_adj",
"show": 1,
"params": [],
"text": "Adj. Velocity"
},
{
"id": "area_forecast_order_by",
"show": 0,
"params": [],
"text": "Order By"
},
{
"id": "area_forecast_order_amount",
"show": 0,
"params": [],
"text": "Order Amount"
},
{
"id": "area_forecast_transfer_by",
"show": 0,
"params": [],
"text": "Transfer By"
},
{
"id": "area_forecast_transfer_amount",
"show": 0,
"params": [],
"text": "Transfer Amount"
},
{
"id": "product_inv_fba_stock",
"show": 0,
"params": [],
"text": "Total FBA Stock"
},
{
"id": "area_forecast_stock_remaining",
"show": 1,
"params": [],
"text": "Days of Supply on AMZ"
},
{
"id": "area_next_restock_days",
"show": 0,
"params": [],
"text": "# of Days until Restock @ AMZ"
},
{
"id": "warehouses",
"show": 0,
"params": [],
"text": "Warehouse Stock"
},
{
"id": "area_inv_total",
"show": 0,
"params": [],
"text": "FBA Stock + Inbound / Market or Region"
},
{
"id": "area_inv_inbound",
"show": 1,
"params": [],
"text": "Inbound to FBA"
},
{
"id": "area_next_restock_date",
"show": 1,
"params": [],
"text": "Date of Next AMZ Restock"
},
{
"id": "product_inv_fbm_stock",
"show": 1,
"params": [],
"text": "Total Warehouse Stock"
},
{
"id": "product_inv_fbm_inbound",
"show": 1,
"params": [],
"text": "Inbound to Warehouse"
},
{
"id": "product_inv_fbm_stock_inbound",
"show": 0,
"params": [],
"text": "Total Warehouse + Inbound"
},
{
"id": "product_inv_fbm_cartons",
"show": 0,
"params": [],
"text": "Total Warehouse + Inbound (cartons)"
},
{
"id": "ipi_max_ship_qty",
"show": 0,
"params": [],
"text": "Max Ship Qty"
},
{
"id": "product_inv_stock_total",
"show": 0,
"params": [],
"text": "Total in Stock (FBA + Warehouses)"
},
{
"id": "product_inv_total_stock_inbound",
"show": 0,
"params": [],
"text": "Total In Stock + Inbound"
},
{
"id": "area_stock_out_days_365",
"show": 0,
"params": [],
"text": "Stock Out Days (past 365)"
},
{
"id": "area_stock_out_percentage_365",
"show": 0,
"params": [],
"text": "Stock Out % (past 365)"
},
{
"id": "currency_code",
"show": 0,
"params": [],
"text": "Global Currency"
},
{
"id": "supplier_unit_price",
"show": 0,
"params": [],
"text": "Cost / Unit"
},
{
"id": "supplier_carton_price",
"show": 0,
"params": [],
"text": "Cost / Carton (aka Case)"
},
{
"id": "supplier_pallet_price",
"show": 0,
"params": [],
"text": "Cost / Pallet"
},
{
"id": "supplier_shipping_cost",
"show": 0,
"params": [],
"text": "Est. Shipping Cost / Unit"
},
{
"id": "supplier_cogs_per_unit",
"show": 0,
"params": [],
"text": "Landed Cost"
},
{
"id": "supplier_min_units_to_order",
"show": 0,
"params": [],
"text": "MOQ"
},
{
"id": "area_retail_price",
"show": 0,
"params": [],
"text": "Retail Price - Actual Currency"
},
{
"id": "area_converted_retail_price",
"show": 0,
"params": [],
"text": "Retail Price - Converted Currency"
},
{
"id": "cog_on_hand_less_shipping",
"show": 0,
"params": [],
"text": "COGS in Stock (less shipping costs)"
},
{
"id": "cog_value_less_shipping",
"show": 0,
"params": [],
"text": "COGS Value (less shipping)"
},
{
"id": "est_shipping_value",
"show": 0,
"params": [],
"text": "Est. Shipping Value"
},
{
"id": "total_value",
"show": 0,
"params": [],
"text": "Total COGs Value (In Stock + Inbound to WH and FBA)"
},
{
"id": "product_group_name",
"show": 0,
"params": [],
"text": "AMZ Category"
},
{
"id": "freight_forwarders",
"show": 0,
"params": [],
"text": "Freight Forwarder"
},
{
"id": "supplier_name",
"show": 0,
"params": [],
"text": "Supplier"
},
{
"id": "area_workflow_total_duration",
"show": 0,
"params": [],
"text": "Lead Time per Market"
},
{
"id": "workflow_total_duration",
"show": 0,
"params": [],
"text": "Default Lead Time"
},
{
"id": "product_upc_barcode",
"show": 0,
"params": [],
"text": "UPC"
},
{
"id": "product_part_number",
"show": 0,
"params": [],
"text": "Part Number"
},
{
"id": "supplier_manufacturer_part_number",
"show": 0,
"params": [],
"text": "MPN"
},
{
"id": "product_storage_type_id",
"show": 0,
"params": [],
"text": "Storage Type"
},
{
"id": "brands",
"show": 0,
"params": [],
"text": "Brand"
},
{
"id": "area_inv_missing",
"show": 0,
"params": [],
"text": "Missing FBA"
},
{
"id": "areas",
"show": 0,
"params": [],
"text": "Market / Region"
},
{
"id": "area_inv_updated_at",
"show": 0,
"params": [],
"text": "Last Change To FBA Inventory"
},
{
"id": "inbound_to_fba",
"show": 0,
"params": [],
"text": "Inbound to Amazon ETA"
},
{
"id": "inbound_to_fbm",
"show": 0,
"params": [],
"text": "Inbound to Warehouse or Prep Center ETA"
},
{
"id": "notes",
"show": 0,
"params": [],
"text": "Notes"
},
{
"id": "days_left_fba_inbound",
"show": 0,
"params": [],
"text": "Days Left (FBA + Inbound)"
},
{
"id": "days_left_fba_warehouse",
"show": 0,
"params": [],
"text": "Days Left (FBA + Warehouse) "
},
{
"id": "days_left_fba_warehouse_inbound",
"show": 0,
"params": [],
"text": "Days Left (FBA + WH + Inbound/On Order)"
},
{
"id": "days_left_warehouse",
"show": 0,
"params": [],
"text": "Days Left (Warehouses)"
},
{
"id": "total_warehouse_cartons",
"show": 0,
"params": [],
"text": "Total Warehouse Cartons"
},
{
"id": "total_stock_inbound_to_fba",
"show": 0,
"params": [],
"text": "Total In Stock + Inbound to FBA"
},
{
"id": "total_value_onhand_inbound_to_fba",
"show": 0,
"params": [],
"text": "Total COGs Value (In Stock + Inbound to FBA only)"
},
{
"id": "area_stock_out_days_next_year",
"show": 0,
"params": [],
"text": "Potential Stock Out Days"
},
{
"id": "area_next_stock_out_date_no_action",
"show": 0,
"params": [],
"text": "Next Stock Out Date"
},
{
"id": "product_units_per_carton",
"show": 0,
"params": [],
"text": "Units / Carton"
},
{
"id": "tags",
"show": 1,
"params": [],
"text": "Tags"
},
{
"id": "carton_dimensions",
"show": 0,
"params": [],
"text": "Carton Dimensions"
},
{
"id": "warehouse_location",
"show": 0,
"params": [],
"text": "Warehouse Location"
},
{
"id": "fba_days_remaining",
"show": 0,
"params": [],
"text": "FBA Days Remaining"
},
{
"id": "product_calculation_velocity_180",
"show": 0,
"params": [],
"text": "180 Day Velocity"
},
{
"id": "product_calculation_velocity_90",
"show": 0,
"params": [],
"text": "90 Day Velocity"
},
{
"id": "product_calculation_velocity_60",
"show": 0,
"params": [],
"text": "60 Day Velocity"
},
{
"id": "product_calculation_velocity_30",
"show": 0,
"params": [],
"text": "30 Day Velocity"
},
{
"id": "product_calculation_velocity_15",
"show": 0,
"params": [],
"text": "15 Day Velocity"
},
{
"id": "product_calculation_velocity_7",
"show": 0,
"params": [],
"text": "7 Day Velocity"
},
{
"id": "product_calculation_velocity_2",
"show": 0,
"params": [],
"text": "2 Day Velocity"
},
{
"id": "cbm_per_warehouse",
"show": 0,
"params": [],
"text": "CBM Per Warehouse"
},
{
"id": "warehouse_3pl_pallets",
"show": 0,
"params": [],
"text": "Pallets at Warehouse"
},
{
"id": "inbound_to_3pl",
"show": 0,
"params": [],
"text": "Inbound per Warehouse"
},
{
"id": "first_seen",
"show": 0,
"params": [],
"text": "First Seen"
},
{
"id": "cubic_feet",
"show": 0,
"params": [],
"text": "Cubic Feet Per Unit"
},
{
"id": "area_sale_price",
"show": 0,
"params": [],
"text": "Sale Price - Actual Currency"
},
{
"id": "area_converted_sale_price",
"show": 0,
"params": [],
"text": "Sale Price - Converted Currency"
},
{
"id": "product_total_cubic_feet",
"show": 0,
"params": [],
"text": "<span style=\"color: red; font-size:15px; font-weight: bold;\">41.75</span> Total Cubic Feet"
},
{
"id": "package_dimensions",
"show": 0,
"params": [],
"text": "Item Package Dimensions"
},
{
"id": "area_overstock_fees_monthly",
"show": 0,
"params": [],
"text": "Total Monthly FBA Storage Fees (365 Days)"
},
{
"id": "area_overstock_fees_monthly91",
"show": 0,
"params": [],
"text": "Overstock Storage Fees"
},
{
"id": "area_overstock_fees_aged",
"show": 0,
"params": [],
"text": "Aged Inventory Fees"
},
{
"id": "area_overstock_fees_aged_upcoming",
"show": 0,
"params": [],
"text": "<span style=\"color: red; font-size:15px; font-weight: bold;\">0.00 </span> Upcoming Aged Fees"
},
{
"id": "area_annual_sales",
"show": 0,
"params": [],
"text": "<span style=\"color: red; font-size:15px; font-weight: bold;\">0</span> Annual Sales (365 Days)"
},
{
"id": "product_total_overstock_fees",
"show": 0,
"params": [],
"text": "<span style=\"color: red; font-size:15px; font-weight: bold;\">2.30 </span> Total OverStock Fees"
},
{
"id": "product_total_annual_sales",
"show": 0,
"params": []
},
{
"id": "days_impending_low_inventory_fees",
"show": 0,
"params": [],
"text": "Impending Low Inventory"
},
{
"id": "days_incur_low_inventory_fees",
"show": 0,
"params": [],
"text": "Incurring Low-Inventory Fees"
},
{
"id": "parent_asin",
"show": 0,
"params": [],
"text": "Parent ASIN"
},
{
"id": "length_and_girth",
"show": 0,
"params": [],
"text": "Length & Girth"
},
{
"id": "product_size_tier",
"show": 0,
"params": [],
"text": "Product Size Tier"
},
{
"id": "area_pending_removal_qty",
"show": 0,
"params": [],
"text": "Pending Removals"
},
{
"id": "billable_weight",
"show": 0,
"params": [],
"text": "Billable Weight"
},
{
"id": "area_sales_rank",
"show": 0,
"params": [],
"text": "Sales Rank"
},
{
"id": "area_low_recovery_units",
"show": 0,
"params": [],
"text": "Low Recovery Value per unit"
},
{
"id": "area_avg_recovery_units",
"show": 0,
"params": [],
"text": "Avg Recovery Value per unit"
},
{
"id": "area_high_recovery_units",
"show": 0,
"params": [],
"text": "High Recovery Value per unit"
},
{
"id": "supplier_other_cost",
"show": 0,
"params": [],
"text": "Other Unit Costs"
},
{
"id": "units_shipped_t7",
"show": 0,
"params": [],
"text": "FBA Units Shipped 7d"
},
{
"id": "units_shipped_t30",
"show": 0,
"params": [],
"text": "FBA Units Shipped 30d"
},
{
"id": "units_shipped_t60",
"show": 0,
"params": [],
"text": "FBA Units Shipped 60d"
},
{
"id": "units_shipped_t90",
"show": 0,
"params": [],
"text": "FBA Units Shipped 90d"
}
],
"filters": [
{
"x": "AND",
"c": "status_id",
"o": "=",
"v": "1",
},
],
"group_by": "",
"order_by": "product_name",
"order_direction": "ASC",
"per_page": 250,
"term": "",
"export_type": "expanded", // use 'collapsed' for collapsed export
"with_inactive": 0,
"snapshot_date": ""
}
Inventory Snapshot - Request Body
Endpoint - POST
/inventories/export-snapshot
Use same payload as ‘Export Current View’ only keys you need to add/modify are
{
"export_type": "snapshot",
"with_inactive": 0, // 0 for active and 1 for all products
"snapshot_date": "2025-01-01", // date for snapshot
}
Export Inventory with Breakdown by Warehouses - Request Body
Endpoint - POST
/product-inventories/warehouse-breakdown-export
Use same payload as ‘Export Current View’ only keys you need to add/modify are
{
"export_type": "warehouse-breakdown"
}
The request body structure as detailed above is subject to change as the API evolves. It is crucial to inspect the request made by the application to ensure the correct body format is used. However, the authentication method via the Authorization header with a Bearer token will remain consistent.