Search records action (batch)

Use the Search records action (batch) to search for transactions or relationships in Orderful.

Input

The input fields are dynamic and depend on the object you select.

Transaction object input fields

Input field	Description
Object	Use the Object drop-down to select the type of record to search for, such as Transaction or Relationship.
Delivery status	Provide the delivery status.
Acknowledgment status	Provide the acknowledgment status.
Sender interchange control header (ISA) ID	Enter the sender’s ISA ID.
Receiver interchange control header (ISA) ID	Enter the receiver’s ISA ID.
Reference identifier	Enter a reference identifier for filtering or lookup.
Previous cursor	Provide the pagination token returned by the previous response.
Next cursor	Provide the pagination token returned by the next response.
Stream	Provide the transaction stream.
Sender interchange reference identifier	Enter the sender’s interchange reference identifier.
Sender group reference identifier	Enter the sender’s group reference identifier.
Sender transaction reference identifier	Enter the sender’s transaction reference identifier.
Receiver interchange reference identifier	Enter the receiver’s interchange reference identifier.
Receiver group reference identifier	Enter the receiver’s group reference identifier.
Receiver transaction reference identifier	Enter the receiver’s transaction reference identifier.

Relationship object input

Input field	Description
Object	Use the Object drop-down to select the type of record to search for, such as Transaction or Relationship.
Limit	Provide the maximum number of items to return.
Previous cursor	Provide the pagination token returned by the previous response.
Next cursor	Provide the pagination token returned by the next response.
Auto send	Enable or disable automatic sending of the request.

Output

Transaction object output

Output field	Description
Transactions	This object contains all transactions that meet your search criteria.
Transaction ID	Unique identifier of the transaction.
URL	API endpoint URL for the transaction resource.
Version	API version used. For example, v3.
Sender	Object containing details about the sender trading partner.
Interchange control header (ISA) ID (Sender)	Sender’s interchange control header ID.
Interchange control header (ISA) ID qualifier (Sender)	Qualifier for the sender’s interchange control header ID.
Test interchange control header (ISA) ID (Sender)	Test sender interchange control header ID.
Test interchange control header (ISA) ID qualifier (Sender)	Qualifier for the test sender’s interchange control header ID.
Name (Sender)	Name of the sender trading partner.
Receiver	Object containing details about the receiver trading partner.
Interchange control header (ISA) ID (Receiver)	Receiver’s interchange control header ID.
Interchange control header (ISA) ID qualifier (Receiver)	Qualifier for the receiver’s interchange control header ID.
Test interchange control header (ISA) ID (Receiver)	Test receiver interchange control header ID.
Test interchange control header (ISA) ID qualifier (Receiver)	Qualifier for the test receiver’s interchange control header ID.
Name (Receiver)	Name of the receiver trading partner.
Type	Object describing the transaction type.
Name (Type)	Transaction type, such as 850_PURCHASE_ORDER. Refer to Orderful's documentation for more information about available transaction types (opens new window).
Stream	The stream that the transaction belongs to. For example, test refers to your testing environment and live refers to your production environment.
Business number	Business number associated with the transaction.
Reference identifiers	List of reference identifiers tied to the transaction.
Message	Object containing a link to the transaction message.
href (Message)	API endpoint URL for the transaction message.
Validation status	Status of EDI validation, such as VALID or INVALID. Refer to Orderful's documentation for more information about transaction statuses (opens new window).
Delivery status	Status of delivery to the trading partner, such as SENT or FAILED. Refer to Orderful's documentation for more information about transaction statuses (opens new window).
Acknowledgment status	Status of acknowledgment, such as ACCEPTED or REJECTED. Refer to Orderful's documentation for more information about transaction statuses (opens new window).
Created at	Timestamp when the transaction was created.
Last updated at	Timestamp when the transaction was last updated.
Acknowledgment	Object containing a link to the acknowledgment.
URL (Acknowledgment)	API endpoint URL for the transaction acknowledgment.

Relationship object output

Output field	Description
Relationship	This object contains all relationships that match your search criteria.
Relationship ID	Unique identifier of the relationship.
Created at	Timestamp when the relationship was created.
Updated at	Timestamp when the relationship was last updated.
Sender	Object containing details about the sender trading partner.
EDI account ID (Sender)	The sender’s EDI account ID.
Live Interchange control header (ISA) ID (Sender)	The live ISA ID for the sender.
Test Interchange control header (ISA) ID (Sender)	The test ISA ID for the sender.
Organization name (Sender)	The sender’s organization name.
EDI account name (Sender)	The sender’s EDI account name.
Organization ID (Sender)	The sender’s organization ID.
Receiver	Object containing details about the receiver trading partner.
EDI account ID (Receiver)	The receiver’s EDI account ID.
Live Interchange control header (ISA) ID (Receiver)	The live ISA ID for the receiver.
Test Interchange control header (ISA) ID (Receiver)	The test ISA ID for the receiver.
Organization name (Receiver)	The receiver’s organization name.
EDI account name (Receiver)	The receiver’s EDI account name.
Organization ID (Receiver)	The receiver’s organization ID.
Transaction type	Object describing the transaction type.
Name (Transaction type)	The transaction type, such as 850_PURCHASE_ORDER.
Status	The current status of the relationship.
Auto send	Indicates whether automatic sending is enabled for transactions.