GET /ediOrder/retrieveRecords
Allows a partner to retrieve order information (format driven by DataFusion mapper) for a single batch number, a range of batch numbers, or a range of dates.
Roles that can access this endpoint are Users, Fusion Partners.
Parameters
| name |
description |
type |
default |
type |
| partnerId |
string indicating which partner's data should be retrieved |
query
|
|
String
|
| altPartnerId |
string indicating which partner's data should be retrieved |
query
|
|
String
|
| version |
string indicating the version of the data to be retrieved |
query
|
|
String
|
| transactionSet |
string indicating the type of transaction set to be retrieved |
query
|
|
String
|
| batch |
integer indicating a single batch number to be retrieved |
query
|
|
int
|
| beginBatch |
integer indicating the beginning of the batch number range (both begin and end batch numbers must be specified if a range is desired) |
query
|
|
int
|
| endBatch |
integer indicating the end of the batch number range (both begin and end batch numbers must be specified if a range is desired) |
query
|
|
int
|
| beginDate |
date/time indicating the beginning of the date range (both begin and end dates must be specified if a date range is desired) |
query
|
|
Date
|
| endDate |
date/time indicating the beginning of the date range (both begin and end dates must be specified if a date range is desired) |
query
|
|
Date
|
Result
Object
of type:
application/xml
application/json
returns either a generated output from the EDI template in XML, Json, or X12 or returns a List 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.__purposeDescr This value represents the tender purpose.
Child Elements:
RowEdiStop These elements represent the stops associated with the load tender.
Each element contains a __name attribute with the value stops.
Try It Out
Request