Addresses

List addresses

GET /v1/addresses

The account's address book.

Response in data

• items • Required array of objects
  Each item · 18

  • city • Required string

    City.

  • country • Required string

    Two-letter country code, e.g. CA, US.

  • created_at • Required timestamp

    When it was created (ISO 8601, UTC).

  • id • Required uuid
  • is_default_from • Required boolean
  • is_default_to • Required boolean
  • is_residential • Required boolean

    True for a home address. Some carriers charge more for residential delivery.

  • name • Required string
  • nickname • Required string
  • postal_code • Required string

    Postal or ZIP code.

  • state • Required string

    Province or state code, e.g. ON, BC, NY.

  • street • Required string

    Street address.

  • tags • Required array of strings
  • updated_at • Required timestamp

    When it last changed (ISO 8601, UTC).

  • company string

    Company name.

  • email string

    Email address.

  • line2 string

    Apartment, suite or unit.

  • phone string

    Phone number. Carriers need one for the recipient on most international and express services.

1
2

curl "https://api.parcelhub.ca/v1/addresses" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

{
  "ok": true,
  "data": {
    "items": [
      {
        "city": "Toronto",
        "company": "Maple Goods Inc.",
        "country": "CA",
        "created_at": "2026-10-31T15:04:05Z",
        "email": "[email protected]",
        "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
        "is_default_from": false,
        "is_default_to": false,
        "is_residential": false,
        "line2": "Suite 400",
        "name": "Alex Martin",
        "nickname": "string",
        "phone": "+1 416 555 0100",
        "postal_code": "M5V 2T6",
        "state": "ON",
        "street": "123 King St W",
        "tags": [
          "string"
        ],
        "updated_at": "2026-10-31T15:04:05Z"
      }
    ]
  },
  "request_id": "01JBX7Q2…"
}

Add an address

POST /v1/addresses

Adds an address to the address book. It can be made the default sender or recipient at the same time.

Request body

• city • Required string

  City.

• country • Required string

  Two-letter country code, e.g. CA, US.

• name • Required string
• nickname • Required string

  Label for the address book, e.g. "Warehouse".

• postal_code • Required string

  Postal or ZIP code.

• street • Required string

  Street address.

• company string

  Company name.

• email string

  Email address.

• is_default_from boolean

  Also make this the default sender.

• is_default_to boolean

  Also make this the default recipient.

• is_residential boolean

  True for a home address. Some carriers charge more for residential delivery.

• line2 string

  Apartment, suite or unit.

• phone string

  Phone number. Carriers need one for the recipient on most international and express services.

• state string

  Province or state code, e.g. ON, BC, NY.

• tags array of strings

  Your own labels for the address.

Response in data

• city • Required string

  City.

• country • Required string

  Two-letter country code, e.g. CA, US.

• created_at • Required timestamp

  When it was created (ISO 8601, UTC).

• id • Required uuid
• is_default_from • Required boolean
• is_default_to • Required boolean
• is_residential • Required boolean

  True for a home address. Some carriers charge more for residential delivery.

• name • Required string
• nickname • Required string
• postal_code • Required string

  Postal or ZIP code.

• state • Required string

  Province or state code, e.g. ON, BC, NY.

• street • Required string

  Street address.

• tags • Required array of strings
• updated_at • Required timestamp

  When it last changed (ISO 8601, UTC).

• company string

  Company name.

• email string

  Email address.

• line2 string

  Apartment, suite or unit.

• phone string

  Phone number. Carriers need one for the recipient on most international and express services.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

curl -X POST "https://api.parcelhub.ca/v1/addresses" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "city": "Toronto",
  "company": "Maple Goods Inc.",
  "country": "CA",
  "email": "[email protected]",
  "is_default_from": false,
  "is_default_to": false,
  "is_residential": false,
  "line2": "Suite 400",
  "name": "Alex Martin",
  "nickname": "string",
  "phone": "+1 416 555 0100",
  "postal_code": "M5V 2T6",
  "state": "ON",
  "street": "123 King St W",
  "tags": [
    "string"
  ]
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "ok": true,
  "data": {
    "city": "Toronto",
    "company": "Maple Goods Inc.",
    "country": "CA",
    "created_at": "2026-10-31T15:04:05Z",
    "email": "[email protected]",
    "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
    "is_default_from": false,
    "is_default_to": false,
    "is_residential": false,
    "line2": "Suite 400",
    "name": "Alex Martin",
    "nickname": "string",
    "phone": "+1 416 555 0100",
    "postal_code": "M5V 2T6",
    "state": "ON",
    "street": "123 King St W",
    "tags": [
      "string"
    ],
    "updated_at": "2026-10-31T15:04:05Z"
  },
  "request_id": "01JBX7Q2…"
}

