REL documentation
orders orderholderasync (http://api.3plcentral.com/rels/orders/orderholderasync)
Resource:
Async: orderholder
C# Rel Const:
Rels.OrderSvc.OrderHolderAsync
URI template:
orderholder/async{?deallocate,holdReason,release}
Obtain URI from:
Billboard
Asynchronously put one or more orders on hold
Success status: 200
Name Data Type Description
deallocate bool Flag to deallocate orders put on hold
holdReason string Reason to put order(s) on hold. Required if release = false
release bool Flag indicating specified orders should be put removed from hold
List of order identifiers to put on hold
Type Description
OrderIdentifiers IEnumerable<Generic.Models.OrderIdentifier> identifies orders to be affected
Id int
Sample content-type: application/hal+json
 
{
  "orderIdentifiers": [
    {
      "id": 1
    }
  ]
}
Returns status object that can be used to poll status for this job
Type Description
AsyncOperationStatusId int? ...
OrderHoldsAttempted int? ...
OrdersHeld int? ...
OrderHoldResults Order.Models.OrderHoldResults
HeldOrderIds Int32[]
Exceptions Generic.Models.Exceptions.ListException container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
Message string
Faults IList<Generic.Models.Exceptions.ListEntryFault>
EntryNumber int 1-indexed position in the source list
EntryInfo string optional info about the entry in the source list, such as id, sku, ref#, etc.
WmsException Generic.Models.Exceptions.WmsExceptionBase for more details at runtime see which WmsExceptionBase-derived exception it is
ErrorCode string could have been a number, but is a short string for human readability; not to be localized
Hint string helpful word or two if the thrower happens to know more things; not to be localized
Message string
InnerException System.Exception
Links IList<WebApi.Hal.Link>
- /rels/orders/orderholder may be polled until the operation is complete or fails
Links IList<WebApi.Hal.Link>
- /rels/orders/orderholderasyncstatus may be polled until the operation is complete or fails
Sample accept: application/hal+json
{
  "asyncOperationStatusId": 1,
  "orderHoldsAttempted": 1,
  "ordersHeld": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/orderholder": {
      "heldOrderIds": [
        1
      ],
      "exceptions": {
        "message": "ListException: Faults [{EntryNumber 1, }]",
        "faults": [
          {
            "entryNumber": 1,
            "entryInfo": "str"
          }
        ],
        "data": {},
        "helpLink": "str",
        "source": "str",
        "hResult": 3
      }
    }
  }
}

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.