Picking Configuration (Operations)

Endpoints to create, update, and read pick jobs.

Get cutoff time

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

Responses

200

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

application/json

CutoffTimeConfiguration

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

idstringOptional

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

Cutoff time configuration not found

application/json

get/api/configurations/cutofftime

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

{
  "clickAndCollect": {
    "hour": 16,
    "minute": 30
  },
  "id": "text",
  "shipFromStore": {
    "hour": 16,
    "minute": 30
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update cutoff time

put

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

Body

CutoffTimeConfiguration

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

idstringOptional

Responses

200

Cutoff time configuration was written successfully

application/json

CutoffTimeConfiguration

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

idstringOptional

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

Cutoff time configuration not found

application/json

put/api/configurations/cutofftime

PUT /api/configurations/cutofftime HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "clickAndCollect": {
    "hour": 16,
    "minute": 30
  },
  "id": "text",
  "shipFromStore": {
    "hour": 16,
    "minute": 30
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "clickAndCollect": {
    "hour": 16,
    "minute": 30
  },
  "id": "text",
  "shipFromStore": {
    "hour": 16,
    "minute": 30
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get fulfillment process buffer

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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

application/json

FulfillmentProcessBufferConfiguration

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

idstringOptional

minutesintegerRequired

Duration in minutes until an order is processed

Default: 240Example: 240

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

Configuration not found

application/json

get/api/configurations/fulfillmentprocessbuffer

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

{
  "id": "text",
  "minutes": "240",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update fulfillment process buffer

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

FulfillmentProcessBufferConfiguration

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

idstringOptional

minutesintegerRequired

Duration in minutes until an order is processed

Default: 240Example: 240

Responses

200

Configuration was written successfully

application/json

FulfillmentProcessBufferConfiguration

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

idstringOptional

minutesintegerRequired

Duration in minutes until an order is processed

Default: 240Example: 240

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

Configuration not found

application/json

put/api/configurations/fulfillmentprocessbuffer

PUT /api/configurations/fulfillmentprocessbuffer HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "id": "text",
  "minutes": "240",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "id": "text",
  "minutes": "240",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get load unit config

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The load unit configuration can be found in the body.

application/json

LoadUnitConfiguration

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

maxCountintegerOptional

Max creatable count of load units per load unit type

Default: 20Example: 20

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/configurations/loadunit

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

{
  "maxCount": 20,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update load unit config

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

LoadUnitConfiguration

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

maxCountintegerOptional

Max creatable count of load units per load unit type

Default: 20Example: 20

Responses

200

The load unit configuration was successfully updated.

application/json

LoadUnitConfiguration

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

maxCountintegerOptional

Max creatable count of load units per load unit type

Default: 20Example: 20

201

The load unit 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

put/api/configurations/loadunit

PUT /api/configurations/loadunit HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "maxCount": 20,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "maxCount": 20,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get picking config

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Central Configuration of all picking related things

application/json

PickingConfigurations

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

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/configurations/picking

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

{
  "backofficePickingConfiguration": {
    "active": false
  },
  "batchPickingConfiguration": {
    "maxAmountOfPickJobsForBatchPick": 1
  },
  "domainStatusConfiguration": {
    "mapAbortedToFinished": false
  },
  "loadUnitAssignmentConfiguration": {
    "pickJob": "AT_END",
    "pickRun": "AT_END"
  },
  "multiOrderPickingConfiguration": {
    "maxAmountOfPickJobsForMultiOrderPick": 1
  },
  "pickingMethodsConfiguration": {
    "defaultPickingMethod": "SINGLE_ORDER"
  },
  "pickingShortPickConfiguration": {
    "confirmationOnShortPick": false,
    "shortPickReasons": []
  },
  "restartPickJobConfiguration": {
    "active": true
  },
  "scanCodeValidationConfiguration": {
    "pickingScanCodeValidationType": "NO_VALIDATION"
  },
  "scanningConfiguration": {
    "rolesWithOverwritingScanningPermission": [
      "FULFILLER"
    ],
    "scanningRule": {
      "values": [
        {
          "priority": 1,
          "scanningRuleType": "ARTICLE"
        }
      ]
    },
    "scanningType": "MUST_SCAN_FIRST"
  },
  "scheduledPickJobReleaseConfiguration": {
    "openPickJobLeadTimeInMinutes": 1
  },
  "stockUpdateConfiguration": {
    "active": false
  },
  "storageLocationAssignmentConfiguration": {
    "storageLocationRequired": "ALL"
  },
  "takeOverPickJobConfiguration": {
    "active": false
  },
  "takeOverPickRunConfiguration": {
    "active": false
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update picking config

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PickingConfigurations

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

Responses

200

The picking central configuration was successfully updated.

application/json

PickingConfigurations

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

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/api/configurations/picking

PATCH /api/configurations/picking HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1181

{
  "backofficePickingConfiguration": {
    "active": false
  },
  "batchPickingConfiguration": {
    "maxAmountOfPickJobsForBatchPick": 1
  },
  "domainStatusConfiguration": {
    "mapAbortedToFinished": false
  },
  "loadUnitAssignmentConfiguration": {
    "pickJob": "AT_END",
    "pickRun": "AT_END"
  },
  "multiOrderPickingConfiguration": {
    "maxAmountOfPickJobsForMultiOrderPick": 1
  },
  "pickingMethodsConfiguration": {
    "defaultPickingMethod": "SINGLE_ORDER"
  },
  "pickingShortPickConfiguration": {
    "confirmationOnShortPick": false,
    "shortPickReasons": []
  },
  "restartPickJobConfiguration": {
    "active": true
  },
  "scanCodeValidationConfiguration": {
    "pickingScanCodeValidationType": "NO_VALIDATION"
  },
  "scanningConfiguration": {
    "rolesWithOverwritingScanningPermission": [
      "FULFILLER"
    ],
    "scanningRule": {
      "values": [
        {
          "priority": 1,
          "scanningRuleType": "ARTICLE"
        }
      ]
    },
    "scanningType": "MUST_SCAN_FIRST"
  },
  "scheduledPickJobReleaseConfiguration": {
    "openPickJobLeadTimeInMinutes": 1
  },
  "stockUpdateConfiguration": {
    "active": false
  },
  "storageLocationAssignmentConfiguration": {
    "storageLocationRequired": "ALL"
  },
  "takeOverPickJobConfiguration": {
    "active": false
  },
  "takeOverPickRunConfiguration": {
    "active": false
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "backofficePickingConfiguration": {
    "active": false
  },
  "batchPickingConfiguration": {
    "maxAmountOfPickJobsForBatchPick": 1
  },
  "domainStatusConfiguration": {
    "mapAbortedToFinished": false
  },
  "loadUnitAssignmentConfiguration": {
    "pickJob": "AT_END",
    "pickRun": "AT_END"
  },
  "multiOrderPickingConfiguration": {
    "maxAmountOfPickJobsForMultiOrderPick": 1
  },
  "pickingMethodsConfiguration": {
    "defaultPickingMethod": "SINGLE_ORDER"
  },
  "pickingShortPickConfiguration": {
    "confirmationOnShortPick": false,
    "shortPickReasons": []
  },
  "restartPickJobConfiguration": {
    "active": true
  },
  "scanCodeValidationConfiguration": {
    "pickingScanCodeValidationType": "NO_VALIDATION"
  },
  "scanningConfiguration": {
    "rolesWithOverwritingScanningPermission": [
      "FULFILLER"
    ],
    "scanningRule": {
      "values": [
        {
          "priority": 1,
          "scanningRuleType": "ARTICLE"
        }
      ]
    },
    "scanningType": "MUST_SCAN_FIRST"
  },
  "scheduledPickJobReleaseConfiguration": {
    "openPickJobLeadTimeInMinutes": 1
  },
  "stockUpdateConfiguration": {
    "active": false
  },
  "storageLocationAssignmentConfiguration": {
    "storageLocationRequired": "ALL"
  },
  "takeOverPickJobConfiguration": {
    "active": false
  },
  "takeOverPickRunConfiguration": {
    "active": false
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get picking times

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Picking Times config found.

application/json

DefaultPickingTimesConfiguration

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

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/configurations/pickingtimes

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

{
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update picking times

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

DefaultPickingTimesConfiguration

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

Responses

200

The default picking times configuration was successfully updated.

application/json

DefaultPickingTimesConfiguration

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

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

409

Configuration version conflict

application/json

put/api/configurations/pickingtimes

PUT /api/configurations/pickingtimes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 706

{
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get substitution config

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

Responses

200

Substitution config found.

application/json

Substitution Configuration

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

activebooleanRequired

Toggle for substitution articles.

Default: trueExample: false

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/configurations/substitution

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

{
  "active": false,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update substitution config

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Substitution Configuration

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

activebooleanRequired

Toggle for substitution articles.

Default: trueExample: false

Responses

200

The substitution configuration was successfully updated.

application/json

Substitution Configuration

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

activebooleanRequired

Toggle for substitution articles.

Default: trueExample: false

201

The substitution 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

409

Facility version conflict

application/json

put/api/configurations/substitution

PUT /api/configurations/substitution HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "active": false,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "active": false,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get pick job tag config

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

pickjob tag config is in response body.

application/json

PickJobTagConfiguration

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

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/configurations/tags/pickjob

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

{
  "lineItemScanningConfiguration": {
    "offeredScanningRuleByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "scanningType": "MUST_SCAN_FIRST",
        "tagRef": "text"
      }
    ]
  },
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "preferredPickingMethodsConfiguration": {
    "PreferredPickingMethodsPerTag": []
  },
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update pick job tag config

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PickJobTagConfiguration

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

Responses

200

The packing configuration was successfully updated.

application/json

PickJobTagConfiguration

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

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

put/api/configurations/tags/pickjob

PUT /api/configurations/tags/pickjob HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 719

{
  "lineItemScanningConfiguration": {
    "offeredScanningRuleByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "scanningType": "MUST_SCAN_FIRST",
        "tagRef": "text"
      }
    ]
  },
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "preferredPickingMethodsConfiguration": {
    "PreferredPickingMethodsPerTag": []
  },
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "lineItemScanningConfiguration": {
    "offeredScanningRuleByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "scanningType": "MUST_SCAN_FIRST",
        "tagRef": "text"
      }
    ]
  },
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "preferredPickingMethodsConfiguration": {
    "PreferredPickingMethodsPerTag": []
  },
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get pick job document handling

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

ID of the pick job you want to get document handling information

Responses

200

Pick job document handling was found & you were allowed to access it. The result is in the body.

application/json

DocumentHandling

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/pickjobs/{pickJobId}/documenthandling

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

{
  "sendLabel": {
    "enabled": false
  }
}

Last updated 4 hours ago