Get an address

GET /v1/addresses/{id}

One address book entry.

Path parameters

• id • Required string

Response in data

• city • Required string

  City.

• country • Required string

  Two-letter country code, e.g. CA, US.

• created_at • Required timestamp

  When it was created (ISO 8601, UTC).

• id • Required uuid
• is_default_from • Required boolean
• is_default_to • Required boolean
• is_residential • Required boolean

  True for a home address. Some carriers charge more for residential delivery.

• name • Required string
• nickname • Required string
• postal_code • Required string

  Postal or ZIP code.

• state • Required string

  Province or state code, e.g. ON, BC, NY.

• street • Required string

  Street address.

• tags • Required array of strings
• updated_at • Required timestamp

  When it last changed (ISO 8601, UTC).

• company string

  Company name.

• email string

  Email address.

• line2 string

  Apartment, suite or unit.

• phone string

  Phone number. Carriers need one for the recipient on most international and express services.

1
2

curl "https://api.parcelhub.ca/v1/addresses/3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "ok": true,
  "data": {
    "city": "Toronto",
    "company": "Maple Goods Inc.",
    "country": "CA",
    "created_at": "2026-10-31T15:04:05Z",
    "email": "[email protected]",
    "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
    "is_default_from": false,
    "is_default_to": false,
    "is_residential": false,
    "line2": "Suite 400",
    "name": "Alex Martin",
    "nickname": "string",
    "phone": "+1 416 555 0100",
    "postal_code": "M5V 2T6",
    "state": "ON",
    "street": "123 King St W",
    "tags": [
      "string"
    ],
    "updated_at": "2026-10-31T15:04:05Z"
  },
  "request_id": "01JBX7Q2…"
}

Update an address

PATCH /v1/addresses/{id}

Replaces an address book entry with the fields sent.

Path parameters

• id • Required string

Request body

• city • Required string

  City.

• country • Required string

  Two-letter country code, e.g. CA, US.

• name • Required string
• nickname • Required string

  Label for the address book, e.g. "Warehouse".

• postal_code • Required string

  Postal or ZIP code.

• street • Required string

  Street address.

• company string

  Company name.

• email string

  Email address.

• is_default_from boolean

  Also make this the default sender.

• is_default_to boolean

  Also make this the default recipient.

• is_residential boolean

  True for a home address. Some carriers charge more for residential delivery.

• line2 string

  Apartment, suite or unit.

• phone string

  Phone number. Carriers need one for the recipient on most international and express services.

• state string

  Province or state code, e.g. ON, BC, NY.

• tags array of strings

  Your own labels for the address.

Response in data

• city • Required string

  City.

• country • Required string

  Two-letter country code, e.g. CA, US.

• created_at • Required timestamp

  When it was created (ISO 8601, UTC).

• id • Required uuid
• is_default_from • Required boolean
• is_default_to • Required boolean
• is_residential • Required boolean

  True for a home address. Some carriers charge more for residential delivery.

• name • Required string
• nickname • Required string
• postal_code • Required string

  Postal or ZIP code.

• state • Required string

  Province or state code, e.g. ON, BC, NY.

• street • Required string

  Street address.

• tags • Required array of strings
• updated_at • Required timestamp

  When it last changed (ISO 8601, UTC).

• company string

  Company name.

• email string

  Email address.

• line2 string

  Apartment, suite or unit.

• phone string

  Phone number. Carriers need one for the recipient on most international and express services.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

