GET /ediStatus
Retrieves a List of RowEdiStatus objects with a full or partial match to the given value.
Roles that can access this endpoint are Users.
Parameters
name |
description |
type |
default |
type |
q |
string for which to search for shipment statuses by order ID, partner name, partner ID, or alternate partner ID |
query
|
|
String
|
Result
List
<
RowEdiStatus
>
of type:
application/xml
application/json
a list of RowEdiStatus objects
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
.
Try It Out
Request