Inventory document histories

This object contains one entry for each existing transaction in the workflow associated with the selected transaction.

List inventory document histories

get/objects/inventory-control/document-history

Returns a collection with a key, ID, and link for each inventory document history object.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "339",
      • "id": "339",
      • "href": "/objects/inventory-control/document-history/339"
      },
    • {
      • "key": "359",
      • "id": "359",
      • "href": "/objects/inventory-control/document-history/359"
      },
    • {
      • "key": "1343",
      • "id": "1343",
      • "href": "/objects/inventory-control/document-history/1343"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get an inventory document history
get/objects/inventory-control/document-history/{key}
Returns detailed information for a specified inventory document history object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the inventory document history.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "740",
    • "key": "740",
    • "convertedTo": {
      • "id": "SYS-Warehouse Transfer In-WHXFER-000002-doc-In"
      },
    • "convertedFrom": {
      • "id": "SYS-Warehouse Transfer Out-WHXFER-000002-doc-Out",
      • "key": "892",
      • "href": "/objects/inventory-control/document::Beginning%20Balance/892"
      },
    • "inventoryDocument": {
      • "key": "892",
      • "href": "/objects/inventory-control/document::Beginning%20Balance/892"
      },
    • "href": "/objects/inventory-control/document-history/740"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}