Stage fragment

This endpoint stages a fragment for outbound delivery.

POST /fragments/{fragmentGroupId}

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 the Create Outbound Transaction endpoint, Stedi stitches the fragments together into a single transaction and delivers it to your trading partner.

Authorizations

Authorization · string · required · header

A Stedi API Key for authentication.

Path Parameters

fragmentGroupId · string

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.

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.

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 · unknown · 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

application/json

CreateOutboundFragment 201 response

fragmentGroupId · string · required

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

createdAt · string · required

The time Stedi created the fragment.

• Format: date-time

fragmentId · string · required

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

cURL

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
          }
        }
      ]
    }
  }'

JavaScript

const body = JSON.stringify({
  "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
        }
      }
    ]
  }
})

fetch("https://core.us.stedi.com/2023-08-01/fragments/{fragmentGroupId}", {
  headers: {
    "Authorization": "<api_key>"
  },
  body
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://core.us.stedi.com/2023-08-01/fragments/{fragmentGroupId}"
  body := strings.NewReader(`{
    "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
          }
        }
      ]
    }
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Authorization", "<api_key>")
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://core.us.stedi.com/2023-08-01/fragments/{fragmentGroupId}"
body = {
  "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
        }
      }
    ]
  }
}
response = requests.request("POST", url, json = body, headers = {
  "Authorization": "<api_key>",
  "Content-Type": "application/json"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
import java.net.http.HttpRequest.BodyPublishers;

var body = BodyPublishers.ofString("""{
  "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
        }
      }
    ]
  }
}""");
HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://core.us.stedi.com/2023-08-01/fragments/{fragmentGroupId}"))
  .header("Content-Type", "application/json")
  .header("Authorization", "<api_key>")
  .POST(body)
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

201

{
  "fragmentGroupId": "some-transaction-id",
  "createdAt": "2024-02-21T00:00:00Z",
  "fragmentId": "d3b3e3e3-3e3e-3e3e-3e3e-3e3e3e3e3e3e"
}

400

{
  "message": "string"
}

401

{
  "message": "string",
  "code": "string"
}

403

{
  "message": "string",
  "code": "string"
}

404

{
  "message": "string",
  "code": "string"
}

409

{
  "message": "string",
  "code": "string"
}

429

{
  "message": "string",
  "code": "string"
}

500

{
  "message": "string",
  "cause": {
    "name": "string",
    "message": "string",
    "stack": "string"
  }
}

503

{
  "message": "string",
  "code": "string"
}

504

{
  "message": "string",
  "code": "string"
}