Orderful

Orderful

Orderful is a cloud EDI network: your organization trades EDI documents (X12, EDIFACT or Orderful's JSON formats) with trading partners such as retailers, suppliers and carriers. A transaction is one document (for example an 850 purchase order or an 810 invoice), sent (out) or received (in). A relationship is one agreed document type between you and one partner; the partner's organization and EDI account names appear on it.

Setup

1. Sign in at https://ui.orderful.com (US) or https://ui-eu.orderful.com (EU).
2. Click your avatar → Settings → Organization Settings → API Credentials and copy the API Token into ORDERFUL_API_KEY. It is sent in the orderful-api-key header.
3. Set ORDERFUL_API_URL to the region of your account: https://api.orderful.com (US) or https://api-eu.orderful.com (EU). Data is not shared across regions; a US key does not work on the EU host.

Start here

• orderful_get_organization checks the key and shows your organization and EDI accounts (ISA ids).
• orderful_list_transactions is the main query. Narrow it with direction (in/out), simplified_transaction_type (e.g. INVOICE, PURCHASE_ORDER, SHIP_NOTICE), stream (test or live), statuses, business_number (the PO or invoice number) and created_at_start/created_at_end.
• orderful_get_transaction_message returns the document content of one transaction.
• orderful_list_relationships lists your trading partners and which document types you exchange with each.

Ids

• Transactions from the list have a UUID id; the get, message and acknowledgment tools take that UUID.
• Inbound deliveries (from orderful_list_inbox_transactions) carry a delivery object with deliveryId and a numeric transactionId. The delivery tools take both. Orderful has announced that the numeric id in these paths will be replaced; if the accept or fail tools start answering 404, POST to the delivery.approve.href / delivery.fail.href link instead.
• The inbox id is shown in the Orderful UI under Communication Channels (Inbound Poller).

Receiving documents

Read the inbox, process each transaction, then call orderful_accept_delivery (removes it from the inbox and sets delivery status DELIVERED) or orderful_fail_delivery with a note. For relationships that trade JSON, also send a business acknowledgment with orderful_acknowledge_transaction (ACCEPTED or REJECTED, only once per transaction). X12 and EDIFACT relationships acknowledge with a 997 instead.

Sending documents

orderful_create_transaction posts one document in Orderful's Mosaic JSON for the types 850, 855, 856, 810, 846 and 860. Use stream: test until the relationship is live; a live transaction goes to the trading partner. Check validationStatus on the result: INVALID transactions are not delivered.

Pagination

List answers carry metadata.pagination.links.next; pass the nextCursor value from that URL to get the next page. No next link means the last page. Up to 100 transactions per page.

Statuses

validationStatus PROCESSING, VALID, INVALID; deliveryStatus PENDING, SENT, DELIVERED, FAILED; acknowledgmentStatus NOT_ACKNOWLEDGED, ACCEPTED, REJECTED, OVERDUE, ACCEPTED_WITH_ERRORS.