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

Cancelation reasons were found & you were allowed to access them. The result is in the body.

application/json

CancelationReasons

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

Cancelation 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 cancelation reason

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CancelationReasonForCreation

Responses

201

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

application/json

303

The Cancelation Reason already exists. The Location header contains the URL of the document.

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

/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 cancelation reason

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cancelationReasonIdstringRequired

Id of the cancelation reason you wish to retrieve

Responses

200

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

application/json

CancelationReason

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

Cancelation 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 cancelation reason

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cancelationReasonIdstringRequired

ID of the cancelation reason you intend to modify

Body

CancelationReasonForModification

Responses

200

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

application/json

CancelationReason

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

Cancelation 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 cancelation reason

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cancelationReasonIdstringRequired

ID of the cancelation reason you intend to delete

Responses

200

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

Cancelation 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

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 Cancelation Configuration can be found in the body.

application/json

This part of the API is in Beta status. For details please check the api-release-life-cycle 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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

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

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 Modification Configuration can be found in the body.

application/json

This part of the API is in Beta status. For details please check the api-release-life-cycle 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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

This part of the API is in Beta status. For details please check the api-release-life-cycle 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 please check the api-release-life-cycle 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

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

Responses

200

The promisesConfiguration was successfully put.

application/json

PromisesConfiguration

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

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

order tag config is in response body.

application/json

OrderTagConfiguration

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

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OrderTagConfiguration

and

Responses

200

The order tag configuration was successfully updated.

application/json

OrderTagConfiguration

and

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 1 hour ago

hashtagList cancelation reasons

hashtagCreate cancelation reason

hashtagGet cancelation reason

hashtagUpdate cancelation reason

hashtagDelete cancelation reason

hashtagGet order cancelation config

hashtagUpdate order cancelation config

hashtagGet order modification config

hashtagUpdate order modification config

hashtagList promises

hashtagChange promises config

hashtagGet order tag configuration

hashtagUpdate order tag configuration

List cancelation reasons

Create cancelation reason

Get cancelation reason

Update cancelation reason

Delete cancelation reason

Get order cancelation config

Update order cancelation config

Get order modification config

Update order modification config

List promises

Change promises config

Get order tag configuration

Update order tag configuration