API ReferencePickupsList pickup addresses

List pickup addresses

GET/api/v1/pickups/addresses

The pickup addresses on file, default first. Not paginated. With a live key, an account that has not switched to multiple pickup addresses yet gets an empty data and its single address in legacy_default_address. A test key lists its own separate sandbox addresses, and legacy_default_address is always null there. Requires scope pickups:read.

Parameters

No parameters.

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "data": [
      {
        "address_id": "6710a1b2c3d4e5f607182940",
        "alias": "API 7f3a91c2",
        "source": "custom",
        "is_default": true,
        "revision": 1,
        "resolved_version": "9d1f4c6a2b8e3057a1c94d2e6f70b3185a2c9e4d7f6018b3c5a2e9d4f1b70c63",
        "address": {
          "country": "HK",
          "name": "Chan Tai Man",
          "company": "Example Trading Ltd",
          "email": "ops@example.com",
          "phone": "+85291234567",
          "address_line1": "Unit 1203, 12/F, Tower 2, Kowloon Commerce Centre, 51 Kwai Cheong Road",
          "city": "Hong Kong",
          "district": "Kwai Chung"
        },
        "livemode": false
      }
    ],
    "legacy_default_address": null
  }
}

Returned object

Field	Type	Sample
status	number	200
message	string	OK
data	object	{2 keys}

{ "status": 200, "message": "OK", "data": { "data": [ { "address_id": "6710a1b2c3d4e5f607182940", "alias": "API 7f3a91c2", "source": "custom", "is_default": true, "revision": 1, "resolved_version": "9d1f4c6a2b8e3057a1c94d2e6f70b3185a2c9e4d7f6018b3c5a2e9d4f1b70c63", "address": { "country": "HK", "name": "Chan Tai Man", "company": "Example Trading Ltd", "email": "ops@example.com", "phone": "+85291234567", "address_line1": "Unit 1203, 12/F, Tower 2, Kowloon Commerce Centre, 51 Kwai Cheong Road", "city": "Hong Kong", "district": "Kwai Chung" }, "livemode": false } ], "legacy_default_address": null } }