curl -X PATCH "https://api.parcelhub.ca/v1/addresses/3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "city": "Toronto",
  "company": "Maple Goods Inc.",
  "country": "CA",
  "email": "[email protected]",
  "is_default_from": false,
  "is_default_to": false,
  "is_residential": false,
  "line2": "Suite 400",
  "name": "Alex Martin",
  "nickname": "string",
  "phone": "+1 416 555 0100",
  "postal_code": "M5V 2T6",
  "state": "ON",
  "street": "123 King St W",
  "tags": [
    "string"
  ]
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "ok": true,
  "data": {
    "city": "Toronto",
    "company": "Maple Goods Inc.",
    "country": "CA",
    "created_at": "2026-10-31T15:04:05Z",
    "email": "[email protected]",
    "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
    "is_default_from": false,
    "is_default_to": false,
    "is_residential": false,
    "line2": "Suite 400",
    "name": "Alex Martin",
    "nickname": "string",
    "phone": "+1 416 555 0100",
    "postal_code": "M5V 2T6",
    "state": "ON",
    "street": "123 King St W",
    "tags": [
      "string"
    ],
    "updated_at": "2026-10-31T15:04:05Z"
  },
  "request_id": "01JBX7Q2…"
}

Delete an address

DELETE /v1/addresses/{id}

Removes an address from the address book. Shipments already made keep their copy.

Path parameters

• id • Required string

Response in data

• deleted • Required boolean

1
2

curl -X DELETE "https://api.parcelhub.ca/v1/addresses/3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6
7

{
  "ok": true,
  "data": {
    "deleted": true
  },
  "request_id": "01JBX7Q2…"
}

Make default sender

POST /v1/addresses/{id}/set-default-from

Makes this address the default ship-from address.

Path parameters

• id • Required string

Response in data

• city • Required string

  City.

• country • Required string

  Two-letter country code, e.g. CA, US.

• created_at • Required timestamp

  When it was created (ISO 8601, UTC).

• id • Required uuid
• is_default_from • Required boolean
• is_default_to • Required boolean
• is_residential • Required boolean

  True for a home address. Some carriers charge more for residential delivery.

• name • Required string
• nickname • Required string
• postal_code • Required string

  Postal or ZIP code.

• state • Required string

  Province or state code, e.g. ON, BC, NY.

• street • Required string

  Street address.

• tags • Required array of strings
• updated_at • Required timestamp

  When it last changed (ISO 8601, UTC).

• company string

  Company name.

• email string

  Email address.

• line2 string

  Apartment, suite or unit.

• phone string

  Phone number. Carriers need one for the recipient on most international and express services.

1
2

curl -X POST "https://api.parcelhub.ca/v1/addresses/3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f/set-default-from" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "ok": true,
  "data": {
    "city": "Toronto",
    "company": "Maple Goods Inc.",
    "country": "CA",
    "created_at": "2026-10-31T15:04:05Z",
    "email": "[email protected]",
    "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
    "is_default_from": false,
    "is_default_to": false,
    "is_residential": false,
    "line2": "Suite 400",
    "name": "Alex Martin",
    "nickname": "string",
    "phone": "+1 416 555 0100",
    "postal_code": "M5V 2T6",
    "state": "ON",
    "street": "123 King St W",
    "tags": [
      "string"
    ],
    "updated_at": "2026-10-31T15:04:05Z"
  },
  "request_id": "01JBX7Q2…"
}

Make default recipient

POST /v1/addresses/{id}/set-default-to

Makes this address the default ship-to address.

Path parameters

• id • Required string

Response in data

• city • Required string

  City.

• country • Required string

  Two-letter country code, e.g. CA, US.

• created_at • Required timestamp

  When it was created (ISO 8601, UTC).

• id • Required uuid
• is_default_from • Required boolean
• is_default_to • Required boolean
• is_residential • Required boolean

  True for a home address. Some carriers charge more for residential delivery.

• name • Required string
• nickname • Required string
• postal_code • Required string

  Postal or ZIP code.

• state • Required string

  Province or state code, e.g. ON, BC, NY.

• street • Required string

  Street address.

• tags • Required array of strings
• updated_at • Required timestamp

  When it last changed (ISO 8601, UTC).

• company string

  Company name.

• email string

  Email address.

