Returns Configuration (Operations)

Endpoints to create, update, and read returns configuration.

Get return configuration

get

Returns the current return configuration for the tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Return Configuration

application/json

LocalizedReturnConfiguration

activebooleanRequiredDeprecated

Enable or disable legacy returns. Use returnTypeConfiguration instead

Default: trueExample: true

allowTriggerRefundbooleanOptional

If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.

Default: false

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2026-06-17T12:00:00.000Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2026-06-17T12:00:00.000Z

versionintegerRequired

The version of the document to be used in optimistic locking mechanisms.

Example: 1

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

get/api/configurations/return

GET /api/configurations/return HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "allowTriggerRefund": false,
  "availableDecisionReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "context": [
        {
          "type": "ITEM_RETURN_LINE_ITEM_STATUS",
          "values": [
            "ACCEPTED"
          ]
        }
      ],
      "reason": "Item damaged"
    }
  ],
  "availableItemConditions": [
    {
      "conditionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "condition": "Damaged"
    }
  ],
  "availableReturnReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "identifier": "A",
      "reason": "Damaged"
    }
  ],
  "created": "2026-06-17T12:00:00.000Z",
  "lastModified": "2026-06-17T12:00:00.000Z",
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "version": 1
}

Upsert return configuration

put

Updates the return configuration for the tenant. If no configuration exists, it will be created.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ReturnConfiguration

activebooleanRequiredDeprecated

Enable or disable legacy returns. Use returnTypeConfiguration instead

Default: trueExample: true

allowTriggerRefundbooleanOptional

If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.

Default: false

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2026-06-17T12:00:00.000Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2026-06-17T12:00:00.000Z

versionintegerRequired

The version of the document to be used in optimistic locking mechanisms.

Example: 1

Responses

200

ItemReturnJob containing the newly created item return

application/json

LocalizedReturnConfiguration

activebooleanRequiredDeprecated

Enable or disable legacy returns. Use returnTypeConfiguration instead

Default: trueExample: true

allowTriggerRefundbooleanOptional

If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.

Default: false

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2026-06-17T12:00:00.000Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2026-06-17T12:00:00.000Z

versionintegerRequired

The version of the document to be used in optimistic locking mechanisms.

Example: 1

201

ItemReturnJob containing the newly created item return

application/json

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

409

A version conflict occurred.

application/json

put/api/configurations/return

PUT /api/configurations/return HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 605

{
  "allowTriggerRefund": false,
  "availableDecisionReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "context": [
        {
          "type": "ITEM_RETURN_LINE_ITEM_STATUS",
          "values": [
            "ACCEPTED"
          ]
        }
      ],
      "reason": "Item damaged"
    }
  ],
  "availableItemConditions": [
    {
      "conditionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      }
    }
  ],
  "availableReturnReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "identifier": "A"
    }
  ],
  "created": "2026-06-17T12:00:00.000Z",
  "lastModified": "2026-06-17T12:00:00.000Z",
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "version": 1
}

{
  "allowTriggerRefund": false,
  "availableDecisionReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "context": [
        {
          "type": "ITEM_RETURN_LINE_ITEM_STATUS",
          "values": [
            "ACCEPTED"
          ]
        }
      ],
      "reason": "Item damaged"
    }
  ],
  "availableItemConditions": [
    {
      "conditionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "condition": "Damaged"
    }
  ],
  "availableReturnReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "identifier": "A",
      "reason": "Damaged"
    }
  ],
  "created": "2026-06-17T12:00:00.000Z",
  "lastModified": "2026-06-17T12:00:00.000Z",
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "version": 1
}