POST public-api/ic/pickpackshiporder/advancedinfosearch
This method returns a page full of active pick orders given a precise set of search, sort or filter criteria. It's a paging API so this is meant to be called with a smaller number (about 100) or records to fetch, repeatedly, until you get them all. Requires Allow Pick Order permission and enforces Role Site restrictions. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL.
Request Information
URI Parameters
None.
Body Parameters
AdvancedSearchParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCountFromPriorFetch | integer |
None. |
|
| AdditionalSkipCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Sort | Collection of Object |
None. |
|
| Filter | TopLevelFilterType |
None. |
|
| ClientUtcOffset | TimeZoneInfoId |
None. |
|
| FilterBehavior | FilterBehaviorFlags |
None. |
|
| IgnoreAttachments | boolean |
None. |
|
| IgnoreGeoLocation | boolean |
None. |
|
| WorkingSiteIdCsvList | string |
None. |
Request Formats
application/json
Sample:
{
"_sortCriteria": [],
"TotalCountFromPriorFetch": 1,
"AdditionalSkipCount": 1,
"PageSize": 2,
"PageNumber": 3,
"Filter": {
"$id": "1",
"field": "sample string 1",
"operator": "sample string 2",
"value": {},
"logic": "sample string 4",
"filters": []
},
"ClientUtcOffset": null,
"FilterBehavior": 0,
"IgnoreAttachments": true,
"IgnoreGeoLocation": true,
"WorkingSiteIdCsvList": "6"
}
Response Information
Resource Description
WaspResultOfListOfPickOrderInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of PickOrderInfo |
None. |
|
| Messages | Collection of WtResult |
None. |
|
| BatchNumber | integer |
None. |
|
| HasError | boolean |
None. |
|
| HasHttpError | boolean |
None. |
|
| HasMessage | boolean |
None. |
|
| HasSuccessWithMoreDataRemaining | boolean |
None. |
|
| TotalRecordsLongCount | integer |
None. |
Response Formats
application/json
Sample:
{
"Data": [
{
"RowNumber": 1,
"PickOrderNumber": "sample string 2",
"CustomerNumber": "sample string 3",
"ReferenceNumber": "sample string 4",
"SiteName": "sample string 5",
"AltReferenceNumber": "sample string 6",
"OrderDate": "2026-02-27T14:06:33.8033762+00:00",
"DueDate": "2026-02-27T14:06:33.8033762+00:00",
"ShipperName": "sample string 7",
"ShipMethod": "sample string 8",
"ShippingCost": 9.0,
"TaxPercentage": 10.0,
"IssueOrder": true,
"OrderStatus": "sample string 12",
"OrderStatusCode": "sample string 13",
"OrderStatusReasonCode": "sample string 14",
"ShipToContact": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
},
"BillToContact": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
},
"PickOrderLines": [
{
"ItemNumber": "sample string 1",
"Quantity": 2.0,
"UomName": "sample string 3",
"SalesPrice": 4.0,
"CompleteQuantity": 5.0,
"OutstandingQuantity": 6.0
},
{
"ItemNumber": "sample string 1",
"Quantity": 2.0,
"UomName": "sample string 3",
"SalesPrice": 4.0,
"CompleteQuantity": 5.0,
"OutstandingQuantity": 6.0
}
],
"PickOrderNotes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-27T14:06:33.8039214+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-27T14:06:33.8039214+00:00",
"UserLogon": "sample string 2"
}
],
"LastUpdated": "2026-02-27T14:06:33.8039214+00:00",
"CustomFields": [
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-27T14:06:33.8039903+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-27T14:06:33.8039903+00:00",
"DcfValueRecordStatus": 0
}
]
},
{
"RowNumber": 1,
"PickOrderNumber": "sample string 2",
"CustomerNumber": "sample string 3",
"ReferenceNumber": "sample string 4",
"SiteName": "sample string 5",
"AltReferenceNumber": "sample string 6",
"OrderDate": "2026-02-27T14:06:33.8033762+00:00",
"DueDate": "2026-02-27T14:06:33.8033762+00:00",
"ShipperName": "sample string 7",
"ShipMethod": "sample string 8",
"ShippingCost": 9.0,
"TaxPercentage": 10.0,
"IssueOrder": true,
"OrderStatus": "sample string 12",
"OrderStatusCode": "sample string 13",
"OrderStatusReasonCode": "sample string 14",
"ShipToContact": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
},
"BillToContact": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
},
"PickOrderLines": [
{
"ItemNumber": "sample string 1",
"Quantity": 2.0,
"UomName": "sample string 3",
"SalesPrice": 4.0,
"CompleteQuantity": 5.0,
"OutstandingQuantity": 6.0
},
{
"ItemNumber": "sample string 1",
"Quantity": 2.0,
"UomName": "sample string 3",
"SalesPrice": 4.0,
"CompleteQuantity": 5.0,
"OutstandingQuantity": 6.0
}
],
"PickOrderNotes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-27T14:06:33.8039214+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-27T14:06:33.8039214+00:00",
"UserLogon": "sample string 2"
}
],
"LastUpdated": "2026-02-27T14:06:33.8039214+00:00",
"CustomFields": [
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-27T14:06:33.8039903+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-27T14:06:33.8039903+00:00",
"DcfValueRecordStatus": 0
}
]
}
],
"Messages": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"BatchNumber": 1,
"HasError": false,
"HasHttpError": false,
"HasMessage": true,
"HasSuccessWithMoreDataRemaining": false,
"TotalRecordsLongCount": 1
}