Facility endpoints

Get facility

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to get. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Responses

200

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

application/json

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

Facility not found

application/json

get/api/facilities/{facilityId}

HTTPcURLJavaScriptPython

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

{
  "address": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": "America/Los_Angeles"
  },
  "configs": [
    {
      "ref": "text",
      "rel": "text"
    }
  ],
  "id": "Esb20gpHBL94X5NdMp3C",
  "operativeCosts": [
    {
      "currency": "EUR",
      "decimalPlaces": 2,
      "value": 25000
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "customAttributes": {},
  "name": "Hamburg NW2",
  "status": "ONLINE",
  "tenantFacilityId": "K12345",
  "type": "MANAGED_FACILITY",
  "tags": [],
  "capacityEnabled": false,
  "capacityPlanningTimeframe": 1,
  "closingDays": [
    {
      "date": "2020-02-03T09:45:51.525Z",
      "reason": "text",
      "recurrence": "YEARLY"
    }
  ],
  "contact": {
    "customAttributes": {},
    "firstName": "text",
    "lastName": "text",
    "roleDescription": "Manager, Supervisor, Teamleader, etc."
  },
  "fulfillmentProcessBuffer": "240",
  "locationType": "STORE",
  "pickingMethods": [
    "SINGLE_ORDER"
  ],
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "scanningRule": {
    "values": [
      {
        "priority": 1,
        "scanningRuleType": "ARTICLE"
      }
    ]
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ]
}

Create facility

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

or

Responses

201

The facility was successfully created. The Location header contains the URL of the facility.

application/json

or

400

Invalid input. See response for details

application/json

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

HTTPcURLJavaScriptPython

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

{
  "address": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": "America/Los_Angeles"
  },
  "capacityEnabled": false,
  "capacityPlanningTimeframe": 1,
  "closingDays": [
    {
      "date": "2020-02-03T09:45:51.525Z",
      "reason": "text",
      "recurrence": "YEARLY"
    }
  ],
  "contact": {
    "customAttributes": {},
    "firstName": "text",
    "lastName": "text",
    "roleDescription": "Manager, Supervisor, Teamleader, etc."
  },
  "fulfillmentProcessBuffer": "240",
  "locationType": "STORE",
  "pickingMethods": [
    "SINGLE_ORDER"
  ],
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "scanningRule": {
    "values": [
      {
        "priority": 1,
        "scanningRuleType": "ARTICLE"
      }
    ]
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ],
  "customAttributes": {},
  "name": "Hamburg NW2",
  "operativeCosts": [
    {
      "currency": "EUR",
      "decimalPlaces": 2,
      "value": 25000
    }
  ],
  "status": "ONLINE",
  "tenantFacilityId": "K12345",
  "type": "MANAGED_FACILITY",
  "tags": []
}

