Sign in
InventoryOrders

Create an Inventory Order

This endpoint creates an inventory order for the given site.

post/inventory/orders

Request body

purchase_order_numberstring nullable required

The purchase order number for this inventory order.

supplier_idstring uuid required

Identifier of the supplier this order will be sent to. The supplier must belong to the same site as site_id; order line items can only reference inventory products that are linked to this supplier.

supplier_emailstring nullable required

The email address of the supplier for this inventory order.

site_idstring uuid required

Identifier of the site this inventory order is placed for. Goods will be received against this site's stock, and only users with access to this site can view or modify the order.

Example request

{
  "purchase_order_number": "PO123",
  "supplier_email": "orders@example.com"
}

Response

The inventory order was successfully retrieved

Example response

{
  "data": {
    "purchase_order_number": "PO123",
    "supplier_name": "Elemis",
    "supplier_email": "orders@example.com",
    "subtotal": 2000,
    "currency": "gbp",
    "item_count": 10,
    "created_at": "2024-06-01T12:00:00Z",
    "updated_at": "2024-06-01T12:00:00Z",
    "submitted_at": "2024-06-01T12:00:00Z",
    "last_submitted_at": "2024-06-02T12:00:00Z"
  }
}

Changes

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