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.
- Polling the Inbox:
- Make sure you have set up your organization for inbound polling
- Call the
/inboxendpoint to retrieve pending inbound transactions.- For this API, set
HEADER: orderful-api-versiontov4
- For this API, set
- 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.
- 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’sdeliveryStatusis marked as Accepted.
