Workato EDI - New transactions in polling bucket trigger

The New transactions in polling bucket trigger monitors a polling bucket you specify for new transactions in Orderful. This trigger automatically approves delivery for each transaction it retrieves and clears your bucket immediately after retrieval to avoid data duplication. The Delivery status of retrieved transactions shows as Sent rather than Delivered. This is because the status is captured at the moment of retrieval before the approval completes.

ANY FILE TRANSACTIONS

Any File transactions include a nested Download object with a Download URL datapill in the Message object output. Map this datapill into the Download transaction file action to retrieve the file contents.

Refer to the Orderful documentation for more information about Any File transactions.

TRANSACTION SIZE LIMIT

This trigger skips transactions larger than 50 MB. Their Delivery status stays Sent instead of updating to Delivered, and each skipped transaction counts against the trigger's configured batch size without appearing in the output.

Transactions this large are extremely rare in practice. If one occurs, handle it manually in Orderful and Workato.

Input

Input fieldDescription
Bucket IDProvide the ID of the polling bucket you plan to monitor for new transactions.

To retrieve the polling bucket ID, sign in to Orderful, go to Communication Channels, select a communication channel, and locate the Retrieval URL. The polling bucket ID is the last sequence of digits in the URL. For example, if your channel's retrieval URL is https://api.orderful.com/v3/polling-buckets/12345, the bucket ID is 12345.
Trigger poll intervalDetermine how frequently to check for new events. Defaults to five minutes if left blank. The minimum value allowed is five minutes.
Batch sizeSpecify the number of transactions to retrieve per batch. Accepts values from 1 to 100. Defaults to 100 if left blank.

Output

Output fieldDescription
Transaction IDUnique identifier of the transaction.
URLThe full API endpoint URL for the transaction resource.
VersionAPI version used. For example, v3.
SenderObject 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.
ReceiverObject containing details about the receiver trading partner.
Name (Sender)Name of the sender 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.
TypeObject 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.
StreamIndicates whether the transaction was sent to a production or test communication channel. Returns TEST for test communication channels and LIVE for production communication channels.
Business numberThe primary business document identifier for the transaction. The value varies by transaction type. For example, this is the same value as the purchase order number for an 850 or an invoice number for an 810.
Reference identifiersControl numbers from the EDI envelope headers (interchange, functional group, and transaction set) that Orderful captures from a processed transaction.
Value (Reference identifiers)The control number value captured from the EDI envelope.
Type (Reference identifiers)The EDI envelope header the control number came from. Returns INTERCHANGE, GROUP, or TRANSACTION.
Owner (Reference identifiers)The party that owns the reference identifier. Returns SENDER or RECEIVER.
MessageObject containing the transaction message details. Also contains a nested Download object for Any File transactions.
URL (Message)API endpoint URL to retrieve the transaction message.
Transaction message (Message)Standard EDI transactions return the full transaction message of the delivered transaction in JSON. You can map the Transaction message datapill into downstream steps, such as the Convert data format action to convert data into the original EDI format or use another connector like JSON Tools by Workato to parse full message granular datapills.

Any File transactions don't populate this field. Use the Download URL datapill and pass it to the Download transaction file action to retrieve the file contents.
Download (Message)Object containing download details for the transaction file. Populated for Any File transactions.
Download URL (Download)The download URL of the transaction file. Map the Download URL datapill into the Download transaction file action to retrieve the file contents.

The URL expires 24 hours after retrieval and refreshes each time the bucket is polled.
Validation statusStatus of EDI validation, such as VALID or INVALID.
Refer to Orderful's documentation for more information about transaction statuses.
Delivery statusStatus of delivery to the trading partner, such as SENT or FAILED.
Refer to Orderful's documentation for more information about transaction statuses.
Acknowledgment statusStatus of acknowledgment, such as ACCEPTED, REJECTED, or NOT_ACKNOWLEDGED.
Refer to the Orderful transaction statuses documentation for more information.
Created atTimestamp when the transaction was created.
Last updated atTimestamp when the transaction was last updated.
AcknowledgmentObject containing acknowledgment details.
URL (Acknowledgment)API endpoint URL for the acknowledgment, if available.
DeliveryObject containing delivery details.
Delivery ID (Delivery)Unique identifier of the delivery.
URL (Delivery)API endpoint URL for the delivery.
Approve (Delivery)Object containing the API endpoint URL to approve the delivery.
URL (Approve)API endpoint URL to approve the delivery.
Fail (Delivery)Object containing the API endpoint URL to fail the delivery.
URL (Fail)API endpoint URL to fail the delivery.

Last updated: