Set up your organization as a Follower

This section will walk you through the first steps required to set up your Orderful organization.

📘

EDI Account

Every Orderful organization must have an associated EDI AccountEDI Account - Your EDI Account is the object that represents a particular ISA Qualifier or EDI ID within Orderful., and every EDI account is identified using an ISA ID and ISA ID Qualifier.

If you know your ISA ID, then we can create the organization with the known information. If you do not have your ISA ID, we can recommend a standardized ISA ID format and then create your organization after you agree.

To sign in to Orderful for the first time, you will first need an invitation email to join an organization. This email is sent by Orderful when someone invites you to join their organization or when a Trading Partner invites you to trade EDI data with them using Orderful. Click the account setup link in this email and you will be redirected to the sign-up page.

After account setup, sign in to your Orderful account from https://ui.orderful.com/signin

📘

All Trading Partners are represented in Orderful, regardless of whether they are our customers. This means that it is possible that your company is already represented by an entity within Orderful, with an "Unclaimed" status. If you are claiming a previously Unclaimed Organization, it is possible that many of the configuration steps have already been completed for you. Please contact Orderful support if you have any questions.

Settings

Click on your icon in the upper right of the Orderful UI landing page, then select Settings.

On the left hand side, under “User Settings”, click on Account and ensure that your First Name and Last Name are correct.

Under “Organization Settings”, click on Organization and check that your Organization Name and Time Zone are accurate.

Communication Channels

A Communication Channel is the connection between Orderful and your internal system. Each Communication Channel can be Inbound or Outbound. Communication channels are managed under Communication Channels.

If a Trading PartnerTrading Partner - A Trading Partner is an entity that exchanges EDI data with another entity. Put simply, if a company is sending EDI data to another company, both of them are Trading Partners. sends a transaction to you, Orderful can forward it to you over an inbound Communication Channel. Inbound Communication Channels can be one of the following types:

If you would instead like to send a transaction to a Trading Partner, you will have to first create it to Orderful. You can create a transaction by uploading it in the Orderful UI, manually entering a payload, or by sending it to Orderful over an outbound Communication Channel. Outbound Communication Channels can be one of the following types:

Inbound HTTP

The Inbound HTTP Communication Channel can POST transactions from Orderful to an HTTP endpoint that you specify. To see an example payload, refer to our API Reference.

Set up an Inbound HTTP Communication Channel
  1. Go to your Communication Channels settings.
  2. Under "Inbound", click on Create Channel > HTTP.
  3. Enter a descriptive Name for the Communication Channel, along with the URL of your HTTP endpoint.
  4. (Optional) Authorization Type: If you'd like the communication to be encrypted with OAuth 2.0, select this option and fill out your OAuth 2.0 authorization information.
  5. Click Create.

NOTE: Basic authorization is also supported. If you'd like to use it, simply include it as a part of the URL. For example: http://username:[email protected]/yourEndpoint

Test your Inbound HTTP Communication Channel
  1. Go to your Communication Channels settings.
  2. Under "Inbound", select the Inbound HTTP that you would like to test. This will open a side panel.
  3. Click on Send a test. This will bring up a modal where you can select an existing test file to send, or upload your own test file.
  4. Click Send test.
  5. Your test summary will appear in the side panel for your Communication Channel.
Sending your response to Orderful

Once your endpoint has received the transaction, you will have to respond to Orderful so that we can correctly update the status of the transaction.

For example, if you respond with an HTTP 200, we will automatically mark the transaction as DELIVERED. If you respond with an HTTP 202, this means that you have received the transaction but are not finished processing it. In the case of an HTTP 202, you will have to manually update the status of the transaction using our API that Confirms the delivery of a set of transactions. For more information, see Understand transaction delivery statuses.

Inbound Poller

If you retrieve transactions from Orderful via polling, the transactions sit in a “bucket” until they are retrieved and retrieval is confirmed. Upon confirmation, the transactions are cleared from the bucket.

Set up an Inbound Poller
  1. Go to your Communication Channels settings .
  2. Under "Inbound", click on Create Channel > Poller.
  3. Enter a descriptive Name.
  4. Click Create.

For more information, see Use the Inbound Poller API.

Inbound AS2

Orderful can be configured to POST transactions from Orderful to your AS2 server.

Set up an Inbound AS2
  1. Navigate to your Communication Channels settings.
  2. Under "Inbound", click on Create Channel > AS2.
  3. Enter in a descriptive Name.
  4. Enter your AS2 ID.
  5. Enter your AS2 URL (Include the port and path in the URL).
  6. Upload your AS2 certificate in .cer format.
  7. (Optional) If your AS2 server requires authentication, enter a username and password.
  8. Press “Create”.

📘

To receive and authenticate transactions sent by Orderful to your AS2 server, you will need Orderful's AS2 ID, AS2 certificate and the IP addresses we use. You can find this information by going to your Communication Channels page and clicking on "Orderful AS2", which will bring up the settings in a side panel.

Test your Inbound AS2
  1. Select the AS2 Communication Channel that you just created.

  2. Click on Send a test. This will bring up a modal where you can select a prepopulated test file to send, or upload your own test file.

  3. Refresh the page until the "Test Summary" section becomes populated. The AS2 Communication Channel is asynchronous, so you may have to wait a few minutes for the test result to appear. This section includes:

  • The delivery status of the test file: Pending, Delivered, Failed or Timed-out.
  • The test file that was sent, which can be downloaded by clicking on the filename.
  • The MDN response that was received, which can be downloaded by clicking on the filename.
  • An expandable log containing a record of what occurred during the test.

Inbound FTP and SFTP

While currently not available via the UI, you can contact [email protected] if you’d like to create an inbound FTP Client or SFTP Client Communication Channel.

Inbound VAN

While currently not available via the UI, you can contact [email protected] if you’d like to create an inbound VAN Communication Channel.

Outbound HTTP

  1. Go to your Communication Channels settings.
  2. Under "Outbound", click on the Orderful API channel. This will open a side panel.
  3. Use the channel's details to complete the configuration on your end of the connection.
  4. Connect to Orderful.

Outbound AS2

Orderful can be configured to receive transactions from your AS2 server.

  1. Go to your Communication Channels settings.
  2. Under "Outbound", click on the Orderful AS2 channel. This will open a side panel.
  3. Use the channel's details to complete the configuration on your end of the connection.
  4. Connect to Orderful.

Outbound FTP/SFTP

While currently not available via the UI, you can contact [email protected] if you’d like to create an outbound FTP Client or SFTP Client Communication Channel.

Outbound VAN

While currently not available via the UI, you can contact [email protected] if you’d like to create an outbound VAN Communication Channel.

Invite users to your Orderful organization

  1. Go to your Account settings.
  2. Under "Organization Settings" select Users.
  3. Click on "Invite Users" in the upper left.
  4. From the Invite users pop-up, enter the user information of the user you want to invite.
  5. After listing all the users you want to invite to your organization, click on Invite Users. A notification will pop up. If you refresh the page the users you invited will now appear in the list.

Notes:

  • You have to enter a unique email address for each user.
  • You can leave the "First Name" and "Last Name" fields empty. The invited user will be asked for their name during sign up.
  • If these users already have an Orderful account, their status after you invite them will automatically be "Active". They can now access your organization.
  • For users that don’t have an Orderful account yet, their status will be "Invite Sent". If you notice a user is stuck on the "Invite Sent" status for too long, you can always resend them the invitation email.

Did this page help you?