PUT /ediStatus/update
Updates a RowEdiStatus record for the given status data.
Roles that can access this endpoint are Users.
Parameters
name |
description |
type |
default |
type |
status |
the data to use when updating the existing status record |
body of type: application/xml application/json
|
|
RowEdiStatus
|
Result
RowEdiStatus
of type:
application/xml
application/json
the updated RowEdiStatus object
Additional attributes:
__directionDescr
This value represents the status' direction, found in the edistatus.direction
field.
__errorDescr
This value represents the error description, found in the edistatus.error
field.
__readyToSendDescr
This value represents the ready to send description, found in the edistatus.ready_to_send
field.
__eventTypeDescr
This value represents the event type description, found in the edistatus.event_type
field.
__shipmentMatchingDescr
This value represents the shipment matching method description, found in the edistatus.ship_match_type
field.
__stopTypeDescr
This value represents the stop type description, found in the edistatus.curr_stop_type
field.
Child Elements:
RowEdiStatusProfile
This element represents the EDI Shipment Status Profile associated with the status.
The element contains a __name
attribute with the value profile
.
RowCustomer
This element represents the customer associated with the status, by the edistatus.customer_id
field.
The element contains a __name
attribute with the value customer
.
RowEdiMapError
These elements represent the map errors associated with the status.
Each element contains a __name
attribute with the value ediMapErrors
.
RowEdiStatusComment
These elements represent the comments associated with the status.
Each element contains a __name
attribute with the value ediStatusComments
.
RowEdiOsd
These elements represent the OS&D records associated with the status.
Each element contains a __name
attribute with the value ediOsds
.
RowEdiBatchHistory
These elements represent the batch history records associated with the status.
Each element contains a __name
attribute with the value batchHistoryRecords
.
Try It Out
Request