• line2 string

  Apartment, suite or unit.

• phone string

  Phone number. Carriers need one for the recipient on most international and express services.

1
2

curl -X POST "https://api.parcelhub.ca/v1/addresses/3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f/set-default-to" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "ok": true,
  "data": {
    "city": "Toronto",
    "company": "Maple Goods Inc.",
    "country": "CA",
    "created_at": "2026-10-31T15:04:05Z",
    "email": "[email protected]",
    "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
    "is_default_from": false,
    "is_default_to": false,
    "is_residential": false,
    "line2": "Suite 400",
    "name": "Alex Martin",
    "nickname": "string",
    "phone": "+1 416 555 0100",
    "postal_code": "M5V 2T6",
    "state": "ON",
    "street": "123 King St W",
    "tags": [
      "string"
    ],
    "updated_at": "2026-10-31T15:04:05Z"
  },
  "request_id": "01JBX7Q2…"
}

Default addresses

GET /v1/addresses/defaults

The default ship-from and ship-to addresses, if set.

Response in data

• default_from object
  Fields · 18

  • city • Required string

    City.

  • country • Required string

    Two-letter country code, e.g. CA, US.

  • created_at • Required timestamp

    When it was created (ISO 8601, UTC).

  • id • Required uuid
  • is_default_from • Required boolean
  • is_default_to • Required boolean
  • is_residential • Required boolean

    True for a home address. Some carriers charge more for residential delivery.

  • name • Required string
  • nickname • Required string
  • postal_code • Required string

    Postal or ZIP code.

  • state • Required string

    Province or state code, e.g. ON, BC, NY.

  • street • Required string

    Street address.

  • tags • Required array of strings
  • updated_at • Required timestamp

    When it last changed (ISO 8601, UTC).

  • company string

    Company name.

  • email string

    Email address.

  • line2 string

    Apartment, suite or unit.

  • phone string

    Phone number. Carriers need one for the recipient on most international and express services.

• default_to object
  Fields · 18

  • city • Required string

    City.

  • country • Required string

    Two-letter country code, e.g. CA, US.

  • created_at • Required timestamp

    When it was created (ISO 8601, UTC).

  • id • Required uuid
  • is_default_from • Required boolean
  • is_default_to • Required boolean
  • is_residential • Required boolean

    True for a home address. Some carriers charge more for residential delivery.

  • name • Required string
  • nickname • Required string
  • postal_code • Required string

    Postal or ZIP code.

  • state • Required string

    Province or state code, e.g. ON, BC, NY.

  • street • Required string

    Street address.

  • tags • Required array of strings
  • updated_at • Required timestamp

    When it last changed (ISO 8601, UTC).

  • company string

    Company name.

  • email string

    Email address.

  • line2 string

    Apartment, suite or unit.

  • phone string

    Phone number. Carriers need one for the recipient on most international and express services.

1
2

curl "https://api.parcelhub.ca/v1/addresses/defaults" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

{
  "ok": true,
  "data": {
    "default_from": {
      "city": "Toronto",
      "company": "Maple Goods Inc.",
      "country": "CA",
      "created_at": "2026-10-31T15:04:05Z",
      "email": "[email protected]",
      "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
      "is_default_from": false,
      "is_default_to": false,
      "is_residential": false,
      "line2": "Suite 400",
      "name": "Alex Martin",
      "nickname": "string",
      "phone": "+1 416 555 0100",
      "postal_code": "M5V 2T6",
      "state": "ON",
      "street": "123 King St W",
      "tags": [
        "string"
      ],
      "updated_at": "2026-10-31T15:04:05Z"
    },
    "default_to": {
      "city": "Toronto",
      "company": "Maple Goods Inc.",
      "country": "CA",
      "created_at": "2026-10-31T15:04:05Z",
      "email": "[email protected]",
      "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
      "is_default_from": false,
      "is_default_to": false,
      "is_residential": false,
      "line2": "Suite 400",
      "name": "Alex Martin",
      "nickname": "string",
      "phone": "+1 416 555 0100",
      "postal_code": "M5V 2T6",
      "state": "ON",
      "street": "123 King St W",
      "tags": [
        "string"
      ],
      "updated_at": "2026-10-31T15:04:05Z"
    }
  },
  "request_id": "01JBX7Q2…"
}

