PApaymongo
Inventory Items

Create an inventory item

Create a stock record for a variant at a warehouse. on_hand defaults to zero; a non-zero initial on_hand writes a correction movement.

post/v1/inventory_items

Request

  • Base URL
    https://inventories-api.paymongo.com
  • URL
    https://inventories-api.paymongo.com/v1/inventory_items
  • Auth
    HTTP basic

Request body

on_handinteger
variant_idstring required
warehouse_idstring required

Example request

{
  "on_hand": 100,
  "variant_id": "prdvar_abc123",
  "warehouse_id": "ww_abc123"
}

Response

OK

has_moreboolean

Example response

{
  "data": {
    "available": 90,
    "created_at": 1752000000,
    "held": 10,
    "id": "invitem_abc123",
    "livemode": true,
    "low_stock_threshold": 5,
    "on_hand": 100,
    "updated_at": 1752000000,
    "variant_id": "prdvar_abc123",
    "warehouse_id": "ww_abc123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.