Facility connection

If you would like to use these functionalities, contact our Support team for more information.

Facility connections specify for each facility which other facilities within the network can be supplied and whether the consumer can be directly supplied. 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 to 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_REFERENCE

  • Define whether this connection can only be used in case the request/order has a defined tag.

Contexts define which connections can be used by which request. A connection without context can be used by all requests (in routing).

The operator NOT allows users to exclude certain cases (for example, facility groups) from a connection.

Carrier reference/key

This property defines which carrier represents the connection. In case carriers are connected to fulfillmenttools, the corresponding carrierKey can be referenced 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.

Example

DHL picks up parcels at the store in New York on Monday-Friday at 17:00, Saturday at 15:00 and not at all on Sundays. Although January 1st is a Thursday, no pickup will be on this specific date since it is a holiday.

In the context of external suppliers the time point of the actual handover to the carrier is usually not known. However, the cutoff times should still be set in order to enable a correct delivery time calculation. In this case, the cutoff time can be interpreted as the latest point in time until an order needs to placed to guarantee a delivery within the defined transit days.

Example

• Transit time for the facility connection "Supplier 1 to Store New York" is 1 day.

• Cut-off time for this facility connection is Monday-Friday 16:00.

  • If the order is placed on Tuesday 14:00, the items will arrive in New York on Wednesday.

  • If the order is placed on Tuesday 17:00, the items will arrive in New York on Thursday.

Non-delivery days

Non-delivery days are days where 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 (day after pickup until delivery day). There are differences depending on the carrier. While carrier X only delivers from Mondays till Fridays, 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

The packaging units define the different parcel/pallet sizes that are available for a specific facility connection.

Example

When shipping items from "Store New York" to the end customer via DHL, parcel sizes S, M, 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_COUNTRY

  • Prices and transit times might differ depending on where the parcel is shipped. Parcel sizes might differ between domestic and international destinations.

• CATEGORY

  • Define a specific category for which this packaging unit can be used.

  • For example, there might be special parcels for items of category "dangerous goods".

See the transport calculation cost logic article for more information on packaging units.

Cases

1. A managed facility can supply another managed facility within the network (interfacility transfer)

1. A managed facility can supply the consumer directly

1. A supplier can supply the consumer directly

1. A supplier can supply all managed facilities within the network

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

1. A supplier can supply a facility group within the network

Example: Supplier XY can supply the consumer directly, all facilities that are part of the facility group USA, and the facility store Berlin.

Create facility connection

post

Create a connections for a supplier facility with given ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to create a connection for

Body

application/json

or

or

Responses

200

Creation was successful.

application/json

InterFacilityConnection

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

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

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

carrierKeystringOptional

The key of the carrier that is used for this connection. References known and configured carriers in the system.

Example: DHL_V2

carrierNamestringOptional

The name of the carrier that is used for this connection.

Example: DHL

idstringRequired

sourceFacilityRefstringRequired

targetone ofRequired

or

or

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/facilities/{facilityId}/connections

HTTPcURLJavaScriptPython

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: 1595

{
  "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
  },
  "nonDeliveryDays": [
    {
      "country": "text",
      "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"
      ]
    }
  ],
  "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
        }
      ]
    }
  ],
  "target": {
    "excludedFacilityGroupRefs": [
      "text"
    ],
    "excludedFacilityRefs": [
      "text"
    ],
    "facilityRef": "text",
    "type": "SUPPLIER"
  },
  "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
  },
  "id": "text",
  "nonDeliveryDays": [
    {
      "country": "text",
      "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"
      ]
    }
  ],
  "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
        }
      ]
    }
  ],
  "sourceFacilityRef": "text",
  "target": {
    "type": "SUPPLIER"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}