Facility connection endpoints

Create facility connection

post

Create a connections for a supplier facility with given ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to create a connection for

Body

application/json

or

or

Responses

200

Creation was successful.

application/json

InterFacilityConnection

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

carrierKeystringOptional

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

Example: DHL_V2

carrierNamestringOptional

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

Example: DHL

idstringRequired

sourceFacilityRefstringRequired

targetone ofRequired

or

or

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/facilities/{facilityId}/connections

HTTPcURLJavaScriptPython

POST /api/facilities/{facilityId}/connections HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1595

{
  "carrierKey": "DHL_V2",
  "carrierName": "DHL",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "fallbackCosts": [
    {
      "currency": "AED",
      "decimalPlaces": 2,
      "deliveryCostCoefficient": {
        "measurementUnit": "GRAM",
        "value": 1.5
      },
      "value": 25000
    }
  ],
  "fallbackTransitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  },
  "nonDeliveryDays": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "packagingUnitsByContexts": [
    {
      "context": [
        {
          "operator": "NOT",
          "type": "TARGET_POSTALCODE",
          "values": [
            "text"
          ]
        }
      ],
      "packagingUnits": [
        {
          "dimensions": {
            "height": 50,
            "length": 100,
            "maxWeightInGram": 1000,
            "width": 50
          },
          "maxItemQuantity": 10,
          "name": "Parcel XXL",
          "packagingUnitRef": "text",
          "prices": [
            {
              "currency": "AED",
              "decimalPlaces": 2,
              "deliveryCostCoefficient": {
                "measurementUnit": "GRAM",
                "value": 1.5
              },
              "value": 25000
            }
          ],
          "priority": 1,
          "tenantPackagingUnitId": "Parcel XXL",
          "transitTime": {
            "maxTransitDays": 3,
            "minTransitDays": 1
          },
          "volumeBufferInPercent": 10
        }
      ]
    }
  ],
  "target": {
    "excludedFacilityGroupRefs": [
      "text"
    ],
    "excludedFacilityRefs": [
      "text"
    ],
    "facilityRef": "text",
    "type": "SUPPLIER"
  },
  "type": "SUPPLIER"
}

