List Orders

GET

Query parameters

pageintegerOptional

sizeintegerOptional

patientIdlongOptional

Response

This endpoint returns an object.

contentlist of objectsOptional

The content of the page, consisting of a list of objects.

pageintegerOptional

The current page number. The first page has value 1.

sizeintegerOptional

The current page size. Default 15, maximum 250.

totalintegerOptional

The number of objects matching the request.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

GET

1 curl https://app.impiloplatform.com/api/v3/order \
2      -H "Impilo-API-Key: <apiKey>"

200Retrieved

1 {
2   "content": [
3     {
4       "id": 1000000,
5       "externalOrderIds": [
6         "externalOrderIds"
7       ],
8       "patient": {
9         "firstName": "John",
10         "lastName": "Doe",
11         "address": {
12           "lineOne": "lineOne",
13           "city": "city",
14           "state": "state",
15           "zipCode": "zipCode",
16           "country": "country"
17         },
18         "id": 1,
19         "externalIdentifier": "1234abcd",
20         "dateOfBirth": "1980-01-01",
21         "email": "john.doe@example.com",
22         "phoneNumber": "+1234567890",
23         "archived": true
24       },
25       "site": {
26         "id": 1
27       },
28       "currentStatus": "availableForPickup",
29       "orderItems": [
30         {}
31       ],
32       "orderKits": [
33         {}
34       ],
35       "orderEvents": [
36         {}
37       ],
38       "trackingNumbers": [
39         {}
40       ],
41       "devices": [
42         {
43           "id": 1,
44           "currentPatient": {
45             "firstName": "John",
46             "lastName": "Doe",
47             "address": {
48               "lineOne": "lineOne",
49               "city": "city",
50               "state": "state",
51               "zipCode": "zipCode",
52               "country": "country"
53             },
54             "id": 1,
55             "externalIdentifier": "1234abcd",
56             "dateOfBirth": "1980-01-01",
57             "email": "john.doe@example.com",
58             "phoneNumber": "+1234567890",
59             "archived": true
60           }
61         }
62       ],
63       "packedKits": [
64         {}
65       ],
66       "shippingOption": "standard"
67     }
68   ],
69   "page": 1,
70   "size": 1,
71   "total": 1,
72   "first": true,
73   "last": true
74 }

Built with

1	curl https://app.impiloplatform.com/api/v3/order \
2	-H "Impilo-API-Key: <apiKey>"

1	{
2	"content": [
3	{
4	"id": 1000000,
5	"externalOrderIds": [
6	"externalOrderIds"
7	],
8	"patient": {
9	"firstName": "John",
10	"lastName": "Doe",
11	"address": {
12	"lineOne": "lineOne",
13	"city": "city",
14	"state": "state",
15	"zipCode": "zipCode",
16	"country": "country"
17	},
18	"id": 1,
19	"externalIdentifier": "1234abcd",
20	"dateOfBirth": "1980-01-01",
21	"email": "john.doe@example.com",
22	"phoneNumber": "+1234567890",
23	"archived": true
24	},
25	"site": {
26	"id": 1
27	},
28	"currentStatus": "availableForPickup",
29	"orderItems": [
30	{}
31	],
32	"orderKits": [
33	{}
34	],
35	"orderEvents": [
36	{}
37	],
38	"trackingNumbers": [
39	{}
40	],
41	"devices": [
42	{
43	"id": 1,
44	"currentPatient": {
45	"firstName": "John",
46	"lastName": "Doe",
47	"address": {
48	"lineOne": "lineOne",
49	"city": "city",
50	"state": "state",
51	"zipCode": "zipCode",
52	"country": "country"
53	},
54	"id": 1,
55	"externalIdentifier": "1234abcd",
56	"dateOfBirth": "1980-01-01",
57	"email": "john.doe@example.com",
58	"phoneNumber": "+1234567890",
59	"archived": true
60	}
61	}
62	],
63	"packedKits": [
64	{}
65	],
66	"shippingOption": "standard"
67	}
68	],
69	"page": 1,
70	"size": 1,
71	"total": 1,
72	"first": true,
73	"last": true
74	}