Restowing (Operations)

Endpoints to manipulate restowing items.

List restow items

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

Authorizations

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

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

{
  "restowedItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "pcs",
      "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"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42,
      "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, see the API release lifecycle documentation.

Authorizations

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

customAttributesobjectOptional

Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

globalLineItemIdstringOptional

This ID is used to identify if this line item is related to the line item of other operational entities.

idstringRequiredExample: LGMl2DuvPnfPoSHhYFOm

measurementUnitKeystringOptional

Identifier for items unit of measurement.

Example: liter

quantityinteger · int64 · min: 1RequiredDefault: 1Example: 1

scannableCodesstring[]Optional

Codes that can be used for scanning this lineItem

secondaryMeasurementUnitKeystring · min: 1Optional

Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram

Example: g

secondaryQuantitynumberOptional

secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight

Example: 42

createdstring · date-timeOptional

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-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

facilityRefstringRequired

The id of the facility reference. The given ID has to be present in the system.

Example: Esb20gpHBL94X5NdMp3C

operativeProcessRefstringOptional

id of the connected operative process if available

processRefstringOptional

id of the connected process if available

restowedbooleanRequired

Indicates if the restowItem has been restowed

Default: falseExample: true

statusstring · enumRequired

Status of the restow item

Possible values:

stockRefstringOptional

id of the stock entity for this line item

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}

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

{
  "article": {
    "titleLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "attributes": [
      {
        "valueLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "keyLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "category": "descriptive",
        "context": {
          "type": "FACILITY_GROUP",
          "value": "text"
        },
        "key": "%%subtitle%%",
        "priority": 100,
        "type": "STRING",
        "value": "585er Gold"
      }
    ],
    "imageUrl": "https://example.com/resource",
    "tenantArticleId": "4711",
    "title": "Cologne Water",
    "weight": 1
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
  "location": {
    "locationRef": "text",
    "scannableCodes": [
      "text"
    ]
  },
  "measurementUnitKey": "pcs",
  "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"
  ],
  "secondaryMeasurementUnitKey": "g",
  "secondaryQuantity": 42,
  "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, see the API release lifecycle documentation. Deprecated, please use /api/restowitems/{restowItemId}/actions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

restowItemIdstringRequired

ID of the restow item you want to update

Body

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

customAttributesobjectOptional

Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

globalLineItemIdstringOptional

This ID is used to identify if this line item is related to the line item of other operational entities.

idstringRequiredExample: LGMl2DuvPnfPoSHhYFOm

measurementUnitKeystringOptional

Identifier for items unit of measurement.

Example: liter

quantityinteger · int64 · min: 1RequiredDefault: 1Example: 1

scannableCodesstring[]Optional

Codes that can be used for scanning this lineItem

secondaryMeasurementUnitKeystring · min: 1Optional

Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram

Example: g

secondaryQuantitynumberOptional

secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight

Example: 42

createdstring · date-timeOptional

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-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

facilityRefstringRequired

The id of the facility reference. The given ID has to be present in the system.

Example: Esb20gpHBL94X5NdMp3C

operativeProcessRefstringOptional

id of the connected operative process if available

processRefstringOptional

id of the connected process if available

restowedbooleanRequired

Indicates if the restowItem has been restowed

Default: falseExample: true

statusstring · enumRequired

Status of the restow item

Possible values:

stockRefstringOptional

id of the stock entity for this line item

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}

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": {
    "titleLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "attributes": [
      {
        "valueLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "keyLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "category": "descriptive",
        "context": {
          "type": "FACILITY_GROUP",
          "value": "text"
        },
        "key": "%%subtitle%%",
        "priority": 100,
        "type": "STRING",
        "value": "585er Gold"
      }
    ],
    "imageUrl": "https://example.com/resource",
    "tenantArticleId": "4711",
    "title": "Cologne Water",
    "weight": 1
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
  "location": {
    "locationRef": "text",
    "scannableCodes": [
      "text"
    ]
  },
  "measurementUnitKey": "pcs",
  "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"
  ],
  "secondaryMeasurementUnitKey": "g",
  "secondaryQuantity": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Call restow item action

post

Authorizations

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

RestowItemActionsParameter

Responses

200

Updated RestowItem in the body.

application/json

RestowItem

customAttributesobjectOptional

Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

globalLineItemIdstringOptional

This ID is used to identify if this line item is related to the line item of other operational entities.

idstringRequiredExample: LGMl2DuvPnfPoSHhYFOm

measurementUnitKeystringOptional

Identifier for items unit of measurement.

Example: liter

quantityinteger · int64 · min: 1RequiredDefault: 1Example: 1

scannableCodesstring[]Optional

Codes that can be used for scanning this lineItem

secondaryMeasurementUnitKeystring · min: 1Optional

Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram

Example: g

secondaryQuantitynumberOptional

secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight

Example: 42

createdstring · date-timeOptional

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-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

facilityRefstringRequired

The id of the facility reference. The given ID has to be present in the system.

Example: Esb20gpHBL94X5NdMp3C

operativeProcessRefstringOptional

id of the connected operative process if available

processRefstringOptional

id of the connected process if available

restowedbooleanRequired

Indicates if the restowItem has been restowed

Default: falseExample: true

statusstring · enumRequired

Status of the restow item

Possible values:

stockRefstringOptional

id of the stock entity for this line item

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

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": {
    "titleLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "attributes": [
      {
        "valueLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "keyLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "category": "descriptive",
        "context": {
          "type": "FACILITY_GROUP",
          "value": "text"
        },
        "key": "%%subtitle%%",
        "priority": 100,
        "type": "STRING",
        "value": "585er Gold"
      }
    ],
    "imageUrl": "https://example.com/resource",
    "tenantArticleId": "4711",
    "title": "Cologne Water",
    "weight": 1
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
  "location": {
    "locationRef": "text",
    "scannableCodes": [
      "text"
    ]
  },
  "measurementUnitKey": "pcs",
  "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"
  ],
  "secondaryMeasurementUnitKey": "g",
  "secondaryQuantity": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Last updated 3 hours ago

Was this helpful?