The Partnerships API from Stedi — 3 operation(s) for partnerships.
components:
schemas:
AccessDeniedExceptionResponseContent:
description: The server response for authorization failure.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
BadRequestExceptionResponseContent:
description: The server cannot process the request due to an apparent client error.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
CoreCharacterSet:
description: When generating EDI, the character set determines the set of characters allowed in the EDI message.
Characters outside of the specified set (after applying any repairs specified in RepairOptions) will result
in an error.
enum:
- Basic
- Extended
- ExtendedHipaa
type: string
CreatePartnershipOutboundTransactionRequestContent:
properties:
characterSet:
$ref: '#/components/schemas/CoreCharacterSet'
filename:
description: Set a custom name for the generated EDI file. Stedi overwrites files with the same name,
so we recommend making the filename unique by including a timestamp or other identifier. If you do not
specify a filename, Stedi autogenerates a unique name using the same ID generated for the `fileExecutionId`.
maxLength: 300
minLength: 1
pattern: ^([a-zA-Z0-9.*'()!_-]+)$
type: string
fragmentGroupIds:
description: Specify the fragment groups to include when creating this transaction. You can only generate
EDI with a fragment group once. After you include a fragment group in generation call, Stedi locks the
fragment to prevent accidentally generating transactions with duplicate data.
items:
type: string
maxItems: 1
minItems: 1
type: array
interchangeOverrides:
$ref: '#/components/schemas/InterchangeOverrides'
mappingId:
description: Specify a mapping ID to transform the transaction data to Guide JSON format. You can find
the mapping ID on the [Mappings](https://www.stedi.com/app/mappings) page in the Stedi portal.
type: string
repairOptions:
$ref: '#/components/schemas/RepairOptions'
transaction:
description: The data for an EDI transaction. If you are not using a mapping, this transaction data must
be < 5MB and the shape should match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json)
format for the specified outbound transaction setting. If you are using a mapping, this transaction
data must be < 4MB and the shape must match the source schema for the specified mapping.
required:
- transaction
type: object
CreatePartnershipOutboundTransactionResponseContent:
properties:
fileExecutionId:
description: An ID for the process Stedi uses to generate the EDI file. This ID appears on the details
page for the generated file in the Stedi portal, and you can use it to trace the file's status and delivery.
type: string
transactionId:
description: This property is currently not supported. It is reserved for future use.
type: string
type: object
CreateTransactionGroupRequestContent:
properties:
async:
description: 'Determines if the transaction should be uploaded asynchronously through a presigned url.
Either `transaction` or `async: true` is required. Idempotency-Key header is required when using async:
true.'
type: boolean
groupOverrides:
$ref: '#/components/schemas/TransactionGroupOverrides'
mappingId:
description: 'Specify a mapping id to transform the transaction to Stedi''s Guide JSON format. Can not
be used with async: true.'
type: string
transaction:
description: 'The data for an EDI transaction. If you are not using a mapping, this transaction data must
be < 5MB and the shape should match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json)
format for the specified outbound transaction setting. If you are using a mapping, this transaction
data must be < 4MB and the shape must match the source schema for the specified mapping. Either `transaction`
or `async: true` is required.'
type: object
CreateTransactionGroupResponseContent:
properties:
createdAt:
description: The time Stedi staged the transaction.
format: date-time
type: string
transactionGroupId:
description: The transaction group ID where you created and added the transaction.
type: string
transactionId:
description: A unique ID for the staged transaction Stedi created within the group.
type: string
uploadUrl:
description: A pre-signed URL to upload the file using a `PUT` request.
type: string
required:
- createdAt
- transactionGroupId
- transactionId
type: object
ExceptionCause:
properties:
message:
type: string
name:
type: string
stack:
type: string
type: object
GatewayTimeoutExceptionResponseContent:
description: The server was acting as a gateway or proxy and did not receive a timely response from the upstream
server.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
GenerateTransactionGroupEdiRequestContent:
properties:
characterSet:
$ref: '#/components/schemas/CoreCharacterSet'
filename:
description: Set a custom name for the generated EDI file. Stedi overwrites files with the same name,
so we recommend making the filename unique by including a timestamp or other identifier. If you do not
specify a filename, Stedi autogenerates a unique name using an ID.
maxLength: 300
minLength: 1
pattern: ^([a-zA-Z0-9.*'()!_-]+)$
type: string
interchangeAuthorization:
$ref: '#/components/schemas/X12InterchangeAuthorization'
overrides:
$ref: '#/components/schemas/InterchangeOverrides'
repairOptions:
$ref: '#/components/schemas/RepairOptions'
transactionOrdering:
$ref: '#/components/schemas/TransactionOrdering'
type: object
GenerateTransactionGroupEdiResponseContent:
properties:
artifactId:
description: An ID for the generated EDI file.
type: string
fileExecutionId:
description: A ID for the process Stedi uses to generate the EDI file. This ID appears on the details
page for this file execution in the Stedi portal. Internally, Stedi uses this ID to place the file in
Stedi's outbound queue.
type: string
required:
- artifactId
- fileExecutionId
type: object
InterchangeOverrides:
properties:
acknowledgmentRequestedCode:
$ref: '#/components/schemas/X12AcknowledgmentRequestedCode'
delimiters:
$ref: '#/components/schemas/X12Delimiters'
interchangeControlVersionNumberCode:
description: Set [ISA-12](https://www.stedi.com/edi/x12/segment/ISA#ISA-12) to a different value. This
code indicates the version of the `ISA` header segments included in the EDI file. By default, Stedi
sets `ISA-12` to to be the X12 release number of the guide associated with the transaction setting.
maxLength: 5
minLength: 5
type: string
interchangeUsageIndicator:
$ref: '#/components/schemas/X12UsageIndicator'
type: object
RepairOptions:
description: Options for repairing EDI data during generation to ensure it meets X12 requirements
properties:
removeDiacritical:
description: Whether to remove diacritical marks from characters
type: boolean
replaceConfusable:
description: Whether to replace characters that are visually similar but technically different
type: boolean
replaceNonBasicCharacters:
description: Whether to replace non-basic characters with their basic equivalents
type: boolean
replaceStediCanonicalDelimitersConflicts:
description: Whether to replace characters that conflict with Stedi canonical delimiters
type: boolean
trimTrailingSpaces:
description: Whether to trim trailing spaces from data elements
type: boolean
trimTrailingZeroes:
description: Whether to trim trailing zeros from numeric data elements
type: boolean
uppercase:
description: Whether to convert text to uppercase
type: boolean
type: object
ResourceNotFoundExceptionResponseContent:
description: The server response when the specified resource cannot be found after an API request passes authentication
and authorization.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
ResourceUnderChangeExceptionResponseContent:
properties:
message:
type: string
required:
- message
type: object
ServiceExceptionResponseContent:
properties:
exceptionCause:
$ref: '#/components/schemas/ExceptionCause'
message:
type: string
required:
- message
type: object
ServiceUnavailableExceptionResponseContent:
description: The server cannot handle the request due to technical reasons.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
ThrottlingExceptionResponseContent:
description: The server response when usage plan or account-level throttling limits exceeded.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
TransactionGroupOverrides:
description: Customize the Application IDs for you or your trading partner.
properties:
localApplicationId:
description: Set the [GS-02](https://www.stedi.com/edi/x12/segment/GS#GS-02) element to a custom value.
If not set, Stedi uses the Application ID for the local profile associated with the partnership.
maxLength: 15
minLength: 2
type: string
partnerApplicationId:
description: Set the [GS-03](https://www.stedi.com/edi/x12/segment/GS#GS-03) element to a custom value.
If not set, Stedi uses the Application ID for the partner profile associated with the partnership.
maxLength: 15
minLength: 2
type: string
type: object
TransactionOrdering:
description: 'Specify the order of the transactions in the generated X12 EDI file. By default, Stedi doesn''t
guarantee any particular order.
Set to `CONTROL_NUMBER` to order transactions within a functional group by their control number, from lowest
to highest. In X12 EDI, this is `ST02` (Transaction Set Control Number).'
enum:
- CONTROL_NUMBER
type: string
UnauthorizedExceptionResponseContent:
description: The server response when the authorizer failed to authenticate the caller.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
UnprocessableEntityExceptionResponseContent:
description: The request parameters do not match a previous request with the same idempotency key.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
X12AcknowledgmentRequestedCode:
description: Set [ISA-14](https://www.stedi.com/edi/x12/segment/ISA#ISA-14) to a different value. If not set,
the default value is `0 (No Interchange Acknowledgment Requested)`.
enum:
- '0'
- '1'
- '2'
- '3'
type: string
X12AuthorizationInformationQualifier:
description: Identifies the type of information in the Authorization Information (`ISA-01`). Default is `00
- No Authorization Information Present`.
enum:
- '00'
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- 08
type: string
X12Delimiters:
properties:
composite:
description: The component element separator character.
pattern: ^[\W|_]{1}$
type: string
element:
description: The data element separator character.
pattern: ^[\W|_]{1}$
type: string
repetition:
description: The repetition separator character.
pattern: ^[\W|_]{1}$
type: string
segment:
description: The segment terminator character.
pattern: ^[\W|_]{1}$
type: string
required:
- composite
- element
- repetition
- segment
type: object
X12InterchangeAuthorization:
description: Set values for [ISA header](https://www.stedi.com/edi/x12/segment/ISA) elements (ISA-01 to ISA-04).
properties:
authorizationInformation:
description: Information used for additional identification or authorization of the interchange sender
or the data in the interchange (`ISA-02`). The type of information is set by the `authorizationInformationQualifier`.
maxLength: 10
pattern: ^.*[^ ].*$
type: string
authorizationInformationQualifier:
$ref: '#/components/schemas/X12AuthorizationInformationQualifier'
securityInformation:
description: The security information referenced by the `securityInformationQualifier` (`ISA-04`). Typically,
this is a password.
maxLength: 10
pattern: ^.*[^ ].*$
type: string
securityInformationQualifier:
$ref: '#/components/schemas/X12SecurityInformationQualifier'
type: object
X12SecurityInformationQualifier:
description: Identifies the type of information in the Security Information (ISA-03). Default is `00 - No
Security Information Present`.
enum:
- '00'
- '01'
type: string
X12UsageIndicator:
description: Set [ISA-15](https://www.stedi.com/edi/x12/segment/ISA#ISA-15) to a different value. If not set,
the default value is `P (Production Data)`.
enum:
- I
- T
- P
type: string
securitySchemes:
httpApiKeyAuth:
description: A [Stedi API Key](https://www.stedi.com/app/settings/api-keys) for authentication.
in: header
name: Authorization
type: apiKey
info:
contact:
email: healthcare@stedi.com
license:
name: Proprietary
url: https://stedi.com
title: Stedi Healthcare Claims Claim acknowledgments Partnerships API
version: '2025-03-07'
openapi: 3.0.3
paths:
/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/generate-edi:
post:
description: This endpoint generates and delivers a fully-formed EDI file containing the staged transactions
in the specified transaction group.
operationId: GenerateTransactionGroupEdi
parameters:
- description: A unique ID for this partnership within Stedi. You can find this ID on the [Trading partners](https://www.stedi.com/app/core/partnerships)
page under **Partnership identifier**.
examples:
GenerateTransactionGroupEdi_example1:
description: ''
summary: Generate EDI for transaction group
value: ACME_BSW
in: path
name: partnershipId
required: true
schema:
description: A unique ID for this partnership within Stedi. You can find this ID on the [Trading partners](https://www.stedi.com/app/core/partnerships)
page under **Partnership identifier**.
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
- description: A unique ID for a transaction group stored on Stedi. You can only call this endpoint with a
given `transactionGroupId` once. Afterward, the transaction group is locked.
examples:
GenerateTransactionGroupEdi_example1:
description: ''
summary: Generate EDI for transaction group
value: tx-group-02-21-2024
in: path
name: transactionGroupId
required: true
schema:
description: A unique ID for a transaction group stored on Stedi. You can only call this endpoint with
a given `transactionGroupId` once. Afterward, the transaction group is locked.
type: string
- description: A unique string to identify this request to the server. The key can be up to 255 characters.
You can safely retry requests with the same idempotency key within 24 hours of making the first request.
This prevents sending duplicate data to your trading partners in case of network errors or other intermittent
failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).
in: header
name: Idempotency-Key
schema:
description: A unique string to identify this request to the server. The key can be up to 255 characters.
You can safely retry requests with the same idempotency key within 24 hours of making the first request.
This prevents sending duplicate data to your trading partners in case of network errors or other intermittent
failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).
type: string
requestBody:
content:
application/json:
examples:
GenerateTransactionGroupEdi_example1:
description: ''
summary: Generate EDI for transaction group
value:
filename: my-output-file.edi
overrides:
acknowledgmentRequestedCode: '1'
interchangeUsageIndicator: T
schema:
$ref: '#/components/schemas/GenerateTransactionGroupEdiRequestContent'
responses:
'200':
content:
application/json:
examples:
GenerateTransactionGroupEdi_example1:
description: ''
summary: Generate EDI for transaction group
value:
artifactId: f75168e4-e682-4410-bfec-b5b1541c7f21.x12
fileExecutionId: f75168e4-e682-4410-bfec-b5b1541c7f21
schema:
$ref: '#/components/schemas/GenerateTransactionGroupEdiResponseContent'
description: GenerateTransactionGroupEdi 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestExceptionResponseContent'
description: BadRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
description: UnauthorizedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
description: AccessDeniedException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
description: ResourceNotFoundException 404 response
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
description: ResourceUnderChangeException 409 response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
description: UnprocessableEntityException 422 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingExceptionResponseContent'
description: ThrottlingException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceExceptionResponseContent'
description: ServiceException 500 response
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
description: ServiceUnavailableException 503 response
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
description: GatewayTimeoutException 504 response
tags:
- Partnerships
/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/transactions/{transactionSettingId}:
post:
description: This endpoint stages a transaction for outbound delivery.
operationId: CreateTransactionGroup
parameters:
- description: A unique ID for this partnership within Stedi. You can find this ID on the [Trading partners](https://www.stedi.com/app/core/partnerships)
page under **Partnership identifier**.
examples:
CreateTransactionGroup_example1:
description: ''
summary: Stage transaction
value: acme_amazon
CreateTransactionGroup_example2:
description: ''
summary: Stage transaction async
value: acme_amazon
in: path
name: partnershipId
required: true
schema:
description: A unique ID for this partnership within Stedi. You can find this ID on the [Trading partners](https://www.stedi.com/app/core/partnerships)
page under **Partnership identifier**.
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
- description: A unique ID for the outbound transaction setting Stedi should use to determine the correct
guide for validation and generation. It must be attached to the partnership associated with the `partnershipId`.
To find the `transactionSettingsId`, go to the partnership and use the **Transaction Setting ID** field
for the outbound transaction setting.
examples:
CreateTransactionGroup_example1:
description: ''
summary: Stage transaction
value: 004010-850
CreateTransactionGroup_example2:
description: ''
summary: Stage transaction async
value: 004010-850
in: path
name: transactionSettingId
required: true
schema:
description: A unique ID for the outbound transaction setting Stedi should use to determine the correct
guide for validation and generation. It must be attached to the partnership associated with the `partnershipId`.
To find the `transactionSettingsId`, go to the partnership and use the **Transaction Setting ID** field
for the outbound transaction setting.
type: string
- description: A unique ID for a group of transactions on Stedi. Stedi creates a new transaction group if
one does not exist with the specified ID.
examples:
CreateTransactionGroup_example1:
description: ''
summary: Stage transaction
value: tx-group-02-21-2024
CreateTransactionGroup_example2:
description: ''
summary: Stage transaction async
value: tx-group-02-21-2024
in: path
name: transactionGroupId
required: true
schema:
description: A unique ID for a group of transactions on Stedi. Stedi creates a new transaction group if
one does not exist with the specified ID.
type: string
- description: 'A unique string to identify this request to the server. The key can be up to 255 characters.
You can safely retry requests with the same idempotency key within 24 hours of making the first request.
This prevents sending duplicate data to your trading partners in case of network errors or other intermittent
failures. Required if providing `async: true` [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
in: header
name: Idempotency-Key
schema:
description: 'A unique string to identify this request to the server. The key can be up to 255 characters.
You can safely retry requests with the same idempotency key within 24 hours of making the first request.
This prevents sending duplicate data to your trading partners in case of network errors or other intermittent
failures. Required if providing `async: true` [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
type: string
requestBody:
content:
application/json:
examples:
CreateTransactionGroup_example1:
description: ''
summary: Stage transaction
value:
transaction:
detail:
baseline_item_data_PO1_loop:
- baseline_item_data_PO1: {}
heading:
beginning_segment_for_purchase_order_BEG:
date_05: '2023-08-11'
purchase_order_number_03: XXXXX
purchase_order_type_code_02: XX
transaction_set_purpose_code_01: XX
transaction_set_header_ST:
transaction_set_control_number_02: 1
transaction_set_identifier_code_01: '850'
summary:
transaction_set_trailer_SE:
number_of_included_segments_01: 4
transaction_set_control_number_02: 1
CreateTransactionGroup_example2:
description: ''
summary: Stage transaction async
value:
async: true
schema:
$ref: '#/components/schemas/CreateTransactionGroupRequestContent'
responses:
'201':
content:
application/json:
examples:
CreateTransactionGroup_example1:
description: ''
summary: Stage transaction
value:
createdAt: '2024-02-21T00:00:00Z'
transactionGroupId: tx-group-02-21-2024
transactionId: d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e
CreateTransactionGroup_example2:
description: ''
summary: Stage transaction async
value:
createdAt: '2024-02-21T00:00:00Z'
transactionGroupId: tx-group-02-21-2024
transactionId: d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e
uploadUrl: https://s3.amazonaws.com/bucket/key
schema:
$ref: '#/components/schemas/CreateTransactionGroupResponseContent'
description: CreateTransactionGroup 201 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestExceptionResponseContent'
description: BadRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
description: UnauthorizedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
description: AccessDeniedException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
description: ResourceNotFoundException 404 response
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
description: ResourceUnderChangeException 409 response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
description: UnprocessableEntityException 422 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingExceptionResponseContent'
description: ThrottlingException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceExceptionResponseContent'
description: ServiceException 500 response
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
description: ServiceUnavailableException 503 response
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
description: GatewayTimeoutException 504 response
tags:
- Partnerships
/partnerships/{partnershipId}/transactions/{transactionSettingId}:
post:
description: This endpoint generates and delivers fully-formed EDI files containing a single transaction.
It is the simplest way to generate EDI with Stedi.
operationId: CreatePartnershipOutboundTransaction
parameters:
- description: A unique ID for this partnership within Stedi. You can find this ID on the [Trading partners](https://www.stedi.com/app/core/partnerships)
page under **Partnership identifier**.
examples:
CreatePartnershipOutboundTransaction_example1:
description: ''
summary: Generate Transaction with Guide JSON
value: ACME_AMAZON
CreatePartnershipOutboundTransaction_example2:
description: ''
summary: Generate Transaction with Fragments
value: ACME_AMAZON
in: path
name: partnershipId
required: true
schema:
description: A unique ID for this partnership within Stedi. You can find this ID on the [Trading partners](https://www.stedi.com/app/core/partnerships)
page under **Partnership identifier**.
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
- description: A unique ID for the outbound transaction setting Stedi should use to determine the correct
guide for validation and generation. It must be attached to the partnership associated with the `partnershipId`.
To find the `transactionSettingsId`, go to the partnership and use the **Transaction Setting ID** field
for the outbound transaction setting. If you are generating a transaction with fragments, the associated
guide must be configured to use fragments.
examples:
CreatePart
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-partnerships-api-openapi.yml