Returns Configuration (Operations)

Endpoints to create, update and read returns configuration.

Get returns config

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns the current return configuration for the tenant.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Return config found.

application/json

LocalizedReturnConfiguration

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

Entity not found

application/json

get

/api/configurations/return

HTTPcURLJavaScriptPython

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

{
  "allowTriggerRefund": false,
  "availableItemConditions": [],
  "availableReturnReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Beschädigt",
        "en_US": "Damaged"
      },
      "identifier": "A"
    }
  ],
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update returns config

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Updates the return configuration for the tenant. If no configuration exists, it will be created.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ReturnConfiguration

Responses

200

The return configuration was successfully updated.

application/json

LocalizedReturnConfiguration

201

The return configuration was successfully created.

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

Entity version conflict

application/json

put

/api/configurations/return

HTTPcURLJavaScriptPython

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: 221

{
  "allowTriggerRefund": false,
  "availableItemConditions": [],
  "availableReturnReasons": [],
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "allowTriggerRefund": false,
  "availableItemConditions": [],
  "availableReturnReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Beschädigt",
        "en_US": "Damaged"
      },
      "identifier": "A"
    }
  ],
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}