send_outbound_document
Send outbound EDI documents to a trading partner by serializing JSON into valid EDI; delivery status is acknowledged via webhook and retries are safe with an idempotency key.
Instructions
Send an outbound EDI document to a trading partner. SignalEDI serializes the JSON payload into valid EDI and delivers it; the call returns a document id and status and is acknowledged asynchronously via webhook. Required scopes: edi:write. Requires confirm:true and idempotencyKey.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Explicitly confirm this external send. | |
| payload | Yes | The document body as JSON; serialized to EDI by SignalEDI. | |
| metadata | No | Optional metadata echoed back on lifecycle webhooks. | |
| partnerId | Yes | Trading partner id to send to. | |
| workspaceId | No | Optional workspace id (defaults to the API key's workspace). | |
| idempotencyKey | Yes | Unique key for safe retries. | |
| documentTypeCode | Yes | Document type code, e.g. "850", "810", "856". |