The Orderful integration communicates with the Orderful REST API (version 3). All requests are made to a single base address, shown below as [Base URL], and authenticated with an Orderful API key (see Authorization).
Base URL:
https://api.orderful.com/v3/
Throughout this document, [Base URL] stands in for that address so the paths apply to whichever Orderful environment your API key targets.
Table of Contents
Transaction Endpoints
Authorization
Transaction Endpoints
Get a Transaction (GET)
Retrieves a single Orderful transaction by its Orderful transaction ID. Used when bringing a transaction (purchase order, acknowledgement, invoice) into iPaaS.com and when verifying a transaction sent to Orderful.
[Base URL]/transactions/{id}
Get a Transaction Message (GET)
Retrieves the EDI message detail for a transaction by its Orderful transaction ID.
[Base URL]/transactions/{id}/message
Create a Transaction (POST)
Creates a transaction in Orderful. Used for outbound (FROM iPaaS.com) transfers — purchase orders, invoices, and ship-notice tracking.
[Base URL]/transactions
Get Transactions Using a Filter (GET)
Retrieves transactions that match a filter, used when polling for new documents and when locating a transaction for tracking. Results are returned a page at a time using a cursor.
[Base URL]/transactions?transactionType={transactionType}
[Base URL]/transactions?businessNumber={businessNumber}
Common filters include the transaction type (for example, 856_SHIP_NOTICE_MANIFEST) and the business number (the purchase order number used to match ship-notice tracking to its transaction).
Authorization
Orderful authenticates each request with an API key sent in the orderful-api-key request header. There is no separate token/authorization endpoint to call — the API key is generated in the Orderful portal (Account icon > Settings > Organization Settings > API Credentials) and entered into the integration's API Key setting in iPaaS.com. See the Orderful Connections and Settings article for setup steps.
Related Documents