Get Inventory Levels

Endpoint: GET /api/v1/inventory

Full URL: https://api.spreetaileu.com/api/api/v1/inventory

Retrieve current inventory levels for your account.

Authentication-Based Access

  • The inventory returned is automatically filtered based on your authenticated client
  • No additional parameters needed - your JWT token determines which inventory you can see
  • Each client has specific warehouse locations and SKU prefixes configured

Response Data

Returns comprehensive inventory information including:

  • Total inventory count across all SKUs
  • Number of unique SKUs
  • Detailed per-SKU information:
    • SKU/Part Number
    • Physical dimensions (Height, Width, Depth)
    • Weight
    • Retail price
    • Current stock level
    • In Order Book (allocated to orders)
    • Available (free stock)
    • Last update timestamp and operation

Use Cases

  • Monitor stock levels for reordering
  • Check product availability
  • Integrate with your inventory management system
  • Generate stock reports

Pagination

This endpoint supports efficient pagination by passing parameters directly to Linnworks:

  • Use page parameter to specify which page to retrieve (default: 1)
  • Use page_size parameter to control items per page (default: 25, max: 200)
  • Response includes pagination metadata (current_page, page_size, has_more, next_page)
  • Each location indicates if more data is available via has_more field

SKU Filter (optional)

  • Use the sku query parameter to fetch stock for specific SKUs only
  • Comma-separated list of client SKUs, case-insensitive, max 50 per request
  • Example: ?sku=ABC-123,XYZ-789
  • When provided, the response adds requested_sku_count and not_found_skus (any SKUs that did not resolve for your client)
  • When omitted, behavior is unchanged

Performance

  • Typical response time: 2-5 seconds per request
  • Pagination is handled by Linnworks API (very efficient)
  • Recommended: Start with page_size=25-50 for best performance
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number to retrieve (starts at 1)

integer
1 to 200
Defaults to 25

Number of SKUs to return per page (max 200)

string

Optional comma-separated list of client SKUs to filter the response (max 50, case-insensitive). When provided, only those SKUs are returned across all warehouse locations and the response includes requested_sku_count and not_found_skus (any SKUs that did not resolve for this client). Pagination still applies but is typically a no-op because the filtered set fits within one page. When omitted, behavior is unchanged.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json