Get supportRequest a Demo
  • Get Started
    • Welcome
  • Guides
    • Authentication
    • Patient Management
    • Order Management
    • Device Management
    • Webhook Management
  • Webhooks
  • API Reference
  • Resources
    • OpenAPI Spec
    • Mobile SDK
LogoLogo
Get supportRequest a Demo
API ReferenceProcurements

GET
/api/v3/procurement
GET
/api/v3/procurement
1curl https://app.impiloplatform.com/api/v3/procurement \
2 -H "Impilo-API-Key: <Impilo-API-Key>"
Try it
200example
1{
2 "content": [
3 {
4 "currentStatus": "received",
5 "procurementEvents": [
6 {
7 "eventTimestamp": "2024-07-04T00:00:00Z",
8 "name": "received"
9 }
10 ],
11 "procurementItems": [
12 {
13 "costPerItem": 12.34,
14 "item": {
15 "id": 791,
16 "manufacturer": {
17 "id": 2,
18 "name": "Custom Manufacturer"
19 },
20 "model": "iBloodPressureMonitor123",
21 "name": "Blood Pressure Monitor",
22 "sku": "0000001"
23 },
24 "quantityApproved": 5,
25 "quantityRequested": 5
26 }
27 ],
28 "procurementType": "shippingNotice",
29 "id": 789
30 },
31 {
32 "currentStatus": "received",
33 "procurementEvents": [
34 {
35 "eventTimestamp": "2024-07-04T00:00:00Z",
36 "name": "received"
37 }
38 ],
39 "procurementItems": [
40 {
41 "costPerItem": 12.34,
42 "item": {
43 "id": 791,
44 "manufacturer": {
45 "id": 2,
46 "name": "Custom Manufacturer"
47 },
48 "model": "iBloodPressureMonitor123",
49 "name": "Blood Pressure Monitor",
50 "sku": "0000001"
51 },
52 "quantityApproved": 5,
53 "quantityRequested": 5
54 }
55 ],
56 "procurementType": "shippingNotice",
57 "id": 790
58 },
59 {
60 "currentStatus": "received",
61 "procurementEvents": [
62 {
63 "eventTimestamp": "2024-07-04T00:00:00Z",
64 "name": "received"
65 }
66 ],
67 "procurementItems": [
68 {
69 "costPerItem": 12.34,
70 "item": {
71 "id": 791,
72 "manufacturer": {
73 "id": 2,
74 "name": "Custom Manufacturer"
75 },
76 "model": "iBloodPressureMonitor123",
77 "name": "Blood Pressure Monitor",
78 "sku": "0000001"
79 },
80 "quantityApproved": 5,
81 "quantityRequested": 5
82 }
83 ],
84 "procurementType": "shippingNotice",
85 "id": 791
86 },
87 {
88 "currentStatus": "received",
89 "procurementEvents": [
90 {
91 "eventTimestamp": "2024-07-04T00:00:00Z",
92 "name": "received"
93 }
94 ],
95 "procurementItems": [
96 {
97 "costPerItem": 12.34,
98 "item": {
99 "id": 791,
100 "manufacturer": {
101 "id": 2,
102 "name": "Custom Manufacturer"
103 },
104 "model": "iBloodPressureMonitor123",
105 "name": "Blood Pressure Monitor",
106 "sku": "0000001"
107 },
108 "quantityApproved": 5,
109 "quantityRequested": 5
110 }
111 ],
112 "procurementType": "shippingNotice",
113 "id": 792
114 },
115 {
116 "currentStatus": "received",
117 "procurementEvents": [
118 {
119 "eventTimestamp": "2024-07-04T00:00:00Z",
120 "name": "received"
121 }
122 ],
123 "procurementItems": [
124 {
125 "costPerItem": 12.34,
126 "item": {
127 "id": 791,
128 "manufacturer": {
129 "id": 2,
130 "name": "Custom Manufacturer"
131 },
132 "model": "iBloodPressureMonitor123",
133 "name": "Blood Pressure Monitor",
134 "sku": "0000001"
135 },
136 "quantityApproved": 5,
137 "quantityRequested": 5
138 }
139 ],
140 "procurementType": "shippingNotice",
141 "id": 793
142 }
143 ],
144 "first": true,
145 "last": false,
146 "page": 1,
147 "size": 5,
148 "total": 10
149}
Was this page helpful?
Previous

List Procurements 1

Next
Built with
Lists procurements linked to the account requested in a paginated form.
List Procurements

Authentication

Impilo-API-Keystring
API Key authentication via header

Query parameters

pageintegerOptional
The page number of the content returned.
sizeintegerOptional
The size of the page of content returned.
sortDescendingbooleanOptional
True if the sort direction should be descending.
idlist of longsOptional
Lists only procurements with the IDs provided.

Response

OK
contentlist of objects or null
The content of the page, consisting of a list of objects.
firstboolean or null
True if this is the first page, false otherwise.
lastboolean or null
True if this is the last page, false otherwise.
pageinteger or null
The current page number. The first page has value 1.
sizeinteger or null
The current page size. Default 15, maximum 250.
totalinteger or null
The number of objects matching the request.
True if the sort direction should be descending.
Lists only procurements with the IDs provided.
OK