Customers and Addresses

Sender and recipient are supplied at booking, not quoting.

Sender — always an existing customer

The sender is required and is always an existing parcel customer:

  • Pick the customer by unique ID (address_suffix, e.g. YSDX-UGTE-1234).
  • Name, phone, and address come from the stored profile — there is nothing else to fill.
  • Create the customer first if they do not exist yet.

Recipient — same as sender, or manual

Either:

  • tick Recipient is the same as sender — the sender’s customer is reused; or
  • enter details manually: name, phone, and address (street, city, country required; state/postal_code and email optional).

recipient is required when customer_as_recipient is omitted or false. Set customer_as_recipient: true with sender.customer_id only when that same customer is receiving the shipment. In that case, omit recipient because the backend loads the customer’s saved name, phone, email, and address and stores them in the booking’s recipient snapshot. The response still includes recipient. A complete customer profile in your account and API mode is required; no recipient details are guessed. Do not send non-empty recipient details together with the flag; this returns 422 INVALID_PARTY to avoid conflicting instructions.

Rules

  • Email is optional.
  • Customer IDs must resolve within your account and environment; unknown IDs are rejected.
  • The selected sender must have a complete stored profile (name, phone, address). Incomplete profiles produce a specific validation error — complete the customer record or pick another.
  • Manual recipient details apply to this booking only.
  • The booked quote stores a snapshot of the resolved party details.