Multi Order Picking

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

Summary

Multi order picking is a picking method where a picker simultaneously collects items for multiple tasks in a single pass through e.g. the warehouse. This method increases efficiency by reducing the travel time and distance covered, as opposed to picking items for one task at a time. Multi order picking is often optimized using advanced software systems that group orders in a way that minimizes picking paths and improves overall productivity.

Use Case Example

The company has established the following requirements for its operational picking process:

1. Multi order picking is to be implemented exclusively for one designated facility in this case a warehouse, while single order picking is to be utilized for all other facilites.

2. No more than five tasks may be picked simultaneously to ensure efficiency and manageability.

3. Picking operations are conducted using load units, with a total of five distinct load unit types available.

4. Upon completion of picking, the load units are transferred to a designated packing station. The packing process begins from this location.

Configure multi order picking. First of all, everything needs to be configured, so that the process later works as designed.

1. Configure picking method for a warehouse facility

PickingMethod MULTI_ORDER must be set in the designated facility, in this case the warehouse. The default SINGLE_ORDER applies in all other facilities, which is set in the picking configurations.

Patches a facility with the given ID

patch

Authorizations

Path parameters

facilityIdstringRequired

ID of facility you want to patch

Body

versioninteger · int64Required

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

Example: 42

Responses

200

Facility was found & patch-set has been applied. The patched facility is in the body.

application/json

Responseall of

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

Facility not found

application/json

409

Facility version conflict

application/json

patch

HTTPcURLJavaScriptPython

PATCH / HTTP/1.1
Host: %%HOST%%
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1633

{
  "actions": [
    {
      "action": "ModifyFacility",
      "address": {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "street": "Hauptstr.",
        "companyName": "Speedy Boxales Ltd.",
        "emailAddresses": [
          {
            "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
            "value": "[e-mail]"
          }
        ]
      },
      "closingDays": [
        {
          "date": "2020-02-03T09:45:51.525Z",
          "reason": "text",
          "recurrence": "YEARLY"
        }
      ],
      "contact": {
        "customAttributes": {},
        "firstName": "text",
        "lastName": "text",
        "roleDescription": "Manager, Supervisor, Teamleader, etc."
      },
      "customAttributes": {},
      "fulfillmentProcessBuffer": "240",
      "locationType": "STORE",
      "name": "Hamburg NW2",
      "capacityPlanningTimeframe": 1,
      "pickingTimes": {
        "friday": [
          {
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            },
            "capacity": 1
          }
        ],
        "monday": [
          {
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            },
            "capacity": 1
          }
        ],
        "saturday": [
          {
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            },
            "capacity": 1
          }
        ],
        "sunday": [
          {
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            },
            "capacity": 1
          }
        ],
        "thursday": [
          {
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            },
            "capacity": 1
          }
        ],
        "tuesday": [
          {
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            },
            "capacity": 1
          }
        ],
        "wednesday": [
          {
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            },
            "capacity": 1
          }
        ]
      },
      "pickingMethods": [
        "SINGLE_ORDER"
      ],
      "scanningRule": {
        "values": []
      },
      "services": [
        {
          "type": "SHIP_FROM_STORE"
        }
      ],
      "status": "ONLINE",
      "tenantFacilityId": "K12345",
      "capacityEnabled": true,
      "tags": []
    }
  ],
  "version": 42
}

{
  "address": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "province": "NRW",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "closingDays": [
    {
      "date": "2020-02-03T09:45:51.525Z",
      "reason": "text",
      "recurrence": "YEARLY"
    }
  ],
  "contact": {
    "customAttributes": {},
    "firstName": "text",
    "lastName": "text",
    "roleDescription": "Manager, Supervisor, Teamleader, etc."
  },
  "customAttributes": {},
  "fulfillmentProcessBuffer": "240",
  "locationType": "STORE",
  "name": "Hamburg NW2",
  "capacityPlanningTimeframe": 1,
  "pickingTimes": {
    "friday": [
      {
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        },
        "capacity": 1
      }
    ],
    "monday": [
      {
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        },
        "capacity": 1
      }
    ],
    "saturday": [
      {
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        },
        "capacity": 1
      }
    ],
    "sunday": [
      {
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        },
        "capacity": 1
      }
    ],
    "thursday": [
      {
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        },
        "capacity": 1
      }
    ],
    "tuesday": [
      {
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        },
        "capacity": 1
      }
    ],
    "wednesday": [
      {
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        },
        "capacity": 1
      }
    ]
  },
  "pickingMethods": [
    "SINGLE_ORDER"
  ],
  "scanningRule": {
    "values": []
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ],
  "status": "ONLINE",
  "tenantFacilityId": "K12345",
  "capacityEnabled": false,
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "configs": [
    {
      "ref": "text",
      "rel": "text"
    }
  ],
  "id": "Esb20gpHBL94X5NdMp3C"
}

