How to use AfterShip Shipping Pickup API

Overview

With the AfterShip Shipping Pickup API, you can easily schedule on-call pickups with your carrier for your existing shipments.

We support two key use cases to make shipping and pickup arrangements more efficient and convenient.

1. Labels are created with AfterShip Shipping

Use label_ids to arrange pickup. Refer to the below request.

{
  "pickup_date": "2023-09-21",
  "pickup_start_time": "09:00:00",
  "pickup_end_time": "18:00:00",
  "pickup_from": {
    "contact_name": "AfterShip Shipping",
    "company_name": "AfterShip Shipping",
    "street1": "230 W 200 S LBBY",
    "city": "Salt Lake City",
    "state": "UT",
    "postal_code": "84101",
    "country": "USA",
    "phone": "123456789",
    "email": "test@test.com"
  },
  "label_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "pickup_instructions": "instructions"
}

2. Labels are not created with AfterShip Shipping

Use the `shipper_account`and pickup_parcels to specify the carrier and parcel details to arrange pickup. Refer to the below request.

{
    "pickup_date": "2023-09-21",
    "pickup_start_time": "09:00:00",
    "pickup_end_time": "18:00:00",
    "pickup_from": {
        "contact_name": "AfterShip Shipping",
        "company_name": "AfterShip Shipping",
        "street1": "230 W 200 S LBBY",
        "city": "Salt Lake City",
        "state": "UT",
        "postal_code": "84101",
        "country": "USA",
        "phone": "123456789",
        "email": "test@test.com"
    },
    "pickup_location": "APARTMENT_FRONT",
    "pickup_parcels": [
        {
            "weight": {
                "unit": "kg",
                "value": 1
            },
            "quantity": 1
        }
    ],
    "shipper_account": {
        "id": "00000000-0000-0000-0000-000000000000"
    },
    "pickup_instructions": "instructions"
}

Tips

1. ship_to

ship_to address information is required for international shipments.

If ship_to is not present, it's considered as a domestic shipment pickup.

2. pickup_location

Each carrier has its own `pickup_location`options. Refer to the below carrier-allowed pickup_location list.

FedEx

FedEx
APARTMENT_FRONT
APARTMENT_NONE
APARTMENT_SIDE
APARTMENT_REAR
BUILDING_FRONT
BUILDING_NONE
BUILDING_SIDE
BUILDING_REAR
DEPARTMENT_FRONT
DEPARTMENT_NONE
DEPARTMENT_SIDE
DEPARTMENT_REAR
FLOOR_FRONT
FLOOR_NONE
FLOOR_SIDE
FLOOR_REAR
ROOM_FRONT
ROOM_NONE
ROOM_SIDE
ROOM_REAR
SUITE_FRONT
SUITE_NONE
SUITE_SIDE
SUITE_REAR

UPS

UPS
Front Door
Back Door
Side Door
Shipping
Receiving
Reception
Office
Mail Room
Garage
Upstairs
Downstairs
Guard Room
Third Party
Warehouse

Purolator

Purolator
BackDoor
Basement
BetweenDoors
Counter
Desk
FrontDesk
FrontDoor
FrontPorch
Garage
GateHouse
Kiosk Lab
LoadingDock
Lobby
Mailbox
MailRoom
Office
OutsideDoor
PartsDepartment
Pharmacy
ProShop
Receiving
Reception
Security
ServiceCounter
Shipping
SideDoor
Switchboard Vault Warehouse

Updated on: 06/01/2025