STstedi

POST /fragments/{fragmentGroupId}

Changed on

This endpoint stages a fragment for outbound delivery.

Request

  • Base URL
    https://core.us.stedi.com/2023-08-01
  • URL
    https://core.us.stedi.com/2023-08-01/fragments/{fragmentGroupId}
  • Auth
    API key in header Authorization

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.

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.

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.

fragmentunknown required
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

  • 7d72a1312904Revision changes
    • info

      added the non-success response with the status

  • e8b8d62c2e15Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status