API Documentation
| Category |
Description |
Endpoint |
URL Parameter 1 |
URL Parameter 2 |
Body |
| Items |
See a list of available products that can be ordered |
https://aptus-oms.priusintelli.com/items |
|
|
|
| Orders |
See all active orders from your company |
https://aptus-oms.priusintelli.com/getallcomorders |
|
|
|
| Orders |
For a specific order, see all lines on that order |
https://aptus-oms.priusintelli.com/getentireorder/:ordernumber |
Order Number |
|
|
| Orders |
Create an order in the system |
https://aptus-oms.priusintelli.com/createorder/:ponum/:custref |
P.O. Number |
Customer Reference |
|
| Orders |
Add products with an AOI to an order |
https://aptus-oms.priusintelli.com/addorderlines/:ordernumber/:itemid |
Order Number |
Item ID |
AOI |
| Orders |
Obtain delivery URL of complete product line item |
https://aptus-oms.priusintelli.com/deliveryurl/:linenumber |
Order Line Number |
|
|
Header Authentication - required for all activity
| Name |
Description |
Example |
| CustID |
The unique Customer ID. Assigned by Prius Intelli. |
10000 |
| APIKEY |
A 32 digit random key. Assigned by Prius Intelli. |
1E119D7A66DB274E6C06D4463BDE64D3 |
GET all Items
- GET
- https://aptus-oms.priusintelli.com/items/
- HEADER Authentication Required
{
"items": [
{
"ItemID": 50000,
"Description": "5cm RGB Imagery",
"ItemType": "RGB"
}
]
}
POST a new order
- POST
-
https://aptus-oms.priusintelli.com/createorder/:ponum/:custref
- HEADER Authentication Required
| Path Variables |
Description |
Example |
| ponum |
PO Number created by client, as a reference to Prius Intelli for Invoicing.
|
PO: 9383312 |
| custref |
Free field for linking customer orders anonymously from PI OMS to customer
database
|
ABC123 |
- RETURNS
- Order Header Number
{
"orderCreated": {
"OrderNumber": 100120
}
}
POST new order line items
- POST
-
https://aptus-oms.priusintelli.com/addorderlines/:ordernumber/:itemid/
- HEADER Authentication Required
| Path Variables |
Description |
Example |
| ordernumber |
Order Number returned from "Post New Order". |
100119 |
| itemid |
ItemID as depicted in "Get all Items". Assigned by Prius Intelli, chosen by
customer.
|
50000 |
- RETURNS
- Order Line Number
- Total line item price
{
"addedLine": {
"OrderLine": "20210802042733713",
"TotalPrice": 1741388.3
}
}
GET an order with all line items
- GET
-
https://aptus-oms.priusintelli.com/getentireorder/:ordernumber
- HEADER Authentication Required
| Path Variables |
Description |
Example |
| ordernumber |
Order Number returned from "Post New Order". |
100119 |
- RETURNS
- Order Header Number
- Various Detail Lines
{
"ordernumber": 100122,
"orderlines": [
{
"CustomerID": 10000,
"OrderNumber": 100122,
"OrderLine": "20210802043339787",
"PONum": "Example PO",
"CustomerRef": "10922883dd",
"estDeliveryDate": null,
"ItemDescription": "5cm RGB Imagery",
"Status": "Received",
"ItemType": "RGB OrthoImagery",
"TotalPrice": 580512.77
},
{
"CustomerID": 10000,
"OrderNumber": 100122,
"OrderLine": "20210802043459814",
"PONum": "Example PO",
"CustomerRef": "10922883dd",
"estDeliveryDate": null,
"ItemDescription": "5cm RGB Imagery",
"Status": "Received",
"ItemType": "RGB OrthoImagery",
"TotalPrice": 48356.14
}
]
}
GET a line item's delivery url
- GET
-
https://aptus-oms.priusintelli.com/deliveryurl/:linenumber
- HEADER Authentication Required
| Path Variables |
Description |
Example |
| linenumber |
Line Number returned from "Get Order Lines". |
20210803031929986 |
- RETURNS
- Order Order Number
- Order Line Number
- Delivery URL
{
"orderDelivery": [
{
"OrderNumber": 100127,
"OrderLine": "20210803031929986",
"DeliveryURL": "https://files.priusintelli.com/sharing/maps/mineral_wells/mineral-wells-rgb/{z}/{x}/{y}.png"
}
]
}
