PUT v1/Orders/{orderId}/Allocate

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId		integer	Required.

Body Parameters

AllocateOrderInfo

Name	Description	Type	Additional information
AlsoIncludeDeallocatedOrderRows	By default deallocated orderrows are ignored during an allocation attempt. Use this property to override this behavior. This property is ignored if you supply an list of orderows to allocate.	boolean	None.
WarehouseId	Optional ID of warehouse to allocate the order(rows) for. If not set, ShopCtrl determines what warehouse should be used. You can also use a dropship warehouse to prepare orderrows to be dropshipped.	integer	None.
OrderRows	Optional list of orderrows to allocate. Rows for this order that are <b>not</b> in this list are <b>excluded</b> from the allocation attempt. If no orderrows are specified, allocation is performed on the full order	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AlsoIncludeDeallocatedOrderRows": true,
  "WarehouseId": 1,
  "OrderRows": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<AllocateOrderInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AlsoIncludeDeallocatedOrderRows>true</AlsoIncludeDeallocatedOrderRows>
  <WarehouseId>1</WarehouseId>
  <OrderRows>
    <OrderRowId>1</OrderRowId>
    <OrderRowId>2</OrderRowId>
  </OrderRows>
</AllocateOrderInfo>

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.