> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Orderful

> How to set up the Orderful connector, plus the actions that are available.

![Orderful](https://stackone-logos.com/api/orderful/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/orderful/changelog.md)

[24 actions](#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](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/orderful/guides/connector-profile/api-key.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/orderful/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

24 actions

ActionDescription

Create Acknowledgment`orderful_create_acknowledgment`

Acknowledge an inbound Mosaic transaction as ACCEPTED or REJECTED.

Get Acknowledgment`orderful_get_acknowledgment`

Retrieve the acknowledgment recorded for a Mosaic transaction.

Create Traditional Acknowledgment`orderful_create_v3_acknowledgment`

Acknowledge a Traditional (v3) transaction as ACCEPTED or REJECTED by numeric id.

Get Traditional Acknowledgment`orderful_get_v3_acknowledgment`

Retrieve the acknowledgment for a Traditional (v3) transaction by numeric id.

Convert Data`orderful_convert_data`

Convert an EDI document between X12 and JSON formats.

Get Transaction Delivery`orderful_get_transaction_delivery`

Retrieve a delivery of a Mosaic transaction, including its delivery status.

Accept Transaction Delivery`orderful_accept_transaction_delivery`

Mark a transaction delivery as successfully received by your system.

Fail Transaction Delivery`orderful_fail_transaction_delivery`

Mark a transaction delivery as failed, with a note explaining why.

List Inbox Transactions`orderful_list_inbox_transactions`

Retrieve transactions waiting in a Mosaic inbox, each with its delivery.

Get Transactions From Poller Bucket`orderful_get_poller_bucket_transactions`

Retrieve transactions waiting in a polling bucket, each with its delivery.

Approve Delivery`orderful_approve_delivery`

Approve a Traditional (v3) delivery retrieved from a polling bucket or inbox.

Fail Delivery`orderful_fail_delivery`

Fail a Traditional (v3) delivery retrieved from a polling bucket or inbox.

Generate Label`orderful_generate_label`

Generate a UCC-128 (GS1-128) shipping label as PDF or ZPL.

Get Own Organization`orderful_get_own_organization`

Retrieve the organization tied to the API token, with its EDI accounts.

List Relationships`orderful_list_relationships`

List trading partner relationships for your organization.

Create Transaction`orderful_create_transaction`

Create a Mosaic transaction (purchase order, invoice, ship notice and more) to send to a trading partner.

List Transactions`orderful_list_transactions`

List your organization's Mosaic transactions, inbound and outbound, newest first.

Get Transaction`orderful_get_transaction`

Retrieve a single Mosaic transaction by its UUID.

Get Transaction Message`orderful_get_transaction_message`

Download the message content of a Mosaic transaction.

Create Traditional Transaction`orderful_create_v3_transaction`

Create a Traditional (v3) transaction for any supported X12 or EDIFACT type.

Create Raw Transaction`orderful_create_v3_raw_transaction`

Create a Traditional (v3) transaction from a raw document such as X12, XML or CSV.

List Traditional Transactions`orderful_list_v3_transactions`

List Traditional (v3) transactions, newest first, with status and partner filters.

Get Traditional Transaction`orderful_get_v3_transaction`

Retrieve a Traditional (v3) transaction by its numeric id.

Get Traditional Transaction Message`orderful_get_v3_transaction_message`

Retrieve the message content of a Traditional (v3) transaction.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.