Inbound Transactions

There are 2 ways to receive inbound documents from your trading partner.

• Set up "webhooks" - We can POST new documents to an HTTP endpoint you set up on your server.
• Poll the Inbox -> make regular requests to GET any new inbound documents

1. Webhooks:

• Configure a webhook endpoint in your system.
  • See guide
• Orderful delivers new inbound transactions via HTTP POST.
• If your endpoint responds with 200 OK, the transaction’s deliveryStatus is marked as Accepted.

2. Polling the Inbox:

• Make sure you have set up your organization for inbound polling
  • Guide: "Communication Channel" for inbound polling
• Call the /inbox endpoint to retrieve pending inbound transactions.
  • For this API, set HEADER: orderful-api-version to v4
• After processing, you must explicitly POST back to one of the delivery links included with each transaction:
  • delivery.approve.href — you received and processed it successfully
  • delivery.fail.href — you could not process it
  • Use these href values as given. Do not assemble the URLs yourself: the numeric transaction ID they currently contain is deprecated and will be removed in an upcoming release.

This ensures Orderful knows the transaction was successfully received and processed on your side.

Acknowledging inbound transactions

Accepting a delivery tells Orderful you received the transaction. It does not tell your trading partner whether you can act on it — that is a separate, business-level acknowledgment.

If your inbound Relationship has "Send acknowledgment" enabled and trades JSON, transactions stay at NOT_ACKNOWLEDGED until you acknowledge them explicitly:

• Take the id from the delivered payload, or its ready-built transaction.acknowledgment.href — both are present in the webhook body and in each item returned by the Inbox.
• POST { "status": "ACCEPTED" } or { "status": "REJECTED" } to /transactions/{id}/acknowledgment, with HEADER: orderful-api-version set to v4.
• Guide: Acknowledge a Transaction · Reference: Create an Acknowledgment

Do not use integrationPayloadId as the Transaction ID — that is a different identifier and will return a 404.