Ordexs API v1 Get an API key

Inventory

Start a stock count

POSThttps://api.ordexs.com/v1/stock_counts

Opens a count sheet, like Count stock on the Inventory page: one line per tracked variant (or those matching filter and search), each with the quantity Ordexs expects. Fill it with POST /v1/stock_counts/{id}/lines, then apply or discard it.

Body

  • namestring

    up to 120 characters

  • filterstring

    One of all, low, out, reorder, courier, incoming

  • searchstring

    1–100 characters

Returns

201 Created · The new count sheet with the first page of its lines. StockCount

  • idstring

    starts with cnt_

  • objectstring

    always "stock_count"

  • namestring or null
  • statusstring

    One of open, applied, discarded

  • notestring or null
  • lines_totalinteger
  • lines_countedinteger
  • created_atstring

    ISO 8601 date-time, UTC

  • applied_atstring or null

    ISO 8601 date-time, UTC

  • livemodeboolean
  • linesarray of StockCountLines

    A page of lines (single-count answers only).

    9 child fields
    • variant_idstring
    • product_titlestring
    • variant_titlestring or null
    • skustring or null
    • barcodestring or null
    • expectedinteger

      Stock when the sheet was opened.

    • countedinteger or null

      What was counted. null until someone counts it.

    • currentinteger

      Stock right now (sales keep happening while you count).

    • varianceinteger or null

      counted - current: what applying will change.

  • lines_has_moreboolean
  • adjusted_variantsinteger

    On apply

  • adjusted_unitsinteger

    On apply

Errors

Every error has the same shape. This endpoint can answer with: