Sourcing Options (DOMS)

Endpoints for processing the routing decision logs.

Create sourcing option

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

returnMockResponsebooleanOptional

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

respond with mock

Body

application/json

SourcingOptionsRequest

Responses

201

Sourcing Option successfully created

application/jsonapplication/xml

400

Validation exception

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/routing/sourcingoptions

HTTPcURLJavaScriptPython

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

{
  "additionalInfo": {
    "includeListingCustomAttributes": false
  },
  "optimizationHints": {
    "includeCalculationHints": false,
    "requestedResultCount": 3
  },
  "order": {
    "consumer": {
      "addresses": [],
      "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
      "customAttributes": {},
      "facilityRef": "text",
      "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": []
  },
  "resourceInvestment": {
    "level": 0.2
  }
}

{
  "id": "284f32cc-b106-487d-b633-f90d93d8c251",
  "result": {
    "options": [
      {
        "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"
      }
    ]
  }
}

Get sourcing option

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sourcingOptionsRequestIdstringRequired

Id of the sourcing option request

Query parameters

returnMockResponsebooleanOptional

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

respond with mock

Responses

200

Sourcing Options successfully created

application/jsonapplication/xml

SourcingOptionsResponse

idstringRequired

Id referring optimizations runId

Example: 284f32cc-b106-487d-b633-f90d93d8c251

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/routing/sourcingoptions/{sourcingOptionsRequestId}

HTTPcURLJavaScriptPython

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

{
  "id": "284f32cc-b106-487d-b633-f90d93d8c251",
  "result": {
    "options": [
      {
        "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"
      }
    ]
  }
}