POST
/
fragments
/
{fragmentGroupId}
curl --request POST \
  --url https://core.us.stedi.com/2023-08-01/fragments/{fragmentGroupId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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
        }
      }
    ]
  }
}'
{
  "fragmentGroupId": "some-transaction-id",
  "createdAt": "2024-02-21T00:00:00Z",
  "fragmentId": "d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e"
}

You can optionally specify a mapping to transform the fragment to Stedi’s Guide JSON format. If you don’t specify a mapping, the fragment must match the Guide JSON format for the specified guide.

Fragments allow you to split large transactions into smaller chunks for easier processing. You can enable fragments for one repeated EDI segment in each transaction set and then split the transaction into chunks based on that segment. For example, if you enable fragments on the LIN loop in an 846 Inventory Inquiry/Advice, you can stage fragments containing batches of LIN loops. Later, when you call one of the Generate EDI endpoints, Stedi stitches the fragments together into a single transaction and delivers it to your trading partner.

Authorizations

Authorization
string
headerrequired

API key authentication via the 'Authorization' header

Headers

Idempotency-Key
string

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.

Path Parameters

fragmentGroupId
string
required

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.

Body

application/json
guideId
string
required

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 page in the Stedi app.

fragment
any
required

The fragment to stage for outbound delivery. Without a mapping, the fragment must be < 5MB and the shape must match the 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
string

Specify a mapping id to transform the fragment to Stedi's Guide JSON format.

Response

201 - application/json
fragmentGroupId
string
required

The fragment group ID where you created and added the fragment.

createdAt
string
required

The time Stedi created the fragment.

fragmentId
string
required

A unique ID for the fragment Stedi created within the fragment group.

Was this page helpful?

OutputFragment