Facility connection
For each facility, you can define a facility connection that specifies which other facilities in the network it can supply, and whether it can supply a consumer directly. Details for each facility connection can include the carrier used for transportation, available packaging units (and their dimensions), transport times, and associated costs. Fallback times and costs are considered if no specific packaging units are defined.
Target
The target object allows restricting the connection's destination. For example, a connection can be defined for only one specific managed facility or to all managed facilities except for explicitly defined exceptions.
Type
The type of the facility connection defines which receiver category a facility can supply to. This can be either SUPPLIER, MANAGED_FACILITY, or CUSTOMER (consumer).
Context
The context defines specifications for a facility connection depending on the selected context type:
FACILITY:Define the exact facility ID(s) to which the supplying facility is connected, or exclude specific facilities.
FACILITY_GROUP:Define the facility groups to which the supplying facility is connected, or exclude specific facility groups.
CATEGORY:Define a specific category for which this facility connection can be used.
Example: The facility connection can only be used for shipping items in the dangerous goods category.
TAG_REFERENCEDefine whether this connection can only be used in case the request/order has a defined tag.
TARGET_POSTALCODEDefine the postal code(s) of the final recipient for which this connection can be used, or exclude specific postal codes.
Example: A connection that must not be used for island postal codes.
TARGET_COUNTRYDefine the country or countries of the final recipient for which this connection can be used, or exclude specific countries.
TARGET_POSTALCODE and TARGET_COUNTRY refer to the address of the final recipient, which can be a consumer or an ordering facility. The same two context types are also available one level deeper within packagingUnitsByContexts and on surcharges, where they scope packaging units and surcharges rather than the connection as a whole.
Carrier key
The carrier key (or reference) defines which carrier represents the connection. If carriers are connected to fulfillmenttools, you can reference the corresponding carrierKey here as well.
Fallback costs and times
If no shipping cost or transit time information for packaging units is defined for a connection, the fallback costs and/or times will be taken into account for a cost and time calculation during routing.
In case there are packaging unit specific prices and transit times defined, the fallback costs and times will be taken into account in case none of the available packaging units can be used for the requested items.
Cutoff times
The cutoff time defines the time point when parcels are usually picked up at a location. This time point can vary depending on the weekday as well as on public holidays.
For example, DHL picks up parcels at the store in New York at 17:00 Monday-Friday, 15:00 on Saturday, and not at all on Sundays. Although 1 January falls on a Thursday, no pickup will be available on this date because it's a holiday.
You can set cutoff times in Backoffice or via API.
Backoffice
In the Network view, go to Facilities and select the relevant facility. Then, select Carrier from the menu. Click the more icon and select Edit cutoff times.

This will open the modal where you can set cutoff times and capacity levels.

