SEND Packages API

curl -X POST https://api.trysend.com/v1/parcel-customers \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "parcel_customer": {
    "address_suffix": "ACME-001"
  }
}'

{
  "status": "string",
  "message": "string",
  "data": {
    "parcel_customer_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "mobile": "string",
    "address_suffix": "string",
    "full_name": "string",
    "status": "active",
    "mode": "test",
    "origin_address": "string",
    "origin_city": "string",
    "origin_zip_code": "string",
    "origin_state": "string",
    "origin_country": "string",
    "created_at": "2024-01-15T09:30:00Z"
  }
}

Create a new parcel customer (sender profile) for the authenticated business.

Dedup behavior

If address_suffix is provided and a customer with that suffix already exists for this business+mode, returns the existing customer with 200.
If address_suffix is omitted, deduplicates by mobile/email match.

Auto-generation

When address_suffix is omitted, one is auto-generated using your business prefix (e.g. PQSFX-042).

Pickup address

If any sender detail is provided (first_name, email, mobile, origin_*), then origin_address, origin_city, origin_state, and origin_country must all be present.

Create a new parcel customer (sender profile) for the authenticated business. ### Dedup behavior - If `address_suffix` is provided and a customer with that suffix already exists for this business+mode, returns the existing customer with `200`. - If `address_suffix` is omitted, deduplicates by `mobile`/`email` match. ### Auto-generation When `address_suffix` is omitted, one is auto-generated using your business prefix (e.g. `PQSFX-042`). ### Pickup address If any sender detail is provided (`first_name`, `email`, `mobile`, `origin_*`), then `origin_address`, `origin_city`, `origin_state`, and `origin_country` must all be present.

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

parcel_customerobjectRequired

Response

Already exists (dedup by address_suffix or contact)

statusstringOptional

messagestringOptional

dataobjectOptional

Sender profile for a parcel customer. Reusable across quotes and bookings.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error