Orders Configuration (DOMS)

DOMS endpoints to define and manage configuration settings related to order processing, such as defaults, business rules, and operational parameters that influence how orders are handled.

List cancellation reasons

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

All entities after given ID

sizeintegerOptional

Number of entities to show

Default: 25

Responses

200

Cancellation reasons were found and you were allowed to access them. The result is in the body.

application/json

CancelationReasons

hasNextPagebooleanRequired

True if there are more results after the current page

totalintegerRequired

Total number of found entities for this query

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

Cancellation reason not found.

application/json

get/api/cancelationreasons

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

{
  "reasons": [
    {
      "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
    }
  ],
  "hasNextPage": true,
  "total": 1
}

Create cancellation reason

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AbstractReasonForCreation

reasonstringRequired

Text explaining the reason for a supported action.

Example: Rerouted because of an issue in the Facility.

Responses

201

The cancellation reason has been successfully created. The Location header includes the URL of the document.

application/json

CancelationReason

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

303

The cancellation reason already exists. The location header contains the URL of the document.

400

Invalid input. See the 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/api/cancelationreasons

POST /api/cancelationreasons HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

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

{
  "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
}

Get cancellation reason

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cancelationReasonIdstringRequired

ID of the cancellation reason you wish to retrieve

Responses

200

Cancellation reason was found and you were allowed to access it. The result is in the body.

application/json

CancelationReason

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

Cancellation reason not found

application/json

get/api/cancelationreasons/{cancelationReasonId}

GET /api/cancelationreasons/{cancelationReasonId} 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 cancellation reason

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cancelationReasonIdstringRequired

ID of the cancellation reason 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

Cancellation reason was found and you were allowed to access it. The result is in the body.

application/json

CancelationReason

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

Cancellation reason not found

application/json

put/api/cancelationreasons/{cancelationReasonId}

PUT /api/cancelationreasons/{cancelationReasonId} 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 cancellation reason

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cancelationReasonIdstringRequired

ID of the cancellation reason you intend to delete

Responses

200

The cancellation reason 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

Cancellation reason not found

application/json

delete/api/cancelationreasons/{cancelationReasonId}

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

No content

Get order cancelation config

get

Get the order cancelation configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The Order Cancelation Configuration can be found in the body.

application/json

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

This configuration is to define specific rules for canceling orders such as the forced cancelation.

allowForceCancelOrderbooleanRequired

createdstring · date-timeOptional

The date this configuration was created at the platform. This value is generated by the service.

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

idstringOptional

versioninteger · int64Required

The version of the configuration 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

get/api/configurations/ordercancelation

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

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

Update order cancelation config

put

Update the order cancelation configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

This configuration is to define specific rules for canceling orders such as the forced cancelation.

allowForceCancelOrderbooleanRequired

createdstring · date-timeOptional

The date this configuration was created at the platform. This value is generated by the service.

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

idstringOptional

versioninteger · int64Required

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

Example: 42

Responses

200

The order cancelation configuration was successfully updated.

application/json

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

This configuration is to define specific rules for canceling orders such as the forced cancelation.

allowForceCancelOrderbooleanRequired

createdstring · date-timeOptional

The date this configuration was created at the platform. This value is generated by the service.

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

idstringOptional

versioninteger · int64Required

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

Example: 42

201

The order cancelation 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/ordercancelation

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

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

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

Get order modification config

get

Get the order modification configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The Order Modification Configuration can be found in the body.

application/json

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

This configuration is to define specific rules for modifying orders after order creation.

allowOrderLineItemModificationbooleanRequired

createdstring · date-timeOptional

The date this configuration was created at the platform. This value is generated by the service.

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

idstringOptional

versioninteger · int64Required

The version of the configuration 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

get/api/configurations/ordermodification

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

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

Update order modification config

put

Update the order modification configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

This configuration is to define specific rules for modifying orders after order creation.

allowOrderLineItemModificationbooleanRequired

createdstring · date-timeOptional

The date this configuration was created at the platform. This value is generated by the service.

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

idstringOptional

versioninteger · int64Required

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

Example: 42

Responses

200

The order modification configuration was successfully updated.

application/json

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

This configuration is to define specific rules for modifying orders after order creation.

allowOrderLineItemModificationbooleanRequired

createdstring · date-timeOptional

The date this configuration was created at the platform. This value is generated by the service.

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

idstringOptional

versioninteger · int64Required

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

Example: 42

201

The order modification 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/ordermodification

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

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

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

List promises

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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

application/json

PromisesConfiguration

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

invalidAfterTimestringRequired

Default amount of time in ISO 8601 duration format after which an promised order becomes invalid and is cancelled. The duration need to be a multiple of 60 seconds.

Default: PT8HPattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$

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

Promises configuration not found

application/json

get/api/configurations/promises

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

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

Change promises config

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PromisesConfiguration

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

invalidAfterTimestringRequired

Default amount of time in ISO 8601 duration format after which an promised order becomes invalid and is cancelled. The duration need to be a multiple of 60 seconds.

Default: PT8HPattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$

Responses

200

The promisesConfiguration was successfully put.

application/json

PromisesConfiguration

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

invalidAfterTimestringRequired

Default amount of time in ISO 8601 duration format after which an promised order becomes invalid and is cancelled. The duration need to be a multiple of 60 seconds.

Default: PT8HPattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$

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

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

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

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

Get order tag configuration

get

Get the order tag configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

order tag config is in response body.

application/json

OrderTagConfiguration

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

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

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

Update order tag configuration

put

Update the order tag configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OrderTagConfiguration

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 order tag configuration was successfully updated.

application/json

OrderTagConfiguration

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

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

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

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

Last updated 3 hours ago