Future Orders API

This API retrieves order item lines reserved for future dates on Rental Orders or Sale Orders for the specified product or asset within a given date range.

How it works?

If assetorproductid is a product ID, response includes all future reservations for that product.
If assetorproductid is an asset ID, response includes:
- All reservations of the linked product, and
- Any order line where the specific asset ID is reserved.
When given assetorproductid is reserved as part of non-serial kits, child item lines will appear with the kit header's prep/ship dates.
Only Rental Orders and Sale Orders lines are included.

Endpoint

Method: POST

👉🏿

End Point: /orders/futureorders

Purpose: Retrieve future orders for a given product or asset.

Request

Mandatory Header Payload

{
  "empid": "<employee_id>",
  "siteid": "<site_id>"
}

Request Body

{
  "assetorproductid": "string",     // Required
  "shippingsiteid": "string",       // Required
  "lookupdate": "Prep Date",        // Required - "Prep Date" or "Ship Date"
  "fromdate": "MM/dd/yyyy HH:mm",   // Required
  "lookupperiod": 0                 // Required - Number of days
}

Field Details

Field	Type	Required	Description
`assetorproductid`	`string`	✅	ID of the asset or product to check for future reservations. Works for serial items, non-serial items, or serial kits.
`shippingsiteid`	`string`	✅	Site from where the item is reserved. Note: User context `siteid` is not used here.
`lookupdate`	`string`	✅	Lookup reference date: `"Prep Date"` or `"Ship Date"`
`fromdate`	`string`	✅	Start date for the lookup (format: `MM/dd/yyyy HH:mm`)
`lookupperiod`	`int`	✅	Duration in days from `fromdate` to define the lookup window

Response

Code	Description
200	Success – orders found
1186	Invalid request Parameters
1187	Unable to process request
1234	Internal error, error message will be contextual.
2179	R2_02179:'itemorassetid' cannot be empty.
2180	R2_02180:'siteid' cannot be empty.
2182	R2_02182:'lookupperiod' is mandatory and must be a positive number.
2183	R2_02183:'lookupdate' cannot be empty.
2184	R2_02184:Invalid lookupdate value. Allowed values are: 'Prep Date', 'Ship Date'.
2185	R2_02185:The site id not present in the system.
2187	R2_02187:The lookupperiod value must be greater than 0.
2188	R2_02188:The lookupperiod value [LOOKUPPERIOD_VALUE] is not a valid number.
2189	R2_02189:Asset/Product [ASSET_ID_OR_PRODUCT_ID] not found.
2190	R2_02190:[ASSET_ID_OR_PRODUCT_ID] is not a valid asset or item or kit.

Success Response Payload

{
  "assetorproductid": "string",
  "description": "string",
  "binnumber": "string",
  "shelflocation": "string",
  "itemtype": "string",
  "futureorders": [
    {
      "orderid": "string",
      "orderdescription": "string",
      "orderprepdate": "MM/dd/yyyy HH:mm",
      "ordershipdate": "MM/dd/yyyy HH:mm",
      "eventid": "string",
      "projectid": "string",
      "lineprepdate": "MM/dd/yyyy HH:mm",
      "lineshipdate": "MM/dd/yyyy HH:mm",
      "orderlinequantity": 0
    }
  ]
}

Field Details

Field	Description
`assetorproductid`	ID of the asset/product requested
`description`	Description of the asset/product from master
`binnumber`	Bin from shipping site (or asset master)
`shelflocation`	Shelf location from site (or asset master)
`itemtype`	Item type - serial / non-serial
`orderid`	Order ID where item is reserved
`orderdescription`	Order header description
`orderprepdate`	Prep date at order header level
`ordershipdate`	Ship date at order header level
`eventid`	Event ID to which order belongs
`projectid`	Project ID to which order belongs
`lineprepdate`	Prep date at order line level (Kit header date in case of kits)
`lineshipdate`	Ship date at order line level (Kit header date in case of kits)
`orderlinequantity`	Quantity reserved on order line