Get record action

Use the Get record action to retrieve details about a record you specify, such as a Transaction, Transaction message, Organization, Acknowledgment, or Delivery.

Input

Input field	Description
Object	Use the Object drop-down to select the type of record you plan to retrieve. Available options include Transaction, Transaction message, Organization, Acknowledgment, and Delivery.
Transaction ID	Provide the transaction ID of the transaction or transaction message you plan to retrieve. This field is available when you select the Transaction or Transaction message object.
Expand	Specify an object to embed into the response. This field only accepts a message as input. This field is available when you select the Transaction object.
Acknowledgment ID	Provide the transaction ID for the acknowledgment you plan to retrieve. This field is available when you select the Acknowledgment object.
Delivery ID	Provide the delivery ID for the acknowledgment you plan to retrieve. This field is available when you select the Delivery object.

Output

The output for this action is dynamic and depends on the object retrieved from Orderful.

Transaction object output

Output field	Description
Transaction ID	Unique identifier of the transaction.
URL	The full 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 the 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 acknowledgment.

Transaction message object output

Output field	Description
Transaction message	Returns the full transaction message for the transaction you specify. The message is returned in its original format, such as JSON or X12. You can map the Transaction message datapill into downstream steps, such as the Convert data action to convert data into another format.

Organization object output

Output field	Description
Organization ID	The unique identifier assigned to the organization in Orderful. Used for scoping trading partners, configurations, and transactions.
Name	The organization name.
EDI accounts	A list of EDI configurations used for trading partner connections. Each account defines its own ISA IDs and connection context.
EDI account ID (EDI accounts)	A unique ID for the EDI account within the organization.
Name (EDI accounts)	The name of the specific EDI account, usually referencing the trading partner and use case, such as Buyer or Supplier.
Live Interchange control header (ISA) ID (EDI accounts)	The ISA ID used in production environments for EDI transactions. Must match the trading partner’s expected value.
Test Interchange control header (ISA) ID (EDI accounts)	The ISA ID used in test or onboarding environments. Used for validating EDI flows before going live.

Acknowledgment object output

Output field	Description
URL	The full API endpoint for the acknowledgment resource.
Created at	The ISO 8601 timestamp indicating when the acknowledgment was processed by Orderful.
Status	The final status of the acknowledgment, such as ACCEPTED or REJECTED. Refer to Orderful's documentation for more information about transaction statuses (opens new window).
Transaction	A nested object containing the original transaction's reference. Typically includes its URL or ID. Allows traceability back to the related document, such as an 850 Purchase Order.
Transaction ID	The unique numeric identifier of the original transaction within Orderful.

Delivery object output

Output field	Description
Delivery ID	Unique identifier of the delivery.
URL	API endpoint URL for the delivery resource.
Status	Status of the delivery, such as SENT or FAILED. Refer to Orderful's documentation for more information about transaction statuses (opens new window).
Created at	Timestamp when the delivery was created.
Last updated at	Timestamp when the delivery was last updated.
Send succeeded at	Timestamp when the delivery was successfully sent.
Approve	Object containing the API link to approve the delivery.
URL (Approve)	API endpoint URL for approving the delivery.
Fail	Object containing the API URL to fail the delivery.
URL (Fail)	API endpoint URL for failing the delivery.