API
In the facility connection endpoint, you can add the cutoff times and capacity.
For external suppliers, the actual handover time to the carrier is usually unknown. However, the cutoff times should still be set to enable a correct delivery time calculation. In this case, the cutoff time is the latest time an order must be placed to guarantee delivery within the defined transit days.
For example:
Transit time for the facility connection "Supplier 1 to Store New York" is 1 day.
Cutoff time for this facility connection is Monday-Friday 16:00.
If the order is placed at 14:00 on Tuesday, the items will arrive in New York on Wednesday.
If the order is placed at 17:00 on Tuesday, the items will arrive in New York on Thursday.
Non-delivery days
Non-delivery days are days when carriers don't operate. To store this information in fulfillmenttools, it's possible to set up non-delivery-days in the respective carrier configurations. The stored information is then taken into account when calculating delivery times and possible delivery days.
Non-delivery days can be either specific calendar dates (1 January) or a day of the week (Sunday). While days are always recurring (recurringNonDeliveryWeekdays), a specific calendar date can be set up as RECURRING or SINGLE by using the nonDeliveryType.
Non-delivery days refer to the transit days (from the day after pickup to the delivery day). There are differences depending on the carrier. While carrier X delivers only Monday to Friday, carrier Y also operates on Saturdays. In addition, deliveries are usually not made on public holidays. Public holidays again vary from country to country and province to province.
Packaging units
Packaging units define the parcel or pallet sizes available for a specific facility connection.
For example, when shipping items from "Store New York" to the consumer via DHL, parcel sizes S, M, and L can be used.
By using the context within packagingUnitsByContexts, different packaging units with different prices and transit times can be defined depending on the following factors:
TARGET_POSTALCODE/TARGET_COUNTRYPrices and transit times might differ depending on where the parcel is shipped. Parcel sizes might differ between domestic and international destinations.
CATEGORYDefine a specific category for which this packaging unit can be used.
For example, there might be special parcels for items in the "dangerous goods" category.
See the transport calculation cost logic article for more information on packaging units.
Shipment-based pricing
By default, the base price of a transfer is resolved per packaging unit. Some carriers price a shipment as a whole: the items are packed first, and the aggregated weight or volumetric weight of all packaging units then determines a single base price for the entire transfer.
For these tariffs, a price matrix can be configured on the connection itself in pricingPerTransfer. It's structured like the packaging unit price matrix: prices by zone, price rows by upper threshold, and an overflow factor.
The base price is resolved once per transfer, against the aggregated quantity of all packaging units of that transfer.
If
pricingPerTransferis configured, the prices configured on the packaging units of that transfer are ignored. The two aren't added up.Transfers whose connection has no
pricingPerTransfercontinue to resolve prices per packaging unit.Surcharges are unaffected by where the base price comes from. Surcharges configured on the packaging unit and on the connection are both applied, each at its own level.
pricingPerTransfer carries its own pricingBasis, weightBasis, volumetricWeightFactor, maxVolumetricWeight, and volumeBufferInPercent, which apply to the aggregated shipment. For how these values determine the chargeable quantity, see the Transport cost calculation logic article.
For example, one transfer contains three packaging units of 4.2 kg, 6.8 kg, and 3.1 kg. The connection price matrix resolves 14.1 kg against zone IT-20 and yields one base price of €24.40 for the transfer. Per-packaging-unit surcharges still apply three times, transfer surcharges apply once.
Surcharges per transfer
Surcharges that a carrier charges once per shipment rather than per package, for example, a cash on delivery fee or a fuel surcharge on the whole shipment, are configured in surchargesPerTransfer on the connection.
Absolute, relative, and threshold surcharges are supported, each with the same structure as on packaging unit level. They are applied once per transfer, after the packaging units of the transfer have been summed up. A relative surcharge on transfer level can be calculated against amounts charged on packaging unit level.
See the Transport cost calculation logic article for the surcharge types, their application order, and the calculation scope.
Shipment restrictions
Shipment restrictions define what a connection can physically handle. A connection that can't handle a shipment can be excluded from the routing decision through the successful packing fence.
Restrictions that apply to the shipment as a whole are configured in generalShipmentRestrictions. Each entry consists of a restrictionType and a value:
MAX_WEIGHT_PER_SHIPMENT
Maximum total weight of all packaging units of the shipment
MAX_LOADING_METERS_PER_SHIPMENT
Maximum loading meters the shipment may occupy
MAX_PACKAGING_UNITS_PER_SHIPMENT
Maximum number of packaging units in the shipment
MIN_PACKAGING_UNITS_PER_SHIPMENT
Minimum number of packaging units required for the connection to be used
MAX_WEIGHT_PER_LOADING_METER
Maximum weight per loading meter
Restrictions that apply to one packaging unit type are configured in packageTypeSpecificShipmentRestrictions. Each entry consists of a restrictionType of MAX_PACKAGING_UNITS_PER_TYPE, the packagingUnitType it applies to, and a value. Optionally, packagingUnitRefs narrows the restriction to specific packaging units of that type.
A connection without shipment restrictions is unrestricted.
Transport details
The transportDetails object holds properties of the vehicle used on the connection. vehicleWidthInMeters defines the loading width and is used to convert the floor space of the packed shipment into loading meters, which the MAX_LOADING_METERS_PER_SHIPMENT and MAX_WEIGHT_PER_LOADING_METER restrictions and loading-meter-based pricing are evaluated against.
Cases
A managed facility can supply another managed facility within the network (interfacility transfer)

A managed facility can supply the consumer directly

A supplier can supply the consumer directly (dropshipping)

A supplier can supply all managed facilities within the network

A supplier can supply all managed facilities within the network except a specific facility group or facility

A supplier can supply a facility group within the network

Example: Supplier XY can supply the consumer directly, all facilities in the USA facility group, and the Berlin store.

