POST api/{siteCode}/Warehouse/CreateWarehousePick
Creates the warehouse pick.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteCode |
The site code. |
integer |
Required |
Body Parameters
The warehouse booking.
WarehouseOut| Name | Description | Type | Additional information |
|---|---|---|---|
| DeliveryCompanyName |
Consignee company name. |
string |
String length: inclusive between 0 and 50 |
| DeliveryAddress1 |
Consignee address line 1. |
string |
String length: inclusive between 0 and 50 |
| DeliveryAddress2 |
Consignee address line 2. |
string |
String length: inclusive between 0 and 50 |
| DeliveryCity |
Consignee city. |
string |
String length: inclusive between 0 and 50 |
| DeliveryCounty |
Consignee state/county. |
string |
String length: inclusive between 0 and 50 |
| DeliveryPostCode |
Consignee zip/post code. |
string |
String length: inclusive between 0 and 50 |
| DeliveryCountry |
Consignee country. |
string |
String length: inclusive between 0 and 50 |
| DeliveryPhone |
Consignee phone. |
string |
String length: inclusive between 0 and 50 |
| DeliveryContact |
Consignee contact person. |
string |
String length: inclusive between 0 and 50 |
| OutboundRef |
The pick reference. |
string |
String length: inclusive between 0 and 50 |
| ReleaseDate |
Requested release date. |
date |
None. |
| DeliveryDate |
Requested delivery date. |
date |
None. |
| DeliveryTime |
Requested delivery time. |
string |
None. |
| Haulier |
Requested haulier. |
string |
None. |
| PickItems |
Items to pick. |
Collection of WarehouseItem |
None. |
| BranchID |
The branch identifier. |
string |
Required String length: inclusive between 1 and 3 |
| CustomerID |
The customer account identifier. |
string |
Required String length: inclusive between 1 and 8 |
| NOP |
Number of outer packages. |
integer |
None. |
| Weight |
Gross weight. |
decimal number |
None. |
| Cube |
The cube. |
decimal number |
None. |
| CustRef |
The customer reference. |
string |
String length: inclusive between 0 and 255 |
| Remarks |
Comments. |
string |
None. |
Request Formats
application/json, text/json
{
"DeliveryCompanyName": "BoxTop Technologies Ltd",
"DeliveryAddress1": "Providence House",
"DeliveryAddress2": "2 River Street",
"DeliveryCity": "Windsor",
"DeliveryCounty": "Berkshire",
"DeliveryPostCode": "SL4 1QT",
"DeliveryCountry": "GB",
"DeliveryPhone": "+44 20 8400 2000",
"DeliveryContact": "Reece Ipient",
"OutboundRef": "Pick Ref 12345",
"ReleaseDate": "2025-10-29T00:00:00+00:00",
"DeliveryDate": "2025-10-29T00:00:00+00:00",
"DeliveryTime": "Before 17:30",
"Haulier": null,
"PickItems": [
{
"Warehouse": "Unit 1",
"SKUGroupID": null,
"SKUNumber": "ABC123D",
"SKUName": "SKU Description",
"Quantity": 1000,
"Add1": "Colour",
"Add2": "Size",
"Add3": "Batch",
"Add4": null,
"Add5": null,
"Add6": null,
"Comments": "No comment"
},
{
"Warehouse": "Unit 2",
"SKUGroupID": null,
"SKUNumber": "D321CBA",
"SKUName": "SKU Description",
"Quantity": 1000,
"Add1": "Colour",
"Add2": "Size",
"Add3": null,
"Add4": null,
"Add5": null,
"Add6": null,
"Comments": "No comment"
}
],
"BranchID": "H",
"CustomerID": "UKCust",
"NOP": 10,
"Weight": 100.0,
"Cube": 1.123,
"CustRef": "POrd 12345",
"Remarks": "Notify confirmed delivery details asap!"
}
application/xml, text/xml
<WarehouseOut xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<BranchID>H</BranchID>
<CustomerID>UKCust</CustomerID>
<NOP>10</NOP>
<Weight>100</Weight>
<Cube>1.123</Cube>
<CustRef>POrd 12345</CustRef>
<Remarks>Notify confirmed delivery details asap!</Remarks>
<DeliveryCompanyName>BoxTop Technologies Ltd</DeliveryCompanyName>
<DeliveryAddress1>Providence House</DeliveryAddress1>
<DeliveryAddress2>2 River Street</DeliveryAddress2>
<DeliveryCity>Windsor</DeliveryCity>
<DeliveryCounty>Berkshire</DeliveryCounty>
<DeliveryPostCode>SL4 1QT</DeliveryPostCode>
<DeliveryCountry>GB</DeliveryCountry>
<DeliveryPhone>+44 20 8400 2000</DeliveryPhone>
<DeliveryContact>Reece Ipient</DeliveryContact>
<OutboundRef>Pick Ref 12345</OutboundRef>
<ReleaseDate>2025-10-29T00:00:00+00:00</ReleaseDate>
<DeliveryDate>2025-10-29T00:00:00+00:00</DeliveryDate>
<DeliveryTime>Before 17:30</DeliveryTime>
<PickItems>
<WarehouseItem>
<Warehouse>Unit 1</Warehouse>
<SKUGroupID xsi:nil="true" />
<SKUNumber>ABC123D</SKUNumber>
<SKUName>SKU Description</SKUName>
<Quantity>1000</Quantity>
<Add1>Colour</Add1>
<Add2>Size</Add2>
<Add3>Batch</Add3>
<Comments>No comment</Comments>
</WarehouseItem>
<WarehouseItem>
<Warehouse>Unit 2</Warehouse>
<SKUGroupID xsi:nil="true" />
<SKUNumber>D321CBA</SKUNumber>
<SKUName>SKU Description</SKUName>
<Quantity>1000</Quantity>
<Add1>Colour</Add1>
<Add2>Size</Add2>
<Comments>No comment</Comments>
</WarehouseItem>
</PickItems>
</WarehouseOut>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |