---
agentTools:
  projectIndex: https://quiver.readme.io/llms.txt
---

# /fulfilment-locations

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Fulfilment",
    "description": "...",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "FulfilmentLocationService"
    }
  ],
  "paths": {
    "/fulfilment-locations": {
      "get": {
        "operationId": "FulfilmentLocationService_QueryFulfilmentLocations",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/fulfilmentQueryFulfilmentLocationsResponse"
                }
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "FulfilmentLocationService"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.quiver.london/fulfilment"
    }
  ],
  "components": {
    "schemas": {
      "fulfilmentArrivalInstruction": {
        "type": "object",
        "properties": {
          "instruction": {
            "type": "string"
          },
          "photoUrl": {
            "type": "string"
          }
        }
      },
      "fulfilmentDailyOperatingHours": {
        "type": "object",
        "properties": {
          "monday": {
            "$ref": "#/components/schemas/fulfilmentDayOperatingHours"
          },
          "tuesday": {
            "$ref": "#/components/schemas/fulfilmentDayOperatingHours"
          },
          "wednesday": {
            "$ref": "#/components/schemas/fulfilmentDayOperatingHours"
          },
          "thursday": {
            "$ref": "#/components/schemas/fulfilmentDayOperatingHours"
          },
          "friday": {
            "$ref": "#/components/schemas/fulfilmentDayOperatingHours"
          },
          "saturday": {
            "$ref": "#/components/schemas/fulfilmentDayOperatingHours"
          },
          "sunday": {
            "$ref": "#/components/schemas/fulfilmentDayOperatingHours"
          }
        }
      },
      "fulfilmentDayOperatingHours": {
        "type": "object",
        "properties": {
          "operating": {
            "type": "boolean"
          },
          "operatingHours": {
            "$ref": "#/components/schemas/sharedTimeWindow"
          }
        }
      },
      "fulfilmentFulfilmentLocation": {
        "type": "object",
        "properties": {
          "fulfilmentLocationId": {
            "type": "integer",
            "format": "int32"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "deletedAt": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "string"
          },
          "deliveryEcommerceEnabled": {
            "type": "boolean"
          },
          "returnEcommerceEnabled": {
            "type": "boolean"
          },
          "collectionEnabled": {
            "type": "boolean",
            "description": "Whether this location may be selected for store collection. A collection\nrate is returned only when this is enabled and the location has current\nstock for every item in the quoted basket (v1 does not arrange transfers)."
          },
          "address": {
            "$ref": "#/components/schemas/sharedAddress"
          },
          "externalLocationId": {
            "type": "string",
            "description": "The merchant's external location identifier. Use this value as\nmerchantLocationId when booking a collection for a specific location."
          },
          "operatingHours": {
            "$ref": "#/components/schemas/fulfilmentOperatingHours"
          },
          "arrivalInstructions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/fulfilmentArrivalInstruction"
            }
          },
          "contacts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/fulfilmentFulfilmentLocationContact"
            }
          }
        }
      },
      "fulfilmentFulfilmentLocationContact": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          }
        }
      },
      "fulfilmentOperatingHours": {
        "type": "object",
        "properties": {
          "useDaily": {
            "type": "boolean"
          },
          "generic": {
            "$ref": "#/components/schemas/sharedTimeWindow"
          },
          "daily": {
            "$ref": "#/components/schemas/fulfilmentDailyOperatingHours"
          }
        }
      },
      "fulfilmentQueryFulfilmentLocationsResponse": {
        "type": "object",
        "properties": {
          "fulfilmentLocations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/fulfilmentFulfilmentLocation"
            }
          }
        }
      },
      "protobufAny": {
        "type": "object",
        "properties": {
          "@type": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      },
      "rpcStatus": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            }
          }
        }
      },
      "sharedAddress": {
        "type": "object",
        "properties": {
          "addressId": {
            "type": "integer",
            "format": "int32"
          },
          "line1": {
            "type": "string"
          },
          "line2": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "company": {
            "type": "string"
          },
          "latitude": {
            "type": "number",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "format": "double"
          },
          "addressType": {
            "$ref": "#/components/schemas/sharedAddressType"
          },
          "locationTypeLabel": {
            "type": "string",
            "description": "A short, shared label for an address which does not fit the standard\ncategories, e.g. \"School\". It is a place type, never delivery guidance."
          },
          "pinStatus": {
            "$ref": "#/components/schemas/sharedAddressPinStatus"
          },
          "pinSource": {
            "$ref": "#/components/schemas/sharedAddressPinSource"
          },
          "pinProviderQuality": {
            "type": "string"
          },
          "pinPartialMatch": {
            "type": "boolean"
          },
          "pinValidatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "pinConfirmationReason": {
            "type": "string"
          }
        }
      },
      "sharedAddressPinSource": {
        "type": "string",
        "enum": [
          "NAURT",
          "GOOGLE_MAPS",
          "OPERATOR",
          "LEGACY"
        ],
        "description": "The evidence that selected the current operational pin. Provider-specific\nprecision codes belong in pin_provider_quality; clients should use these\nstable, human-meaningful source names instead."
      },
      "sharedAddressPinStatus": {
        "type": "string",
        "enum": [
          "VERIFIED",
          "NEEDS_CONFIRMATION",
          "MANUAL_CONFIRMED",
          "UNAVAILABLE"
        ],
        "description": "Whether the coordinates can be used as an operational delivery pin. This is\ndeliberately separate from whether the written address is valid: an order\nmay name a real address while still needing a human to confirm its location."
      },
      "sharedAddressType": {
        "type": "string",
        "enum": [
          "HOUSE",
          "APARTMENT",
          "OFFICE",
          "SHOP",
          "RESTAURANT_CAFE",
          "HOTEL",
          "HEALTHCARE",
          "EDUCATION",
          "WAREHOUSE"
        ]
      },
      "sharedTimeWindow": {
        "type": "object",
        "properties": {
          "from": {
            "type": "string"
          },
          "to": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 231,
      "2": 26,
      "3": 254,
      "4": 74,
      "5": 54,
      "6": 78,
      "7": 0,
      "8": 13,
      "9": 225,
      "10": 4,
      "11": 102
    }
  }
}
```