Create a connections for a supplier facility with given ID.
ID of facility you want to create a connection for
Creation was successful.
InterFacilityConnection
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42The key of the carrier that is used for this connection. References known and configured carriers in the system.
DHL_V2The name of the carrier that is used for this connection.
DHLYour user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
POST /api/facilities/{facilityId}/connections HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2699
{
"carrierKey": "DHL_V2",
"carrierName": "DHL",
"context": [
{
"operator": "NOT",
"type": "FACILITY",
"values": [
"text"
]
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"cutoffTimes": {
"overwrites": [
{
"cutoffConfigurations": [
{
"capacity": 1,
"time": "12:00"
}
],
"date": "2020-02-03T00:00:00.000Z"
}
],
"weekdays": [
{
"cutoffConfigurations": [
{
"capacity": 1,
"time": "12:00"
}
],
"day": "MONDAY"
}
]
},
"fallbackCosts": [
{
"currency": "AED",
"decimalPlaces": 2,
"deliveryCostCoefficient": {
"measurementUnit": "GRAM",
"value": 1.5
},
"value": 25000
}
],
"fallbackTransitTime": {
"maxTransitDays": 3,
"minTransitDays": 1
},
"generalShipmentRestrictions": [
{
"restrictionType": "MAX_WEIGHT_PER_SHIPMENT",
"value": 1
}
],
"nonDeliveryDays": [
{
"country": "US",
"nonDeliveryDays": [
{
"nonDeliveryDay": "2020-02-03T00:00:00.000Z",
"nonDeliveryType": "SINGLE"
}
],
"nonDeliveryDaysPerProvince": [
{
"nonDeliveryDays": [
{
"nonDeliveryDay": "2020-02-03T00:00:00.000Z",
"nonDeliveryType": "SINGLE"
}
],
"province": "text",
"recurringNonDeliveryWeekdays": [
"MONDAY"
]
}
],
"recurringNonDeliveryWeekdays": [
"MONDAY"
]
}
],
"packageTypeSpecificShipmentRestrictions": [
{
"packagingUnitRefs": [
"text"
],
"packagingUnitType": "PALLET",
"restrictionType": "MAX_PACKAGING_UNITS_PER_TYPE",
"value": 1
}
],
"packagingUnitsByContexts": [
{
"context": [
{
"operator": "NOT",
"type": "TARGET_POSTALCODE",
"values": [
"text"
]
}
],
"packagingUnits": [
{
"dimensions": {
"height": 50,
"length": 100,
"maxWeightInGram": 1000,
"width": 50
},
"maxItemQuantity": 10,
"name": "Parcel XXL",
"packagingUnitRef": "text",
"prices": [
{
"currency": "AED",
"decimalPlaces": 2,
"deliveryCostCoefficient": {
"measurementUnit": "GRAM",
"value": 1.5
},
"value": 25000
}
],
"priority": 1,
"tenantPackagingUnitId": "Parcel XXL",
"transitTime": {
"maxTransitDays": 3,
"minTransitDays": 1
},
"volumeBufferInPercent": 10
}
]
}
],
"pricingPerTransfer": {
"costCoefficient": {
"measurementUnit": "GRAM",
"value": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
}
},
"ldmToWeightFactor": 1850,
"maxVolumetricWeight": 30000,
"pricing": [
{
"overflowFactor": {
"factor": 1.5,
"price": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
}
},
"prices": [
{
"factor": 100000,
"price": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
},
"upperThreshold": 15000
}
],
"zone": "IT-20"
}
],
"pricingBasis": {
"pricingQuantities": [
"ACTUAL_WEIGHT"
],
"pricingUnit": "GRAM"
},
"volumeBufferInPercent": 10,
"volumetricWeightFactor": 0.2,
"weightBasis": "WEIGHT",
"weightToVolumeFactor": 0.005
},
"surchargesPerTransfer": [
{
"amount": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
},
"context": [
{
"operator": "NOT",
"type": "CATEGORY",
"values": [
"text"
]
}
],
"priority": 1,
"tenantSurchargeType": "text",
"type": "ABSOLUTE_SURCHARGE_TYPE"
}
],
"target": {
"excludedFacilityGroupRefs": [
"text"
],
"excludedFacilityRefs": [
"text"
],
"facilityRef": "text",
"type": "SUPPLIER"
},
"transportDetails": {
"vehicleWidthInMeters": 1
},
"type": "SUPPLIER"
}{
"carrierKey": "DHL_V2",
"carrierName": "DHL",
"context": [
{
"operator": "NOT",
"type": "FACILITY",
"values": [
"text"
]
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"cutoffTimes": {
"overwrites": [
{
"cutoffConfigurations": [
{
"capacity": 1,
"time": "12:00"
}
],
"date": "2020-02-03T00:00:00.000Z"
}
],
"weekdays": [
{
"cutoffConfigurations": [
{
"capacity": 1,
"time": "12:00"
}
],
"day": "MONDAY"
}
]
},
"fallbackCosts": [
{
"currency": "AED",
"decimalPlaces": 2,
"deliveryCostCoefficient": {
"measurementUnit": "GRAM",
"value": 1.5
},
"value": 25000
}
],
"fallbackTransitTime": {
"maxTransitDays": 3,
"minTransitDays": 1
},
"generalShipmentRestrictions": [
{
"restrictionType": "MAX_WEIGHT_PER_SHIPMENT",
"value": 1
}
],
"id": "text",
"nonDeliveryDays": [
{
"country": "US",
"nonDeliveryDays": [
{
"nonDeliveryDay": "2020-02-03T00:00:00.000Z",
"nonDeliveryType": "SINGLE"
}
],
"nonDeliveryDaysPerProvince": [
{
"nonDeliveryDays": [
{
"nonDeliveryDay": "2020-02-03T00:00:00.000Z",
"nonDeliveryType": "SINGLE"
}
],
"province": "text",
"recurringNonDeliveryWeekdays": [
"MONDAY"
]
}
],
"recurringNonDeliveryWeekdays": [
"MONDAY"
]
}
],
"packageTypeSpecificShipmentRestrictions": [
{
"packagingUnitRefs": [
"text"
],
"packagingUnitType": "PALLET",
"restrictionType": "MAX_PACKAGING_UNITS_PER_TYPE",
"value": 1
}
],
"packagingUnitsByContexts": [
{
"context": [
{
"operator": "NOT",
"type": "TARGET_POSTALCODE",
"values": [
"text"
]
}
],
"packagingUnits": [
{
"dimensions": {
"height": 50,
"length": 100,
"maxWeightInGram": 1000,
"width": 50
},
"maxItemQuantity": 10,
"name": "Parcel XXL",
"packagingUnitRef": "text",
"prices": [
{
"currency": "AED",
"decimalPlaces": 2,
"deliveryCostCoefficient": {
"measurementUnit": "GRAM",
"value": 1.5
},
"value": 25000
}
],
"priority": 1,
"tenantPackagingUnitId": "Parcel XXL",
"transitTime": {
"maxTransitDays": 3,
"minTransitDays": 1
},
"volumeBufferInPercent": 10
}
]
}
],
"pricingPerTransfer": {
"costCoefficient": {
"measurementUnit": "GRAM",
"value": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
}
},
"ldmToWeightFactor": 1850,
"maxVolumetricWeight": 30000,
"pricing": [
{
"overflowFactor": {
"factor": 1.5,
"price": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
}
},
"prices": [
{
"factor": 100000,
"price": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
},
"upperThreshold": 15000
}
],
"zone": "IT-20"
}
],
"pricingBasis": {
"pricingQuantities": [
"ACTUAL_WEIGHT"
],
"pricingUnit": "GRAM"
},
"volumeBufferInPercent": 10,
"volumetricWeightFactor": 0.2,
"weightBasis": "WEIGHT",
"weightToVolumeFactor": 0.005
},
"sourceFacilityRef": "text",
"surchargesPerTransfer": [
{
"amount": {
"currency": "AED",
"decimalPlaces": 2,
"value": 1
},
"context": [
{
"operator": "NOT",
"type": "CATEGORY",
"values": [
"text"
]
}
],
"priority": 1,
"tenantSurchargeType": "text",
"type": "ABSOLUTE_SURCHARGE_TYPE"
}
],
"target": {
"type": "SUPPLIER"
},
"transportDetails": {
"vehicleWidthInMeters": 1
},
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42
}Last updated
Was this helpful?

