Procurement
Procurement API
The Procurement API allows apps to manage the supply chain, including suppliers, purchase orders, and multi-location inventory movements.
Scopes Required
This API requires the read:procurement scope for list/get operations and write:procurement for create/update operations.
Suppliers
Manage the vendors and manufacturers that supply products to the store.
List Suppliers
GET /api/apps/v1/suppliers
Create Supplier
POST /api/apps/v1/suppliers
Request Body:
name: (string, required) Supplier name.contact_name: (string)phone: (string)email: (string)address: (string)
Purchase Orders (PO)
Track the lifecycle of inventory orders from suppliers.
List Purchase Orders
GET /api/apps/v1/purchase-orders
Create Purchase Order
POST /api/apps/v1/purchase-orders
Request Body:
supplier_id: (integer, required)location_id: (integer, required)items: (array, required)sku_id: (integer)quantity: (integer)cost_price: (integer) Integer representing cents/paisa.
Mark as Ordered
POST /api/apps/v1/purchase-orders/:id/mark-ordered
Receive Items
POST /api/apps/v1/purchase-orders/:id/receive
Stock Transfers
Manage inventory movement between locations.
List Transfers
GET /api/apps/v1/transfers
Ship Transfer
POST /api/apps/v1/transfers/:id/ship
Complete Transfer
POST /api/apps/v1/transfers/:id/complete