Quick Start

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

1. Log into the Orderful Portal
2. Click your profile icon in the top right corner
3. Select Settings
4. Navigate to API Credentials under Organization Settings
5. Copy your API Token

Step 2: 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
  }
}

Step 3: Set Up Integration Testing

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

1. Navigate to Integration Testing in the sidebar
2. Select your EDI Account
3. Click Add Retail Scenario Testing Demo
4. 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 5: Receive Your First Test Transaction

Use the Resend 850 button on the Integration Testing page to send a test Purchase Order to your organization. Then retrieve it via the API:

curl -X GET "https://api.orderful.com/v3/transactions?stream=test&direction=inbound&limit=1" \
  -H "orderful-api-key: YOUR_API_KEY"

Understanding API Versions

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

📘

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 [email protected]