---
title: "GET /openapi/{version}/shipping/pickup-locations/"
method: GET
path: "/openapi/{version}/shipping/pickup-locations/"
tags: ["Shipping (Separate Service)"]
---

# GET /openapi/{version}/shipping/pickup-locations/

`GET /openapi/{version}/shipping/pickup-locations/`

## Request

- Base URL: `https://base_url`
- URL: `https://base_url/openapi/{version}/shipping/pickup-locations/`
- Auth: none declared

The pickup location is where the carrier collects the parcel, typically your warehouse, store, or the place where orders are packed.

## Path parameters

- `version` string, required

## Query parameters

- `known_as` string
- `limit` integer
- `offset` integer
- `search` string

## Response `200`

Successfully retrieved the pickup locations

- EnvelopedCarrierPickupLocationV2
  - `success` boolean
  - `data` CarrierPickupLocationSerializerV2, required
    - `known_as` string, nullable
    - `id` integer, required
    - `address` PickupLocationAddressSerializerV2, required
      - `first_name` string, required
      - `last_name` string
      - `address_line1` string, required
      - `address_line2` string, nullable
      - `address_line3` string, nullable
      - `city` string, required
      - `state` string, required
      - `country` 'Philippines' | 'Australia' | 'Thailand' | 'Singapore' | 'Malaysia' | 'Hong Kong' | 'Indonesia' | 'United Arab Emirates' | 'United States' | 'Saudi Arabia' | 'Canada' | 'Bahrain' | 'Kuwait' | 'Oman' | 'Qatar', required: * `Philippines` - Philippines * `Australia` - Australia * `Thailand` - Thailand * `Singapore` - Singapore * `Malaysia` - Malaysia * `Hong Kong` - Hong Kong * `Indonesia` - Indonesia * `United Arab Emirates` - United Arab Emirates * `United States` - United States * `Saudi Arabia` - Saudi Arabia * `Canada` - Canada * `Bahrain` - Bahrain * `Kuwait` - Kuwait * `Oman` - Oman * `Qatar` - Qatar
      - `barangay` string, nullable
      - `suburb` string, nullable
      - `customs_code` string, nullable: Customs code for the address
      - `zipcode` string, required
      - `phone` string, required
      - `email` string
      - `latitude` string, decimal, nullable
      - `longitude` string, decimal, nullable
      - `id` integer, required
    - `default` boolean: If true, This will be the default pickup location for the brand and other pickup locations will be set to false
  - `message` string, required

## Other responses

- `400`: Bad Request - Invalid input.
- `401`: Unauthorized - Invalid or expired credentials.
- `403`: Forbidden - You do not have permission to access this resource.
- `404`: Not Found - The requested resource does not exist.
- `500`: Internal Server Error - Unexpected error occurred.

---

[API](https://skmtc.dev/golocad/apis/locad-api.md) - [All operations](https://skmtc.dev/golocad/apis/locad-api/llms.txt) - [OpenAPI document](https://skmtc.dev/golocad/apis/locad-api/revisions/428200f33a81?raw)
