# Returns Configuration (Operations)

Endpoints to create, update and read returns configuration.

## Get returns config

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Returns the current return configuration for the tenant.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns configuration.","name":"Returns Configuration (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LocalizedReturnConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"active":{"default":true,"deprecated":true,"description":"This part of the API is deprecated. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#deprecated\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Enable or disable legacy returns. Use returnTypeConfiguration instead","type":"boolean"},"allowTriggerRefund":{"default":false,"description":"If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.","type":"boolean"},"availableItemConditions":{"items":{"$ref":"#/components/schemas/LocalizedAvailableItemCondition"},"type":"array"},"availableReturnReasons":{"items":{"$ref":"#/components/schemas/LocalizedAvailableReturnReason"},"type":"array"},"returnTypeConfiguration":{"$ref":"#/components/schemas/ReturnTypeConfiguration"}},"required":["active"],"type":"object","title":"LocalizedReturnConfiguration","description":"LocalizedReturnConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"LocalizedAvailableItemCondition":{"additionalProperties":false,"properties":{"conditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"condition":{"description":"translated conditionsLocalized","type":"string"}},"required":["conditionLocalized","condition"],"title":"LocalizedAvailableItemCondition","description":"LocalizedAvailableItemCondition"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"LocalizedAvailableReturnReason":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/AvailableReturnReason"}],"properties":{"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"},"reason":{"description":"translated reasonLocalized","type":"string"}},"required":["reasonLocalized","reason","identifier"],"title":"LocalizedAvailableReturnReason","description":"LocalizedAvailableReturnReason"},"AvailableReturnReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Will be translated into 'reason' when requested"},"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"}},"required":["reasonLocalized"],"title":"AvailableReturnReason","description":"AvailableReturnReason"},"ReturnTypeConfiguration":{"properties":{"type":{"$ref":"#/components/schemas/ReturnConfigurationType"}},"required":["type"],"title":"ReturnTypeConfiguration","description":"ReturnTypeConfiguration"},"ReturnConfigurationType":{"description":"ReturnConfigurationType RETURN is deprecated.","enum":["RETURN","ITEM_RETURN"],"type":"string","title":"ReturnConfigurationType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/return":{"get":{"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Returns the current return configuration for the tenant.","operationId":"getReturnConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalizedReturnConfiguration"}}},"description":"Return config found."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get returns config","tags":["Returns Configuration (Operations)"]}}}}
```

## Update returns config

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Updates the return configuration for the tenant. If no configuration exists, it will be created.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns configuration.","name":"Returns Configuration (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReturnConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"active":{"default":true,"deprecated":true,"description":"This part of the API is deprecated. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#deprecated\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Enable or disable legacy returns. Use returnTypeConfiguration instead","type":"boolean"},"allowTriggerRefund":{"default":false,"description":"If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.","type":"boolean"},"availableItemConditions":{"items":{"$ref":"#/components/schemas/AvailableItemCondition"},"type":"array"},"availableReturnReasons":{"items":{"$ref":"#/components/schemas/AvailableReturnReason"},"type":"array"},"returnTypeConfiguration":{"$ref":"#/components/schemas/ReturnTypeConfiguration"}},"required":["active"],"type":"object","title":"ReturnConfiguration","description":"ReturnConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AvailableItemCondition":{"additionalProperties":false,"properties":{"conditionLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Will be translated into 'condition' when requested"}},"title":"AvailableItemCondition","description":"AvailableItemCondition"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"AvailableReturnReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Will be translated into 'reason' when requested"},"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"}},"required":["reasonLocalized"],"title":"AvailableReturnReason","description":"AvailableReturnReason"},"ReturnTypeConfiguration":{"properties":{"type":{"$ref":"#/components/schemas/ReturnConfigurationType"}},"required":["type"],"title":"ReturnTypeConfiguration","description":"ReturnTypeConfiguration"},"ReturnConfigurationType":{"description":"ReturnConfigurationType RETURN is deprecated.","enum":["RETURN","ITEM_RETURN"],"type":"string","title":"ReturnConfigurationType"},"LocalizedReturnConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"active":{"default":true,"deprecated":true,"description":"This part of the API is deprecated. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#deprecated\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Enable or disable legacy returns. Use returnTypeConfiguration instead","type":"boolean"},"allowTriggerRefund":{"default":false,"description":"If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.","type":"boolean"},"availableItemConditions":{"items":{"$ref":"#/components/schemas/LocalizedAvailableItemCondition"},"type":"array"},"availableReturnReasons":{"items":{"$ref":"#/components/schemas/LocalizedAvailableReturnReason"},"type":"array"},"returnTypeConfiguration":{"$ref":"#/components/schemas/ReturnTypeConfiguration"}},"required":["active"],"type":"object","title":"LocalizedReturnConfiguration","description":"LocalizedReturnConfiguration"},"LocalizedAvailableItemCondition":{"additionalProperties":false,"properties":{"conditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"condition":{"description":"translated conditionsLocalized","type":"string"}},"required":["conditionLocalized","condition"],"title":"LocalizedAvailableItemCondition","description":"LocalizedAvailableItemCondition"},"LocalizedAvailableReturnReason":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/AvailableReturnReason"}],"properties":{"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"},"reason":{"description":"translated reasonLocalized","type":"string"}},"required":["reasonLocalized","reason","identifier"],"title":"LocalizedAvailableReturnReason","description":"LocalizedAvailableReturnReason"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/return":{"put":{"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Updates the return configuration for the tenant. If no configuration exists, it will be created.","operationId":"upsertReturnConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnConfiguration"}}},"description":"Desired return configuration to create/update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalizedReturnConfiguration"}}},"description":"The return configuration was successfully updated."},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalizedReturnConfiguration"}}},"description":"The return configuration was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity version conflict"}},"summary":"Update returns config","tags":["Returns Configuration (Operations)"]}}}}
```
