Checkout Options (DOMS)

Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery.

Deprecated

Create fulfillability

post

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Deprecated: Use /api/promises instead.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Provides the paramters you are interested in. You must supply at least either the shipping or the collect attribute as the description of the last mile expectation.

estimatedOrderDatestring · date-timeRequired

The point in time when the order estimated to be supplied to fulfillmenttools platform, e.g. calling this endpoint during checkout, you would most likely put the timestamp for 'now' in here.

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

Responses

200

The result of the fulfillability .

application/json

The response to a fulfillability request.

204

There was no result of the fulfillability request. Please make sure to provide at least one of the attributes shipping or collect.

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

HTTPcURLJavaScriptPython

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

{
  "collect": {
    "geoFence": {
      "lat": 50.968713,
      "lon": 7.011375,
      "radius": 1
    }
  },
  "constraints": [
    {
      "type": "ITEMS",
      "value": {}
    }
  ],
  "estimatedOrderDate": "2020-02-03T08:45:50.525Z",
  "shipping": {
    "serviceLevels": [
      "SAMEDAY"
    ],
    "targetAddress": {
      "country": "DE",
      "postalCode": "40764"
    }
  }
}

{
  "collect": {
    "facilities": [
      {
        "created": "2020-02-03T08:45:51.525Z",
        "lastModified": "2020-02-03T09:45:51.525Z",
        "version": 42,
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr.",
        "id": "text",
        "name": "Köln store",
        "status": "ONLINE",
        "tenantFacilityId": "K12345",
        "type": "MANAGED_FACILITY"
      }
    ]
  },
  "shipping": {
    "DELIVERY": {
      "available": false
    },
    "SAMEDAY": {
      "available": true,
      "validUntil": "2020-02-03T08:45:50.525Z"
    }
  }
}

Deprecated

Create click and collect fulfillability

post

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Deprecated: Use /api/promises instead.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Provides the paramters you are interested in. You must supply at least the articles you are interested in

deliveryCountrystringOptional

A two-digit country code as per ISO 3166-1 alpha-2

Example: DEPattern: ^[A-Z]{2}$

deliveryPostalCodestringOptional

facilityRefsstring[]Optional

Responses

200

The result of the fulfillability for click and collect.

application/json

FulfillabilityResult

204

There was no result of the fulfillability request. Please make sure to provide at least one of the attributes shipping or collect.

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/fulfillability/clickandcollect

HTTPcURLJavaScriptPython

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

{
  "articles": [
    {
      "quantity": 1,
      "tenantArticleId": "text"
    }
  ],
  "deliveryCountry": "DE",
  "deliveryPostalCode": "text",
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "facilityRefs": [
    "text"
  ],
  "geoFence": {
    "lat": 50.968713,
    "lon": 7.011375,
    "radius": 1
  }
}

{
  "fulfillability": []
}

Deprecated

Create ship from store fulfillability

post

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Deprecated: Use /api/promises instead.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Provides the paramters you are interested in. You must supply at least the articles you are interested in

deliveryCountrystringOptional

A two-digit country code as per ISO 3166-1 alpha-2

Example: DEPattern: ^[A-Z]{2}$

deliveryPostalCodestringOptional

facilityRefsstring[]Optional

Responses

200

The result of the fulfillability for ship from store.

application/json

FulfillabilityResult

204

There was no result of the fulfillability request.

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/fulfillability/shipfromstore

HTTPcURLJavaScriptPython

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

{
  "articles": [
    {
      "quantity": 1,
      "tenantArticleId": "text"
    }
  ],
  "deliveryCountry": "DE",
  "deliveryPostalCode": "text",
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "facilityRefs": [
    "text"
  ],
  "geoFence": {
    "lat": 50.968713,
    "lon": 7.011375,
    "radius": 1
  }
}

{
  "fulfillability": []
}

List all record items (search cached for 5 minutes)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LookupRecordItemSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

LookupRecordItemPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

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

application/json

post

