ediTransactionMessage

Generate an EDI transaction message for an order. This query uses the transaction mapping factory to build context data and the renderer to generate the full transaction message JSON.

Arguments

Argument	Description	Type	Required
orderId	The ID of the order to generate the transaction for.	ID	Yes
transactionType	The EDI transaction type code (e.g., "856", "855", "810").	String	Yes
integrationId	The ID of the Orderful integration.	ID	Yes

Returns

Returns the fully rendered transaction message as JSON (Hash).

Errors

• OrderNotFoundError: Raised when the order is not found.
• IntegrationNotFoundError: Raised when the integration is not found.
• TransactionMappingNotFoundError: Raised when no transaction mapping exists for the given transaction type.
• InvalidTransactionTypeError: Raised when the transaction type is invalid or the factory class cannot be found.
• RenderError: Raised when there is an error rendering the transaction message.

ediTransactionMessage(
  integrationId: ID!
  orderId: ID!
  transactionType: String!
): JSON!

Arguments

ediTransactionMessage.integrationId ● ID! non-null scalar

The ID of the Orderful integration

ediTransactionMessage.orderId ● ID! non-null scalar

The ID of the order

ediTransactionMessage.transactionType ● String! non-null scalar

The EDI transaction type code (e.g., "856", "855")

Type

JSON scalar

Represents untyped JSON