Stedi Partnerships API
The Partnerships API from Stedi — 3 operation(s) for partnerships.
The Partnerships API from Stedi — 3 operation(s) for partnerships.
openapi: 3.0.3
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'
servers:
- description: Production
url: https://claims.us.stedi.com/2025-03-07
security:
- httpApiKeyAuth: []
tags:
- name: Partnerships
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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTransactionGroupEdiRequestContent'
examples:
GenerateTransactionGroupEdi_example1:
summary: Generate EDI for transaction group
description: ''
value:
filename: my-output-file.edi
overrides:
interchangeUsageIndicator: T
acknowledgmentRequestedCode: '1'
parameters:
- name: partnershipId
in: path
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**.
schema:
type: string
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
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**.
required: true
examples:
GenerateTransactionGroupEdi_example1:
summary: Generate EDI for transaction group
description: ''
value: ACME_BSW
- name: transactionGroupId
in: path
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.
schema:
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.
required: true
examples:
GenerateTransactionGroupEdi_example1:
summary: Generate EDI for transaction group
description: ''
value: tx-group-02-21-2024
- name: Idempotency-Key
in: header
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).
schema:
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).
responses:
'200':
description: GenerateTransactionGroupEdi 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTransactionGroupEdiResponseContent'
examples:
GenerateTransactionGroupEdi_example1:
summary: Generate EDI for transaction group
description: ''
value:
artifactId: f75168e4-e682-4410-bfec-b5b1541c7f21.x12
fileExecutionId: f75168e4-e682-4410-bfec-b5b1541c7f21
'400':
description: BadRequestException 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestExceptionResponseContent'
'401':
description: UnauthorizedException 401 response
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
'403':
description: AccessDeniedException 403 response
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
'404':
description: ResourceNotFoundException 404 response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
'409':
description: ResourceUnderChangeException 409 response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
'422':
description: UnprocessableEntityException 422 response
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
'429':
description: ThrottlingException 429 response
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingExceptionResponseContent'
'500':
description: ServiceException 500 response
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceExceptionResponseContent'
'503':
description: ServiceUnavailableException 503 response
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
'504':
description: GatewayTimeoutException 504 response
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
tags:
- Partnerships
/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/transactions/{transactionSettingId}:
post:
description: This endpoint stages a transaction for outbound delivery.
operationId: CreateTransactionGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTransactionGroupRequestContent'
examples:
CreateTransactionGroup_example1:
summary: Stage transaction
description: ''
value:
transaction:
heading:
transaction_set_header_ST:
transaction_set_identifier_code_01: '850'
transaction_set_control_number_02: 1
beginning_segment_for_purchase_order_BEG:
transaction_set_purpose_code_01: XX
purchase_order_type_code_02: XX
purchase_order_number_03: XXXXX
date_05: '2023-08-11'
detail:
baseline_item_data_PO1_loop:
- baseline_item_data_PO1: {}
summary:
transaction_set_trailer_SE:
number_of_included_segments_01: 4
transaction_set_control_number_02: 1
CreateTransactionGroup_example2:
summary: Stage transaction async
description: ''
value:
async: true
parameters:
- name: partnershipId
in: path
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**.
schema:
type: string
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
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**.
required: true
examples:
CreateTransactionGroup_example1:
summary: Stage transaction
description: ''
value: acme_amazon
CreateTransactionGroup_example2:
summary: Stage transaction async
description: ''
value: acme_amazon
- name: transactionSettingId
in: path
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.
schema:
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.
required: true
examples:
CreateTransactionGroup_example1:
summary: Stage transaction
description: ''
value: 004010-850
CreateTransactionGroup_example2:
summary: Stage transaction async
description: ''
value: 004010-850
- name: transactionGroupId
in: path
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.
schema:
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.
required: true
examples:
CreateTransactionGroup_example1:
summary: Stage transaction
description: ''
value: tx-group-02-21-2024
CreateTransactionGroup_example2:
summary: Stage transaction async
description: ''
value: tx-group-02-21-2024
- name: Idempotency-Key
in: header
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).'
schema:
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).'
responses:
'201':
description: CreateTransactionGroup 201 response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTransactionGroupResponseContent'
examples:
CreateTransactionGroup_example1:
summary: Stage transaction
description: ''
value:
transactionGroupId: tx-group-02-21-2024
createdAt: '2024-02-21T00:00:00Z'
transactionId: d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e
CreateTransactionGroup_example2:
summary: Stage transaction async
description: ''
value:
transactionGroupId: tx-group-02-21-2024
createdAt: '2024-02-21T00:00:00Z'
transactionId: d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e
uploadUrl: https://s3.amazonaws.com/bucket/key
'400':
description: BadRequestException 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestExceptionResponseContent'
'401':
description: UnauthorizedException 401 response
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
'403':
description: AccessDeniedException 403 response
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
'404':
description: ResourceNotFoundException 404 response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
'409':
description: ResourceUnderChangeException 409 response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
'422':
description: UnprocessableEntityException 422 response
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
'429':
description: ThrottlingException 429 response
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingExceptionResponseContent'
'500':
description: ServiceException 500 response
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceExceptionResponseContent'
'503':
description: ServiceUnavailableException 503 response
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
'504':
description: GatewayTimeoutException 504 response
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePartnershipOutboundTransactionRequestContent'
examples:
CreatePartnershipOutboundTransaction_example1:
summary: Generate Transaction with Guide JSON
description: ''
value:
filename: my-output-file.edi
transaction:
heading:
transaction_set_header_ST:
transaction_set_identifier_code_01: '850'
transaction_set_control_number_02: 1
beginning_segment_for_purchase_order_BEG:
transaction_set_purpose_code_01: XX
purchase_order_type_code_02: XX
purchase_order_number_03: XXXXX
date_05: '2023-08-11'
detail:
baseline_item_data_PO1_loop:
- baseline_item_data_PO1: {}
summary:
transaction_set_trailer_SE:
number_of_included_segments_01: 4
transaction_set_control_number_02: 1
CreatePartnershipOutboundTransaction_example2:
summary: Generate Transaction with Fragments
description: ''
value:
filename: my-output-file-fragments.edi
fragmentGroupIds:
- some-fragment-group-id
transaction:
heading:
transaction_set_header_ST:
transaction_set_identifier_code_01: '850'
transaction_set_control_number_02: 1
beginning_segment_for_purchase_order_BEG:
transaction_set_purpose_code_01: XX
purchase_order_type_code_02: XX
purchase_order_number_03: XXXX
date_05: '2023-12-12'
detail:
baseline_item_data_PO1_loop: []
summary: {}
required: true
parameters:
- name: partnershipId
in: path
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**.
schema:
type: string
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
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**.
required: true
examples:
CreatePartnershipOutboundTransaction_example1:
summary: Generate Transaction with Guide JSON
description: ''
value: ACME_AMAZON
CreatePartnershipOutboundTransaction_example2:
summary: Generate Transaction with Fragments
description: ''
value: ACME_AMAZON
- name: transactionSettingId
in: path
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.
schema:
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.
required: true
examples:
CreatePartnershipOutboundTransaction_example1:
summary: Generate Transaction with Guide JSON
description: ''
value: some-setting-id
CreatePartnershipOutboundTransaction_example2:
summary: Generate Transaction with Fragments
description: ''
value: some-setting-id
- name: Idempotency-Key
in: header
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).
schema:
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).
responses:
'200':
description: CreatePartnershipOutboundTransaction 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePartnershipOutboundTransactionResponseContent'
examples:
CreatePartnershipOutboundTransaction_example1:
summary: Generate Transaction with Guide JSON
description: ''
value:
transactionId: some-transaction-id
fileExecutionId: d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e
CreatePartnershipOutboundTransaction_example2:
summary: Generate Transaction with Fragments
description: ''
value:
transactionId: some-transaction-id
fileExecutionId: d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e
'400':
description: BadRequestException 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestExceptionResponseContent'
'401':
description: UnauthorizedException 401 response
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
'403':
description: AccessDeniedException 403 response
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
'404':
description: ResourceNotFoundException 404 response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
'409':
description: ResourceUnderChangeException 409 response
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
'422':
description: UnprocessableEntityException 422 response
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
'429':
description: ThrottlingException 429 response
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingExceptionResponseContent'
'500':
description: ServiceException 500 response
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceExceptionResponseContent'
'503':
description: ServiceUnavailableException 503 response
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
'504':
description: GatewayTimeoutException 504 response
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
tags:
- Partnerships
components:
schemas:
GenerateTransactionGroupEdiRequestContent:
type: object
properties:
characterSet:
$ref: '#/components/schemas/CoreCharacterSet'
repairOptions:
$ref: '#/components/schemas/RepairOptions'
filename:
type: string
maxLength: 300
minLength: 1
pattern: ^([a-zA-Z0-9.*'()!_-]+)$
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.
overrides:
$ref: '#/components/schemas/InterchangeOverrides'
interchangeAuthorization:
$ref: '#/components/schemas/X12InterchangeAuthorization'
transactionOrdering:
$ref: '#/components/schemas/TransactionOrdering'
X12AcknowledgmentRequestedCode:
type: string
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'
TransactionOrdering:
type: string
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
ServiceExceptionResponseContent:
type: object
properties:
message:
type: string
exceptionCause:
$ref: '#/components/schemas/ExceptionCause'
required:
- message
ServiceUnavailableExceptionResponseContent:
type: object
description: The server cannot handle the request due to technical reasons.
properties:
message:
type: string
code:
type: string
required:
- message
AccessDeniedExceptionResponseContent:
type: object
description: The server response for authorization failure.
properties:
message:
type: string
code:
type: string
required:
- message
ExceptionCause:
type: object
properties:
name:
type: string
message:
type: string
stack:
type: string
ResourceNotFoundExceptionResponseContent:
type: object
description: The server response when the specified resource cannot be found after an API request passes authentication and authorization.
properties:
message:
type: string
code:
type: string
required:
- message
X12UsageIndicator:
type: string
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
InterchangeOverrides:
type: object
properties:
interchangeUsageIndicator:
$ref: '#/components/schemas/X12UsageIndicator'
acknowledgmentRequestedCode:
$ref: '#/components/schemas/X12AcknowledgmentRequestedCode'
interchangeControlVersionNumberCode:
type: string
maxLength: 5
minLength: 5
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.
delimiters:
$ref: '#/components/schemas/X12Delimiters'
TransactionGroupOverrides:
type: object
description: Customize the Application IDs for you or your trading partner.
properties:
localApplicationId:
type: string
maxLength: 15
minLength: 2
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.
partnerApplicationId:
type: string
maxLength: 15
minLength: 2
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.
RepairOptions:
type: object
description: Options for repairing EDI data during generation to ensure it meets X12 requirements
properties:
trimTrailingSpaces:
type: boolean
description: Whether to trim trailing spaces from data elements
uppercase:
type: boolean
description: Whether to convert text to uppercase
replaceConfusable:
type: boolean
description: Whether to replace characters that are visually similar but technically different
removeDiacritical:
type: boolean
description: Whether to remove diacritical marks from characters
replaceNonBasicCharacters:
type: boolean
description: Whether to replace non-basic characters with their basic equivalents
replaceStediCanonicalDelimitersConflicts:
type: boolean
description: Whether to replace characters that conflict with Stedi canonical delimiters
trimTrailingZeroes:
type: boolean
description: Whether to trim trailing zeros from numeric data elements
X12InterchangeAuthorization:
type: object
description: Set values for [ISA header](https://www.stedi.com/edi/x12/segment/ISA) elements (ISA-01 to ISA-04).
properties:
authorizationInformationQualifier:
$ref: '#/components/schemas/X12AuthorizationInformationQualifier'
authorizationInformation:
type: string
maxLength: 10
pattern: ^.*[^ ].*$
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`.
securityInformationQualifier:
$ref: '#/components/schemas/X12SecurityInformationQualifier'
securityInformation:
type: string
maxLength: 10
pattern: ^.*[^ ].*$
description: The security information referenced by the `securityInformationQualifier` (`ISA-04`). Typically, this is a password.
CreateTransactionGroupRequestContent:
type: object
properties:
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.'
mappingId:
type: string
description: 'Specify a mapping id to transform the transaction to Stedi''s Guide JSON format. Can not be used with async: true.'
groupOverrides:
$ref: '#/components/schemas/TransactionGroupOverrides'
async:
type: boolean
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.'
UnauthorizedExceptionResponseContent:
type: object
description: The server response when the authorizer failed to authenticate the caller.
properties:
message:
type: string
code:
type: string
required:
- message
GatewayTimeoutExceptionResponseContent:
type: object
description: The server was acting as a gatew
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-partnerships-api-openapi.yml