Skip to main content

Installing the Return Portal in TRAEDE

Before you can call any endpoint in this API, the brand administrator must create an external return portal inside their TRAEDE account and share its credentials with you.

What the brand does​

  1. In TRAEDE, navigate to Settings → Return portals and create a new return portal.
  2. Pick a type other than traede. Use reversio, returnflows or float if you are integrating one of our official partners, otherwise use custom.
  3. Set the return address and inventory location used for received returns.
  4. Enter the webhook_endpoint where TRAEDE should deliver webhooks to your portal.
  5. Save the portal. TRAEDE will generate a public_id and a webhook_secret on first save.

What you need from the brand​

The brand must share the following values with you:

  • The portal's public_id (used as {publicId} in every endpoint URL).
  • The portal's webhook_secret (used to verify webhook signatures - see Working with TRAEDE webhooks).
caution

The webhook_secret is generated once, when the portal is created. The brand can rotate it on demand from the same settings page. If the secret is rotated, make sure to update your stored copy.

Authentication credentials​

In addition to the portal credentials above, the integrator also needs a standard TRAEDE API setup:

If your portal type is reversio, returnflows or float, the API app's internal_code must match the portal type. Contact TRAEDE to have your API app set up as an official partner. custom portals have no such restriction.