Delivery promise

The endpoint supports in the last step of the checkout journey. It can be requested when the customer has already decided on what to buy and is about to make the purchase. At this time point of time the method of delivery (e.g., the click and collect facility or the address of the consumer), the items in the cart, the delivery preferences as well as the consumer address are known. Since all relevant information is known, an order routing can be performed already and a preliminary reservation can be made.

More API information can be found here: REST API documentation – delivery promise

Request and response

When sending a promise order, a routing decision is performed with the respective DOMS configurations and the respective stock is reserved. The response gives information on where fulfillment can be performed, when the fulfillment can be expected to be completed and when the delivery can be completed.

If the consumer decides to buy, the promised order becomes a "normal" order for fulfillment. If the consumer decides against the purchase, the stock reservation is dissolved after a configurable timeframe.

Create promise order

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PromiseRequest

customAttributesobjectOptional

Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

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

statusstring · enumOptional

The state of the order. Initially it is OPEN.

Possible values:

tenantOrderIdstringOptional

Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.

Example: R456728546

Responses

201

The order promise was created URL of the order promse.

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

post

/api/promises/deliverypromise

HTTPcURLJavaScriptPython

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

{
  "additionalInfo": {
    "includeListingCustomAttributes": false
  },
  "consumer": {
    "addresses": [
      {
        "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."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "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]"
          ]
        }
      ]
    }
  ],
  "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"
  },
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "shopPrice": 1200,
      "tags": []
    }
  ],
  "paymentInfo": {
    "methodLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "currency": "EUR"
  },
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "status": "OPEN",
  "statusReasons": [],
  "stickers": [],
  "tenantOrderId": "R456728546",
  "tags": []
}

{
  "backOrdered": {
    "lineItems": [
      {
        "availabilityTimeframe": {
          "start": "2020-02-03T08:45:50.525Z"
        },
        "available": 1,
        "outOfStockBehaviour": "NONE",
        "quantity": 1,
        "tenantArticleId": "text",
        "title": "text"
      }
    ]
  },
  "collect": {
    "targetTime": "2026-03-02T16:38:15.867Z",
    "facility": {
      "facilityName": "text",
      "facilityRef": "text",
      "tenantFacilityId": "text"
    },
    "lineItems": [
      {
        "availabilityTimeframe": {
          "start": "2020-02-03T08:45:50.525Z"
        },
        "available": 1,
        "outOfStockBehaviour": "NONE",
        "quantity": 1,
        "tenantArticleId": "text",
        "title": "text"
      }
    ]
  },
  "orderRef": "text",
  "orderVersion": 1,
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "shipToCustomer": [
    {
      "facility": {
        "facilityName": "text",
        "facilityRef": "text",
        "tenantFacilityId": "text"
      },
      "lineItems": [
        {
          "availabilityTimeframe": {
            "start": "2020-02-03T08:45:50.525Z"
          },
          "available": 1,
          "outOfStockBehaviour": "NONE",
          "quantity": 1,
          "tenantArticleId": "text",
          "title": "text"
        }
      ]
    }
  ],
  "shipToStore": [
    {
      "facility": {
        "facilityName": "text",
        "facilityRef": "text",
        "tenantFacilityId": "text"
      },
      "lineItems": [
        {
          "availabilityTimeframe": {
            "start": "2020-02-03T08:45:50.525Z"
          },
          "available": 1,
          "outOfStockBehaviour": "NONE",
          "quantity": 1,
          "tenantArticleId": "text",
          "title": "text"
        }
      ]
    }
  ],
  "sourcingOption": {
    "estimatedDeliveryDate": "2025-02-05T00:00:00.000Z",
    "id": "text",
    "listingDetails": [],
    "nodes": [
      {
        "facilityRef": "DE-FAC-4711",
        "id": "f439e7b6-119e-47cc-a263-05a31baea0de",
        "isPickUpLocation": true,
        "lineItems": [
          {
            "quantity": 1,
            "tenantArticleId": "text"
          }
        ],
        "tenantFacilityId": "DE-FAC-4711",
        "type": "SUPPLIER"
      }
    ],
    "nonAssignedOrderLineItems": [
      {
        "quantity": 1,
        "tenantArticleId": "text"
      }
    ],
    "ratingResults": [],
    "runId": "text",
    "totalCosts": {
      "salesPrices": [
        {
          "amount": 1,
          "discount": [
            {
              "type": "RELATIVE",
              "value": 7.1
            }
          ],
          "salesPricePerUnitWithDiscountAmount": {
            "currency": "AED",
            "decimalPlaces": 1,
            "value": 1
          },
          "salesPricePerUnitWithoutDiscountAmount": {
            "currency": "AED",
            "decimalPlaces": 1,
            "value": 1
          },
          "sourceFacilityRef": "DE-FAC-4711",
          "sourceTenantFacilityId": "facility-east",
          "tenantArticleId": "DE-ZGT-4711"
        }
      ],
      "totalCosts": {
        "currency": "AED",
        "decimalPlaces": 1,
        "value": 1
      },
      "totalSalesPriceAmount": {
        "currency": "AED",
        "decimalPlaces": 1,
        "value": 1
      },
      "totalShippingCosts": {
        "packageCosts": [
          {
            "costAmount": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            },
            "packageName": "Small Box"
          }
        ],
        "totalTransportCostAmount": {
          "currency": "AED",
          "decimalPlaces": 1,
          "value": 1
        }
      }
    },
    "totalPenalty": 187,
    "transfers": [
      {
        "carrier": {
          "carrierKey": "text",
          "carrierName": "text"
        },
        "facilityConnectionRef": "f439e7b6-119e-47cc-a263-05a31baea0de",
        "lineItems": [
          {
            "quantity": 1,
            "tenantArticleId": "text"
          }
        ],
        "packagingInformation": [
          {
            "packagingUnit": {
              "dimensions": {
                "height": 1,
                "length": 1,
                "maxWeightInGram": 1,
                "width": 1
              },
              "maxItemQuantity": 10,
              "name": "Small Box",
              "prices": [
                {
                  "currency": "AED",
                  "decimalPlaces": 1,
                  "value": 1
                }
              ],
              "priority": 1,
              "transitTime": {
                "maxTransitDays": 1,
                "minTransitDays": 1
              },
              "volumeBufferInPercent": 10
            },
            "packedItems": [
              {
                "quantity": 1,
                "tenantArticleId": "text"
              }
            ],
            "totalCosts": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ],
        "sourceNodeRef": "f439e7b6-119e-47cc-a263-05a31baea0de",
        "targetNodeRef": "ad6c5038-15ee-41b8-a180-4c86290d04c3",
        "timeLine": {
          "calculationStartPoint": "2020-02-03T08:45:50.525Z",
          "earliestPickingStart": "2020-02-03T08:45:50.525Z",
          "earliestPossibleDeliveryTime": "2020-02-03T00:00:00.000Z",
          "latestPickingStart": "2020-02-03T08:45:50.525Z",
          "targetTime": "2020-02-03T08:45:50.525Z",
          "usedTransitTimeInDays": 3
        }
      }
    ],
    "validUntil": "text"
  }
}