GET
/
transactions
/
{transactionId}
/
fragments
/
{fragmentIndex}
/
output
  curl --request GET \
    --url https://core.us.stedi.com/2023-08-01/transactions/{transactionId}/fragments/{fragmentIndex}/output \
    --header "Authorization: ${STEDI_API_KEY}"

{
  "item_identification_LIN_loop": [
    {
      "item_identification_LIN": {
        "assigned_identification_01": "1",
        "product_service_id_qualifier_02": "VC",
        "product_service_id_03": "AAD15-1000"
      },
      "quantity_information_QTY_loop": [
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "17",
            "quantity_02": 0,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "EA"
            }
          }
        },
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "ZZ",
            "quantity_02": 179.45,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "DO"
            }
          }
        }
      ]
    },
    {
      "item_identification_LIN": {
        "assigned_identification_01": "2",
        "product_service_id_qualifier_02": "VC",
        "product_service_id_03": "AAD15-2"
      },
      "quantity_information_QTY_loop": [
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "17",
            "quantity_02": 0,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "EA"
            }
          }
        },
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "ZZ",
            "quantity_02": 179.45,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "DO"
            }
          }
        }
      ]
    }
  ]
}

There are no size restrictions on documents when fetching from this endpoint, however they are generally smaller and consumable because they are fragments.

​
Response

This endpoint returns a 302 Temporary redirect to the document download URL. Many HTTP clients will automatically follow this redirect, or have a simple follow redirects configuration to set. For example, using the -L or --location flag in cURL will automatically follow the redirect.

In the event you cannot, or chose not to automatically follow the redirect, the body of the response contains a JSON object with a single key documentDownloadUrl which contains a temporary URL to download the document. This URL is available for 60 minutes.

This functionality is available in a Stedi module. Contact us for details.

  curl --request GET \
    --url https://core.us.stedi.com/2023-08-01/transactions/{transactionId}/fragments/{fragmentIndex}/output \
    --header "Authorization: ${STEDI_API_KEY}"

{
  "item_identification_LIN_loop": [
    {
      "item_identification_LIN": {
        "assigned_identification_01": "1",
        "product_service_id_qualifier_02": "VC",
        "product_service_id_03": "AAD15-1000"
      },
      "quantity_information_QTY_loop": [
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "17",
            "quantity_02": 0,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "EA"
            }
          }
        },
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "ZZ",
            "quantity_02": 179.45,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "DO"
            }
          }
        }
      ]
    },
    {
      "item_identification_LIN": {
        "assigned_identification_01": "2",
        "product_service_id_qualifier_02": "VC",
        "product_service_id_03": "AAD15-2"
      },
      "quantity_information_QTY_loop": [
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "17",
            "quantity_02": 0,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "EA"
            }
          }
        },
        {
          "quantity_information_QTY": {
            "quantity_qualifier_01": "ZZ",
            "quantity_02": 179.45,
            "composite_unit_of_measure_03": {
              "unit_or_basis_for_measurement_code_01": "DO"
            }
          }
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A Stedi API Key for authentication.

Path Parameters

​
transactionId
string
required

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event, or you can retrieve it manually from the transaction's details page within the Stedi app.

​
fragmentIndex
number
required

The identifier for a specific fragment within a processed transaction. This ID is included in the fragment processed event, or you can retrieve it manually from the transaction's details page within the Stedi app.

Response

302
application/json
GetTransactionFragmentOutputDocument 302 response
​
documentDownloadUrl
string

A URL to download the document. This URL is available for 60 minutes.

Was this page helpful?

FragmentInvoke mapping