PUT public-api/ic/order/SaveOrderExtraFields
Request Information
URI Parameters
None.
Body Parameters
SaveOrderExtraFieldsRequestModelName | Description | Type | Additional information |
---|---|---|---|
OrderNumber | string |
None. |
|
NewOrderNumber | string |
None. |
|
OrderType | string |
None. |
|
AttachmentFileName |
In order to ADD NEW attachment, both the file name and the OrderNumber must form a logically distinct (unique) value pair. If the combination of the 2 already exist, then the attachment data will be updated instead of insert(add). |
string |
None. |
AttachmentData | Collection of byte |
None. |
|
OrderLinesToUpdate | Collection of OrderLineUpdateModelSDK |
None. |
|
OrderPriority |
should be a value from 0 (unspecified/lowest) to 10 (highest) any value out of this range will be normalized back to inclusive range 0 to 10. Specify null to skip update |
byte |
None. |
OrderSourceText |
The source or name of the system which produced this order. Specify null/empty/white spaces to skip update. Any value greater than 100 characters will be truncated |
string |
None. |
SiteName |
update order default site set to null to disable update. set to empty string to remove existing value |
string |
None. |
LocationCode | string |
None. |
|
OrderReferenceNumber | string |
None. |
|
OrderAltReference | string |
None. |
|
DateStarted | date |
None. |
|
OrderDueDate | date |
None. |
|
OrderDateCompleted | date |
None. |
|
OrderSupplier | string |
None. |
|
OrderDescriptionText | string |
None. |
|
Requestor |
set order requestor. set to null to disable update. |
string |
None. |
IsDropShip |
set order drop shipment flag. set to null to disable update |
boolean |
None. |
Request Formats
application/json
{ "OrderNumber": "sample string 1", "NewOrderNumber": "sample string 2", "OrderType": "sample string 3", "AttachmentFileName": "sample string 4", "AttachmentData": "QEA=", "OrderLinesToUpdate": [ { "ItemNumber": "sample string 1", "RequestedQuantity": 1.0 }, { "ItemNumber": "sample string 1", "RequestedQuantity": 1.0 } ], "OrderPriority": 64, "OrderSourceText": "sample string 5", "SiteName": "sample string 6", "LocationCode": "sample string 7", "OrderReferenceNumber": "sample string 8", "OrderAltReference": "sample string 9", "DateStarted": "2025-04-02T04:28:18.5009427+00:00", "OrderDueDate": "2025-04-02T04:28:18.5009427+00:00", "OrderDateCompleted": "2025-04-02T04:28:18.5009427+00:00", "OrderSupplier": "sample string 10", "OrderDescriptionText": "sample string 11", "Requestor": "sample string 12", "IsDropShip": true }
Response Information
Resource Description
WaspResultOfSaveOrderExtraFieldsRequestModelName | Description | Type | Additional information |
---|---|---|---|
Data |
Type specific result that always depends on the function called. |
SaveOrderExtraFieldsRequestModel |
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": { "OrderNumber": "sample string 1", "NewOrderNumber": "sample string 2", "OrderType": "sample string 3", "AttachmentFileName": "sample string 4", "AttachmentData": "QEA=", "OrderLinesToUpdate": [ { "ItemNumber": "sample string 1", "RequestedQuantity": 1.0 }, { "ItemNumber": "sample string 1", "RequestedQuantity": 1.0 } ], "OrderPriority": 64, "OrderSourceText": "sample string 5", "SiteName": "sample string 6", "LocationCode": "sample string 7", "OrderReferenceNumber": "sample string 8", "OrderAltReference": "sample string 9", "DateStarted": "2025-04-02T04:28:18.5152975+00:00", "OrderDueDate": "2025-04-02T04:28:18.5152975+00:00", "OrderDateCompleted": "2025-04-02T04:28:18.5152975+00:00", "OrderSupplier": "sample string 10", "OrderDescriptionText": "sample string 11", "Requestor": "sample string 12", "IsDropShip": true }, "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 }