Delivery patch sizes and overlaps

GET

/patches/overview

const url = 'https://example.com/patches/overview';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/patches/overview \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

How many postcodes and saved addresses each patch covers, and which other patches cover the same addresses.

Authorizations

sessionCookie
rounds:read
apiKey
rounds:read

Responses

200

Sizes and overlaps

application/json

object

items

required

Array<object>

object

patchId

required

UUID v7

string format: uuid

postcodes

required

integer

addresses

required

integer

overlaps

required

Array<object>

object

patchId

required

UUID v7

string format: uuid

addresses

required

integer

> 0

Example

{
  "items": [
    {
      "patchId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "overlaps": [
        {
          "patchId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}