/api/lookuprecorditems/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "recordRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantRecordId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "values": {
              "contains": {
                "attributeId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "attributeValue": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "recordRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantRecordId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "values": {
              "contains": {
                "attributeId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "attributeValue": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "recordRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantRecordId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "values": {
          "contains": {
            "attributeId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "attributeValue": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "recordRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantRecordId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "values": {
          "contains": {
            "attributeId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "attributeValue": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "recordRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "tenantRecordId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "values": {
      "contains": {
        "attributeId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "attributeValue": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1
}

{
  "lookupRecordItems": [
    {
      "id": "text",
      "recordRef": "text",
      "tenantRecordId": "text",
      "values": {
        "attributeId": "text",
        "attributeValue": "text"
      }
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

Get all lookup records

get

Retrieves all lookup records.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved the lookup records.

application/json

LookupRecord

attributeDefinitionsall ofRequired

Map of attribute definitions that specify the type for each attribute.

object · LookupAttributeDefinitionsOptional

LookupAttributeDefinitions

createdstring · date-timeOptional

The date when the record was created.

idstringRequired

lastModifiedstring · date-timeOptional

The date when the record was last modified.

tenantRecordIdstring · min: 1 · max: 20Optional

Tenant-specific identifier for the lookup record.

versionnumberRequired

The version of the record.

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

application/json

404

The requested entity was not found

application/json

get

/api/lookuprecords

HTTPcURLJavaScriptPython

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

{
  "attributeDefinitions": {},
  "created": "2026-03-13T15:49:43.310Z",
  "id": "text",
  "items": [
    {
      "id": "text",
      "values": [
        {
          "attributeId": "text",
          "attributeValue": "text"
        }
      ]
    }
  ],
  "lastModified": "2026-03-13T15:49:43.310Z",
  "tenantRecordId": "text",
  "version": 1
}

Create a lookup record by its ID

post

Creates a single lookup record.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LookupRecordForCreation

attributeDefinitionsall ofRequired

Map of attribute definitions that specify the type for each attribute.

object · LookupAttributeDefinitionsOptional

LookupAttributeDefinitions

tenantRecordIdstring · min: 1 · max: 20Optional

Tenant-specific identifier for the lookup record.

Responses

200

Successfully created the lookup record.

application/json

LookupRecord

attributeDefinitionsall ofRequired

Map of attribute definitions that specify the type for each attribute.

object · LookupAttributeDefinitionsOptional

LookupAttributeDefinitions

createdstring · date-timeOptional

The date when the record was created.

idstringRequired

lastModifiedstring · date-timeOptional

The date when the record was last modified.

tenantRecordIdstring · min: 1 · max: 20Optional

Tenant-specific identifier for the lookup record.

versionnumberRequired

The version of the record.

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

application/json

404

The requested entity was not found

application/json

post

/api/lookuprecords

HTTPcURLJavaScriptPython

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

{
  "attributeDefinitions": {},
  "items": [
    {
      "values": [
        {
          "attributeId": "text",
          "attributeValue": "text"
        }
      ]
    }
  ],
  "tenantRecordId": "text"
}

{
  "attributeDefinitions": {},
  "created": "2026-03-13T15:49:43.310Z",
  "id": "text",
  "items": [
    {
      "id": "text",
      "values": [
        {
          "attributeId": "text",
          "attributeValue": "text"
        }
      ]
    }
  ],
  "lastModified": "2026-03-13T15:49:43.310Z",
  "tenantRecordId": "text",
  "version": 1
}

Get a lookup record by its ID

get

Retrieves a single lookup record using its unique identifier.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

recordIdstringRequired

Responses

200

Successfully retrieved the lookup record.

application/json

LookupRecord

attributeDefinitionsall ofRequired

Map of attribute definitions that specify the type for each attribute.

object · LookupAttributeDefinitionsOptional

LookupAttributeDefinitions

createdstring · date-timeOptional

The date when the record was created.

idstringRequired

lastModifiedstring · date-timeOptional

The date when the record was last modified.

tenantRecordIdstring · min: 1 · max: 20Optional

Tenant-specific identifier for the lookup record.

versionnumberRequired

The version of the record.

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

application/json

404

The requested entity was not found

application/json

get

/api/lookuprecords/{recordId}

HTTPcURLJavaScriptPython

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

{
  "attributeDefinitions": {},
  "created": "2026-03-13T15:49:43.310Z",
  "id": "text",
  "items": [
    {
      "id": "text",
      "values": [
        {
          "attributeId": "text",
          "attributeValue": "text"
        }
      ]
    }
  ],
  "lastModified": "2026-03-13T15:49:43.310Z",
  "tenantRecordId": "text",
  "version": 1
}

Updates a whole lookup record by its ID

put

Updates a single lookup record.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

recordIdstringRequired

Body

application/json

LookupRecordForUpdate

attributeDefinitionsall ofRequired

Map of attribute definitions that specify the type for each attribute.

object · LookupAttributeDefinitionsOptional

LookupAttributeDefinitions

tenantRecordIdstring · min: 1 · max: 20Optional

Tenant-specific identifier for the lookup record.

versionnumberRequired

The version of the record.

Responses

200

Successfully updated the lookup record.

application/json

LookupRecord

attributeDefinitionsall ofRequired

Map of attribute definitions that specify the type for each attribute.

object · LookupAttributeDefinitionsOptional

LookupAttributeDefinitions

createdstring · date-timeOptional

The date when the record was created.

idstringRequired

lastModifiedstring · date-timeOptional

The date when the record was last modified.

tenantRecordIdstring · min: 1 · max: 20Optional

Tenant-specific identifier for the lookup record.

versionnumberRequired

The version of the record.

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

application/json

404

The requested entity was not found

application/json

put

/api/lookuprecords/{recordId}

HTTPcURLJavaScriptPython

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

{
  "attributeDefinitions": {},
  "items": [
    {
      "values": [
        {
          "attributeId": "text",
          "attributeValue": "text"
        }
      ]
    }
  ],
  "tenantRecordId": "text",
  "version": 1
}

{
  "attributeDefinitions": {},
  "created": "2026-03-13T15:49:43.310Z",
  "id": "text",
  "items": [
    {
      "id": "text",
      "values": [
        {
          "attributeId": "text",
          "attributeValue": "text"
        }
      ]
    }
  ],
  "lastModified": "2026-03-13T15:49:43.310Z",
  "tenantRecordId": "text",
  "version": 1
}

Delete a lookup record by its ID

delete

Deletes a single lookup record using its unique identifier.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

recordIdstringRequired

Responses

200

Successfully deleted the lookup record.

application/json

LookupRecord

attributeDefinitionsall ofRequired

Map of attribute definitions that specify the type for each attribute.

object · LookupAttributeDefinitionsOptional

LookupAttributeDefinitions

createdstring · date-timeOptional

The date when the record was created.

idstringRequired

lastModifiedstring · date-timeOptional

The date when the record was last modified.

tenantRecordIdstring · min: 1 · max: 20Optional

Tenant-specific identifier for the lookup record.

versionnumberRequired

The version of the record.

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

application/json

404

The requested entity was not found

application/json

delete

/api/lookuprecords/{recordId}

HTTPcURLJavaScriptPython

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

{
  "attributeDefinitions": {},
  "created": "2026-03-13T15:49:43.310Z",
  "id": "text",
  "items": [
    {
      "id": "text",
      "values": [
        {
          "attributeId": "text",
          "attributeValue": "text"
        }
      ]
    }
  ],
  "lastModified": "2026-03-13T15:49:43.310Z",
  "tenantRecordId": "text",
  "version": 1
}

Deprecated

Create checkout options

post

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Evaluate a checkout options input against the DOMS.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckoutOptionsInput

filterDuplicatesbooleanOptional

Filter duplicate facilities

orderLineItemsobject[]Required

Order line items

tagsobject[]Optional

Tags

Responses

200

The request could be evaluated

application/json

or

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post

/api/promises/checkoutoptions

HTTPcURLJavaScriptPython

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

{
  "consumerAddress": {
    "addressType": "POSTAL_ADDRESS",
    "city": "text",
    "country": "DE",
    "houseNumber": "text",
    "postalCode": "text",
    "province": "text",
    "street": "text"
  },
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customServices": [
    {
      "articleItems": [
        {
          "quantity": 1,
          "tenantArticleRef": "text"
        }
      ],
      "customServiceDefinition": {
        "additionalInformation": [
          {
            "additionalInformationRef": "text",
            "tenantAdditionalInformationId": "text",
            "value": "text"
          }
        ],
        "customAttributes": {},
        "customServiceRef": "text",
        "isBundled": true,
        "tenantCustomServiceId": "text"
      },
      "customServiceItems": [
        {
          "articleItems": [
            {
              "quantity": 1,
              "tenantArticleRef": "text"
            }
          ],
          "customServiceDefinition": {
            "additionalInformation": [
              {
                "additionalInformationRef": "text",
                "tenantAdditionalInformationId": "text",
                "value": "text"
              }
            ],
            "customAttributes": {},
            "customServiceRef": "text",
            "isBundled": true,
            "tenantCustomServiceId": "text"
          },
          "customServiceItems": "[Circular Reference]"
        }
      ],
      "id": "text"
    }
  ],
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "filterDuplicates": true,
  "geoFence": {
    "lat": 50.968713,
    "lon": 7.011375,
    "radius": 1
  },
  "orderLineItems": [
    {}
  ],
  "tags": [
    {}
  ]
}

{
  "facilities": [
    {
      "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",
        "province": "NRW",
        "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,
          "source": "Google Maps API",
          "timeZoneId": "America/Los_Angeles",
          "timeZoneName": "Pacific Standard Time"
        }
      },
      "availabilities": [
        {
          "available": 1,
          "carrier": {
            "carrierProductCategory": "STANDARD",
            "carrierRef": "text"
          },
          "isBackOrderable": true,
          "latestPickingStart": "2026-03-13T15:49:43.310Z",
          "preOrderReleaseDate": "2026-03-13T15:49:43.310Z",
          "tenantArticleId": "text"
        }
      ],
      "closingDays": [
        {
          "date": "2020-02-03T09:45:51.525Z",
          "reason": "text",
          "recurrence": "YEARLY"
        }
      ],
      "customServices": [
        {
          "customServiceRef": "text",
          "name": "text"
        }
      ],
      "facilityRef": "text",
      "name": "text",
      "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
            }
          }
        ]
      },
      "targetTime": "2026-03-13T15:49:43.310Z"
    }
  ]
}

Get earliest collect

post

Get earliest collect timepoint for a given checkoutOption

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckoutOptionsCollectEarliestRequest

desiredCollectDatestring · date-timeOptional

Desired collection date

includeCalculationHintsbooleanOptional

Whether to include calculation hints in the response

tenantArticleIdsstring[] · min: 1Required

List of tenant article IDs

Responses

200

The request could be evaluated

application/json

CheckoutOptionsDeliveryEarliestResponse

calculationHintsstring[]Optional

Calculation hints for debugging

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post

/api/promises/checkoutoptions/collect/earliest

HTTPcURLJavaScriptPython

POST /api/promises/checkoutoptions/collect/earliest HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "desiredCollectDate": "2026-03-13T15:49:43.310Z",
  "facilities": [
    {
      "facilityRef": "text"
    }
  ],
  "includeCalculationHints": true,
  "tenantArticleIds": [
    "text"
  ]
}

{
  "calculationHints": [
    "text"
  ],
  "checkoutOptions": [
    {
      "availableCarriers": [
        {
          "carrierRef": "text",
          "latestPickingStartDate": "2026-03-13T15:49:43.310Z",
          "name": "text",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "availableFacilityConnections": [
        {
          "connectionRef": "text",
          "latestPickingStartDate": "2026-03-13T15:49:43.310Z",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "earliestPredictedDeliveryDate": "2026-03-13T15:49:43.310Z",
      "listingDetails": [
        {
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "facilityRef": "text",
          "tenantFacilityId": "text"
        }
      ],
      "tenantArticleId": "text"
    }
  ]
}

Get earliest delivery

post

Get earliest delivery timepoint for a given checkoutOption

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckoutOptionsDeliveryEarliestRequest

earliestDeliveryDatestring · date-timeOptional

Earliest delivery date

includeCalculationHintsbooleanOptional

Whether to include calculation hints in the response

includeListingDetailsbooleanOptional

Indicates whether listing-related details should be included in the response. If set to true, the response contains additional listing details. Defaults to false.

tenantArticleIdsstring[] · min: 1Required

List of tenant article IDs

Responses

200

The request could be evaluated

application/json

CheckoutOptionsDeliveryEarliestResponse

calculationHintsstring[]Optional

Calculation hints for debugging

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post

/api/promises/checkoutoptions/delivery/earliest

HTTPcURLJavaScriptPython

POST /api/promises/checkoutoptions/delivery/earliest HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 337

{
  "consumerAddress": {
    "addressType": "POSTAL_ADDRESS",
    "city": "text",
    "country": "DE",
    "houseNumber": "text",
    "postalCode": "text",
    "province": "text",
    "street": "text"
  },
  "earliestDeliveryDate": "2026-03-13T15:49:43.310Z",
  "filter": {
    "customAttributes": {},
    "tags": []
  },
  "includeCalculationHints": true,
  "includeListingDetails": true,
  "tenantArticleIds": [
    "text"
  ]
}

{
  "calculationHints": [
    "text"
  ],
  "checkoutOptions": [
    {
      "availableCarriers": [
        {
          "carrierRef": "text",
          "latestPickingStartDate": "2026-03-13T15:49:43.310Z",
          "name": "text",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "availableFacilityConnections": [
        {
          "connectionRef": "text",
          "latestPickingStartDate": "2026-03-13T15:49:43.310Z",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "earliestPredictedDeliveryDate": "2026-03-13T15:49:43.310Z",
      "listingDetails": [
        {
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "facilityRef": "text",
          "tenantFacilityId": "text"
        }
      ],
      "tenantArticleId": "text"
    }
  ]
}

Get delivery time period

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckoutOptionsDeliveryTimePeriodRequest

endDatestring · date-timeOptional

End date-time of the period

includeCalculationHintsbooleanOptional

Whether to include calculation hints in the response

startDatestring · date-timeOptional

Start date-time of the period

Responses

200

The request could be evaluated

application/json

CheckoutOptionsDeliveryTimePeriodResponse

calculationHintsstring[]Optional

Calculation hints

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post

/api/promises/checkoutoptions/delivery/timeperiod

HTTPcURLJavaScriptPython

POST /api/promises/checkoutoptions/delivery/timeperiod HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 543

{
  "basket": [
    {
      "quantity": 1,
      "tenantArticleId": "text"
    }
  ],
  "consumerAddress": {
    "addressType": "POSTAL_ADDRESS",
    "city": "text",
    "country": "DE",
    "houseNumber": "text",
    "postalCode": "text",
    "province": "text",
    "street": "text"
  },
  "deliveryPreferences": {
    "carrierProductCategory": "STANDARD",
    "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
    "preferredCarriers": [
      "text"
    ],
    "preferredCarriersWithProduct": [],
    "preselectedFacilities": [
      null
    ],
    "serviceLevel": "DELIVERY"
  },
  "endDate": "2026-03-13T15:49:43.310Z",
  "includeCalculationHints": true,
  "startDate": "2026-03-13T15:49:43.310Z"
}

{
  "calculationHints": [
    "text"
  ],
  "checkoutOptions": [
    {
      "availableCarriers": [
        {
          "carrierRef": "text",
          "latestPickingStartDate": "2026-03-13T15:49:43.310Z",
          "name": "text",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "availableFacilityConnections": [
        {
          "connectionRef": "text",
          "latestPickingStartDate": "2026-03-13T15:49:43.310Z",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "date": "2026-03-13T15:49:43.310Z",
      "overallStatus": "ALL"
    }
  ]
}

Get delivery timepoint

post

This endpoint is to be used to get information about the possible delivery of items.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckoutOptionsDeliveryTimePointRequest

desiredDeliveryDatestring · date-timeRequired

Desired delivery date-time

tenantArticleIdsstring[]Required

Tenant article IDs

Responses

200

The request could be evaluated

application/json

CheckoutOptionsDeliveryTimePointResponse

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post

/api/promises/checkoutoptions/delivery/timepoint

HTTPcURLJavaScriptPython

POST /api/promises/checkoutoptions/delivery/timepoint HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "desiredDeliveryDate": "2026-03-13T15:49:43.310Z",
  "facilities": [
    {
      "facilityRef": "text",
      "latestPickingStart": "2026-03-13T15:49:43.310Z"
    }
  ],
  "tenantArticleIds": [
    "text"
  ]
}

{
  "items": [
    {
      "available": 1,
      "facilityRef": "text",
      "latestPickingStart": "2026-03-13T15:49:43.310Z",
      "tenantArticleId": "text"
    }
  ]
}