Inbound Transactions

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

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

  1. Polling the Inbox:
  • Make sure you have set up your organization 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 either:
    • /transactions/{transactionId}/deliveries/{deliveryId}/accept
    • /transactions/{transactionId}/deliveries/{deliveryId}/fail

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

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