{"items":[{"type":"link","label":"Locations API","link":"/connect/locations-api/versions/2025.1/openapi","routeSlug":"/connect/locations-api/versions/2025.1/openapi","content":{"contentType":"overview","meta":{"name":"Locations API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/connect/locations-api/versions/2025.1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/connect/locations-api/versions/2025.1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"support@scurri.com","label":"support@scurri.com","withCopyButton":true,"copyContent":"support@scurri.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/connect/locations-api/versions/2025.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://sandbox.scurri.co.uk/locations/api/company/{company_slug}/{service_slug}","description":"The base URL for the Locations API","variables":{"company_slug":{"default":"api-test-company","description":"The slug of your company in Scurri."},"service_slug":{"default":"api-test-service","description":"The slug of the service you want to retrieve locations for."}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Locations API (2025.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Locations API provides eCommerce sellers with a list of delivery locations available\n at checkout. This allows customers to deliver their package to a location convenient \n to them."}],"sectionId":"/connect/locations-api/versions/2025.1/openapi"}],"sectionId":"/connect/locations-api/versions/2025.1/openapi"}]}]}},{"type":"group","label":"Locations","link":"/connect/locations-api/versions/2025.1/openapi/locations","routeSlug":"/connect/locations-api/versions/2025.1/openapi/locations","items":[{"label":"List Delivery Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/locations-api/versions/2025.1/openapi/locations/getlocations","routeSlug":"/connect/locations-api/versions/2025.1/openapi/locations/getlocations","metadata":{"seo":{"title":"List Delivery Locations","description":"Retrieve delivery locations for a service based on the given parameters:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocations","name":"List Delivery Locations","isWebhook":false,"pointer":"/paths/~1delivery~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Delivery Locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve delivery locations for a service based on the given parameters:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company_slug"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The slug of your company in Scurri."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"service_slug"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The slug of the carrier service whose delivery locations are to be searched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"postcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"sup","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postcode being the epicentre of the search."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"sup","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country of the postcode."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"latitude"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"sup","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latitude of the epicentre of the search."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"longitude"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"sup","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The longitude of the epicentre of the search."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"radius"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search radius in kilometers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of points returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"categories"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The categories of delivery locations to return. Accepts multiple values."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"sup","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1,2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" At least one set of the numbered parameters is required (either postcode+country or latitude+longitude)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"IMPORTANT!"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To trigger postcode-specific rules within "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.scurri.com/connect/delivery-options-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you MUST use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Coordinates ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"longitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not supported for evaluating these conditions."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requests must be authenticated using Basic Auth. With Basic Auth, you have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to send the username and password base64-encoded in the standard Basic manner,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. Authorization: Basic YXBpdGVzdDphcGkgcGFzc3dvcmQgdGVzdA==. Here is some"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sample code in Python to generate the value of the header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  >>> import base64\n  >>> username = 'apitest'\n  >>> password = 'api-test-password'\n  >>> base64.b64encode(f'{username}:{password}'.encode('ascii'))\n  b'YXBpdGVzdDphcGktdGVzdC1wYXNzd29yZA=='\n","language":"python"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  >>> import base64\n  >>> username = 'apitest'\n  >>> password = 'api-test-password'\n  >>> base64.b64encode(f'{username}:{password}'.encode('ascii'))\n  b'YXBpdGVzdDphcGktdGVzdC1wYXNzd29yZA=='\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"postcode","in":"query","schemaId":"schema_211","description":"The postcode to filter locations by. Acts as the epicenter of the search, from which locations will be returned based on the radius and limit specified\n","example":"Y35 1X5"},{"name":"country","in":"query","schemaId":"schema_212","description":"The country of the postcode. Required if postcode is provided.\n","example":"IE"},{"name":"latitude","in":"query","schemaId":"schema_213","description":"The latitude of the epicenter of the search. Required if longitude is provided.\n","example":52.2},{"name":"longitude","in":"query","schemaId":"schema_214","description":"The longitude of the epicenter of the search. Required if latitude is provided.\n","example":-6.5},{"name":"radius","in":"query","schemaId":"schema_215","description":"The search radius in kilometers. Defaults to 10km if not specified.\n","example":10},{"name":"limit","in":"query","schemaId":"schema_216","description":"The maximum number of points to return. Defaults to 20 if not specified.\n","example":20},{"name":"categories","in":"query","schemaId":"schema_217","description":"The categories of delivery locations to return. Accepts multiple string values.\n","example":["locker","collection_point"]}],"pointer":"/paths/~1delivery~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/delivery/","servers":[{"url":"/_mock/connect/locations-api/versions/2025.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://sandbox.scurri.co.uk/locations/api/company/{company_slug}/{service_slug}","description":"The base URL for the Locations API","variables":{"company_slug":{"default":"api-test-company"},"service_slug":{"default":"api-test-service"}}}],"parameters":{"path":[],"query":[{"name":"postcode","in":"query","required":false,"example":"Y35 1X5","schemaId":"schema_211"},{"name":"country","in":"query","required":false,"example":"IE","schemaId":"schema_212"},{"name":"latitude","in":"query","required":false,"example":52.2,"schemaId":"schema_213"},{"name":"longitude","in":"query","required":false,"example":-6.5,"schemaId":"schema_214"},{"name":"radius","in":"query","required":false,"example":10,"schemaId":"schema_215"},{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_216"},{"name":"categories","in":"query","required":false,"example":["locker","collection_point"],"schemaId":"schema_217"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/delivery/","href":"locations/getlocations","openApiOperationId":"getLocations","summary":"List Delivery Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connect/locations-api/versions/2025.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://sandbox.scurri.co.uk/locations/api/company/{company_slug}/{service_slug}","description":"The base URL for the Locations API","variables":{"company_slug":{"default":"api-test-company"},"service_slug":{"default":"api-test-service"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of delivery locations for the specified service","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationsResponse"}},"schemaId":"components/schemas/LocationsResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}},"schemaId":"schema_218"},{"code":"404","description":"You don't have permission to access this resource"}],"pointer":"/paths/~1delivery~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationsResponse"}}},{"code":"400","schemaId":"schema_218","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/getlocations"}],"panels":[]}]},"httpPath":"/delivery/"}],"content":{"contentType":"group","meta":{"name":"Locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Locations","showPageActions":true},{"nodeType":"markdoc","content":"Locations related endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/delivery/","summary":"List Delivery Locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/getlocations","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","properties":{"address1":{"type":"string","description":"The first line of the address","example":"Innovation House"},"address2":{"type":"string","description":"The second line of the address","example":"The Bullring"},"address3":{"type":"string","description":"The third line of the address","example":""},"city":{"type":"string","description":"The city of the delivery location","example":"Wexford"},"state":{"type":"string","description":"The state or region of the delivery location","example":"County Wexford"},"postcode":{"type":"string","description":"The postcode of the delivery location","example":"Y35 1X5"},"country":{"type":"string","description":"The country of the delivery location","example":"IE"}}}},"components/schemas/OpeningHours":{"id":"components/schemas/OpeningHours","kind":"json-schema","title":"OpeningHours","data":{"type":"object","properties":{"day_of_week":{"type":"string","description":"The day of the week","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"example":"Monday"},"open_from":{"type":"string","description":"The opening time in 24-hour format","example":"09:00"},"open_to":{"type":"string","description":"The closing time in 24-hour format","example":"17:00"}}}},"components/schemas/DeliveryLocation":{"id":"components/schemas/DeliveryLocation","kind":"json-schema","title":"DeliveryLocation","data":{"type":"object","properties":{"code":{"type":"string","description":"The unique code for the delivery location","example":"10"},"name":{"type":"string","description":"The name of the delivery location","example":"Wexford post office"},"type":{"type":"string","description":"The type of the delivery location as assigned by the carrier","example":"POL"},"address":{"$ref":"#/components/schemas/Address"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"The latitude of the delivery location","example":52.2},"longitude":{"type":"number","format":"float","description":"The longitude of the delivery location","example":-6.5}}},"distance":{"type":"string","description":"The distance from the epicenter of the search in kilometers","example":"1.5"},"opening_hours":{"type":"array","items":{"$ref":"#/components/schemas/OpeningHours"}},"carrier":{"type":"object","properties":{"name":{"type":"string","description":"The name of the carrier for the delivery location","example":"Generic Carrier"},"logo":{"type":"string","description":"The url of the carrier's logo","example":"https://example.com/logo.png"}}},"category":{"type":"string","description":"The category of the delivery location","example":"collection_point"}}}},"components/schemas/LocationsResponse":{"id":"components/schemas/LocationsResponse","kind":"json-schema","title":"LocationsResponse","data":{"type":"object","properties":{"delivery_locations":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryLocation"}}}}},"schema_211":{"kind":"json-schema","data":{"type":"string"},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"string","maxLength":20},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"type":"number","format":"float","minimum":-90,"maximum":90},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"type":"number","format":"float","minimum":-180,"maximum":180},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"number","format":"float","minimum":0,"maximum":50},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"integer","minimum":0,"maximum":100},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"array"},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"type":"object","properties":{"detail":{"type":"string","description":"A description of the error","example":"Locations are not available for this service."}}},"id":"schema_218"}},"exampleStore":{},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requests must be authenticated using Basic Auth. With Basic Auth, you have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to send the username and password base64-encoded in the standard Basic manner,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. Authorization: Basic YXBpdGVzdDphcGkgcGFzc3dvcmQgdGVzdA==. Here is some"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sample code in Python to generate the value of the header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  >>> import base64\n  >>> username = 'apitest'\n  >>> password = 'api-test-password'\n  >>> base64.b64encode(f'{username}:{password}'.encode('ascii'))\n  b'YXBpdGVzdDphcGktdGVzdC1wYXNzd29yZA=='\n","language":"python"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  >>> import base64\n  >>> username = 'apitest'\n  >>> password = 'api-test-password'\n  >>> base64.b64encode(f'{username}:{password}'.encode('ascii'))\n  b'YXBpdGVzdDphcGktdGVzdC1wYXNzd29yZA=='\n"},"children":[]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/connect/locations-api/versions/2025.1/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://sandbox.scurri.co.uk/locations/api/company/{company_slug}/{service_slug}","description":"The base URL for the Locations API","variables":{"company_slug":{"default":"api-test-company","description":"The slug of your company in Scurri."},"service_slug":{"default":"api-test-service","description":"The slug of the service you want to retrieve locations for."}}}],"specType":"openapi"},"options":{"schemasExpansionLevel":2,"mockServer":{"url":"/_mock/connect/locations-api/versions/2025.1/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connect/locations-api/versions/2025.1/openapi.json?download"},{"url":"/_bundle/connect/locations-api/versions/2025.1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Locations API","description":"The Locations API provides eCommerce sellers with a list of delivery locations available\n at checkout. This allows customers to deliver their package to a location convenient \n to them.\n"}},"baseSlug":"/connect/locations-api/versions/2025.1/openapi","routesMapping":{}}