How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orderful Transaction (v3) API

Create and manage EDI transactions using the v3 API.

Orderful Transaction (v3) API is one of 9 APIs that Orderful publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transaction (v3). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 6 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.15.0.

Requests are made against a single base URL, https://api.orderful.com.

8 operations 6 paths 19 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.15.0
Base URL
https://api.orderful.com
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Orderful Transaction (v3) API declares 1 security scheme for authenticating requests. An API key is passed in the header as orderful-api-key (API_KEY).

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Transaction (v3) 8

Create and manage EDI transactions using the v3 API.

POST
/v3/transactions/{transactionId}/acknowledgment
Create an Acknowledgment
TransactionControllerV3_acknowledgeTransaction 2 params body → 201
GET
/v3/transactions/{transactionId}/acknowledgment
Get an Acknowledgment
TransactionControllerV3_getAcknowledgment 2 params → 200404
POST
/v3/transactions/confirm-deliverydeprecated
Confirm the delivery of a set of Transactions
TransactionControllerV3_confirmDelivery body → 200
POST
/v3/transactions
Create a Transaction
TransactionControllerV3_create 1 param body → 201400403
GET
/v3/transactions
List Transactions
TransactionControllerV3_list 19 params → 200
POST
/v3/transactions/raw
Create a raw Transaction
TransactionControllerV3_createRaw 6 params body → 201
GET
/v3/transactions/{transactionId}
Get a Transaction
TransactionControllerV3_getById 3 params → 200404
GET
/v3/transactions/{transactionId}/message
Get a Transaction Message
TransactionControllerV3_getMessage 2 params → 200404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are TransactionV3Dto (16 properties), GetTransactionAcknowledgmentResponseV3Dto (6 properties), CreateTransactionBodyV3 (5 properties), TransactionIdentityV3Dto (5 properties). Each schema is shown below with its type and property counts.

SetTransactionAcknowledgmentRequestDto
object
2 properties 1 required
CreateTransactionBodyTypeV3Dto
object
1 property 1 required
CreateTransactionBodyIdentityV3Dto
object
1 property 1 required
TransactionMessageWithContentV3Dto
object
2 properties 2 required
TransactionAcknowledgmentRefV3Dto
object
1 property 1 required
ListTransactionsResponseV3MetadataDto
object
1 property
BatchConfirmDeliveryBody
object
3 properties 2 required
CreateTransactionResponseV3
object
1 property 1 required
TransactionV3Dto
object
16 properties 16 required
TransactionErrorMessageV3Dto
object
3 properties 3 required
CreateTransactionBodyV3
object
Request body for creating a v3 transaction.
5 properties 4 required
PaginationV3
object
1 property 1 required
TransactionReferenceIdentifierV3Dto
object
3 properties 3 required
ListTransactionsResponseV3Dto
object
2 properties 2 required
TransactionRefV3Dto
object
1 property 1 required
TransactionTypeV3Dto
object
1 property 1 required
GetTransactionAcknowledgmentResponseV3Dto
object
6 properties 5 required
TransactionIdentityV3Dto
object
5 properties 5 required
PaginationLinkV3
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orderful-transaction-v3-api-openapi.yml Raw ↑

Other APIs Orderful publishes across the network.

Orderful Conversion API
Orderful Delivery API
Orderful Inbox API
Orderful Label API
Orderful Organization API
Orderful Poller API
Orderful Relationship API
Orderful Transaction API
Where this information came from

This is an independent, third-party profile of Orderful Transaction (v3) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.