Orderful

The Orderful Developer Hub

Welcome to the Orderful developer hub. Here you'll find everything you need to start working with Orderful as quickly as possible, as well as support resources in case you get stuck. Click GET STARTED to dive in!

Get Started    API Reference

Getting Started Guide

Getting Started

Orderful is a modern B2B document trading hub. Our one-to-many design allows our customers to connect once to our API and trade EDI with the world. Our simple and easy to use software platform allows you to manage all of your EDI transactions with trading partners in your supply chain. Orderful makes EDI compliance easy with real-time set up, testing and management of all of your EDI transactions.

This guide will quickly help you get started with Orderful. If you would like to learn in detail about specific features, take a look at our Overview Page.

Logging In

In order to login to Orderful navigate to ui.orderful.com/signin and enter your username and password

Transaction Dashboard

The transaction dashboard is the home page in the Orderful UI. You can view all of your individual EDI transactions, both inbound (sent from a trading partner to you) and outbound (sent from you to your trading partner). You can filter transactions based on date, status, stream, direction, transaction type, trading partner or business number. You are also able to view real-time metrics on number of transactions and status of valid vs. invalid transactions.

Transaction level information is presented in list view below the graphic dashboard. Further transaction level detail can be found by clicking on individual transactions.

Transaction table descriptions:

  • Status: Indicates the status of an individual transaction. For more information on transaction statuses please reference Transaction Statuses.
  • Stream: Indicates whether the transaction is a test transaction or a live transaction in production
  • Direction: Indicates the direction of the transaction. In = from trading partner to you, Out = from you to trading partner
  • Transaction Type: Indicates the type of business transaction
  • Trading Partner: Trading partner the transaction is being sent to (in the case of an outbound transaction) or being received from (in the case of an inbound transaction)
  • Sender ISA ID: ISA ID of the entity that originated the transaction
  • Received ISA ID: ISA ID of the entity that received the transaction
  • Business Number: Number associated with the transaction in the Sender's system of record
  • Created At: Time the transaction was sent

For more information on the Transaction Dashboard reference Managing Transactions documentation.

Relationship Dashboard

The relationship tab displays all of your trading partner relationships. Relationships are defined as a unique transaction type per trading partner. For example, if you trade a purchase order and an invoice with Trading Partner A, you will see two relationships in your relationships dashboard, one for the purchase order and one for the invoice associated with Trading Partner A. You can filter relationships based on direction, transaction type, trading partner and active status.

Relationship table descriptions:

  • Direction: Indicates the direction of the transaction. In = from trading partner to you, Out = from you to trading partner
  • Transaction Type: Indicates the type of business transaction
  • Trading Partner: Trading partner the transaction is being sent to (in the case of an outbound transaction) or being received from (in the case of an inbound transaction)
  • Create At: Created At: Time the transaction was sent
  • Active: A "Yes" status indicates the relationship is in production and live transactions can be sent. A "No" status indicates that live transactions cannot be sent to or from the Trading Partner

Guideline Dashboard

The guideline tab lists all of the guidelines associated with your organization. Guidelines define the type and structure of transactions that you will be trading. For example, if you send invoices to your buyers you will need to create an outbound guideline for the invoice transaction type. Within the guideline you will set all the necessary fields your system of record needs to process the transaction.

Creating guidelines ensure that the data you transmit to and receive from trading partners is consistent and standardized. Guidelines help you to avoid invalid transactions and reduce charge backs. You will need to create guidelines for both inbound and outbound transactions. For more information on how to create a guideline reference Integration documentation.

You can filter guidelines based on direction, transaction type, x12 version and status.

Guideline table descriptions:

  • Direction: Indicates the direction of the transaction. In = from trading partner to you, Out = from you to trading partner
  • Transaction Type: Indicates the type of business transaction
  • Version: x12 version used in trading (default is 007050)
  • Status: Published indicates the guideline is active. Archived indicates an old version of the guideline

Settings

The organization settings tab is located on the top right of the Orderful UI. This dashboard allows you to change your organization settings, access Orderful's API documentation, switch organizations or sign out of Orderful.

Within the Settings field you are able to access both user and organization settings.

User Settings

Account Settings

The default page opens to User Account settings where you can edit your name information.

Security Settings

You can update / change your password within Security settings

Notification Settings

Notifications allow you to set up email notifications based on transaction statuses and direction. Notifications are only sent for live transactions and are set at the User level.

Organization Settings

Organization Settings

You are able to update your organization name, time zone and authorized domain within organization settings. You also have the option to upload a profile picture to your organization.

EDI Accounts

Within EDI Accounts settings you can set x12 requirements for your organization including ISA ID, organization description, x12 ID Qualifer, x12 Separator and End-of-line characters. You can edit the existing account by clicking in the table. You can add a new EDI account by clicking on the "New EDI Account" button and entering the required information.

Lookup Tables

Looking table information is contained here. You can edit an existing lookup table by clicking in the table. You can add a new table by clicking on the "New Lookup Table" button and entering the required information.

API Credentials

Your unique API token is located here. For additional information on the Orderful API please reference our API Documentation.

Billing Information

Billing information and billing support contact information can be found within billing settings.

Webhooks

You can setup Webhooks to notify you of transaction creation events within Webhooks settings. More detailed information on creating and receiving Webhooks can be found within our API documentation here: Creating and Receiving a Webhook.

Updated about a month ago

Getting Started Guide


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.