Prerequisites

Before you begin, make sure you have:

An Orderful organization account
Access to your API credentials
A tool for making HTTP requests (curl, Postman, or your preferred language)

Step 1: Get Your API Key

Log into the Orderful Portal
Click your profile icon in the top right corner
Select Settings
Navigate to API Credentials under Organization Settings
Copy your API Token

Step 2: Set Up Integration Testing

The fastest way to start testing is with Orderful's built-in demo trading partner:

Navigate to Integration Testing in the sidebar
Select your EDI Account
Click Add Retail Scenario Testing Demo
You'll now have access to pre-configured test scenarios

This demo partner allows you to:

Receive sample Purchase Orders (850)
Send Purchase Order Acknowledgments (855)
Send Advance Ship Notices (856)
Send Invoices (810)

Step 3: Make Your First API Call

Let's verify your API connection by listing your transactions:

curl -X GET "https://api.orderful.com/v3/transactions?limit=5" \
  -H "orderful-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Expected Response

{
  "items": [
    {
      "id": 12345,
      "transactionType": "850",
      "direction": "inbound",
      "stream": "test",
      "createdAt": "2026-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "limit": 5,
    "offset": 0,
    "total": 42
  }
}

Understanding API Versions

Orderful's API spans multiple versions. Here's a quick reference for common tasks:

Task	API Version	Endpoint
Create transaction (Mosaic)	v4	`POST /v4/transactions`
List transactions	v3	`GET /v3/transactions`
Get transaction content	v3	`GET /v3/transactions/{id}/message`
Manage inbox	v4	`GET /v4/inbox`

📘
Learn More: See the API Version Guide for complete details on when to use each version.

Next Steps

Now that you've made your first API call, here's where to go next:

Choose Your Integration Path - Decide between Mosaic, Orderful JSON, or X12 Passthrough
Mosaic Integration Guide - Build a complete integration using our recommended approach
Order to Cash Workflow - Implement the full PO → POA → ASN → Invoice flow
API Reference - Explore all available endpoints

Need Help?

Support Knowledge Base - Search our help articles
API Reference - Detailed endpoint documentation
Contact Support - Reach out to developers@orderful.com