{
  "carrierKey": "DHL_V2",
  "carrierName": "DHL",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "fallbackCosts": [
    {
      "currency": "AED",
      "decimalPlaces": 2,
      "deliveryCostCoefficient": {
        "measurementUnit": "GRAM",
        "value": 1.5
      },
      "value": 25000
    }
  ],
  "fallbackTransitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  },
  "id": "text",
  "nonDeliveryDays": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "packagingUnitsByContexts": [
    {
      "context": [
        {
          "operator": "NOT",
          "type": "TARGET_POSTALCODE",
          "values": [
            "text"
          ]
        }
      ],
      "packagingUnits": [
        {
          "dimensions": {
            "height": 50,
            "length": 100,
            "maxWeightInGram": 1000,
            "width": 50
          },
          "maxItemQuantity": 10,
          "name": "Parcel XXL",
          "packagingUnitRef": "text",
          "prices": [
            {
              "currency": "AED",
              "decimalPlaces": 2,
              "deliveryCostCoefficient": {
                "measurementUnit": "GRAM",
                "value": 1.5
              },
              "value": 25000
            }
          ],
          "priority": 1,
          "tenantPackagingUnitId": "Parcel XXL",
          "transitTime": {
            "maxTransitDays": 3,
            "minTransitDays": 1
          },
          "volumeBufferInPercent": 10
        }
      ]
    }
  ],
  "sourceFacilityRef": "text",
  "target": {
    "type": "SUPPLIER"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List facility connections

get

Get the details for all connections related to the facility with the given ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to get connections

Query parameters

targetFacilityRefstringOptional

The targetFacilityRef of the connection

startAfterIdstringOptional

all entities

sizeintegerOptional

number of entities to show

Default: 25

localestringOptional

Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.

Responses

200

Facility connections was found & you were allowed to access it. The result is in the body.

application/json

InterFacilityConnections

totalintegerRequired

Total number of entities found for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get

/api/facilities/{facilityId}/connections

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityId}/connections HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "interFacilityConnections": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Get facility connection

get

Get the details for a facility connection related to the facility with the given ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to get connections

connectionIdstringRequired

The ID that describes the connection of this facility to the its connections

Query parameters

localestringOptional

Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.

Responses

200

Facility connections was found & you were allowed to access it. The result is in the body.

application/json

InterFacilityConnection

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

carrierKeystringOptional

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

Example: DHL_V2

carrierNamestringOptional

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

Example: DHL

idstringRequired

sourceFacilityRefstringRequired

targetone ofRequired

or

or

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

There is no connection for this facility referenced by the provided connectionId

application/json

get

/api/facilities/{facilityId}/connections/{connectionId}

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityId}/connections/{connectionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "carrierKey": "DHL_V2",
  "carrierName": "DHL",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "fallbackCosts": [
    {
      "currency": "AED",
      "decimalPlaces": 2,
      "deliveryCostCoefficient": {
        "measurementUnit": "GRAM",
        "value": 1.5
      },
      "value": 25000
    }
  ],
  "fallbackTransitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  },
  "id": "text",
  "nonDeliveryDays": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "packagingUnitsByContexts": [
    {
      "context": [
        {
          "operator": "NOT",
          "type": "TARGET_POSTALCODE",
          "values": [
            "text"
          ]
        }
      ],
      "packagingUnits": [
        {
          "dimensions": {
            "height": 50,
            "length": 100,
            "maxWeightInGram": 1000,
            "width": 50
          },
          "maxItemQuantity": 10,
          "name": "Parcel XXL",
          "packagingUnitRef": "text",
          "prices": [
            {
              "currency": "AED",
              "decimalPlaces": 2,
              "deliveryCostCoefficient": {
                "measurementUnit": "GRAM",
                "value": 1.5
              },
              "value": 25000
            }
          ],
          "priority": 1,
          "tenantPackagingUnitId": "Parcel XXL",
          "transitTime": {
            "maxTransitDays": 3,
            "minTransitDays": 1
          },
          "volumeBufferInPercent": 10
        }
      ]
    }
  ],
  "sourceFacilityRef": "text",
  "target": {
    "type": "SUPPLIER"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update facility connection

put

Update the given connection for a facility

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to get

connectionIdstringRequired

The referenced connection ID

Query parameters

localestringOptional

Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.

Body

application/json

or

or

Responses

200

Modification was successful.

application/json

InterFacilityConnection

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

carrierKeystringOptional

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

Example: DHL_V2

carrierNamestringOptional

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

Example: DHL

idstringRequired

sourceFacilityRefstringRequired

targetone ofRequired

or

or

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

There is no connection with this facility referenced by the provided cnnectionId.

application/json

put

/api/facilities/{facilityId}/connections/{connectionId}

HTTPcURLJavaScriptPython

PUT /api/facilities/{facilityId}/connections/{connectionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1607

{
  "carrierKey": "DHL_V2",
  "carrierName": "DHL",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "fallbackCosts": [
    {
      "currency": "AED",
      "decimalPlaces": 2,
      "deliveryCostCoefficient": {
        "measurementUnit": "GRAM",
        "value": 1.5
      },
      "value": 25000
    }
  ],
  "fallbackTransitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  },
  "nonDeliveryDays": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "packagingUnitsByContexts": [
    {
      "context": [
        {
          "operator": "NOT",
          "type": "TARGET_POSTALCODE",
          "values": [
            "text"
          ]
        }
      ],
      "packagingUnits": [
        {
          "dimensions": {
            "height": 50,
            "length": 100,
            "maxWeightInGram": 1000,
            "width": 50
          },
          "maxItemQuantity": 10,
          "name": "Parcel XXL",
          "packagingUnitRef": "text",
          "prices": [
            {
              "currency": "AED",
              "decimalPlaces": 2,
              "deliveryCostCoefficient": {
                "measurementUnit": "GRAM",
                "value": 1.5
              },
              "value": 25000
            }
          ],
          "priority": 1,
          "tenantPackagingUnitId": "Parcel XXL",
          "transitTime": {
            "maxTransitDays": 3,
            "minTransitDays": 1
          },
          "volumeBufferInPercent": 10
        }
      ]
    }
  ],
  "target": {
    "excludedFacilityGroupRefs": [
      "text"
    ],
    "excludedFacilityRefs": [
      "text"
    ],
    "facilityRef": "text",
    "type": "SUPPLIER"
  },
  "type": "SUPPLIER",
  "version": 1
}

{
  "carrierKey": "DHL_V2",
  "carrierName": "DHL",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "fallbackCosts": [
    {
      "currency": "AED",
      "decimalPlaces": 2,
      "deliveryCostCoefficient": {
        "measurementUnit": "GRAM",
        "value": 1.5
      },
      "value": 25000
    }
  ],
  "fallbackTransitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  },
  "id": "text",
  "nonDeliveryDays": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "packagingUnitsByContexts": [
    {
      "context": [
        {
          "operator": "NOT",
          "type": "TARGET_POSTALCODE",
          "values": [
            "text"
          ]
        }
      ],
      "packagingUnits": [
        {
          "dimensions": {
            "height": 50,
            "length": 100,
            "maxWeightInGram": 1000,
            "width": 50
          },
          "maxItemQuantity": 10,
          "name": "Parcel XXL",
          "packagingUnitRef": "text",
          "prices": [
            {
              "currency": "AED",
              "decimalPlaces": 2,
              "deliveryCostCoefficient": {
                "measurementUnit": "GRAM",
                "value": 1.5
              },
              "value": 25000
            }
          ],
          "priority": 1,
          "tenantPackagingUnitId": "Parcel XXL",
          "transitTime": {
            "maxTransitDays": 3,
            "minTransitDays": 1
          },
          "volumeBufferInPercent": 10
        }
      ]
    }
  ],
  "sourceFacilityRef": "text",
  "target": {
    "type": "SUPPLIER"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete facility connection

delete

Delete the connection for facility with the given ID

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to delete a connection

connectionIdstringRequired

The ID of the connection you want to delete

Responses

200

Deletion was successful

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

There is no connection for the facility and the provided id

application/json

delete

/api/facilities/{facilityId}/connections/{connectionId}

HTTPcURLJavaScriptPython

DELETE /api/facilities/{facilityId}/connections/{connectionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content