{ "openapi": "3.0.2", "info": { "title": "Core", "version": "2023-08-01", "contact": { "email": "core@stedi.com" }, "license": { "name": "Proprietary", "url": "https://stedi.com" } }, "paths": { "/events/{eventId}/destinations/attempts": { "get": { "description": "Fetch webhook delivery attempts for a specific event id.", "operationId": "GetWebhookDeliveryAttempts", "parameters": [ { "name": "eventId", "in": "path", "description": "The ID of the event you want to get webhook delivery logs for", "schema": { "type": "string", "description": "The ID of the event you want to get webhook delivery logs for" }, "required": true } ], "responses": { "200": { "description": "GetWebhookDeliveryAttempts 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookDeliveryAttemptsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/events/{eventId}/destinations/attempts/{attemptId}": { "get": { "description": "Fetch webhook delivery attempt details for a specific event id and attempt id.", "operationId": "GetWebhookDeliveryAttemptDetails", "parameters": [ { "name": "eventId", "in": "path", "description": "The ID of the event you want to get logs for", "schema": { "type": "string", "description": "The ID of the event you want to get logs for" }, "required": true }, { "name": "attemptId", "in": "path", "description": "The ID of the attempt you want to get detailed logs for", "schema": { "type": "string", "description": "The ID of the attempt you want to get detailed logs for" }, "required": true } ], "responses": { "200": { "description": "GetWebhookDeliveryAttemptDetails 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhookDeliveryAttemptDetailsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/events/{eventId}/retry": { "post": { "description": "This endpoint retriggers the specified processing event.", "operationId": "RetryEvent", "parameters": [ { "name": "eventId", "in": "path", "description": "The ID of the event you want Stedi to re-emit.", "schema": { "type": "string", "description": "The ID of the event you want Stedi to re-emit." }, "required": true, "examples": { "RetryEvent_example1": { "summary": "Retry event", "description": "", "value": "f75168e4-e682-4410-bfec-b5b1541c7f21" } } } ], "responses": { "200": { "description": "RetryEvent 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetryEventResponseContent" }, "examples": { "RetryEvent_example1": { "summary": "Retry event", "description": "", "value": { "eventId": "f75168e4-e682-4410-bfec-b5b1541c7f22" } } } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions": { "get": { "description": "Fetch a list of executions, sorted by the date they were created from newest to oldest.", "operationId": "ListExecutions", "parameters": [ { "name": "pageSize", "in": "query", "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.", "schema": { "type": "number", "minimum": 1, "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100." } }, { "name": "pageToken", "in": "query", "description": "An opaque token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.", "schema": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "An opaque token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results." } } ], "responses": { "200": { "description": "ListExecutions 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExecutionsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}": { "get": { "description": "Retrieve the file execution details for a given executionId.", "operationId": "GetExecution", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "200": { "description": "GetExecution 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutionResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}/input": { "get": { "description": "This endpoint retrieves an execution's input document before it passes through any translation and mappings.", "operationId": "GetExecutionInputDocument", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "GetExecutionInputDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutionInputDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}/input-url": { "get": { "description": "This endpoint is used to retrieve an execution's input document before it passes through any translation and mappings. Generally, this will be EDI. This endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.", "operationId": "GetExecutionInputDocumentUrl", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "GetExecutionInputDocumentUrl 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutionInputDocumentUrlResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}/metadata": { "get": { "description": "This endpoint retrieves an execution's metadata document.", "operationId": "GetExecutionMetadataDocument", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "GetExecutionMetadataDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutionMetadataDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}/metadata-url": { "get": { "description": "This endpoint is used to retrieve a file execution's metadata document, limited to inbound/outbound x12 files. This endpoint returns the metadata document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.", "operationId": "GetExecutionMetadataDocumentUrl", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "GetExecutionMetadataDocumentUrl 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutionMetadataDocumentUrlResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}/output": { "get": { "description": "This endpoint retrieves an execution's output document.", "operationId": "GetExecutionOutputDocument", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file delivered event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-delivered), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file delivered event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-delivered), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "GetExecutionOutputDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutionOutputDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}/output-url": { "get": { "description": "This endpoint is used to retrieve an execution's output document. This endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.", "operationId": "GetExecutionOutputDocumentUrl", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "GetExecutionOutputDocumentUrl 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutionOutputDocumentUrlResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/executions/{executionId}/transactions": { "get": { "description": "Fetch a list of transactions for a given file execution, sorted by the date they were created from newest to oldest. Includes the full transaction details.", "operationId": "ListExecutionTransactions", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true }, { "name": "pageSize", "in": "query", "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.", "schema": { "type": "number", "maximum": 500, "minimum": 1, "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100." } }, { "name": "pageToken", "in": "query", "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.", "schema": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results." } } ], "responses": { "200": { "description": "ListExecutionTransactions 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExecutionTransactionsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/fragments/{fragmentGroupId}": { "post": { "description": "This endpoint stages a fragment for outbound delivery.", "operationId": "CreateOutboundFragment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutboundFragmentRequestContent" }, "examples": { "CreateOutboundFragment_example1": { "summary": "Stage fragment", "description": "", "value": { "guideId": "01HQ1XPE9C3SCEB2ND7VC53A8M", "fragment": { "baseline_item_data_PO1_loop": [ { "baseline_item_data_PO1": { "assigned_identification_01": "123", "quantity_02": 3, "unit_or_basis_for_measurement_code_03": "XX", "unit_price_04": 3 } }, { "baseline_item_data_PO1": { "assigned_identification_01": "456", "quantity_02": 4, "unit_or_basis_for_measurement_code_03": "XX", "unit_price_04": 4 } }, { "baseline_item_data_PO1": { "assigned_identification_01": "789", "quantity_02": 5, "unit_or_basis_for_measurement_code_03": "XX", "unit_price_04": 5 } }, { "baseline_item_data_PO1": { "assigned_identification_01": "756", "quantity_02": 3, "unit_or_basis_for_measurement_code_03": "XX", "unit_price_04": 3 } }, { "baseline_item_data_PO1": { "assigned_identification_01": "432", "quantity_02": 4, "unit_or_basis_for_measurement_code_03": "XX", "unit_price_04": 4 } }, { "baseline_item_data_PO1": { "assigned_identification_01": "543", "quantity_02": 5, "unit_or_basis_for_measurement_code_03": "XX", "unit_price_04": 5 } } ] } } } } } }, "required": true }, "parameters": [ { "name": "fragmentGroupId", "in": "path", "description": "A unique ID for a group of fragments on Stedi. Stedi creates a new fragment group if one does not exist with the specified ID.", "schema": { "type": "string", "description": "A unique ID for a group of fragments on Stedi. Stedi creates a new fragment group if one does not exist with the specified ID." }, "required": true, "examples": { "CreateOutboundFragment_example1": { "summary": "Stage fragment", "description": "", "value": "fragmentGroup-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": { "201": { "description": "CreateOutboundFragment 201 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutboundFragmentResponseContent" }, "examples": { "CreateOutboundFragment_example1": { "summary": "Stage fragment", "description": "", "value": { "fragmentGroupId": "some-transaction-id", "createdAt": "2024-02-21T00:00:00Z", "fragmentId": "d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e" } } } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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": "ResourceConflictException 409 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceConflictExceptionResponseContent" } } } }, "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" } } } } } } }, "/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": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/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": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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": "ResourceConflictException 409 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceConflictExceptionResponseContent" } } } }, "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" } } } } } } }, "/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": { "fileExecutionId": "d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e" } }, "CreatePartnershipOutboundTransaction_example2": { "summary": "Generate Transaction with Fragments", "description": "", "value": { "fileExecutionId": "d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e" } } } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/pg-executions/{executionId}": { "get": { "description": "Retrieve the file execution details for a given executionId.", "operationId": "PgGetExecution", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "200": { "description": "PgGetExecution 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PgGetExecutionResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/pg-executions/{executionId}/faults": { "get": { "description": "Fetch a list of faults for a given file execution, sorted by the date they were created from newest to oldest.", "operationId": "PgListExecutionFaults", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true }, { "name": "pageSize", "in": "query", "description": "The maximum number of elements to return in a page. If not specified, the default is 100.", "schema": { "type": "number", "maximum": 500, "minimum": 1, "description": "The maximum number of elements to return in a page. If not specified, the default is 100." } }, { "name": "pageToken", "in": "query", "description": "`pageToken` is an opaque token returned by a previous call to this operation in the `nextPageToken`", "schema": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "`pageToken` is an opaque token returned by a previous call to this operation in the `nextPageToken`" } } ], "responses": { "200": { "description": "PgListExecutionFaults 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PgListExecutionFaultsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/pg-executions/{executionId}/input": { "get": { "description": "This endpoint retrieves an execution's input document before it passes through any translation and mappings.", "operationId": "PgGetExecutionInputDocument", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "PgGetExecutionInputDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PgGetExecutionInputDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/pg-executions/{executionId}/metadata": { "get": { "description": "This endpoint retrieves an execution's metadata document.", "operationId": "PgGetExecutionMetadataDocument", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "PgGetExecutionMetadataDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PgGetExecutionMetadataDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/pg-executions/{executionId}/output": { "get": { "description": "This endpoint retrieves an execution's output document.", "operationId": "PgGetExecutionOutputDocument", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file delivered event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-delivered), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file delivered event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-delivered), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "PgGetExecutionOutputDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PgGetExecutionOutputDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/pg-executions/{executionId}/transactions": { "get": { "description": "Fetch a list of transactions for a given file execution, sorted by the date they were created from newest to oldest. Includes the full transaction details.", "operationId": "PgListExecutionTransactions", "parameters": [ { "name": "executionId", "in": "path", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the file execution within Stedi. This ID is included in the [file processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#file-processed), or you can retrieve it manually from the file's details page within the Stedi app." }, "required": true }, { "name": "pageSize", "in": "query", "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.", "schema": { "type": "number", "maximum": 500, "minimum": 1, "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100." } }, { "name": "pageToken", "in": "query", "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.", "schema": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results." } } ], "responses": { "200": { "description": "PgListExecutionTransactions 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PgListExecutionTransactionsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/polling/executions": { "get": { "description": "This endpoint is used to regularly poll for new executions that have been processed by Stedi.\n\nYou must define one of `startDateTime` or `pageToken` when making a request.\n\nYou may optionally define a `pageSize`. The minimum `pageSize` is 1, and the maximum `pageSize` is 1000. The default is 100.\n\n`startDateTime` takes a string in ISO 8601 format. (ex: `2023-08-10T18:00:00Z`). \n`startDateTime` must be set to at least 1 minute in the past.\n\nThe results will contain executions that occurred after this `startDateTime`. Starting from the oldest to newest executions ordered by the `processedAt` field. Note, this is _exclusive_ of the `startDateTime`, a execution occuring at exactly `2023-08-10T18:00:00Z` for instance, would not be included. In addition, there is a 15 second window where newly created executions will not be included to account for any network latency or clock drifts within the systems to ensure you do not miss any executions.\n\nEach request will _always_ return a `nextPageToken`, regardless of whether there are new executions or not.\n\nWe DO NOT recommend trying to roll your own polling strategy leveraging `startDateTime` only. There are edge cases around two executions occuring at the _exact_ same time and being on the edge of a pagination which could cause you to miss one due to the exclusive nature of `startDateTime`. We recommend using `pageToken`'s instead.\n\nWhen making subsequent polling requests (not initiating with `startDateTime`), the `pageToken` can be used to continue iterating through pages of executions. Usage of the `pageToken` guaruntees you will not miss any executions on the stream. If at any point there are no more new executions in the `item` array, you will still receive a `nextPageToken`. Continue to use this token to poll for new executions. Once there are new executions, they will be returned in the `item` array.\n\n`pageToken`'s you have retrieved can serve as checkpoints. They do not expire, and you can always start from that point in the execution stream again if you need to catch a system up or recover from a failure. Storing `pageToken`'s as part of your polling process is encouraged.\n\n`pageToken`'s are unique per request, opaque, and should not be parsed or modified in any way. They are not guaranteed to be in any particular format, and may change in the future.\n", "operationId": "ListPollingExecutions", "parameters": [ { "name": "pageSize", "in": "query", "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.", "schema": { "type": "number", "minimum": 1, "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100." } }, { "name": "pageToken", "in": "query", "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.", "schema": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results." } }, { "name": "startDateTime", "in": "query", "description": "An ISO 8601 formatted string. For example `2023-08-28T00:00:00Z`. Stedi returns executions processed after this time.", "schema": { "type": "string", "description": "An ISO 8601 formatted string. For example `2023-08-28T00:00:00Z`. Stedi returns executions processed after this time.", "format": "date-time" } } ], "responses": { "200": { "description": "ListPollingExecutions 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPollingExecutionsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/polling/transactions": { "get": { "description": "This endpoint is used to regularly poll for new transactions that have been processed in Core.\n\nYou must define one of `startDateTime` or `pageToken` when making a request.\n\nYou may optionally define a `pageSize`. The minimum `pageSize` is 1, and the maximum `pageSize` is 1000. The default is 100.\n\n`startDateTime` takes a string in ISO 8601 format. (ex: `2023-08-10T18:00:00Z`). \n`startDateTime` must be set to at least 1 minute in the past.\n\nThe results will contain transactions that occurred after this `startDateTime`. Starting from the oldest to newest transactions ordered by the `processedAt` field. Note, this is _exclusive_ of the `startDateTime`, a transaction occuring at exactly `2023-08-10T18:00:00Z` for instance, would not be included. In addition, there is a 15 second window where newly created transactions will not be included to account for any network latency or clock drifts within the systems to ensure you do not miss any transactions.\n\nEach request will _always_ return a `nextPageToken`, regardless of whether there are new transactions or not.\n\nWe DO NOT recommend trying to roll your own polling strategy leveraging `startDateTime` only. There are edge cases around two transactions occuring at the _exact_ same time and being on the edge of a pagination which could cause you to miss one due to the exclusive nature of `startDateTime`. We recommend using `pageToken`'s instead.\n\nWhen making subsequent polling requests (not initiating with `startDateTime`), the `pageToken` can be used to continue iterating through pages of transactions. Usage of the `pageToken` guaruntees you will not miss any transactions on the stream. If at any point there are no more new transactions in the `item` array, you will still receive a `nextPageToken`. Continue to use this token to poll for new transactions. Once there are new transactions, they will be returned in the `item` array.\n\n`pageToken`'s you have retrieved can serve as checkpoints. They do not expire, and you can always start from that point in the transaction stream again if you need to catch a system up or recover from a failure. Storing `pageToken`'s as part of your polling process is encouraged.\n\n`pageToken`'s are unique per request, opaque, and should not be parsed or modified in any way. They are not guaranteed to be in any particular format, and may change in the future.\n", "operationId": "ListPollingTransactions", "parameters": [ { "name": "pageSize", "in": "query", "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.", "schema": { "type": "number", "minimum": 1, "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100." } }, { "name": "pageToken", "in": "query", "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.", "schema": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results." } }, { "name": "startDateTime", "in": "query", "description": "An ISO 8601 formatted string. For example `2023-08-28T00:00:00Z`. Stedi returns transactions processed after this time.", "schema": { "type": "string", "description": "An ISO 8601 formatted string. For example `2023-08-28T00:00:00Z`. Stedi returns transactions processed after this time.", "format": "date-time" } } ], "responses": { "200": { "description": "ListPollingTransactions 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPollingTransactionsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions": { "get": { "description": "Fetch a list of transactions, sorted by the date they were created from newest to oldest.\nGenerally this endpoint is used to display a list of transactions in a UI.\nIf you are looking to regularly fetch and check for new transactions for programmatic usage, you should use the `ListPollingTransactions` operation instead.", "operationId": "ListTransactions", "parameters": [ { "name": "pageSize", "in": "query", "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.", "schema": { "type": "number", "maximum": 500, "minimum": 1, "description": "The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100." } }, { "name": "pageToken", "in": "query", "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.", "schema": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results." } } ], "responses": { "200": { "description": "ListTransactions 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}": { "get": { "description": "Fetch a single transaction by its ID.", "operationId": "GetTransaction", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "200": { "description": "GetTransaction 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/attachment/{artifactId}": { "get": { "description": "This endpoint retrieves a transaction's output document after it has been translated.", "operationId": "GetTransactionAttachmentDocument", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true }, { "name": "artifactId", "in": "path", "description": "A unique identifier for the artifact within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the artifact within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "GetTransactionAttachmentDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionAttachmentDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/attachment/{artifactId}/url": { "get": { "description": "This endpoint is used to retrieve a transaction's attachment document url.\n\nThis endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.\n", "operationId": "GetTransactionAttachmentDocumentUrl", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true }, { "name": "artifactId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "GetTransactionAttachmentDocumentUrl 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionAttachmentDocumentUrlResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/fragments/{fragmentIndex}": { "get": { "description": "This endpoint fetches a fragment by its index for a given transaction.", "operationId": "GetTransactionFragment", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true }, { "name": "fragmentIndex", "in": "path", "description": "The identifier for a specific fragment within a processed transaction. This ID is included in the [fragment processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#fragment-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "number", "description": "The identifier for a specific fragment within a processed transaction. This ID is included in the [fragment processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#fragment-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "200": { "description": "GetTransactionFragment 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionFragmentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/fragments/{fragmentIndex}/output": { "get": { "description": "This endpoint retrieves a transaction fragment's output document after it has been translated.", "operationId": "GetTransactionFragmentOutputDocument", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true }, { "name": "fragmentIndex", "in": "path", "description": "The identifier for a specific fragment within a processed transaction. This ID is included in the [fragment processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#fragment-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "number", "description": "The identifier for a specific fragment within a processed transaction. This ID is included in the [fragment processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#fragment-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "GetTransactionFragmentOutputDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionFragmentOutputDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/fragments/{fragmentIndex}/output-url": { "get": { "description": "This endpoint is used to retrieve a transaction fragment's output document URL after it has been translated via Core.\n\nThis endpoint returns the document download URL, it must be then fetched for the actual document content.\nThere are no size restrictions on documents when fetching from this endpoint, however they are generally smaller and consumable by nature of being a fragment.\n", "operationId": "GetTransactionFragmentOutputDocumentUrl", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true }, { "name": "fragmentIndex", "in": "path", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "GetTransactionFragmentOutputDocumentUrl 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionFragmentOutputDocumentUrlResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/input": { "get": { "description": "This endpoint retrieves a transaction's input document before it passes through any translation and mappings.", "operationId": "GetTransactionInputDocument", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "GetTransactionInputDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionInputDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/input-url": { "get": { "description": "This endpoint is used to retrieve a transaction's input document url before it passes through any translation and mappings, generally this will be EDI.\n\nThis endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.\n", "operationId": "GetTransactionInputDocumentUrl", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "200": { "description": "GetTransactionInputDocumentUrl 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionInputDocumentUrlResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/output": { "get": { "description": "This endpoint retrieves a transaction's output document after it has been translated.", "operationId": "GetTransactionOutputDocument", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [transaction processed event](https://www.stedi.com/docs/edi-platform/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "302": { "description": "GetTransactionOutputDocument 302 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionOutputDocumentResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/transactions/{transactionId}/output-url": { "get": { "description": "This endpoint is used to retrieve a transaction's output document url after it has been translated via Core.\n\nThis endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.\n", "operationId": "GetTransactionOutputDocumentUrl", "parameters": [ { "name": "transactionId", "in": "path", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app.", "schema": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "required": true } ], "responses": { "200": { "description": "GetTransactionOutputDocumentUrl 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionOutputDocumentUrlResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } }, "/x12/partnerships/{partnershipId}/configuration": { "delete": { "operationId": "DeleteX12PartnershipConfiguration", "parameters": [ { "name": "partnershipId", "in": "path", "description": "Identifier chosen by the user to uniquely identify a partnership.", "schema": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "Identifier chosen by the user to uniquely identify a partnership." }, "required": true } ], "responses": { "200": { "description": "DeleteX12PartnershipConfiguration 200 response" }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } }, "get": { "operationId": "GetX12PartnershipConfiguration", "parameters": [ { "name": "partnershipId", "in": "path", "description": "Identifier chosen by the user to uniquely identify a partnership.", "schema": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "Identifier chosen by the user to uniquely identify a partnership." }, "required": true } ], "responses": { "200": { "description": "GetX12PartnershipConfiguration 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetX12PartnershipConfigurationResponseContent" } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } }, "put": { "operationId": "PutX12PartnershipConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutX12PartnershipConfigurationRequestContent" } } } }, "parameters": [ { "name": "partnershipId", "in": "path", "description": "Identifier chosen by the user to uniquely identify a partnership.", "schema": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "Identifier chosen by the user to uniquely identify a partnership." }, "required": true } ], "responses": { "200": { "description": "PutX12PartnershipConfiguration 200 response" }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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": "ResourceConflictException 409 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceConflictExceptionResponseContent" } } } }, "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" } } } } } } }, "/x12/partnerships/{partnershipId}/generate-edi": { "post": { "description": "This endpoint generates and delivers fully-formed EDI files to your trading partners.", "operationId": "GenerateEdi", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateEdiRequestContent" }, "examples": { "GenerateEdi_example1": { "summary": "Generate EDI", "description": "", "value": { "filename": "my-output-file.edi", "overrides": { "interchangeUsageIndicator": "T", "acknowledgmentRequestedCode": "1" }, "transactionGroups": [ { "transactionSettingId": "some-setting-id", "overrides": { "localApplicationId": "customLocal", "partnerApplicationId": "customPartner" }, "transactions": [ { "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 } } } ] } ] } } } } }, "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": { "GenerateEdi_example1": { "summary": "Generate EDI", "description": "", "value": "ACME_BSW" } } }, { "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": "GenerateEdi 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateEdiResponseContent" }, "examples": { "GenerateEdi_example1": { "summary": "Generate EDI", "description": "", "value": { "edi": "ISA*00* *00* *14*ANOTHERMERCH *ZZ*THISISME *230828*0900*^*00801*000000002*1*P*>~GS*PO*ANOTHERMERCH*THISISME*20230828*090020*000000002*X*008010~ST*850*0001~BEG*XX*XX*XXXXX**20230811~PO1~SE*4*0001~GE*1*000000002~IEA*1*000000002~", "artifactId": "f75168e4-e682-4410-bfec-b5b1541c7f21.x12", "fileExecutionId": "f75168e4-e682-4410-bfec-b5b1541c7f21" } } } } } }, "400": { "description": "ResourceUnderChangeException 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnderChangeExceptionResponseContent" } } } }, "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" } } } }, "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" } } } } } } } }, "components": { "schemas": { "AccessDeniedExceptionResponseContent": { "type": "object", "description": "The server response for authorization failure.", "properties": { "message": { "type": "string", "description": "Human readable exception message." }, "code": { "type": "string", "description": "Classification of the exception type." } }, "required": [ "message" ] }, "Artifact": { "type": "object", "properties": { "artifactType": { "$ref": "#/components/schemas/ArtifactType" }, "usage": { "$ref": "#/components/schemas/ArtifactUsage" }, "sizeBytes": { "type": "number" }, "url": { "type": "string" }, "model": { "$ref": "#/components/schemas/ArtifactModel" } }, "required": [ "artifactType", "model", "sizeBytes", "url", "usage" ] }, "ArtifactModel": { "type": "string", "enum": [ "execution", "fragment", "transaction", "fault" ] }, "ArtifactType": { "type": "string", "enum": [ "text/csv", "application/edifact", "application/filepart", "application/json", "application/pdf", "text/psv", "text/tsv", "application/edi-x12", "application/xml", "application/zip", "image/jpeg", "image/png", "image/tiff", "text/plain" ] }, "ArtifactUsage": { "type": "string", "enum": [ "attachment", "input", "metadata", "output" ] }, "BusinessIdentifier": { "type": "object", "properties": { "elementId": { "type": "string", "description": "The identifier of the element as seen in the EDI ref." }, "element": { "type": "string", "description": "The element where the business identifier was found. For example, `BEG-03`." }, "name": { "type": "string", "description": "The friendly name of the business identifier. For example, `Purchase Order Number`." }, "value": { "type": "string" } }, "required": [ "element", "elementId", "name", "value" ] }, "ConnectionType": { "type": "string", "enum": [ "bucket", "remote-ftp", "stedi-ftp", "as2" ] }, "CoreCharacterSet": { "type": "string", "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" ] }, "CoreX12UsageIndicator": { "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" ] }, "CreateOutboundFragmentRequestContent": { "type": "object", "properties": { "guideId": { "type": "string", "description": "The ID of the Stedi guide for the outbound transaction setting. The guide must be configured to use fragments. You can find this ID on the [Guides](https://www.stedi.com/app/guides) page in the Stedi app." }, "fragment": { "description": "The fragment to stage for outbound delivery. Without a mapping, the fragment must be < 5MB and the shape must match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format for the specified guide. With a mapping, the fragment must be < 4MB and the shape must match the source schema of the specified mapping." }, "mappingId": { "type": "string", "description": "Specify a mapping id to transform the fragment to Stedi's Guide JSON format." } }, "required": [ "fragment", "guideId" ] }, "CreateOutboundFragmentResponseContent": { "type": "object", "properties": { "fragmentGroupId": { "type": "string", "description": "The fragment group ID where you created and added the fragment." }, "createdAt": { "type": "string", "description": "The time Stedi created the fragment.", "format": "date-time" }, "fragmentId": { "type": "string", "description": "A unique ID for the fragment Stedi created within the fragment group." } }, "required": [ "createdAt", "fragmentGroupId", "fragmentId" ] }, "CreatePartnershipOutboundTransactionRequestContent": { "type": "object", "properties": { "characterSet": { "$ref": "#/components/schemas/CoreCharacterSet" }, "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." }, "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 the same ID generated for the `fileExecutionId`." }, "fragmentGroupIds": { "type": "array", "items": { "type": "string" }, "maxItems": 1, "minItems": 1, "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." }, "mappingId": { "type": "string", "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 app." }, "interchangeOverrides": { "$ref": "#/components/schemas/InterchangeOverrides" } }, "required": [ "transaction" ] }, "CreatePartnershipOutboundTransactionResponseContent": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "This property is currently not supported. It is reserved for future use." }, "fileExecutionId": { "type": "string", "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 app, and you can use it to trace the file's status and delivery." } } }, "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." } } }, "CreateTransactionGroupResponseContent": { "type": "object", "properties": { "transactionGroupId": { "type": "string", "description": "The transaction group ID where you created and added the transaction." }, "createdAt": { "type": "string", "description": "The time Stedi staged the transaction.", "format": "date-time" }, "transactionId": { "type": "string", "description": "A unique ID for the staged transaction Stedi created within the group." }, "uploadUrl": { "type": "string", "description": "A pre-signed URL to upload the file using a `PUT` request." } }, "required": [ "createdAt", "transactionGroupId", "transactionId" ] }, "DeliveryReport": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "executionId": { "type": "string" }, "partnershipId": { "type": "string" }, "connectionType": { "$ref": "#/components/schemas/ConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "Autogenerated identifier for a connection" }, "attempt": { "type": "number" }, "filename": { "type": "string" }, "status": { "$ref": "#/components/schemas/DeliveryReportStatus" }, "message": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/DeliveryReportMetadata" } }, "required": [ "attempt", "connectionId", "connectionType", "createdAt", "executionId", "filename", "id", "message", "partnershipId", "status" ] }, "DeliveryReportMetadata": { "type": "object", "properties": { "attempts": { "type": "number" }, "mdn_file": { "$ref": "#/components/schemas/MdnFile" } } }, "DeliveryReportStatus": { "type": "string", "enum": [ "FAILED", "DELIVERED" ] }, "DestinationAttempt": { "type": "object", "properties": { "attemptId": { "type": "string" }, "destinationId": { "type": "string" }, "eventId": { "type": "string" }, "status": { "$ref": "#/components/schemas/DestinationAttemptStatus" }, "timestamp": { "type": "string", "format": "date-time" } } }, "DestinationAttemptStatus": { "type": "string", "enum": [ "SUCCESS", "FAILURE", "PROCESSING" ] }, "DetailedDestinationAttemptLog": { "type": "object", "properties": { "messageType": { "type": "string" }, "timestamp": { "type": "string" }, "payload": { "type": "string" }, "request": { "type": "string" }, "response": { "type": "string" } } }, "Direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND", "UNKNOWN" ] }, "ExceptionCause": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" } } }, "ExecutionFault": { "type": "object", "description": "A failure to process a given file within stedi.", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "executionId": { "type": "string" }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "faultMessage": { "type": "string" }, "guideId": { "type": "string" }, "receiverProfile": { "$ref": "#/components/schemas/ExecutionPartnershipProfile" }, "senderProfile": { "$ref": "#/components/schemas/ExecutionPartnershipProfile" }, "translateFaultContext": {}, "transactionSetIdentifier": { "type": "string" }, "release": { "type": "string" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } } }, "required": [ "createdAt", "executionId", "faultCode", "faultMessage", "id" ] }, "ExecutionFaultCode": { "type": "string", "enum": [ "DELIVERY_FAILURE", "FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS", "FAILED_TO_FIND_GUIDE", "FAILED_TO_FIND_LOCAL_PROFILE", "FAILED_TO_FIND_PARTNER_PROFILE", "FAILED_TO_FIND_PARTNERSHIP", "FAILED_TO_FIND_PROFILES", "FAILED_TO_FIND_RECEIVER_PROFILE", "FAILED_TO_FIND_SENDER_PROFILE", "FAILED_TO_FIND_CONNECTION", "FAILED_TO_GENERATE_CONTROL_NUMBERS", "FAILED_TO_PARSE", "FAILED_TO_PARSE_METADATA", "FAILED_TO_TRANSLATE", "FAILED_TO_ACK", "FAILED_TO_ACK_INTERCHANGE", "FILE_NOT_FOUND", "INVALID_EVENT", "INVALID_CONFIGURATION", "MISMATCHED_PARTNERSHIP_CONNECTION", "MISSING_FUNCTIONAL_GROUP_CONTROL_NUMBER", "MISSING_FUNCTIONAL_GROUP_RELEASE", "MISSING_INTERCHANGE_CONTROL_NUMBER", "MISSING_TRANSACTION_SET_CONTROL_NUMBER", "MISSING_RECEIVER_ID", "MISSING_RECEIVER_QUALIFIER", "MISSING_SENDER_ID", "MISSING_SENDER_QUALIFIER", "MULTIPLE_MATCHING_GUIDES", "MULTIPLE_MATCHING_TRANSACTION_SETTINGS", "MULTIPLE_PARTNERSHIPS", "NO_TRANSLATION_OUTPUT", "NO_TRANSACTION_SETS", "NOT_SUPPORTED", "NO_FUNCTIONAL_GROUPS", "NO_USAGE_INDICATOR_CODE", "PREVIOUSLY_RETRIED", "TRANSLATION_ERROR", "UNKNOWN_ERROR" ] }, "ExecutionPartnershipProfile": { "type": "object", "properties": { "interchangeQualifier": { "$ref": "#/components/schemas/X12InterchangeQualifier" }, "interchangeId": { "type": "string", "maxLength": 15, "minLength": 1, "pattern": "^.*[^ ].*$" }, "profileId": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$" }, "profileType": { "$ref": "#/components/schemas/ProfileType" }, "applicationId": { "type": "string", "maxLength": 15, "minLength": 2 } }, "required": [ "interchangeId", "interchangeQualifier", "profileId", "profileType" ] }, "ExecutionSource": { "type": "object", "properties": { "dirname": { "type": "string" }, "name": { "type": "string" } }, "required": [ "dirname", "name" ] }, "ExecutionStatus": { "type": "string", "enum": [ "COMPLETED", "PARTIALLY_COMPLETED", "FAILED", "IGNORED", "IN_PROGRESS", "RETRYING", "RETRIED", "STARTED" ] }, "ExecutionSummary": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "executionId": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExecutionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "transactionCount": { "type": "number" }, "faultCount": { "type": "number" }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "faultMessage": { "type": "string" }, "fileType": { "$ref": "#/components/schemas/FileType" }, "retryable": { "type": "boolean" }, "parentExecutionId": { "type": "string" }, "childExecutionId": { "type": "string" }, "partnershipId": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "Identifier chosen by the user to uniquely identify a partnership." }, "connectionType": { "$ref": "#/components/schemas/ConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "Autogenerated identifier for a connection" }, "source": { "$ref": "#/components/schemas/ExecutionSource" }, "operation": { "type": "string" } }, "required": [ "createdAt", "direction", "executionId", "status", "updatedAt" ] }, "FileType": { "type": "string", "enum": [ "CSV", "EDI/EDIFACT", "FILEPART", "JSON", "PSV", "JSON/STEDI-GUIDE", "TSV", "UNKNOWN", "EDI/X12", "XML", "ZIP" ] }, "GatewayTimeoutExceptionResponseContent": { "type": "object", "description": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.", "properties": { "message": { "type": "string", "description": "Human readable exception message." }, "code": { "type": "string", "description": "Classification of the exception type." } }, "required": [ "message" ] }, "GenerateEdiRequestContent": { "type": "object", "properties": { "characterSet": { "$ref": "#/components/schemas/CoreCharacterSet" }, "repairOptions": { "$ref": "#/components/schemas/RepairOptions" }, "transactionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionGroup" }, "minItems": 1, "description": "Contains one or more EDI functional groups, each containing the data for one or more EDI transactions. You can override the Application IDs (GS-02 and GS-03) for each group individually. The outbound transaction setting for each group must be configured to use the same connection. If you need to send transactions to different connections, you must call the endpoint multiple times." }, "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" }, "interchangeUsageIndicatorOverride": { "$ref": "#/components/schemas/CoreX12UsageIndicator" }, "interchangeAuthorization": { "$ref": "#/components/schemas/X12InterchangeAuthorization" } }, "required": [ "transactionGroups" ] }, "GenerateEdiResponseContent": { "type": "object", "properties": { "edi": { "type": "string", "description": "The EDI Stedi generated from the JSON transaction data." }, "artifactId": { "type": "string", "description": "An ID for the generated EDI file." }, "fileExecutionId": { "type": "string", "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 app. Internally, Stedi uses this ID to place the file in Stedi's outbound queue." } }, "required": [ "artifactId", "fileExecutionId" ] }, "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" } } }, "GenerateTransactionGroupEdiResponseContent": { "type": "object", "properties": { "artifactId": { "type": "string", "description": "An ID for the generated EDI file." }, "fileExecutionId": { "type": "string", "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 app. Internally, Stedi uses this ID to place the file in Stedi's outbound queue." } }, "required": [ "artifactId", "fileExecutionId" ] }, "GetExecutionInputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionInputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionMetadataDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionMetadataDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionOutputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionOutputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionResponseContent": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "executionId": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExecutionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "transactionCount": { "type": "number" }, "faultCount": { "type": "number" }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "faultMessage": { "type": "string" }, "fileType": { "$ref": "#/components/schemas/FileType" }, "retryable": { "type": "boolean" }, "parentExecutionId": { "type": "string" }, "childExecutionId": { "type": "string" }, "partnershipId": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "Identifier chosen by the user to uniquely identify a partnership." }, "connectionType": { "$ref": "#/components/schemas/ConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "Autogenerated identifier for a connection" }, "source": { "$ref": "#/components/schemas/ExecutionSource" }, "operation": { "type": "string" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } }, "deliveryReports": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryReport" } } }, "required": [ "createdAt", "direction", "executionId", "status", "updatedAt" ] }, "GetTransactionAttachmentDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionAttachmentDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionFragmentOutputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionFragmentOutputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionFragmentResponseContent": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "fileExecutionId": { "type": "string" }, "direction": { "$ref": "#/components/schemas/Direction" }, "mode": { "$ref": "#/components/schemas/Mode" }, "processedAt": { "type": "string", "format": "date-time" }, "fragmentIndex": { "type": "number" }, "fragments": { "$ref": "#/components/schemas/TransactionFragmentsSummary" }, "transactionUrl": { "type": "string" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } }, "partnership": { "$ref": "#/components/schemas/Partnership" }, "x12": { "$ref": "#/components/schemas/X12TransactionSummary" } }, "required": [ "artifacts", "direction", "fileExecutionId", "fragmentIndex", "fragments", "mode", "partnership", "processedAt", "transactionId", "transactionUrl" ] }, "GetTransactionInputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionInputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionOutputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionOutputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionResponseContent": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "fileExecutionId": { "type": "string" }, "status": { "$ref": "#/components/schemas/TransactionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "mode": { "$ref": "#/components/schemas/Mode" }, "processedAt": { "type": "string", "format": "date-time" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } }, "partnership": { "$ref": "#/components/schemas/Partnership" }, "x12": { "$ref": "#/components/schemas/X12TransactionSummary" }, "fragments": { "$ref": "#/components/schemas/TransactionFragmentsSummary" }, "translationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationError" } }, "businessIdentifiers": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessIdentifier" } }, "operation": { "type": "string" } }, "required": [ "artifacts", "direction", "fileExecutionId", "mode", "partnership", "processedAt", "status", "transactionId" ] }, "GetWebhookDeliveryAttemptDetailsResponseContent": { "type": "object", "properties": { "attemptId": { "type": "string" }, "destinationId": { "type": "string" }, "eventId": { "type": "string" }, "status": { "$ref": "#/components/schemas/DestinationAttemptStatus" }, "timestamp": { "type": "string", "format": "date-time" }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/DetailedDestinationAttemptLog" } } } }, "GetWebhookDeliveryAttemptsResponseContent": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DestinationAttempt" }, "description": "The related webhook delivery attempts for the event." } } }, "GetX12PartnershipConfigurationResponseContent": { "type": "object", "properties": { "ackConfiguration": { "$ref": "#/components/schemas/X12PartnershipAckConfiguration" }, "processingConfiguration": { "$ref": "#/components/schemas/ProcessingConfiguration" } } }, "Index": { "type": "object", "properties": { "line": { "type": "number" }, "column": { "type": "number" } }, "required": [ "column", "line" ] }, "InterchangeAcknowledgments": { "type": "string", "description": "Control when to send interchange acknowledgments.\n\nInterchange acknowledgments confirm to your trading partner that an interchange group in the EDI file was processed without syntax errors.\nAsk your trading partner if they expect to receive interchange acknowledgments before configuring acknowledgments.\n\ncode | description\n--------------|--------------------------\nNever | (Default). Do not send interchange acknowledgments\nAlways | Always send interchange acknowledgments\nWhenRequested | Send interchange acknowledgments when requested by the trading partner in the ISA 14 field", "enum": [ "Never", "Always", "WhenRequested" ] }, "InterchangeOverrides": { "type": "object", "properties": { "interchangeUsageIndicator": { "$ref": "#/components/schemas/CoreX12UsageIndicator" }, "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" } } }, "ListExecutionTransactionsResponseContent": { "type": "object", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "The token used for pagination" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } }, "required": [ "items" ] }, "ListExecutionsResponseContent": { "type": "object", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "The token used for pagination" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionSummary" } } }, "required": [ "items" ] }, "ListPollingExecutionsResponseContent": { "type": "object", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "The token used for pagination" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionSummary" } } }, "required": [ "items" ] }, "ListPollingTransactionsResponseContent": { "type": "object", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "The token used for pagination" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } }, "required": [ "items" ] }, "ListTransactionsResponseContent": { "type": "object", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "The token used for pagination" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } }, "required": [ "items" ] }, "Mark": { "type": "object", "description": "The location in the document where the problem occurred. May be a single index or a range.", "properties": { "start": { "$ref": "#/components/schemas/Index" }, "end": { "$ref": "#/components/schemas/Index" } }, "required": [ "start" ] }, "MdnFile": { "type": "object", "properties": { "repository": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "repository" ] }, "Mode": { "type": "string", "enum": [ "test", "production", "other" ] }, "OutboundConnection": { "type": "object", "properties": { "connectionType": { "$ref": "#/components/schemas/ConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "Autogenerated identifier for a connection" }, "subdirectory": { "type": "string", "maxLength": 105, "description": "Optional subdirectory used to store generated EDI files" }, "filename": { "type": "string", "maxLength": 300, "description": "Optional filename expression only used for acknowledgments. Allows `$millis()` and `$acknowledgmentType()` functions and string concatenation." } }, "required": [ "connectionId", "connectionType" ] }, "Partnership": { "type": "object", "properties": { "partnershipId": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "Identifier chosen by the user to uniquely identify a partnership." }, "partnershipType": { "$ref": "#/components/schemas/PartnershipType" }, "sender": { "$ref": "#/components/schemas/PartnershipSender" }, "receiver": { "$ref": "#/components/schemas/PartnershipReceiver" } }, "required": [ "partnershipId", "partnershipType", "receiver", "sender" ] }, "PartnershipReceiver": { "type": "object", "properties": { "profileId": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$" } }, "required": [ "profileId" ] }, "PartnershipSender": { "type": "object", "properties": { "profileId": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$" } }, "required": [ "profileId" ] }, "PartnershipType": { "type": "string", "enum": [ "x12", "edifact" ] }, "PgGetExecutionInputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "PgGetExecutionMetadataDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "PgGetExecutionOutputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "PgGetExecutionResponseContent": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "executionId": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExecutionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "transactionCount": { "type": "number" }, "faultCount": { "type": "number" }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "faultMessage": { "type": "string" }, "fileType": { "$ref": "#/components/schemas/FileType" }, "retryable": { "type": "boolean" }, "parentExecutionId": { "type": "string" }, "childExecutionId": { "type": "string" }, "partnershipId": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "Identifier chosen by the user to uniquely identify a partnership." }, "connectionType": { "$ref": "#/components/schemas/ConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "Autogenerated identifier for a connection" }, "source": { "$ref": "#/components/schemas/ExecutionSource" }, "operation": { "type": "string" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } }, "deliveryReports": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryReport" } } }, "required": [ "createdAt", "direction", "executionId", "status", "updatedAt" ] }, "PgListExecutionFaultsResponseContent": { "type": "object", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "The token used for pagination" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionFault" } } }, "required": [ "items" ] }, "PgListExecutionTransactionsResponseContent": { "type": "object", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "The token used for pagination" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } }, "required": [ "items" ] }, "ProcessingConfiguration": { "type": "object", "properties": { "strategy": { "$ref": "#/components/schemas/ProcessingStrategy" } }, "required": [ "strategy" ] }, "ProcessingStrategy": { "type": "string", "description": "The configuration of stedi core when processing an inbound transaction.\n\ncode | description\n-----|--------------------------\nAllTransactions | all transactions in the interchange must succeed processing for any to a succeed\nAnyTransaction | any good transaction can succeed regardless of their neighbours", "enum": [ "AllTransactions", "AnyTransaction" ] }, "ProfileType": { "type": "string", "enum": [ "local", "partner" ] }, "PutX12PartnershipConfigurationRequestContent": { "type": "object", "properties": { "ackConfiguration": { "$ref": "#/components/schemas/X12PartnershipAckConfiguration" }, "processingConfiguration": { "$ref": "#/components/schemas/ProcessingConfiguration" } } }, "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" }, "trimTrailingZeroes": { "type": "boolean", "description": "Whether to trim trailing zeros from numeric data elements" } } }, "ResourceConflictExceptionResponseContent": { "type": "object", "description": "The server could not process the request because of conflict in the current state of the resource.", "properties": { "message": { "type": "string", "description": "Human readable exception message." }, "code": { "type": "string", "description": "Classification of the exception type." } }, "required": [ "message" ] }, "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", "description": "Human readable exception message." }, "code": { "type": "string", "description": "Classification of the exception type." } }, "required": [ "message" ] }, "ResourceUnderChangeExceptionResponseContent": { "type": "object", "properties": { "message": { "type": "string", "description": "Human readable exception message." } }, "required": [ "message" ] }, "RetryEventResponseContent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The ID of the newly retried event." } } }, "ServiceExceptionResponseContent": { "type": "object", "properties": { "message": { "type": "string", "description": "Human readable exception message." }, "cause": { "$ref": "#/components/schemas/ExceptionCause" } }, "required": [ "message" ] }, "ServiceUnavailableExceptionResponseContent": { "type": "object", "description": "The server cannot handle the request due to technical reasons.", "properties": { "message": { "type": "string", "description": "Human readable exception message." }, "code": { "type": "string", "description": "Classification of the exception type." } }, "required": [ "message" ] }, "ThrottlingExceptionResponseContent": { "type": "object", "description": "The server response when usage plan or account-level throttling limits exceeded.", "properties": { "message": { "type": "string", "description": "Human readable exception message." }, "code": { "type": "string", "description": "Classification of the exception type." } }, "required": [ "message" ] }, "TransactionFragmentsSummary": { "type": "object", "properties": { "keyName": { "type": "string" }, "fragmentCount": { "type": "number" }, "batchSize": { "type": "number" } }, "required": [ "batchSize", "fragmentCount", "keyName" ] }, "TransactionGroup": { "type": "object", "description": "A transaction group contains data for one or more EDI transactions in [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format.", "properties": { "transactionSettingId": { "type": "string", "maxLength": 50, "pattern": "^([a-zA-Z0-9_-]+)$", "description": "A unique ID outbound transaction setting Stedi should use to determine the correct guide for validation and generation. To find this ID, go to the partnership and use the **Transaction Setting ID** field for the outbound transaction setting." }, "transactions": { "type": "array", "items": {}, "minItems": 1, "description": "This payload contains the transaction data. It must conform to the JSON Schema for the guide associated with each transaction setting (Guide JSON format)." }, "overrides": { "$ref": "#/components/schemas/TransactionGroupOverrides" } }, "required": [ "transactionSettingId", "transactions" ] }, "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." } } }, "TransactionStatus": { "type": "string", "enum": [ "failed", "succeeded" ] }, "TransactionSummary": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the [`transaction.processed.v2` event](https://www.stedi.com/docs/operate/event-types#transaction-processed), or you can retrieve it manually from the transaction's details page within the Stedi app." }, "fileExecutionId": { "type": "string" }, "status": { "$ref": "#/components/schemas/TransactionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "mode": { "$ref": "#/components/schemas/Mode" }, "processedAt": { "type": "string", "format": "date-time" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } }, "partnership": { "$ref": "#/components/schemas/Partnership" }, "x12": { "$ref": "#/components/schemas/X12TransactionSummary" }, "fragments": { "$ref": "#/components/schemas/TransactionFragmentsSummary" }, "translationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationError" } }, "businessIdentifiers": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessIdentifier" } }, "operation": { "type": "string" } }, "required": [ "artifacts", "direction", "fileExecutionId", "mode", "partnership", "processedAt", "status", "transactionId" ] }, "TranslationError": { "type": "object", "properties": { "context": { "$ref": "#/components/schemas/TranslationErrorContext" }, "mark": { "$ref": "#/components/schemas/Mark" }, "message": { "type": "string" } }, "required": [ "message" ] }, "TranslationErrorContext": { "type": "object", "properties": { "code": { "type": "string" }, "schemaPath": { "type": "string" } } }, "UnauthorizedExceptionResponseContent": { "type": "object", "description": "The server response when the authorizer failed to authenticate the caller.", "properties": { "message": { "type": "string", "description": "Human readable exception message." }, "code": { "type": "string", "description": "Classification of the exception type." } }, "required": [ "message" ] }, "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" ] }, "X12AuthorizationInformationQualifier": { "type": "string", "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" ] }, "X12Delimiters": { "type": "object", "properties": { "element": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The data element separator character." }, "composite": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The component element separator character." }, "repetition": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The repetition separator character." }, "segment": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The segment terminator character." } }, "required": [ "composite", "element", "repetition", "segment" ] }, "X12FunctionalAcknowledgmentType": { "type": "string", "description": "The transaction set to use when acknowledging a functional group.\n\ncode | description\n-----|--------------------------\n997 | Used in all transaction sets. Not used to respond to a 997\n999 | Used in some healthcare transaction sets. Not used to respond to a 999.", "enum": [ "997", "999" ] }, "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." } } }, "X12InterchangeQualifier": { "type": "string", "enum": [ "01", "02", "03", "04", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "AM", "NR", "SA", "SN", "ZZ" ] }, "X12PartnershipAckConfiguration": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If not enabled the acknowledgment configuration will be deleted." }, "negativeAcknowledgmentEnabled": { "type": "boolean" }, "positiveTransactionLevelAcknowledgments": { "type": "boolean" }, "interchangeAcknowledgments": { "$ref": "#/components/schemas/InterchangeAcknowledgments" }, "functionalAcknowledgmentType": { "$ref": "#/components/schemas/X12FunctionalAcknowledgmentType" }, "functionalAcknowledgmentConnection": { "$ref": "#/components/schemas/OutboundConnection" }, "interchangeAcknowledgmentConnection": { "$ref": "#/components/schemas/OutboundConnection" } }, "required": [ "enabled" ] }, "X12SecurityInformationQualifier": { "type": "string", "description": "Identifies the type of information in the Security Information (ISA-03). Default is `00 - No Security Information Present`.", "enum": [ "00", "01" ] }, "X12TransactionMetadata": { "type": "object", "properties": { "interchange": { "$ref": "#/components/schemas/X12TransactionMetadataInterchange" }, "functionalGroup": { "$ref": "#/components/schemas/X12TransactionMetadataFunctionalGroup" }, "transaction": { "$ref": "#/components/schemas/X12TransactionMetadataTransaction" }, "sender": { "$ref": "#/components/schemas/X12TransactionMetadataProfile" }, "receiver": { "$ref": "#/components/schemas/X12TransactionMetadataProfile" } }, "required": [ "functionalGroup", "interchange", "receiver", "sender", "transaction" ] }, "X12TransactionMetadataFunctionalGroup": { "type": "object", "properties": { "controlNumber": { "type": "number", "maximum": 999999999, "minimum": 0 }, "date": { "type": "string" }, "functionalIdentifierCode": { "type": "string" }, "time": { "type": "string" }, "release": { "type": "string" } }, "required": [ "controlNumber", "date", "functionalIdentifierCode", "release", "time" ] }, "X12TransactionMetadataInterchange": { "type": "object", "properties": { "acknowledgmentRequestedCode": { "type": "string" }, "controlNumber": { "type": "number", "maximum": 999999999, "minimum": 0 } }, "required": [ "acknowledgmentRequestedCode", "controlNumber" ] }, "X12TransactionMetadataProfile": { "type": "object", "properties": { "applicationCode": { "type": "string" }, "isa": { "$ref": "#/components/schemas/X12TransactionMetadataProfileISA" } }, "required": [ "applicationCode", "isa" ] }, "X12TransactionMetadataProfileISA": { "type": "object", "properties": { "qualifier": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id", "qualifier" ] }, "X12TransactionMetadataTransaction": { "type": "object", "properties": { "controlNumber": { "type": "string" }, "transactionSetIdentifier": { "type": "string" } }, "required": [ "controlNumber", "transactionSetIdentifier" ] }, "X12TransactionSetting": { "type": "object", "properties": { "guideId": { "type": "string" }, "transactionSettingId": { "type": "string" } } }, "X12TransactionSummary": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/X12TransactionMetadata" }, "transactionSetting": { "$ref": "#/components/schemas/X12TransactionSetting" } }, "required": [ "metadata" ] } }, "securitySchemes": { "httpApiKeyAuth": { "type": "apiKey", "description": "A [Stedi API Key](https://www.stedi.com/app/settings/api-keys) for authentication.", "name": "Authorization", "in": "header" } } }, "security": [ { "httpApiKeyAuth": [] } ], "x-stedi": { "lifecycle": "general_availability", "product": "core", "public": true }, "tags": [], "servers": [ { "url": "https://core.us.stedi.com/2023-08-01", "description": "Production" } ] }