inventory inventoryhold (http://api.3plcentral.com/rels/inventory/inventoryhold)
Resource:
GroupOperator: hold/release inventory
C# Rel Const:
Rels.InventorySvc.InventoryHold
URI template:
holder{?holdReason,release}
To hold/release a list of receive items; receive items on hold are not available for allocation
ReceiveItems in a Quarantine Location cannot have their Hold removed.
Success status: 200
Name Data Type Description
holdReason string must be supplied if 'release' is false
release bool false (the default): place the receive items on hold; true: release receive items
list of receive item ids to be affected
Type Description
ReceiveItemIdentifiers IEnumerable<Generic.Models.ReceiveItemIdentifier> identifies receive items to be affected
Id int
Sample content-type: application/hal+json
{
  "receiveItemIdentifiers": [
    {
      "id": 1
    }
  ]
}
Type Description
ResourceList IList<Inventory.Models.ReceiveItemWithAllocatedOrderInfo>
ReceiveItemId int
OnHold bool
RelatedOrders IEnumerable<Inventory.Models.RelatedOrderInfo>
OrderIdentifier Generic.Models.OrderIdentifier
Id int
IsShipped bool
InPickJob bool
PickTickedPrinted bool
Sample accept: application/hal+json
{
  "_embedded": {
    "item": [
      {
        "receiveItemId": 1,
        "onHold": true,
        "relatedOrders": [
          {
            "orderIdentifier": {
              "id": 1
            },
            "isShipped": true,
            "inPickJob": true,
            "pickTickedPrinted": true
          }
        ]
      }
    ]
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.