{
  "address": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": "America/Los_Angeles"
  },
  "configs": [
    {
      "ref": "text",
      "rel": "text"
    }
  ],
  "id": "Esb20gpHBL94X5NdMp3C",
  "operativeCosts": [
    {
      "currency": "EUR",
      "decimalPlaces": 2,
      "value": 25000
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "customAttributes": {},
  "name": "Hamburg NW2",
  "status": "ONLINE",
  "tenantFacilityId": "K12345",
  "type": "MANAGED_FACILITY",
  "tags": [],
  "capacityEnabled": false,
  "capacityPlanningTimeframe": 1,
  "closingDays": [
    {
      "date": "2020-02-03T09:45:51.525Z",
      "reason": "text",
      "recurrence": "YEARLY"
    }
  ],
  "contact": {
    "customAttributes": {},
    "firstName": "text",
    "lastName": "text",
    "roleDescription": "Manager, Supervisor, Teamleader, etc."
  },
  "fulfillmentProcessBuffer": "240",
  "locationType": "STORE",
  "pickingMethods": [
    "SINGLE_ORDER"
  ],
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "scanningRule": {
    "values": [
      {
        "priority": 1,
        "scanningRuleType": "ARTICLE"
      }
    ]
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ]
}

Update facility

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to patch. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Body

application/json

or

or

Responses

200

Facility was found & patch-set has been applied. The patched facility is in the body.

application/json

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

Facility not found

application/json

409

Facility version conflict

application/json

patch/api/facilities/{facilityId}

HTTPcURLJavaScriptPython

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

{
  "address": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": "America/Los_Angeles"
  },
  "configs": [
    {
      "ref": "text",
      "rel": "text"
    }
  ],
  "id": "Esb20gpHBL94X5NdMp3C",
  "operativeCosts": [
    {
      "currency": "EUR",
      "decimalPlaces": 2,
      "value": 25000
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "customAttributes": {},
  "name": "Hamburg NW2",
  "status": "ONLINE",
  "tenantFacilityId": "K12345",
  "type": "MANAGED_FACILITY",
  "tags": [],
  "capacityEnabled": false,
  "capacityPlanningTimeframe": 1,
  "closingDays": [
    {
      "date": "2020-02-03T09:45:51.525Z",
      "reason": "text",
      "recurrence": "YEARLY"
    }
  ],
  "contact": {
    "customAttributes": {},
    "firstName": "text",
    "lastName": "text",
    "roleDescription": "Manager, Supervisor, Teamleader, etc."
  },
  "fulfillmentProcessBuffer": "240",
  "locationType": "STORE",
  "pickingMethods": [
    "SINGLE_ORDER"
  ],
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "scanningRule": {
    "values": [
      {
        "priority": 1,
        "scanningRuleType": "ARTICLE"
      }
    ]
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ]
}

Update facility

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to replace. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Body

application/json

or

Responses

200

Facility was replaced. The replaced facility is in the body.

application/json

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

Facility not found

application/json

409

Facility version conflict

application/json

put/api/facilities/{facilityId}

HTTPcURLJavaScriptPython

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

{
  "address": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": "America/Los_Angeles"
  },
  "capacityEnabled": false,
  "capacityPlanningTimeframe": 1,
  "closingDays": [
    {
      "date": "2020-02-03T09:45:51.525Z",
      "reason": "text",
      "recurrence": "YEARLY"
    }
  ],
  "configs": [
    {
      "ref": "text",
      "rel": "text"
    }
  ],
  "contact": {
    "customAttributes": {},
    "firstName": "text",
    "lastName": "text",
    "roleDescription": "Manager, Supervisor, Teamleader, etc."
  },
  "customAttributes": {},
  "fulfillmentProcessBuffer": "240",
  "locationType": "STORE",
  "name": "Hamburg NW2",
  "pickingMethods": [
    "SINGLE_ORDER"
  ],
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "scanningRule": {
    "values": [
      {
        "priority": 1,
        "scanningRuleType": "ARTICLE"
      }
    ]
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ],
  "status": "ONLINE",
  "tenantFacilityId": "K12345",
  "type": "MANAGED_FACILITY",
  "version": 42,
  "tags": []
}

{
  "address": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": "America/Los_Angeles"
  },
  "configs": [
    {
      "ref": "text",
      "rel": "text"
    }
  ],
  "id": "Esb20gpHBL94X5NdMp3C",
  "operativeCosts": [
    {
      "currency": "EUR",
      "decimalPlaces": 2,
      "value": 25000
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "customAttributes": {},
  "name": "Hamburg NW2",
  "status": "ONLINE",
  "tenantFacilityId": "K12345",
  "type": "MANAGED_FACILITY",
  "tags": [],
  "capacityEnabled": false,
  "capacityPlanningTimeframe": 1,
  "closingDays": [
    {
      "date": "2020-02-03T09:45:51.525Z",
      "reason": "text",
      "recurrence": "YEARLY"
    }
  ],
  "contact": {
    "customAttributes": {},
    "firstName": "text",
    "lastName": "text",
    "roleDescription": "Manager, Supervisor, Teamleader, etc."
  },
  "fulfillmentProcessBuffer": "240",
  "locationType": "STORE",
  "pickingMethods": [
    "SINGLE_ORDER"
  ],
  "pickingTimes": {
    "friday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "sunday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "capacity": 1,
        "end": {
          "hour": 1,
          "minute": 1
        },
        "start": {
          "hour": 1,
          "minute": 1
        }
      }
    ]
  },
  "scanningRule": {
    "values": [
      {
        "priority": 1,
        "scanningRuleType": "ARTICLE"
      }
    ]
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ]
}

Delete facility

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to delete. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Query parameters

forceDeletionbooleanOptional

cascading deletion without pre condition check

Default: false

Responses

200

Facility was found & you were allowed to delete it.

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

Facility not found

application/json

delete/api/facilities/{facilityId}

HTTPcURLJavaScriptPython

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

No content

List facilities

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

statusstring[]Optional

Reference to the status you want to get the corresponding facilities

sizeintegerOptional

number of facilities to show

Default: 25

tenantFacilityIdstringOptional

query facilities with the given tenantFacilityId

orderBystring · enumOptional

Attribute to order a facility list

Possible values:

Responses

200

Facilities are found.

application/json

StrippedFacilities

totalintegerOptional

Total number of found entities 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

HTTPcURLJavaScriptPython

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

{
  "facilities": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr.",
      "id": "text",
      "name": "Köln store",
      "status": "ONLINE",
      "tenantFacilityId": "K12345",
      "type": "MANAGED_FACILITY"
    }
  ],
  "total": 42
}

List facilities (search)

post

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for Facility

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FacilitySearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

Example: 10

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

FacilityPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

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/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "address": {
      "city": "Yellowstone",
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "country": "US",
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": {
          "eq": true,
          "notEq": true
        }
      },
      "emailAddresses": "[e-mail]",
      "houseNumber": 42,
      "postalCode": "42420",
      "province": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "street": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "and": [
      {
        "address": {
          "city": "Yellowstone",
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "country": "US",
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "emailAddresses": "[e-mail]",
          "houseNumber": 42,
          "postalCode": "42420",
          "province": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "street": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "and": [
          {
            "address": {
              "city": "Yellowstone",
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": "US",
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "emailAddresses": "[e-mail]",
              "houseNumber": 42,
              "postalCode": "42420",
              "province": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "street": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "and": "[Circular Reference]",
            "contact": {
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "locationType": {
              "eq": "STORE",
              "in": [
                "STORE"
              ],
              "notEq": "STORE"
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "referenced": {
              "facilityCarrierConnection": {
                "carrierKey": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "services": {
              "contains": {
                "type": {
                  "eq": "SHIP_FROM_STORE",
                  "in": [
                    "SHIP_FROM_STORE"
                  ],
                  "notEq": "SHIP_FROM_STORE"
                }
              },
              "exists": true
            },
            "status": {
              "eq": "ONLINE",
              "in": [
                "ONLINE"
              ],
              "notEq": "ONLINE"
            },
            "tenantFacilityId": "MY_FACILITY_ID",
            "type": {
              "eq": "MANAGED_FACILITY",
              "in": [
                "MANAGED_FACILITY"
              ],
              "notEq": "MANAGED_FACILITY"
            },
            "tags": {
              "contains": {
                "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "exists": true
            }
          }
        ],
        "contact": {
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "locationType": {
          "eq": "STORE",
          "in": [
            "STORE"
          ],
          "notEq": "STORE"
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "address": {
              "city": "Yellowstone",
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": "US",
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "emailAddresses": "[e-mail]",
              "houseNumber": 42,
              "postalCode": "42420",
              "province": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "street": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "and": "[Circular Reference]",
            "contact": {
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "locationType": {
              "eq": "STORE",
              "in": [
                "STORE"
              ],
              "notEq": "STORE"
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "referenced": {
              "facilityCarrierConnection": {
                "carrierKey": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "services": {
              "contains": {
                "type": {
                  "eq": "SHIP_FROM_STORE",
                  "in": [
                    "SHIP_FROM_STORE"
                  ],
                  "notEq": "SHIP_FROM_STORE"
                }
              },
              "exists": true
            },
            "status": {
              "eq": "ONLINE",
              "in": [
                "ONLINE"
              ],
              "notEq": "ONLINE"
            },
            "tenantFacilityId": "MY_FACILITY_ID",
            "type": {
              "eq": "MANAGED_FACILITY",
              "in": [
                "MANAGED_FACILITY"
              ],
              "notEq": "MANAGED_FACILITY"
            },
            "tags": {
              "contains": {
                "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "exists": true
            }
          }
        ],
        "referenced": {
          "facilityCarrierConnection": {
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "services": {
          "contains": {
            "type": {
              "eq": "SHIP_FROM_STORE",
              "in": [
                "SHIP_FROM_STORE"
              ],
              "notEq": "SHIP_FROM_STORE"
            }
          },
          "exists": true
        },
        "status": {
          "eq": "ONLINE",
          "in": [
            "ONLINE"
          ],
          "notEq": "ONLINE"
        },
        "tenantFacilityId": "MY_FACILITY_ID",
        "type": {
          "eq": "MANAGED_FACILITY",
          "in": [
            "MANAGED_FACILITY"
          ],
          "notEq": "MANAGED_FACILITY"
        },
        "tags": {
          "contains": {
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "exists": true
        }
      }
    ],
    "contact": {
      "firstName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "lastName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "locationType": {
      "eq": "STORE",
      "in": [
        "STORE"
      ],
      "notEq": "STORE"
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "address": {
          "city": "Yellowstone",
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "country": "US",
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "emailAddresses": "[e-mail]",
          "houseNumber": 42,
          "postalCode": "42420",
          "province": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "street": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "and": "[Circular Reference]",
        "contact": {
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "locationType": {
          "eq": "STORE",
          "in": [
            "STORE"
          ],
          "notEq": "STORE"
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "referenced": {
          "facilityCarrierConnection": {
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "services": {
          "contains": {
            "type": {
              "eq": "SHIP_FROM_STORE",
              "in": [
                "SHIP_FROM_STORE"
              ],
              "notEq": "SHIP_FROM_STORE"
            }
          },
          "exists": true
        },
        "status": {
          "eq": "ONLINE",
          "in": [
            "ONLINE"
          ],
          "notEq": "ONLINE"
        },
        "tenantFacilityId": "MY_FACILITY_ID",
        "type": {
          "eq": "MANAGED_FACILITY",
          "in": [
            "MANAGED_FACILITY"
          ],
          "notEq": "MANAGED_FACILITY"
        },
        "tags": {
          "contains": {
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "exists": true
        }
      }
    ],
    "referenced": {
      "facilityCarrierConnection": {
        "carrierKey": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    },
    "services": {
      "contains": {
        "type": {
          "eq": "SHIP_FROM_STORE",
          "in": [
            "SHIP_FROM_STORE"
          ],
          "notEq": "SHIP_FROM_STORE"
        }
      },
      "exists": true
    },
    "status": {
      "eq": "ONLINE",
      "in": [
        "ONLINE"
      ],
      "notEq": "ONLINE"
    },
    "tenantFacilityId": "MY_FACILITY_ID",
    "type": {
      "eq": "MANAGED_FACILITY",
      "in": [
        "MANAGED_FACILITY"
      ],
      "notEq": "MANAGED_FACILITY"
    },
    "tags": {
      "contains": {
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "value": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "exists": true
    }
  },
  "size": 10,
  "sort": [
    {
      "address": {
        "city": "ASC",
        "country": "ASC",
        "postalCode": "ASC"
      },
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "ASC",
      "lastModified": "ASC",
      "locationType": "ASC",
      "name": "ASC",
      "services": {
        "type": "ASC"
      },
      "status": "ASC",
      "tenantFacilityId": "ASC",
      "type": "ASC"
    }
  ]
}

{
  "facilities": [
    {
      "address": {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr.",
        "companyName": "Speedy Boxales Ltd.",
        "emailAddresses": [
          {
            "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
            "value": "text"
          }
        ],
        "resolvedCoordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "resolvedTimeZone": "America/Los_Angeles"
      },
      "configs": [
        {
          "ref": "text",
          "rel": "text"
        }
      ],
      "id": "Esb20gpHBL94X5NdMp3C",
      "operativeCosts": [
        {
          "currency": "EUR",
          "decimalPlaces": 2,
          "value": 25000
        }
      ],
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "customAttributes": {},
      "name": "Hamburg NW2",
      "status": "ONLINE",
      "tenantFacilityId": "K12345",
      "type": "MANAGED_FACILITY",
      "tags": [],
      "capacityEnabled": false,
      "capacityPlanningTimeframe": 1,
      "closingDays": [
        {
          "date": "2020-02-03T09:45:51.525Z",
          "reason": "text",
          "recurrence": "YEARLY"
        }
      ],
      "contact": {
        "customAttributes": {},
        "firstName": "text",
        "lastName": "text",
        "roleDescription": "Manager, Supervisor, Teamleader, etc."
      },
      "fulfillmentProcessBuffer": "240",
      "locationType": "STORE",
      "pickingMethods": [
        "SINGLE_ORDER"
      ],
      "pickingTimes": {
        "friday": [
          {
            "capacity": 1,
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            }
          }
        ],
        "monday": [
          {
            "capacity": 1,
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            }
          }
        ],
        "saturday": [
          {
            "capacity": 1,
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            }
          }
        ],
        "sunday": [
          {
            "capacity": 1,
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            }
          }
        ],
        "thursday": [
          {
            "capacity": 1,
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            }
          }
        ],
        "tuesday": [
          {
            "capacity": 1,
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            }
          }
        ],
        "wednesday": [
          {
            "capacity": 1,
            "end": {
              "hour": 1,
              "minute": 1
            },
            "start": {
              "hour": 1,
              "minute": 1
            }
          }
        ]
      },
      "scanningRule": {
        "values": [
          {
            "priority": 1,
            "scanningRuleType": "ARTICLE"
          }
        ]
      },
      "services": [
        {
          "type": "SHIP_FROM_STORE"
        }
      ]
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}