Facilities (Core)

Facilities represent various locations that form part of the fulfillment network.

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
}

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

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

{
  "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": []
  },
  "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": []
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ]
}

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": []
  },
  "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: 1763

{
  "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": []
  },
  "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": []
  },
  "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

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": []
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ]
}

Call facility action

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

Reference to the facility you want to call the action for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Body

application/json

FacilityActionsParameter

or

Responses

200

Updated Facility in the body.

application/json

ManagedFacility

and

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}/actions

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "version": 1
}

{
  "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": []
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ]
}

List facility carrier connections

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. List all carrier connections configured for the given facility

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

Responses

200

Listing returned successfully.

application/json

totalnumberRequired

Total number of carrier connections

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

application/json

get

/api/facilities/{facilityId}/carriers

HTTPcURLJavaScriptPython

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

{
  "carriers": [
    {
      "deliveryType": "text",
      "id": "text",
      "key": "text",
      "name": "text",
      "status": "text",
      "version": 1
    }
  ],
  "total": 1
}

Get facility carrier connection

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Get the details for a carrier related to the facility with the given ID

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

carrierRefstringRequired

Responses

200

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

application/json

FacilityCarrierConnection

carrierRefstringRequired

Reference to the carrier

createdstring · date-timeRequired

Creation timestamp

deliveryTypestring · enumOptional

Type of delivery service

Possible values:

facilityRefstringRequired

Reference to the facility

idstringRequired

Unique identifier for the facility carrier connection

keystringRequired

Configuration key for the carrier connection

lastModifiedstring · date-timeRequired

Last modification timestamp

namestringOptional

Human-readable name for the connection

statusstring · enumRequired

Status of the carrier connection

Possible values:

versionnumberRequired

Version number for optimistic locking

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

application/json

404

The requested entity was not found

application/json

get

/api/facilities/{facilityId}/carriers/{carrierRef}

HTTPcURLJavaScriptPython

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

{
  "carrierRef": "text",
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created": "2026-03-13T16:24:42.691Z",
  "credentials": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTime": {
    "hour": 16,
    "minute": 30
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "deliveryAreas": [
    {
      "country": "DE",
      "postalCode": "40764"
    }
  ],
  "deliveryType": "SAMEDAY",
  "facilityRef": "text",
  "id": "text",
  "key": "text",
  "lastModified": "2026-03-13T16:24:42.691Z",
  "name": "text",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "status": "ACTIVE",
  "validDeliveryTargets": [
    "SHIP_TO_STORE"
  ],
  "version": 1,
  "tags": []
}

Create facility carrier connection

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Create a connection of a configured carrier to the facility with given ID

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

carrierRefstringRequired

Body

application/json

FacilityCarrierConnectionForCreation

namestringOptional

Human-readable name for the connection

statusstring · enumOptional

Status of the carrier connection

Possible values:

Responses

201

Creation was successful.

application/json

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

application/json

404

The requested entity was not found

application/json

post

/api/facilities/{facilityId}/carriers/{carrierRef}

HTTPcURLJavaScriptPython

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

{
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTime": {
    "hour": 16,
    "minute": 30
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "deliveryAreas": [
    {
      "country": "DE",
      "postalCode": "40764"
    }
  ],
  "name": "text",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "status": "ACTIVE",
  "validDeliveryTargets": [
    "SHIP_TO_STORE"
  ],
  "tags": []
}

{
  "carrierRef": "text",
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created": "2026-03-13T16:24:42.691Z",
  "credentials": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTime": {
    "hour": 16,
    "minute": 30
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "deliveryAreas": [
    {
      "country": "DE",
      "postalCode": "40764"
    }
  ],
  "deliveryType": "SAMEDAY",
  "facilityRef": "text",
  "id": "text",
  "key": "text",
  "lastModified": "2026-03-13T16:24:42.691Z",
  "name": "text",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "status": "ACTIVE",
  "validDeliveryTargets": [
    "SHIP_TO_STORE"
  ],
  "version": 1,
  "tags": []
}

Update facility carrier connection

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Connect a configured carrier to the facility with given ID

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

carrierRefstringRequired

Body

application/json

FacilityCarrierConnectionForModification

namestringOptional

Human-readable name for the connection

statusstring · enumOptional

Status of the carrier connection

Possible values:

versionnumberRequired

Version number for optimistic locking

Responses

200

Modification was successful.

application/json

FacilityCarrierConnection

carrierRefstringRequired

Reference to the carrier

createdstring · date-timeRequired

Creation timestamp

deliveryTypestring · enumOptional

Type of delivery service

Possible values:

facilityRefstringRequired

Reference to the facility

idstringRequired

Unique identifier for the facility carrier connection

keystringRequired

Configuration key for the carrier connection

lastModifiedstring · date-timeRequired

Last modification timestamp

namestringOptional

Human-readable name for the connection

statusstring · enumRequired

Status of the carrier connection

Possible values:

versionnumberRequired

Version number for optimistic locking

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

application/json

404

The requested entity was not found

application/json

put

/api/facilities/{facilityId}/carriers/{carrierRef}

HTTPcURLJavaScriptPython

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

{
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTime": {
    "hour": 16,
    "minute": 30
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "deliveryAreas": [
    {
      "country": "DE",
      "postalCode": "40764"
    }
  ],
  "name": "text",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "status": "ACTIVE",
  "validDeliveryTargets": [
    "SHIP_TO_STORE"
  ],
  "version": 1,
  "tags": []
}

{
  "carrierRef": "text",
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created": "2026-03-13T16:24:42.691Z",
  "credentials": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cutoffTime": {
    "hour": 16,
    "minute": 30
  },
  "cutoffTimes": {
    "overwrites": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "date": "2020-02-03T00:00:00.000Z"
      }
    ],
    "weekdays": [
      {
        "cutoffConfigurations": [
          {
            "capacity": 1,
            "time": "12:00"
          }
        ],
        "day": "MONDAY"
      }
    ]
  },
  "deliveryAreas": [
    {
      "country": "DE",
      "postalCode": "40764"
    }
  ],
  "deliveryType": "SAMEDAY",
  "facilityRef": "text",
  "id": "text",
  "key": "text",
  "lastModified": "2026-03-13T16:24:42.691Z",
  "name": "text",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "status": "ACTIVE",
  "validDeliveryTargets": [
    "SHIP_TO_STORE"
  ],
  "version": 1,
  "tags": []
}

Calculate best carriers

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Calculate prioritized list of recommended carriers for the given facility and input parameters

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

Body

application/json

CarrierPriorityCalculationRequest

Responses

200

Calculated carrier prioritization result.

application/json

CarrierPriorityResult

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

application/json

post

/api/facilities/{facilityId}/carriers/prioritization

HTTPcURLJavaScriptPython

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

{
  "productValue": {
    "currency": "EUR",
    "decimalPlaces": 2,
    "value": 25000
  }
}

{
  "otherCarriers": [
    {
      "carrier": {
        "credentials": {
          "key": "text"
        },
        "defaultParcelHeightInCm": 10,
        "defaultParcelLengthInCm": 25,
        "defaultParcelWeightInGram": 1000,
        "defaultParcelWidthInCm": 35,
        "key": "DHL_V2",
        "logoUrl": "text",
        "name": "DHL Köln",
        "parcelLabelClassifications": [
          {
            "nameLocalized": {
              "de_DE": "S-Paket",
              "en_US": "S-Parcel",
              "ru_RU": "S-пакет"
            },
            "dimensions": {
              "customWeight": 1700,
              "height": 50,
              "length": 100,
              "weight": 1700,
              "width": 25
            },
            "name": "S-Parcel",
            "services": {
              "bulkyGoods": false
            }
          }
        ],
        "productValueNeeded": true,
        "status": "ACTIVE",
        "created": "2020-02-03T08:45:51.525Z",
        "lastModified": "2020-02-03T09:45:51.525Z",
        "version": 42,
        "deliveryType": "SAMEDAY",
        "id": "LGMl2DuvPnfPoSHhYFOm",
        "lifecycle": "GA"
      },
      "priority": 1,
      "threshold": {
        "currency": "EUR",
        "decimalPlaces": 2,
        "from": 1299,
        "to": 25000
      }
    }
  ],
  "recommendedCarriers": [
    {
      "carrier": {
        "credentials": {
          "key": "text"
        },
        "defaultParcelHeightInCm": 10,
        "defaultParcelLengthInCm": 25,
        "defaultParcelWeightInGram": 1000,
        "defaultParcelWidthInCm": 35,
        "key": "DHL_V2",
        "logoUrl": "text",
        "name": "DHL Köln",
        "parcelLabelClassifications": [
          {
            "nameLocalized": {
              "de_DE": "S-Paket",
              "en_US": "S-Parcel",
              "ru_RU": "S-пакет"
            },
            "dimensions": {
              "customWeight": 1700,
              "height": 50,
              "length": 100,
              "weight": 1700,
              "width": 25
            },
            "name": "S-Parcel",
            "services": {
              "bulkyGoods": false
            }
          }
        ],
        "productValueNeeded": true,
        "status": "ACTIVE",
        "created": "2020-02-03T08:45:51.525Z",
        "lastModified": "2020-02-03T09:45:51.525Z",
        "version": 42,
        "deliveryType": "SAMEDAY",
        "id": "LGMl2DuvPnfPoSHhYFOm",
        "lifecycle": "GA"
      },
      "priority": 1,
      "threshold": {
        "currency": "EUR",
        "decimalPlaces": 2,
        "from": 1299,
        "to": 25000
      }
    }
  ]
}

