Item Conditions

This page is outdated. Please go to our new documentation under https://docs.fulfillmenttools.com/documentation.

Default values for item condition in the backend are not provided; however, it is possible to manage them on the client side. Like we are doing it with our app by setting the default value for item condition to "not damaged". If no additional conditions are specified through the backend, the conditions will not be displayed.

Adding predefined item conditions

You can add localized itemConditions to the returnConfiguration via API. The translation depends on the locale of the user using this endpoint and the tenantLocaleConfiguration as a fallback.

Get the current configuration for returns

GET/api/configurations/return

Response

200401403404

Return config found.

Body

application/json

createdstring (date-time)

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

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

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

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

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

Example: 42

Request

JavaScriptCurlPython

const response = await fetch('/api/configurations/return', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "allowTriggerRefund": false
}

Change the tenant wide return configuration

PUT/api/configurations/return

Body

application/json

Desired return configuration to create/update

createdstring (date-time)

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

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

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

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

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

Example: 42

Response

200201400401403409

The return configuration was successfully updated.

Body

application/json

createdstring (date-time)

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

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

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

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

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

Example: 42

Request

JavaScriptCurlPython

const response = await fetch('/api/configurations/return', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": true
    }),
});
const data = await response.json();

Response

200201

{
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "allowTriggerRefund": false
}

Using item conditions in itemReturns

A user of our API can use these predefined conditions or provide their own ones when creating or updating itemReturnLineItem of an ItemReturn. The localized condition can be provided like this example:

itemConditionLocalized = { de_DE: 'gefällt nicht', en_US: 'do not like' }

When getting this ItemReturn via REST oder GQL, you will receive an additional field called itemCondition which contains only the localized value. This translation depends on the users locale.

Getting and setting these values via REST:

Get item returns

GEThttps://%%HOST%%//api/itemreturnjobs/{itemReturnJobId}/itemreturns

Authorization

firebase

Path parameters

itemReturnJobId*string

item return job to read the item return for

Query parameters

Response

200401403404

Get all item returns for a given item return job

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/itemreturnjobs/{itemReturnJobId}/itemreturns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get item return by id

GEThttps://%%HOST%%//api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}

Authorization

firebase

Path parameters

itemReturnJobId*string

item return job to read the item return for

itemReturnId*string

id of the item return you want to read

Query parameters

Response

200401403404

Get a specific item return

Body

application/json

id*string

createdstring (date-time)

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

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

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

Example: "2020-02-03T09:45:51.525Z"

returnFacilityRef*string

status*ItemReturnStatus (enum)

ANNOUNCEDOPENIN_PROGRESSPAUSEDFINISHED

tenantOrderIdstring

scannableCodesarray of string

returnedLineItems*array of ItemReturnLineItem (object)

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "returnFacilityRef": "text",
  "status": "ANNOUNCED",
  "tenantOrderId": "text",
  "scannableCodes": [
    "text"
  ],
  "returnedLineItems": [
    {
      "id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
      "itemCondition": "Damaged",
      "itemReturnJobLineItemRefs": [
        "a69006ba-7100-4b4d-a610-1ca28016a4eb"
      ]
    }
  ]
}

Actions for a ItemReturn

POSThttps://%%HOST%%//api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions

Authorization

firebase

Path parameters

itemReturnJobId*string

id of the Item Return Job

itemReturnId*string

id of the Item Return

Body

application/json

ItemReturnActionsParameter (any of)

ItemReturnStatusChangeActionParameter (object)ItemReturnReplaceReturnedLineItemsActionParameter (object)DeleteItemReturnActionParameter (object)

Response

200401403404

Updated entity

Body

application/json

createdstring (date-time)

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

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

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

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

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

Example: 42

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "STATUS_CHANGE",
      "itemReturnJobVersion": 0,
      "status": "ANNOUNCED"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "processRef": "text",
  "originFacilityRefs": [
    "text"
  ],
  "status": "OPEN",
  "tenantOrderId": "text",
  "consumerAddresses": [
    {
      "companyName": "Speedy Boxales Ltd.",
      "firstName": "Maxine",
      "lastName": "Muller",
      "salutation": "Frau",
      "email": "[e-mail]",
      "addressType": "POSTAL_ADDRESS"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "returnableLineItems": [
    {
      "id": "text",
      "returned": 0,
      "returnable": 0
    }
  ],
  "itemReturns": [
    {
      "id": "text",
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "returnFacilityRef": "text",
      "status": "ANNOUNCED",
      "tenantOrderId": "text",
      "scannableCodes": [
        "text"
      ],
      "returnedLineItems": [
        {
          "id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
          "itemCondition": "Damaged",
          "itemReturnJobLineItemRefs": [
            "a69006ba-7100-4b4d-a610-1ca28016a4eb"
          ]
        }
      ]
    }
  ],
  "anonymized": false
}