Sign in

This endpoint stages a fragment for outbound delivery.

post/fragments/{fragmentGroupId}

Path parameters

fragmentGroupIdstring 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.

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-Keystring

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.

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.

Request body

guideIdstring 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 portal.

{"stackTrail":"components:schemas:CreateOutboundFragmentRequestContent:properties:fragment","oasType":"schema","type":"unknown","description":"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."}
mappingIdstring

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

Response

CreateOutboundFragment 201 response

fragmentGroupIdstring required

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

createdAtstring date-time required

The time Stedi created the fragment.

fragmentIdstring required

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

Changes

Changed in 3 of the 51 revisions of this API.23

  • 7d72a13129041See the full diff
    • ○

      added the non-success response with the status 422

      response-non-success-status-added

  • e8b8d62c2e1511See the full diff
    • ●

      removed the optional property cause from the response with the 500 status

      response-optional-property-removed

    • ○

      added the optional property exceptionCause to the response with the 500 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 057d587553be11See the full diff
    • ●

      removed the optional property code from the response with the 409 status

      response-optional-property-removed

    • ○

      added the optional property code to the response with the 400 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog