POST public-api/ic/pickpackshiporder/update
This method edits an existing pick order. Requires an Edit Pick Order permission. Accepts a maximum of 500 records at a time.
Request Information
URI Parameters
None.
Body Parameters
Collection of PickOrderInfoName | Description | Type | Additional information |
---|---|---|---|
RowNumber |
Internal. This is used to help identify errors if any. |
integer |
None. |
PickOrderNumber |
The unique order number for the pick order. |
string |
None. |
CustomerNumber |
Indicates the customer number the product is being picked for. |
string |
None. |
ReferenceNumber |
Indicates the reference number of the order. |
string |
None. |
AltReferenceNumber |
Indicates the Alt Reference Number of the order for edi 945 . |
string |
None. |
OrderDate |
Indicates the date on which the order was placed. |
date |
None. |
DueDate |
Indicates the date on which the order is due. |
date |
None. |
ShipperName |
ship method is being returned, so as might as well return shipper name (such as FedEx, USPS, UPS, DHL, etc) |
string |
None. |
ShipMethod |
Indicates the shipping method used to ship the order. |
string |
None. |
ShippingCost |
Indicates the cost of shipping the entire order. |
decimal number |
None. |
TaxPercentage |
Indicates the tax percentage used on the order. |
decimal number |
None. |
IssueOrder |
By default the pick orders are created in a "Draft" state that require validation on the web. By setting this value to true pick orders, it will be created in a "Ready" state to immediately be picked, bypassing the "Draft" state. |
boolean |
None. |
OrderStatus |
Indicates the status of the order. |
string |
None. |
OrderStatusCode |
Indicates the Order Status Code. |
string |
None. |
OrderStatusReasonCode |
Indicates the Order Status Reason Code. |
string |
None. |
ShipToContact |
Indicates the location the pick order is being shipped to. |
AddressInfo |
None. |
BillToContact |
Indicates the billing information. |
AddressInfo |
None. |
PickOrderLines |
Indicates the line item information of the order. |
Collection of PickOrderLineInfo |
None. |
PickOrderNotes |
Indicates the notes related to the pick order. |
Collection of NoteInfo |
None. |
CustomFields | Collection of DcfValueInfo |
None. |
Request Formats
application/json
[ { "RowNumber": 0, "PickOrderNumber": "12345", "CustomerNumber": "2334660", "ReferenceNumber": "UPDATE", "OrderDate": "2025-02-21T17:08:53.997Z", "DueDate": "2025-02-28T17:08:53.997Z", "ShipperName": "FedEx", "ShipMethod": "Priority Overnight", "ShippingCost": 14.99, "TaxPercentage": 8.25, "IssueOrder": false, "OrderStatus": "Draft - OK", "OrderStatusCode": "Draft", "OrderStatusReasonCode": "OK", "ShipToContact": { "AddressLine1": "123 Main St", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "AddressCity": "Mayberry", "AddressStateProvince": "North Carolina", "AddressCountry": "United States", "AddressPostalCode": "27513", "ContactPhone": "123-456-7890", "ContactEmail": "andy@gmail.com" }, "BillToContact": { "AddressLine1": "123 Main St", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "AddressCity": "Mayberry", "AddressStateProvince": "North Carolina", "AddressCountry": "United States", "AddressPostalCode": "27513", "ContactPhone": "123-456-7890", "ContactEmail": "andy@gmail.com" }, "PickOrderLines": [ { "ItemNumber": "403226", "Quantity": 20.0, "UomName": "each", "SalesPrice": 10.0, "CompleteQuantity": 0.0, "OutstandingQuantity": 20.0 }, { "ItemNumber": "614126", "Quantity": 10.0, "UomName": "each", "SalesPrice": 15.0, "CompleteQuantity": 0.0, "OutstandingQuantity": 10.0 } ], "PickOrderNotes": [ { "NoteText": "A test pick order from the public api", "NoteDate": "2025-02-21T17:08:56.093Z", "UserLogon": "Bruce" } ], "CustomFields": [] } ]
Response Information
Resource Description
WaspResultOfResultsName | Description | Type | Additional information |
---|---|---|---|
Data |
Type specific result that always depends on the function called. |
Results |
None. |
Messages |
List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages. |
Collection of WtResult |
None. |
BatchNumber |
This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party. |
integer |
None. |
HasError |
True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available. |
boolean |
None. |
HasHttpError |
True if an API function call could not be fully posted to the server or the results could not be fully returned. |
boolean |
None. |
HasMessage |
True if any message is available. |
boolean |
None. |
HasSuccessWithMoreDataRemaining |
True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time. |
boolean |
None. |
TotalRecordsLongCount |
This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster. |
integer |
None. |
Response Formats
application/json
{ "Data": { "ResultList": [ { "ResultCode": 0, "Message": "Success.", "HttpStatusCode": 200 } ], "SuccessfullResults": 1, "TotalResults": 1, "ErrorCount": 0 }, "Messages": [ { "ResultCode": 0, "Message": "Success.", "HttpStatusCode": 200, "FieldName": "" } ], "TotalRecordsLongCount": 1, "HasSuccessWithMoreDataRemaining": false, "HasError": false, "HasMessage": true, "HasHttpError": false }