Routing Plans Configuration (DOMS)

Endpoints for configuring routing plan handling.

Get capacity planning timeframe

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

CapacityPlanningTimeframeConfiguration

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

daysinteger · min: 1Required

The range in days per facility which defines how many days in the future the capacity of the facility can be planned

Default: 100Example: 240

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

Configuration not found

application/json

get

/api/configurations/capacityplanningtimeframe

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

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

Update capacity planning timeframe

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CapacityPlanningTimeframeConfiguration

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

daysinteger · min: 1Required

The range in days per facility which defines how many days in the future the capacity of the facility can be planned

Default: 100Example: 240

idstringOptional

Responses

200

Configuration was written successfully

application/json

CapacityPlanningTimeframeConfiguration

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

daysinteger · min: 1Required

The range in days per facility which defines how many days in the future the capacity of the facility can be planned

Default: 100Example: 240

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

Configuration not found

application/json

put

/api/configurations/capacityplanningtimeframe

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

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

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

Get order routing config

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The Order Routing Configuration can be found in the body.

application/json

OrderRoutingConfiguration

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

infiniteStockEnabledbooleanOptional

Config to enable/disable infinite stock

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/orderrouting

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

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

Update order routing config

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OrderRoutingConfiguration

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

infiniteStockEnabledbooleanOptional

Config to enable/disable infinite stock

Responses

200

The order routing configuration was successfully updated.

application/json

OrderRoutingConfiguration

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

infiniteStockEnabledbooleanOptional

Config to enable/disable infinite stock

201

The order routing 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/orderrouting

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

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

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

Get reroute description

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

rerouteDescriptionIdstringRequired

Id of the reroute description you wish to retrieve

Responses

200

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

application/json

RerouteDescription

reasonstringRequired

Text explaining the reason for a supported action.

Example: Rerouted because of an issue in the Facility.

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

actionstring · enumRequiredPossible values:

idstringRequired

The id of the Reason

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

User not found

application/json

get

/api/reroutedescriptions/{rerouteDescriptionId}

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

{
  "action": "text",
  "id": "text",
  "reasonLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "reason": "Rerouted because of an issue in the Facility.",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update reroute description

put

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

rerouteDescriptionIdstringRequired

ID of the reroute description you intend to modify

Body

AbstractReasonForModification

reasonstringRequired

Text explaining the reason for a supported action.

Example: Rerouted because of an issue in the Facility.

versioninteger · int64Required

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

Example: 42

Responses

200

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

application/json

RerouteDescription

reasonstringRequired

Text explaining the reason for a supported action.

Example: Rerouted because of an issue in the Facility.

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

actionstring · enumRequiredPossible values:

idstringRequired

The id of the Reason

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

RerouteDescription not found

application/json

put

/api/reroutedescriptions/{rerouteDescriptionId}

PUT /api/reroutedescriptions/{rerouteDescriptionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "reasonLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "reason": "Rerouted because of an issue in the Facility.",
  "version": 42
}

{
  "action": "text",
  "id": "text",
  "reasonLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "reason": "Rerouted because of an issue in the Facility.",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete reroute description

delete

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

rerouteDescriptionIdstringRequired

ID of the reroute description you intend to delete

Responses

200

The reroute description was found, and you have been granted permission to delete it.

No content

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

RerouteDescription not found

application/json

delete

/api/reroutedescriptions/{rerouteDescriptionId}

DELETE /api/reroutedescriptions/{rerouteDescriptionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated 1 hour ago