Ordexs API v1 Get an API key

Inventory

List stock counts

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

Query parameters

  • limitinteger

    How many objects to return, 1–100. Default 25.

    1–100

  • cursorstring

    The next_cursor from the previous page. Repeat the same filters with it.

    up to 512 characters

  • statusstring

    One of open, applied, discarded

Returns

200 OK · A page of stock counts, newest first (without their lines). StockCountList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

    Pass as cursor to get the next page. null on the last page.

  • dataarray of StockCountsRequired
    14 child fields
    • 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: