GET /ediOrder/retrieveRecords/new
Allows a partner to retrieve a List of 'new' EdiBatch objects (those not already sent to or retrieved by the partner).
Roles that can access this endpoint are EDI 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
|
Result
List
<
EdiBatch
>
of type:
application/xml
application/json
a list of EdiBatch 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