GET /ediOrder
Retrieves a List of RowEdiOrder 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 load tenders by load tender ID, order ID, partner name, partner ID, or alternate partner ID |
query
|
|
String
|
Result
List
<
RowEdiOrder
>
of type:
application/xml
application/json
a list of RowEdiOrder objects
Additional attributes:
__collectionMethodDescr
This value represents the description of the collection method, found in the edi_order.collection_method
field.
__rateTypeDescr
This value represents the description of the rate type, found in the edi_order.rate_type
field.
__directionDescr
This value represents the tender direction, found in the edi_order.direction
field.
__purposeDescr
This value represents the tender purpose.
__appTypeDescr
This value represents the description of the tender app type.
__errorDescr
This value represents the error description, found in the edi_order.edi_error
field.
__tenderStatusDescr
This value represents the tender status description, found in the edi_order.tender_status
field.
__readyToSendDescr
This value represents the reply to sender description.
__replyActionDescr
This value represents the reply action description, found in the edi_order.reply_action
field.
__requiresReply
This value represents whether a reply is required by associated EDI Order Profile.
__ltxCellColor
This value represents the background color to be used in Load Tender Express.
__ltxMRBColor
This value represents the Must Respond By date color to be used in Load Tender Express.
__ltxTextColor
This value represents the text color to be used in Load Tender Express.
Child Elements:
RowCustomer
This element represent the customer associated with the tender, by the edi_order.customer_id
field.
The element contains a __name
attribute with the value customer
.
RowEdiOrderProfile
This element represent the EDI Order Profile associated with the tender.
The element contains a __name
attribute with the value profile
.
RowStop
These elements represent the stops associated with the tender.
Each element contains a __name
attribute with the value stops
.
Try It Out
Request