2. Configure the maximum of tasks for multi order pick

    "multiOrderPickingConfiguration": {
        "maxAmountOfPickJobsForMultiOrderPick": 5
    },

Change the tenant wide picking central configuration

patch

Authorizations

Body

Responses

200

The picking central configuration was successfully updated.

application/json

201

The picking central 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

patch

HTTPcURLJavaScriptPython

PATCH / HTTP/1.1
Host: %%HOST%%
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 718

{
  "pickingShortPickConfiguration": {
    "confirmationOnShortPick": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_FIRST",
    "scanningRule": {
      "values": []
    },
    "rolesWithOverwritingScanningPermission": [
      "FULFILLER"
    ]
  },
  "scanCodeValidationConfiguration": {
    "pickingScanCodeValidationType": "NO_VALIDATION"
  },
  "takeOverPickJobConfiguration": {
    "active": false
  },
  "loadUnitAssignmentConfiguration": {
    "pickJob": "AT_END",
    "pickRun": "AT_END"
  },
  "pickingMethodsConfiguration": {
    "defaultPickingMethod": "SINGLE_ORDER"
  },
  "restartPickJobConfiguration": {
    "active": true
  },
  "stockUpdateConfiguration": {
    "active": false
  },
  "backofficePickingConfiguration": {
    "active": false
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "pickingShortPickConfiguration": {
    "confirmationOnShortPick": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_FIRST",
    "scanningRule": {
      "values": []
    },
    "rolesWithOverwritingScanningPermission": [
      "FULFILLER"
    ]
  },
  "scanCodeValidationConfiguration": {
    "pickingScanCodeValidationType": "NO_VALIDATION"
  },
  "takeOverPickJobConfiguration": {
    "active": false
  },
  "loadUnitAssignmentConfiguration": {
    "pickJob": "AT_END",
    "pickRun": "AT_END"
  },
  "pickingMethodsConfiguration": {
    "defaultPickingMethod": "SINGLE_ORDER"
  },
  "restartPickJobConfiguration": {
    "active": true
  },
  "stockUpdateConfiguration": {
    "active": false
  },
  "backofficePickingConfiguration": {
    "active": false
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

3. Create load unit types

OperativeContainerTypes must be created and defined in which fulfillment process step, so called allowedOperativeTypes are required.

Create operativeContainerType

post

Body

iconUrlstringOptional

priorityinteger · int32 · min: 1 · max: 10000Optional

This value gives the priority of the respective operativeContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order packingContainerTypes in the UI.

Example: 100

weightLimitInGnumber · min: 1Optional

Maximal weight in gramm(gr) the container can be loaded with.

Example: 2500

customAttributesobjectOptional

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

Responses

201

Successfully created resource.

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

post

HTTPcURLJavaScriptPython

POST /api/operativecontainertypes HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1457

{
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "iconUrl": "text",
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "priority": 100,
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "weightLimitInG": 2500,
  "customAttributes": {},
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "scannableIdentifiers": [
    {
      "searchType": "PREFIX",
      "identifiers": [
        "text"
      ]
    }
  ],
  "icon": {
    "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
    "name": "example.pdf"
  }
}

{
  "description": "text",
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "iconUrl": "text",
  "id": "text",
  "name": "text",
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "priority": 100,
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "weightLimitInG": 2500,
  "customAttributes": {},
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "scannableIdentifiers": [
    {
      "searchType": "PREFIX",
      "identifiers": [
        "text"
      ]
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

4. Create storage locations

This is the location, where you store your load units at the end of the picking process.

Create a new storage location

post

Creates a new storage location in this facility.

Authorizations

Path parameters

facilityIdstringRequired

ID of facility from whom you want to create the storage location

Body

namestring · max: 15Required

The name of this storage location

tenantLocationIdstringOptional

The internal tenant id for this location

typestring · enumRequired

Describes the kind of a storage location:

• SINGLE_STORAGE- it is only allowed to store stock with the same tenantArticleId here
• BULK_STORAGE- stocks belonging to different tenantArticleIds can be stored here

Possible values:

scannableCodesstring[] · max: 5Required

Barcodes representing this storage location

zoneRefstringOptional

The id of the Zone to which this storage location belongs

Example: Esb20gpHBL94X5NdMp3C

zoneNamestringOptional

The name of the Zone to which this storage location belongs

informationstring · max: 1024Optional

A free text information about this storage location, max length 1024

customAttributesobjectOptional

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

Responses

201

The storage location was successfully created.

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

404

Facility not found

application/json

post

HTTPcURLJavaScriptPython

POST / HTTP/1.1
Host: %%HOST%%
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "name": "text",
  "tenantLocationId": "text",
  "type": "SINGLE_STORAGE",
  "traits": [
    "PICKABLE"
  ],
  "traitConfig": [
    {
      "trait": "PICKABLE",
      "enabled": true
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "runningSequences": [
    {
      "type": "PICKING_SEQUENCE",
      "previousStorageLocationRef": "text",
      "nextStorageLocationRef": "text"
    }
  ],
  "zoneRef": "Esb20gpHBL94X5NdMp3C",
  "zoneName": "text",
  "information": "text",
  "customAttributes": {}
}

{
  "id": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "traits": [
    "PICKABLE"
  ],
  "traitConfig": [
    {
      "trait": "PICKABLE",
      "enabled": true
    }
  ],
  "schemaVersion": 1,
  "version": 42,
  "name": "text",
  "tenantLocationId": "text",
  "type": "SINGLE_STORAGE",
  "scannableCodes": [
    "text"
  ],
  "runningSequences": [
    {
      "type": "PICKING_SEQUENCE",
      "previousStorageLocationRef": "text",
      "nextStorageLocationRef": "text"
    }
  ],
  "zoneRef": "Esb20gpHBL94X5NdMp3C",
  "zoneName": "text",
  "information": "text",
  "customAttributes": {},
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

---

How to fulfill a task in multi order pick

When everything is configured, you are ready to fulfill your tasks with multi order picking.

1. Create a multi order pick

2. Start the pickrun

3. Add items to load units

4. Store load units at your storage location

5. Finish pickrun

1. Create a multi order pick pickrun

Add a new PickRun

post

Body

pickJobRefsstring[] · min: 1Required

statusstring · enumOptional

The state of the PickRun

Possible values:

facilityRefstringRequired

pickRunTypestring · enumOptional

Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead

Default: batchPickPossible values:

Responses

201

The PickRun was successfully created. The Location header contains the URL of it.

application/json

Responseall of

and

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

post

HTTPcURLJavaScriptPython

POST /api/pickruns HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "pickJobRefs": [
    "text"
  ],
  "status": "OPEN",
  "facilityRef": "text",
  "pickRunType": "batchPick"
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "pickLineItems": [
    {
      "article": {
        "attributes": [
          {
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold",
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            }
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "picked": 20,
      "secondaryPicked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "status": "OPEN",
      "substituteLineItems": [
        {
          "id": "text",
          "refused": [],
          "article": {
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "weight": 1,
            "attributes": [
              {
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold",
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                }
              }
            ]
          },
          "priority": 1,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "quantity": 21,
          "scannableCodes": [
            "text"
          ],
          "partialStockLocations": [
            {
              "quantity": 21,
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              }
            }
          ]
        }
      ],
      "stockEmptied": true,
      "pickJobLineItemRef": "12345",
      "partialStockLocations": [
        {
          "tenantPartialStockId": "text",
          "stockRef": "text",
          "quantity": 21,
          "available": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "stockProperties": {
            "expiry": "text"
          }
        }
      ],
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "shortPickReason": {
        "reason": "text",
        "reasonLocalized": "{ en_US: 'SomeName' }"
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "measurementUnitKey": "liter",
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "measurementValidation": {
        "shortPickSoftTolerancePercentage": 10,
        "shortPickHardTolerancePercentage": 15,
        "overPickSoftTolerancePercentage": 15,
        "overPickHardTolerancePercentage": 20
      },
      "tags": [],
      "stickers": [],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold",
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              }
            }
          ],
          "imageUrl": "text",
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "tenantArticleId": "text",
          "title": "text"
        }
      ]
    },
    {
      "pickJobRef": "text"
    }
  ],
  "pickJobRefs": [
    "text"
  ],
  "facilityRef": "text",
  "status": "OPEN",
  "id": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "pickRunType": "batchPick"
}

2. Start the pickrun

Call a single action on a given pickRun

post

Path parameters

pickRunIdstringRequired

Reference to the pick run you want to call the action for

Body

any ofOptional

or

or

or

or

Responses

200

Updated Pick Run in the body.

application/json

Responseall of

and

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

post

HTTPcURLJavaScriptPython

POST /api/pickruns/{pickRunId}/actions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "START",
  "version": 1
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "pickLineItems": [
    {
      "article": {
        "attributes": [
          {
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold",
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            }
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "picked": 20,
      "secondaryPicked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "status": "OPEN",
      "substituteLineItems": [
        {
          "id": "text",
          "refused": [],
          "article": {
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "weight": 1,
            "attributes": [
              {
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold",
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                }
              }
            ]
          },
          "priority": 1,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "quantity": 21,
          "scannableCodes": [
            "text"
          ],
          "partialStockLocations": [
            {
              "quantity": 21,
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              }
            }
          ]
        }
      ],
      "stockEmptied": true,
      "pickJobLineItemRef": "12345",
      "partialStockLocations": [
        {
          "tenantPartialStockId": "text",
          "stockRef": "text",
          "quantity": 21,
          "available": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "stockProperties": {
            "expiry": "text"
          }
        }
      ],
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "shortPickReason": {
        "reason": "text",
        "reasonLocalized": "{ en_US: 'SomeName' }"
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "measurementUnitKey": "liter",
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "measurementValidation": {
        "shortPickSoftTolerancePercentage": 10,
        "shortPickHardTolerancePercentage": 15,
        "overPickSoftTolerancePercentage": 15,
        "overPickHardTolerancePercentage": 20
      },
      "tags": [],
      "stickers": [],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold",
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              }
            }
          ],
          "imageUrl": "text",
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "tenantArticleId": "text",
          "title": "text"
        }
      ]
    },
    {
      "pickJobRef": "text"
    }
  ],
  "pickJobRefs": [
    "text"
  ],
  "facilityRef": "text",
  "status": "OPEN",
  "id": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "pickRunType": "batchPick"
}

