{"openapi":"3.1.0","info":{"title":"Orderful (BYOK) API","version":"0.1.0","description":"Orderful (BYOK) lets an AI assistant read your own Orderful data through the Orderful API with a key you supply (Orderful API token (US region)). Read-only: 6 tools (get_organization, list_relationships, list_transactions, get_transaction, get_transaction_message, get_transaction_acknowledgment). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-orderful.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-orderful/docs"},"termsOfService":"https://connectorbay.com/byok-orderful/terms"},"servers":[{"url":"https://byok-orderful.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-orderful/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_organization":{"post":{"operationId":"get_organization","summary":"Show the Orderful organization the key belongs to and its EDI accounts with live and test ISA IDs. Use for \"Which Orderf","description":"Show the Orderful organization the key belongs to and its EDI accounts with live and test ISA IDs. Use for \"Which Orderful organization and EDI accounts does my key belong to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_organizationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_relationships":{"post":{"operationId":"list_relationships","summary":"List trading partner relationships (sender, receiver, transaction type, status, auto-send setting). Use for \"Which tradi","description":"List trading partner relationships (sender, receiver, transaction type, status, auto-send setting). Use for \"Which trading partner relationships do I have in Orderful\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"auto_send":{"anyOf":[{"enum":["ENABLED","DISABLED"],"type":"string"},{"type":"null"}],"default":null,"description":"Only relationships with auto-send enabled or disabled.","title":"Auto Send"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many relationships to return (1 to 100).","title":"Limit"},"next_cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's metadata.pagination.links.next (the value of its nextCursor parameter) to get the next page.","title":"Next Cursor"}},"title":"list_relationshipsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_transactions":{"post":{"operationId":"list_transactions","summary":"List EDI transactions, newest first, with type, sender, receiver, business number (such as the PO number), validation, d","description":"List EDI transactions, newest first, with type, sender, receiver, business number (such as the PO number), validation, delivery and acknowledgment status. Message bodies are not included. Use for \"Which Orderful purchase orders failed validation\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"stream":{"anyOf":[{"enum":["TEST","LIVE"],"type":"string"},{"type":"null"}],"default":null,"description":"Test or live stream.","title":"Stream"},"transaction_type":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Transaction type name such as 850 Purchase Order (one value).","title":"Transaction Type"},"business_number":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Business number of the document, for example the PO number (one value).","title":"Business Number"},"validation_status":{"anyOf":[{"enum":["PROCESSING","VALID","INVALID"],"type":"string"},{"type":"null"}],"default":null,"description":"Validation status.","title":"Validation Status"},"delivery_status":{"anyOf":[{"enum":["PENDING","SENT","DELIVERED","FAILED"],"type":"string"},{"type":"null"}],"default":null,"description":"Delivery status.","title":"Delivery Status"},"acknowledgment_status":{"anyOf":[{"enum":["NOT_ACKNOWLEDGED","ACCEPTED","REJECTED","OVERDUE","ACCEPTED_WITH_ERRORS"],"type":"string"},{"type":"null"}],"default":null,"description":"Acknowledgment status.","title":"Acknowledgment Status"},"sender_isa_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Sender ISA ID (one value).","title":"Sender Isa Id"},"receiver_isa_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Receiver ISA ID (one value).","title":"Receiver Isa Id"},"created_at":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only transactions created on or before this ISO 8601 time.","title":"Created At"},"next_cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's metadata.pagination.links.next (the value of its nextCursor parameter) to get the next page.","title":"Next Cursor"}},"title":"list_transactionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_transaction":{"post":{"operationId":"get_transaction","summary":"Get one transaction by its numeric ID with parties, type, business number and status fields. Use for \"Show Orderful tran","description":"Get one transaction by its numeric ID with parties, type, business number and status fields. Use for \"Show Orderful transaction 123456\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"transaction_id":{"description":"Numeric Orderful transaction ID.","minimum":1,"title":"Transaction Id","type":"integer"}},"required":["transaction_id"],"title":"get_transactionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_transaction_message":{"post":{"operationId":"get_transaction_message","summary":"Get the message content (the EDI document as JSON) of one transaction. Can be large; it is cut to a size limit. Use for ","description":"Get the message content (the EDI document as JSON) of one transaction. Can be large; it is cut to a size limit. Use for \"Show the content of Orderful transaction 123456\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"transaction_id":{"description":"Numeric Orderful transaction ID.","minimum":1,"title":"Transaction Id","type":"integer"}},"required":["transaction_id"],"title":"get_transaction_messageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_transaction_acknowledgment":{"post":{"operationId":"get_transaction_acknowledgment","summary":"Get the acknowledgment of one transaction: status (accepted or rejected) and any errors. Use for \"Was Orderful transacti","description":"Get the acknowledgment of one transaction: status (accepted or rejected) and any errors. Use for \"Was Orderful transaction 123456 acknowledged\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"transaction_id":{"description":"Numeric Orderful transaction ID.","minimum":1,"title":"Transaction Id","type":"integer"}},"required":["transaction_id"],"title":"get_transaction_acknowledgmentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}