Restowing (Operations)

Endpoints to manipulate restowing items.

List restow items

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

facilityRefstringOptional

Reference to the facility you want to get the corresponding restows

restowedbooleanOptional

Reference restowed status of the restow items

statusstring[]Optional

Reference status of the restow items

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

orderBystring · enumOptional

RestowItemsSortOptionsEnum

Possible values:

Responses

200

Restow items were found. The results are in the body.

application/json

RestowedItems

totalintegerOptional

Total number of found entities for this query

Example: 42

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

get

/api/restowitems

HTTPcURLJavaScriptPython

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

{
  "restowedItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Get restow item

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

restowItemIdstringRequired

ID of the restow item you want to get

Responses

200

RestowItem was found & you were allowed to access it. The result is in the body.

application/json

RestowItem

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/restowitems/{restowItemId}

HTTPcURLJavaScriptPython

GET /api/restowitems/{restowItemId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "article": {},
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
  "location": {
    "locationRef": "text",
    "scannableCodes": [
      "text"
    ]
  },
  "measurementUnitKey": "liter",
  "operativeProcessRef": "text",
  "processRef": "text",
  "quantity": 1,
  "restowed": true,
  "status": "CANCELED",
  "stockRef": "text",
  "customAttributes": {},
  "globalLineItemId": "text",
  "recordableAttributes": [
    {
      "keyLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "group": "general",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "key": "country of origin",
      "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "recordingRule": "MANDATORY",
      "value": "Germany"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update restow item

patch

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Deprecated, please use /api/restowitems/{restowItemId}/actions

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

restowItemIdstringRequired

ID of the restow item you want to update

Body

application/json

Deprecated Actions to modify restow items - please use /api/restowitem/{id}/actions

versioninteger · int64Required

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

Example: 42

Responses

200

RestowItem was found & patch-set has been applied. The patched restow item is in the body.

application/json

RestowItem

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

RestowItem not found

application/json

409

RestowItem version conflict

application/json

patch

/api/restowitems/{restowItemId}

HTTPcURLJavaScriptPython

PATCH /api/restowitems/{restowItemId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "actions": [
    {
      "action": "ModifyRestowItem",
      "location": {
        "locationRef": "text",
        "scannableCodes": [
          "text"
        ]
      },
      "restowed": true
    }
  ],
  "version": 42
}

{
  "article": {},
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
  "location": {
    "locationRef": "text",
    "scannableCodes": [
      "text"
    ]
  },
  "measurementUnitKey": "liter",
  "operativeProcessRef": "text",
  "processRef": "text",
  "quantity": 1,
  "restowed": true,
  "status": "CANCELED",
  "stockRef": "text",
  "customAttributes": {},
  "globalLineItemId": "text",
  "recordableAttributes": [
    {
      "keyLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "group": "general",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "key": "country of origin",
      "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "recordingRule": "MANDATORY",
      "value": "Germany"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Call restow item action

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

restowItemIdstringRequired

Reference to the restow item you want to call an action for

Body

application/json

RestowItemActionsParameter

or

Responses

200

Updated RestowItem in the body.

application/json

RestowItem

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 entity you want to call an action for was not found.

application/json

post

/api/restowitems/{restowItemId}/actions

HTTPcURLJavaScriptPython

POST /api/restowitems/{restowItemId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "location": {
    "locationRef": "text",
    "scannableCodes": [
      "text"
    ]
  },
  "name": "RESTOW",
  "version": 1
}

{
  "article": {},
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
  "location": {
    "locationRef": "text",
    "scannableCodes": [
      "text"
    ]
  },
  "measurementUnitKey": "liter",
  "operativeProcessRef": "text",
  "processRef": "text",
  "quantity": 1,
  "restowed": true,
  "status": "CANCELED",
  "stockRef": "text",
  "customAttributes": {},
  "globalLineItemId": "text",
  "recordableAttributes": [
    {
      "keyLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "group": "general",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "key": "country of origin",
      "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "recordingRule": "MANDATORY",
      "value": "Germany"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}