3. Patch items to load units

Patch a loadUnit by its ID

patch

Path parameters

loadUnitIdstringRequired

Query parameters

localestringOptional

Provide the localized names and descriptions for the routing configuration. If not provided the default locale is used., for example de_DE

Body

any ofOptional

or

Responses

200

The found load unit.

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

404

Entity not found

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/loadunits/{loadUnitId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 518

{
  "actions": [
    {
      "action": "ReplaceLoadUnitLineItems",
      "loadUnitLineItems": [
        {
          "article": {},
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "quantity": 1,
          "recordableAttributes": [
            {
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ]
        }
      ]
    }
  ],
  "version": 42
}

{
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "weightLimitInG": 1,
  "description": "text",
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "name": "text",
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "loadUnitLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "codes": [
    "text"
  ],
  "pickJobRefs": [
    "text"
  ],
  "customAttributes": {},
  "storageLocationRef": "text",
  "operativeContainerTypeRef": "text",
  "stackRef": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

5. Create and store load units at your storage location

Add new load units

post

Body

Responses

201

Load units are 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

post

HTTPcURLJavaScriptPython

POST /api/loadunits HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 450

{
  "loadUnits": [
    {
      "codes": [
        "text"
      ],
      "loadUnitLineItems": [
        {
          "article": {},
          "customAttributes": {},
          "globalLineItemId": "text",
          "quantity": 1,
          "recordableAttributes": [
            {
              "group": "general",
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ]
        }
      ],
      "pickJobRefs": [
        "text"
      ],
      "customAttributes": {},
      "storageLocationRef": "text",
      "operativeContainerTypeRef": "text",
      "stackRef": "text"
    }
  ]
}

{
  "loadUnits": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

4. Finish a pickrun

The pickrun result can be finished by using the PickrunFinishActionParameter

After all that, you have successfully picked multiple tasks with the multi order pick method.

---