> For the complete documentation index, see [llms.txt](https://docs.fulfillmenttools.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/complex-routing-with-combinatorics/network-model/facility-connection/facility-connection-endpoints.md).
# Facility connection endpoints
## The InterFacilityConnection object
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnection":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"id":{"type":"string"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"sourceFacilityRef":{"type":"string"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array","description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
"},"target":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionCustomerTarget","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget","SUPPLIER":"#/components/schemas/InterFacilityConnectionSupplierTarget"}}},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"}},"required":["id","sourceFacilityRef","target"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnection","description":"InterFacilityConnection"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightBasis":{"$ref":"#/components/schemas/InterFacilityConnectionWeightBasis"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"factor":{"description":"Charges price once per this many units of pricingUnit started, rounded up, instead of as a flat price for the tier. Use 1 to bill exactly. Omit it to charge price flat.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionWeightBasis":{"description":"The article weight the aggregated weight of the transfer is calculated from: WEIGHT (weightPerUnit) or BILLABLE_WEIGHT (billableWeightPerUnit). Defaults to WEIGHT.","enum":["WEIGHT","BILLABLE_WEIGHT"],"title":"InterFacilityConnectionWeightBasis","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionSurchargeCalculationScope":{"additionalProperties":false,"description":"The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.","properties":{"mode":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeMode"},"references":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["mode","references"],"title":"InterFacilityConnectionSurchargeCalculationScope","type":"object"},"InterFacilityConnectionSurchargeScopeMode":{"description":"Whether a scope names the charges a percentage is calculated on, or the ones it is not calculated on.","enum":["INCLUDE","EXCLUDE"],"title":"InterFacilityConnectionSurchargeScopeMode","type":"string"},"InterFacilityConnectionSurchargeScopeReference":{"additionalProperties":false,"description":"One entry of a calculation scope.","properties":{"kind":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReferenceKind"},"level":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeLevel"}],"description":"Restricts the reference to the charges made on one pricing level. If omitted, charges of both levels are selected, so a tenantSurchargeType configured on both matches both."},"tenantSurchargeType":{"description":"The referenced tenant surcharge type. Only read for TENANT_SURCHARGE references.","type":"string"}},"required":["kind"],"title":"InterFacilityConnectionSurchargeScopeReference","type":"object"},"InterFacilityConnectionSurchargeScopeReferenceKind":{"description":"What a scope reference selects. BASE_PRICE is the resolved base price of the transfer, TENANT_SURCHARGE every charge made under the reference's tenantSurchargeType, PACKAGING_UNITS everything the packaging units of the transfer charged, and GOODS_VALUE the order's goods value that ships with the transfer. PACKAGING_UNITS and GOODS_VALUE are only available on the transfer level.","enum":["BASE_PRICE","TENANT_SURCHARGE","PACKAGING_UNITS","GOODS_VALUE"],"title":"InterFacilityConnectionSurchargeScopeReferenceKind","type":"string"},"InterFacilityConnectionSurchargeScopeLevel":{"description":"The pricing level that made a charge. PACKAGING_UNIT is what the packaging units of the transfer charged, TRANSFER what the transfer itself charged.","enum":["PACKAGING_UNIT","TRANSFER"],"title":"InterFacilityConnectionSurchargeScopeLevel","type":"string"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```
## Create facility connection
> Create a connections for a supplier facility with given ID.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InterFacilityConnectionToSupplierForCreation":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["target","type"],"type":"object","xml":{"name":"InterFacilityConnectionToSupplierForCreation"},"title":"InterFacilityConnectionToSupplierForCreation","description":"InterFacilityConnectionToSupplierForCreation"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightBasis":{"$ref":"#/components/schemas/InterFacilityConnectionWeightBasis"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"factor":{"description":"Charges price once per this many units of pricingUnit started, rounded up, instead of as a flat price for the tier. Use 1 to bill exactly. Omit it to charge price flat.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionWeightBasis":{"description":"The article weight the aggregated weight of the transfer is calculated from: WEIGHT (weightPerUnit) or BILLABLE_WEIGHT (billableWeightPerUnit). Defaults to WEIGHT.","enum":["WEIGHT","BILLABLE_WEIGHT"],"title":"InterFacilityConnectionWeightBasis","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionSurchargeCalculationScope":{"additionalProperties":false,"description":"The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.","properties":{"mode":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeMode"},"references":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["mode","references"],"title":"InterFacilityConnectionSurchargeCalculationScope","type":"object"},"InterFacilityConnectionSurchargeScopeMode":{"description":"Whether a scope names the charges a percentage is calculated on, or the ones it is not calculated on.","enum":["INCLUDE","EXCLUDE"],"title":"InterFacilityConnectionSurchargeScopeMode","type":"string"},"InterFacilityConnectionSurchargeScopeReference":{"additionalProperties":false,"description":"One entry of a calculation scope.","properties":{"kind":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReferenceKind"},"level":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeLevel"}],"description":"Restricts the reference to the charges made on one pricing level. If omitted, charges of both levels are selected, so a tenantSurchargeType configured on both matches both."},"tenantSurchargeType":{"description":"The referenced tenant surcharge type. Only read for TENANT_SURCHARGE references.","type":"string"}},"required":["kind"],"title":"InterFacilityConnectionSurchargeScopeReference","type":"object"},"InterFacilityConnectionSurchargeScopeReferenceKind":{"description":"What a scope reference selects. BASE_PRICE is the resolved base price of the transfer, TENANT_SURCHARGE every charge made under the reference's tenantSurchargeType, PACKAGING_UNITS everything the packaging units of the transfer charged, and GOODS_VALUE the order's goods value that ships with the transfer. PACKAGING_UNITS and GOODS_VALUE are only available on the transfer level.","enum":["BASE_PRICE","TENANT_SURCHARGE","PACKAGING_UNITS","GOODS_VALUE"],"title":"InterFacilityConnectionSurchargeScopeReferenceKind","type":"string"},"InterFacilityConnectionSurchargeScopeLevel":{"description":"The pricing level that made a charge. PACKAGING_UNIT is what the packaging units of the transfer charged, TRANSFER what the transfer itself charged.","enum":["PACKAGING_UNIT","TRANSFER"],"title":"InterFacilityConnectionSurchargeScopeLevel","type":"string"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"},"InterFacilityConnectionToManagedFacilityForCreation":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["target","type"],"type":"object","xml":{"name":"InterFacilityConnectionToManagedFacilityForCreation"},"title":"InterFacilityConnectionToManagedFacilityForCreation","description":"InterFacilityConnectionToManagedFacilityForCreation"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionToCustomerForCreation":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["target","type"],"type":"object","xml":{"name":"InterFacilityConnectionToCustomerForCreation"},"title":"InterFacilityConnectionToCustomerForCreation","description":"InterFacilityConnectionToCustomerForCreation"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnection":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"id":{"type":"string"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"sourceFacilityRef":{"type":"string"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array","description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
"},"target":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionCustomerTarget","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget","SUPPLIER":"#/components/schemas/InterFacilityConnectionSupplierTarget"}}},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"}},"required":["id","sourceFacilityRef","target"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnection","description":"InterFacilityConnection"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/connections":{"post":{"description":"Create a connections for a supplier facility with given ID.","operationId":"createConnectionToFacility","parameters":[{"description":"ID of facility you want to create a connection for","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionToSupplierForCreation"},{"$ref":"#/components/schemas/InterFacilityConnectionToManagedFacilityForCreation"},{"$ref":"#/components/schemas/InterFacilityConnectionToCustomerForCreation"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionToCustomerForCreation","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionToManagedFacilityForCreation","SUPPLIER":"#/components/schemas/InterFacilityConnectionToSupplierForCreation"}}}}},"description":"Representation that the connection","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterFacilityConnection"}}},"description":"Creation was successful."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create facility connection","tags":["Facilities"]}}}}
```
## List facility connections
> Get the details for all connections related to the facility with the given ID.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InterFacilityConnections":{"additionalProperties":false,"properties":{"interFacilityConnections":{"items":{"$ref":"#/components/schemas/InterFacilityConnection"},"type":"array"},"total":{"description":"Total number of entities found for this query","type":"integer"}},"required":["interFacilityConnections","total"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnections","description":"InterFacilityConnections"},"InterFacilityConnection":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"id":{"type":"string"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"sourceFacilityRef":{"type":"string"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array","description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
"},"target":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionCustomerTarget","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget","SUPPLIER":"#/components/schemas/InterFacilityConnectionSupplierTarget"}}},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"}},"required":["id","sourceFacilityRef","target"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnection","description":"InterFacilityConnection"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightBasis":{"$ref":"#/components/schemas/InterFacilityConnectionWeightBasis"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"factor":{"description":"Charges price once per this many units of pricingUnit started, rounded up, instead of as a flat price for the tier. Use 1 to bill exactly. Omit it to charge price flat.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionWeightBasis":{"description":"The article weight the aggregated weight of the transfer is calculated from: WEIGHT (weightPerUnit) or BILLABLE_WEIGHT (billableWeightPerUnit). Defaults to WEIGHT.","enum":["WEIGHT","BILLABLE_WEIGHT"],"title":"InterFacilityConnectionWeightBasis","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionSurchargeCalculationScope":{"additionalProperties":false,"description":"The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.","properties":{"mode":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeMode"},"references":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["mode","references"],"title":"InterFacilityConnectionSurchargeCalculationScope","type":"object"},"InterFacilityConnectionSurchargeScopeMode":{"description":"Whether a scope names the charges a percentage is calculated on, or the ones it is not calculated on.","enum":["INCLUDE","EXCLUDE"],"title":"InterFacilityConnectionSurchargeScopeMode","type":"string"},"InterFacilityConnectionSurchargeScopeReference":{"additionalProperties":false,"description":"One entry of a calculation scope.","properties":{"kind":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReferenceKind"},"level":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeLevel"}],"description":"Restricts the reference to the charges made on one pricing level. If omitted, charges of both levels are selected, so a tenantSurchargeType configured on both matches both."},"tenantSurchargeType":{"description":"The referenced tenant surcharge type. Only read for TENANT_SURCHARGE references.","type":"string"}},"required":["kind"],"title":"InterFacilityConnectionSurchargeScopeReference","type":"object"},"InterFacilityConnectionSurchargeScopeReferenceKind":{"description":"What a scope reference selects. BASE_PRICE is the resolved base price of the transfer, TENANT_SURCHARGE every charge made under the reference's tenantSurchargeType, PACKAGING_UNITS everything the packaging units of the transfer charged, and GOODS_VALUE the order's goods value that ships with the transfer. PACKAGING_UNITS and GOODS_VALUE are only available on the transfer level.","enum":["BASE_PRICE","TENANT_SURCHARGE","PACKAGING_UNITS","GOODS_VALUE"],"title":"InterFacilityConnectionSurchargeScopeReferenceKind","type":"string"},"InterFacilityConnectionSurchargeScopeLevel":{"description":"The pricing level that made a charge. PACKAGING_UNIT is what the packaging units of the transfer charged, TRANSFER what the transfer itself charged.","enum":["PACKAGING_UNIT","TRANSFER"],"title":"InterFacilityConnectionSurchargeScopeLevel","type":"string"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/connections":{"get":{"description":"Get the details for all connections related to the facility with the given ID.","operationId":"getFacilityConnections","parameters":[{"description":"ID of facility you want to get connections","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"The targetFacilityRef of the connection","in":"query","name":"targetFacilityRef","required":false,"schema":{"type":"string"}},{"description":"all entities","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterFacilityConnections"}}},"description":"Facility connections was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List facility connections","tags":["Facilities"]}}}}
```
## Get facility connection
> Get the details for a facility connection related to the facility with the given ID.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InterFacilityConnection":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"id":{"type":"string"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"sourceFacilityRef":{"type":"string"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array","description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
"},"target":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionCustomerTarget","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget","SUPPLIER":"#/components/schemas/InterFacilityConnectionSupplierTarget"}}},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"}},"required":["id","sourceFacilityRef","target"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnection","description":"InterFacilityConnection"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightBasis":{"$ref":"#/components/schemas/InterFacilityConnectionWeightBasis"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"factor":{"description":"Charges price once per this many units of pricingUnit started, rounded up, instead of as a flat price for the tier. Use 1 to bill exactly. Omit it to charge price flat.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionWeightBasis":{"description":"The article weight the aggregated weight of the transfer is calculated from: WEIGHT (weightPerUnit) or BILLABLE_WEIGHT (billableWeightPerUnit). Defaults to WEIGHT.","enum":["WEIGHT","BILLABLE_WEIGHT"],"title":"InterFacilityConnectionWeightBasis","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionSurchargeCalculationScope":{"additionalProperties":false,"description":"The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.","properties":{"mode":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeMode"},"references":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["mode","references"],"title":"InterFacilityConnectionSurchargeCalculationScope","type":"object"},"InterFacilityConnectionSurchargeScopeMode":{"description":"Whether a scope names the charges a percentage is calculated on, or the ones it is not calculated on.","enum":["INCLUDE","EXCLUDE"],"title":"InterFacilityConnectionSurchargeScopeMode","type":"string"},"InterFacilityConnectionSurchargeScopeReference":{"additionalProperties":false,"description":"One entry of a calculation scope.","properties":{"kind":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReferenceKind"},"level":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeLevel"}],"description":"Restricts the reference to the charges made on one pricing level. If omitted, charges of both levels are selected, so a tenantSurchargeType configured on both matches both."},"tenantSurchargeType":{"description":"The referenced tenant surcharge type. Only read for TENANT_SURCHARGE references.","type":"string"}},"required":["kind"],"title":"InterFacilityConnectionSurchargeScopeReference","type":"object"},"InterFacilityConnectionSurchargeScopeReferenceKind":{"description":"What a scope reference selects. BASE_PRICE is the resolved base price of the transfer, TENANT_SURCHARGE every charge made under the reference's tenantSurchargeType, PACKAGING_UNITS everything the packaging units of the transfer charged, and GOODS_VALUE the order's goods value that ships with the transfer. PACKAGING_UNITS and GOODS_VALUE are only available on the transfer level.","enum":["BASE_PRICE","TENANT_SURCHARGE","PACKAGING_UNITS","GOODS_VALUE"],"title":"InterFacilityConnectionSurchargeScopeReferenceKind","type":"string"},"InterFacilityConnectionSurchargeScopeLevel":{"description":"The pricing level that made a charge. PACKAGING_UNIT is what the packaging units of the transfer charged, TRANSFER what the transfer itself charged.","enum":["PACKAGING_UNIT","TRANSFER"],"title":"InterFacilityConnectionSurchargeScopeLevel","type":"string"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/connections/{connectionId}":{"get":{"description":"Get the details for a facility connection related to the facility with the given ID.","operationId":"getFacilityConnection","parameters":[{"description":"ID of facility you want to get connections","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"The ID that describes the connection of this facility to the its connections","in":"path","name":"connectionId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterFacilityConnection"}}},"description":"Facility connections was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"There is no connection for this facility referenced by the provided connectionId"}},"summary":"Get facility connection","tags":["Facilities"]}}}}
```
## Update facility connection
> Update the given connection for a facility
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InterFacilityConnectionToSupplierForUpdate":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"},"version":{"type":"number"}},"required":["target","version","type"],"type":"object","xml":{"name":"InterFacilityConnectionToSupplierForUpdate"},"title":"InterFacilityConnectionToSupplierForUpdate","description":"InterFacilityConnectionToSupplierForUpdate"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightBasis":{"$ref":"#/components/schemas/InterFacilityConnectionWeightBasis"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"factor":{"description":"Charges price once per this many units of pricingUnit started, rounded up, instead of as a flat price for the tier. Use 1 to bill exactly. Omit it to charge price flat.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionWeightBasis":{"description":"The article weight the aggregated weight of the transfer is calculated from: WEIGHT (weightPerUnit) or BILLABLE_WEIGHT (billableWeightPerUnit). Defaults to WEIGHT.","enum":["WEIGHT","BILLABLE_WEIGHT"],"title":"InterFacilityConnectionWeightBasis","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionSurchargeCalculationScope":{"additionalProperties":false,"description":"The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.","properties":{"mode":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeMode"},"references":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["mode","references"],"title":"InterFacilityConnectionSurchargeCalculationScope","type":"object"},"InterFacilityConnectionSurchargeScopeMode":{"description":"Whether a scope names the charges a percentage is calculated on, or the ones it is not calculated on.","enum":["INCLUDE","EXCLUDE"],"title":"InterFacilityConnectionSurchargeScopeMode","type":"string"},"InterFacilityConnectionSurchargeScopeReference":{"additionalProperties":false,"description":"One entry of a calculation scope.","properties":{"kind":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeReferenceKind"},"level":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeScopeLevel"}],"description":"Restricts the reference to the charges made on one pricing level. If omitted, charges of both levels are selected, so a tenantSurchargeType configured on both matches both."},"tenantSurchargeType":{"description":"The referenced tenant surcharge type. Only read for TENANT_SURCHARGE references.","type":"string"}},"required":["kind"],"title":"InterFacilityConnectionSurchargeScopeReference","type":"object"},"InterFacilityConnectionSurchargeScopeReferenceKind":{"description":"What a scope reference selects. BASE_PRICE is the resolved base price of the transfer, TENANT_SURCHARGE every charge made under the reference's tenantSurchargeType, PACKAGING_UNITS everything the packaging units of the transfer charged, and GOODS_VALUE the order's goods value that ships with the transfer. PACKAGING_UNITS and GOODS_VALUE are only available on the transfer level.","enum":["BASE_PRICE","TENANT_SURCHARGE","PACKAGING_UNITS","GOODS_VALUE"],"title":"InterFacilityConnectionSurchargeScopeReferenceKind","type":"string"},"InterFacilityConnectionSurchargeScopeLevel":{"description":"The pricing level that made a charge. PACKAGING_UNIT is what the packaging units of the transfer charged, TRANSFER what the transfer itself charged.","enum":["PACKAGING_UNIT","TRANSFER"],"title":"InterFacilityConnectionSurchargeScopeLevel","type":"string"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"calculationScope":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeCalculationScope"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"priority":{"description":"Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.","minimum":0,"type":"integer"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"},"InterFacilityConnectionToManagedFacilityForUpdate":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"},"version":{"type":"number"}},"required":["target","version","type"],"type":"object","xml":{"name":"InterFacilityConnectionToManagedFacilityForUpdate"},"title":"InterFacilityConnectionToManagedFacilityForUpdate","description":"InterFacilityConnectionToManagedFacilityForUpdate"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionToCustomerForUpdate":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"},"version":{"type":"number"}},"required":["target","version","type"],"type":"object","xml":{"name":"InterFacilityConnectionToCustomerForUpdate"},"title":"InterFacilityConnectionToCustomerForUpdate","description":"InterFacilityConnectionToCustomerForUpdate"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnection":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"id":{"type":"string"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"sourceFacilityRef":{"type":"string"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array","description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
"},"target":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionCustomerTarget","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget","SUPPLIER":"#/components/schemas/InterFacilityConnectionSupplierTarget"}}},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"}},"required":["id","sourceFacilityRef","target"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnection","description":"InterFacilityConnection"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/connections/{connectionId}":{"put":{"description":"Update the given connection for a facility","operationId":"updateFacilityConnection","parameters":[{"description":"ID of facility you want to get","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"The referenced connection ID","in":"path","name":"connectionId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionToSupplierForUpdate"},{"$ref":"#/components/schemas/InterFacilityConnectionToManagedFacilityForUpdate"},{"$ref":"#/components/schemas/InterFacilityConnectionToCustomerForUpdate"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionToCustomerForUpdate","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionToManagedFacilityForUpdate","SUPPLIER":"#/components/schemas/InterFacilityConnectionToSupplierForUpdate"}}}}},"description":"Representation that describes the facility","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterFacilityConnection"}}},"description":"Modification was successful."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"There is no connection with this facility referenced by the provided cnnectionId."}},"summary":"Update facility connection","tags":["Facilities"]}}}}
```
## Delete facility connection
> Delete the connection for facility with the given ID
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/connections/{connectionId}":{"delete":{"description":"Delete the connection for facility with the given ID","operationId":"deleteFacilityConnection","parameters":[{"description":"ID of facility you want to delete a connection","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"The ID of the connection you want to delete","in":"path","name":"connectionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deletion was successful"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"There is no connection for the facility and the provided id"}},"summary":"Delete facility connection","tags":["Facilities"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/complex-routing-with-combinatorics/network-model/facility-connection/facility-connection-endpoints.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.