Skip to main content
Orderful
Betav0.1.0
24 actions · 1 auth method

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Key · Connector Profile

No app registration required. Uses the organization API token from Orderful, sent as the orderful-api-key header, agains…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Key · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

24 actions
Action
Description
Create Acknowledgment
Acknowledge an inbound Mosaic transaction as ACCEPTED or REJECTED.
Get Acknowledgment
Retrieve the acknowledgment recorded for a Mosaic transaction.
Create Traditional Acknowledgment
Acknowledge a Traditional (v3) transaction as ACCEPTED or REJECTED by numeric id.
Get Traditional Acknowledgment
Retrieve the acknowledgment for a Traditional (v3) transaction by numeric id.
Convert Data
Convert an EDI document between X12 and JSON formats.
Get Transaction Delivery
Retrieve a delivery of a Mosaic transaction, including its delivery status.
Accept Transaction Delivery
Mark a transaction delivery as successfully received by your system.
Fail Transaction Delivery
Mark a transaction delivery as failed, with a note explaining why.
List Inbox Transactions
Retrieve transactions waiting in a Mosaic inbox, each with its delivery.
Get Transactions From Poller Bucket
Retrieve transactions waiting in a polling bucket, each with its delivery.
Approve Delivery
Approve a Traditional (v3) delivery retrieved from a polling bucket or inbox.
Fail Delivery
Fail a Traditional (v3) delivery retrieved from a polling bucket or inbox.
Generate Label
Generate a UCC-128 (GS1-128) shipping label as PDF or ZPL.
Get Own Organization
Retrieve the organization tied to the API token, with its EDI accounts.
List Relationships
List trading partner relationships for your organization.
Create Transaction
Create a Mosaic transaction (purchase order, invoice, ship notice and more) to send to a trading partner.
List Transactions
List your organization’s Mosaic transactions, inbound and outbound, newest first.
Get Transaction
Retrieve a single Mosaic transaction by its UUID.
Get Transaction Message
Download the message content of a Mosaic transaction.
Create Traditional Transaction
Create a Traditional (v3) transaction for any supported X12 or EDIFACT type.
Create Raw Transaction
Create a Traditional (v3) transaction from a raw document such as X12, XML or CSV.
List Traditional Transactions
List Traditional (v3) transactions, newest first, with status and partner filters.
Get Traditional Transaction
Retrieve a Traditional (v3) transaction by its numeric id.
Get Traditional Transaction Message
Retrieve the message content of a Traditional (v3) transaction.