Address books

GET /v1/addresses/sources

Every address book this account can ship from: the account's own and, for a business account, the person's personal book.

Response in data

• active • Required object
  Fields · 4

  • addresses • Required array of objects
    Each item · 18

    • city • Required string

      City.

    • country • Required string

      Two-letter country code, e.g. CA, US.

    • created_at • Required timestamp

      When it was created (ISO 8601, UTC).

    • id • Required uuid
    • is_default_from • Required boolean
    • is_default_to • Required boolean
    • is_residential • Required boolean

      True for a home address. Some carriers charge more for residential delivery.

    • name • Required string
    • nickname • Required string
    • postal_code • Required string

      Postal or ZIP code.

    • state • Required string

      Province or state code, e.g. ON, BC, NY.

    • street • Required string

      Street address.

    • tags • Required array of strings
    • updated_at • Required timestamp

      When it last changed (ISO 8601, UTC).

    • company string

      Company name.

    • email string

      Email address.

    • line2 string

      Apartment, suite or unit.

    • phone string

      Phone number. Carriers need one for the recipient on most international and express services.

  • is_personal • Required boolean
  • name • Required string
  • organization_id • Required uuid
• business_address_id uuid
• personal object
  Fields · 4

  • addresses • Required array of objects
    Each item · 18

    • city • Required string

      City.

    • country • Required string

      Two-letter country code, e.g. CA, US.

    • created_at • Required timestamp

      When it was created (ISO 8601, UTC).

    • id • Required uuid
    • is_default_from • Required boolean
    • is_default_to • Required boolean
    • is_residential • Required boolean

      True for a home address. Some carriers charge more for residential delivery.

    • name • Required string
    • nickname • Required string
    • postal_code • Required string

      Postal or ZIP code.

    • state • Required string

      Province or state code, e.g. ON, BC, NY.

    • street • Required string

      Street address.

    • tags • Required array of strings
    • updated_at • Required timestamp

      When it last changed (ISO 8601, UTC).

    • company string

      Company name.

    • email string

      Email address.

    • line2 string

      Apartment, suite or unit.

    • phone string

      Phone number. Carriers need one for the recipient on most international and express services.

  • is_personal • Required boolean
  • name • Required string
  • organization_id • Required uuid

1
2

curl "https://api.parcelhub.ca/v1/addresses/sources" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

{
  "ok": true,
  "data": {
    "active": {
      "addresses": [
        {
          "city": "Toronto",
          "company": "Maple Goods Inc.",
          "country": "CA",
          "created_at": "2026-10-31T15:04:05Z",
          "email": "[email protected]",
          "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
          "is_default_from": false,
          "is_default_to": false,
          "is_residential": false,
          "line2": "Suite 400",
          "name": "Alex Martin",
          "nickname": "string",
          "phone": "+1 416 555 0100",
          "postal_code": "M5V 2T6",
          "state": "ON",
          "street": "123 King St W",
          "tags": [
            "string"
          ],
          "updated_at": "2026-10-31T15:04:05Z"
        }
      ],
      "is_personal": false,
      "name": "Alex Martin",
      "organization_id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f"
    },
    "business_address_id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
    "personal": {
      "addresses": [
        {
          "city": "Toronto",
          "company": "Maple Goods Inc.",
          "country": "CA",
          "created_at": "2026-10-31T15:04:05Z",
          "email": "[email protected]",
          "id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f",
          "is_default_from": false,
          "is_default_to": false,
          "is_residential": false,
          "line2": "Suite 400",
          "name": "Alex Martin",
          "nickname": "string",
          "phone": "+1 416 555 0100",
          "postal_code": "M5V 2T6",
          "state": "ON",
          "street": "123 King St W",
          "tags": [
            "string"
          ],
          "updated_at": "2026-10-31T15:04:05Z"
        }
      ],
      "is_personal": false,
      "name": "Alex Martin",
      "organization_id": "3f2b8c1e-5d6a-4b7c-9e0f-1a2b3c4d5e6f"
    }
  },
  "request_id": "01JBX7Q2…"
}