REL documentation
orders ordersallocate (http://api.3plcentral.com/rels/orders/ordersallocate)
Resource:
GroupOperator: of orderallocate
C# Rel Const:
Rels.OrderSvc.OrdersAllocate
URI template:
allocator{?receiverid,skipShortOrders}
Obtain URI from:
Billboard , /rels/inventory/receiver , /rels/inventory/receiverdigests
To allocate under-allocated orders for goods received through a given Receiver.
Success status: 200
Name (* = required) Data Type Description
receiverid * int
Type Description
FullyAllocatedOrderIds IEnumerable<int> orders now fully allocated
ShortOrderIds IEnumerable<int> partially or not allocated; if skipShortOrders = true specified, these were skipped and hence are unchanged
FaultedOrders 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
Sample accept: application/hal+json
{
  "fullyAllocatedOrderIds": [
    1
  ],
  "shortOrderIds": [
    1
  ],
  "faultedOrders": {
    "message": "ListException: Faults [{EntryNumber 1, }]",
    "faults": [
      {
        "entryNumber": 1,
        "entryInfo": "str"
      }
    ],
    "data": {},
    "helpLink": "str",
    "source": "str",
    "hResult": 3
  }
}
To allocate a list of open orders.
Success status: 200
Name Data Type Description
skipShortOrders bool true: if can't fully allocate order, don't modify it; in this case even if http status 400 or 500 returned, some of the orders may have been allocated
A list of OrderIds with optional lists of manual allocations for each.
Type Description
ProposedAllocations IEnumerable<Order.Models.ProposedAllocationsByOrderId>
OrderId int
ProposedAllocations IEnumerable<Order.Models.ProposedAllocationsByOrderItemId>
OrderItemId int
ProposedAllocations IEnumerable<Generic.Models.ProposedAllocation>
ReceiveItemId int
Qty decimal
Sample content-type: application/hal+json
 
{
  "proposedAllocations": [
    {
      "orderId": 1,
      "proposedAllocations": [
        {
          "orderItemId": 1,
          "proposedAllocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0
            }
          ]
        }
      ]
    }
  ]
}
Type Description
FullyAllocatedOrderIds IEnumerable<int> orders now fully allocated
ShortOrderIds IEnumerable<int> partially or not allocated; if skipShortOrders = true specified, these were skipped and hence are unchanged
FaultedOrders 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
Sample accept: application/hal+json
{
  "fullyAllocatedOrderIds": [
    1
  ],
  "shortOrderIds": [
    1
  ],
  "faultedOrders": {
    "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.