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_accountand 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_locationoptions. Refer to the below carrier-allowed pickup_location list.

FedEx

UPS

Purolator

Updated on: 06/01/2025