List facility connections

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. 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
}

Create facility connection

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. 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

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
}

Get facility connection

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. 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

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

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. 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

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

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. 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

List facility discounts

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

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

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of facilities to show

Default: 25

Responses

200

The discounts were successfully retrieved. The result is in the body.

application/json

anyOptional

FacilityDiscountPaginatedResult

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/{facilityRef}/discounts

HTTPcURLJavaScriptPython

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

[]

Create facility discount

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

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

Body

application/json

FacilityDiscountForCreation

contextanyOptional

The context of the discount. This is used to determine the conditions under which the discount can be applied.

discountone ofRequired

or

priorityintegerRequired

The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.

Example: 1

typestring · enumRequired

Determines the price type this discount can be applied to.

Possible values:

Responses

201

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

application/json

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

404

Facility not found

application/json

post

/api/facilities/{facilityRef}/discounts

HTTPcURLJavaScriptPython

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

{
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "priority": 1,
  "type": "SALES_PRICE"
}

{
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "facilityRef": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "id": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "priority": 1,
  "type": "SALES_PRICE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get facility discount

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

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

facilityDiscountRefstringRequired

ID of the discount you want to get

Responses

200

The discount was successfully retrieved. The result is in the body.

application/json

FacilityDiscount

and

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 or discount not found

application/json

get

/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

HTTPcURLJavaScriptPython

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

{
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "facilityRef": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "id": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "priority": 1,
  "type": "SALES_PRICE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete facility discount

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

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

facilityDiscountRefstringRequired

ID of the discount you want to delete

Responses

200

The discount was successfully deleted. The result is in the body.

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 or discount not found

application/json

delete

/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

HTTPcURLJavaScriptPython

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

No content

Update facility discount

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

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

facilityDiscountRefstringRequired

ID of the discount you want to update

Body

application/json

FacilityDiscountForUpdate

contextanyOptional

The context of the discount. This is used to determine the conditions under which the discount can be applied.

discountone ofOptional

or

priorityintegerOptional

The priority of the discount. Discounts with the lowest priority value are applied first. Must be greater than 0 and smaller than 1000.

Example: 1

typestring · enumOptional

Determines the price type this discount can be applied to.

Possible values:

versioninteger · int64Required

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

Example: 42

Responses

200

The discount was successfully updated. The result is in the body.

application/json

FacilityDiscount

and

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

404

Facility or discount not found

application/json

patch

/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

HTTPcURLJavaScriptPython

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

{
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "priority": 1,
  "type": "SALES_PRICE",
  "version": 42
}

{
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "facilityRef": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "id": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "priority": 1,
  "type": "SALES_PRICE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List facilities (search)

post

This part of the API is in Beta status. For details please check the api-release-life-cycle 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.

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

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "address": {
      "city": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "country": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": {
          "eq": true,
          "notEq": true
        }
      },
      "emailAddresses": {
        "contains": {
          "recipient": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "value": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      },
      "houseNumber": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "postalCode": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "province": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "street": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "and": [
      {
        "address": {
          "city": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "country": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "emailAddresses": {
            "contains": {
              "recipient": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "value": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "houseNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "postalCode": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "province": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "street": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "and": [
          {
            "address": {
              "city": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "emailAddresses": {
                "contains": {
                  "recipient": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "value": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "houseNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "postalCode": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "locationType": {
              "eq": "STORE",
              "in": [
                "STORE"
              ],
              "notEq": "STORE"
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "services": {
              "contains": {
                "type": {
                  "eq": "SHIP_FROM_STORE",
                  "in": [
                    "SHIP_FROM_STORE"
                  ],
                  "notEq": "SHIP_FROM_STORE"
                }
              }
            },
            "status": {
              "eq": "ONLINE",
              "in": [
                "ONLINE"
              ],
              "notEq": "ONLINE"
            },
            "tenantFacilityId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "type": {
              "eq": "MANAGED_FACILITY",
              "in": [
                "MANAGED_FACILITY"
              ],
              "notEq": "MANAGED_FACILITY"
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "locationType": {
          "eq": "STORE",
          "in": [
            "STORE"
          ],
          "notEq": "STORE"
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "address": {
              "city": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "emailAddresses": {
                "contains": {
                  "recipient": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "value": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "houseNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "postalCode": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "locationType": {
              "eq": "STORE",
              "in": [
                "STORE"
              ],
              "notEq": "STORE"
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "services": {
              "contains": {
                "type": {
                  "eq": "SHIP_FROM_STORE",
                  "in": [
                    "SHIP_FROM_STORE"
                  ],
                  "notEq": "SHIP_FROM_STORE"
                }
              }
            },
            "status": {
              "eq": "ONLINE",
              "in": [
                "ONLINE"
              ],
              "notEq": "ONLINE"
            },
            "tenantFacilityId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "type": {
              "eq": "MANAGED_FACILITY",
              "in": [
                "MANAGED_FACILITY"
              ],
              "notEq": "MANAGED_FACILITY"
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "services": {
          "contains": {
            "type": {
              "eq": "SHIP_FROM_STORE",
              "in": [
                "SHIP_FROM_STORE"
              ],
              "notEq": "SHIP_FROM_STORE"
            }
          }
        },
        "status": {
          "eq": "ONLINE",
          "in": [
            "ONLINE"
          ],
          "notEq": "ONLINE"
        },
        "tenantFacilityId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "type": {
          "eq": "MANAGED_FACILITY",
          "in": [
            "MANAGED_FACILITY"
          ],
          "notEq": "MANAGED_FACILITY"
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "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": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "locationType": {
      "eq": "STORE",
      "in": [
        "STORE"
      ],
      "notEq": "STORE"
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "address": {
          "city": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "country": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "emailAddresses": {
            "contains": {
              "recipient": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "value": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "houseNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "postalCode": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "locationType": {
          "eq": "STORE",
          "in": [
            "STORE"
          ],
          "notEq": "STORE"
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "services": {
          "contains": {
            "type": {
              "eq": "SHIP_FROM_STORE",
              "in": [
                "SHIP_FROM_STORE"
              ],
              "notEq": "SHIP_FROM_STORE"
            }
          }
        },
        "status": {
          "eq": "ONLINE",
          "in": [
            "ONLINE"
          ],
          "notEq": "ONLINE"
        },
        "tenantFacilityId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "type": {
          "eq": "MANAGED_FACILITY",
          "in": [
            "MANAGED_FACILITY"
          ],
          "notEq": "MANAGED_FACILITY"
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "services": {
      "contains": {
        "type": {
          "eq": "SHIP_FROM_STORE",
          "in": [
            "SHIP_FROM_STORE"
          ],
          "notEq": "SHIP_FROM_STORE"
        }
      }
    },
    "status": {
      "eq": "ONLINE",
      "in": [
        "ONLINE"
      ],
      "notEq": "ONLINE"
    },
    "tenantFacilityId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "type": {
      "eq": "MANAGED_FACILITY",
      "in": [
        "MANAGED_FACILITY"
      ],
      "notEq": "MANAGED_FACILITY"
    },
    "tags": {
      "contains": {
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "value": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1,
  "sort": [
    {
      "address": {
        "city": "ASC",
        "country": "ASC",
        "postalCode": "ASC"
      },
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "ASC",
      "lastModified": "ASC",
      "name": "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": []
      },
      "services": [
        {
          "type": "SHIP_FROM_STORE"
        }
      ]
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}