Ordexs API v1 Get an API key

Inventory

Receive an incoming delivery

POSThttps://api.ordexs.com/v1/variants/{variant_id}/receive_incoming

The delivery set on the variant (incoming) has arrived: its units move into stock as a restock, and incoming returns to 0. Units already promised to pre-orders are covered first, as in the dashboard.

Path parameters

  • variant_idstringRequired

    starts with var_

Returns

200 OK · The variant's new stock picture. InventoryLevel

  • objectstring

    always "inventory_level"

  • variant_idstring

    starts with var_

  • product_idstring

    starts with prod_

  • product_titlestring
  • variant_titlestring or null
  • skustring or null
  • barcodestring or null
  • trackedboolean

    Whether the store counts this variant's stock. Untracked variants are always orderable.

  • availableinteger

    What can still be ordered. Negative when pre-orders or back-orders took more than the shelf holds.

  • committedinteger

    Units taken by orders not yet with a courier.

  • on_handinteger

    available + committed: what should physically be in the store.

  • incominginteger

    Units of a delivery on its way.

  • incoming_due_atstring or null

    ISO 8601 date-time, UTC

  • at_courierinteger

    Units the merchant keeps at the courier's warehouse.

  • on_shelfinteger

    Available units in the merchant's own place.

  • low_stockboolean

    At or under the store's alert level.

  • allow_backorderboolean
  • allow_preorderboolean
  • sold_30dinteger

    Units sold in the last 30 days.

  • days_of_covernumber or null

    How many days the stock lasts at the 30-day pace. null when nothing sold.

  • livemodeboolean

Errors

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