Skip to main content

Addresses and quotes, and hold_reason on ACCOUNT_ON_HOLD

Reeds Engineering
Reeds Engineering
Developer platform

How the address and quote endpoints behave in v1, in Test and Live mode.

Addresses​

  • POST /addresses resolves an address from a place_id, your latitude and longitude, or the text. A precise place or your coordinates are verified; an area, a whole road, or a text match that is only approximate is needs_confirmation with Reeds' suggestion. match.confidence is exact, approximate, none or confirmed.
  • Saving the same place with the same contact again returns the existing address as it is. Use PATCH /addresses/{id} to change its contact, notes or metadata; sending address, place_id, latitude or longitude there is 422 INVALID_REQUEST.
  • An address placed from your coordinates has location.place_id: null.
  • POST /addresses/{id}/confirm takes exactly one of accept_suggestion: true, a place_id, or latitude and longitude, and sends the address.confirmed webhook. An address that is already verified gets 409 ACTION_NOT_ALLOWED.
  • DELETE /addresses/{id} expires the address's unused quotes at once, and is refused with 409 ADDRESS_IN_USE while a draft uses it.
  • GET /addresses lists saved addresses only; addresses saved inline by POST /quotes are not listed (read them by id), and are deleted 30 days after their last use if no delivery was made from them.
  • metadata takes up to 20 keys of up to 40 characters, with string values of up to 500.

Quotes​

  • POST /quotes returns 201 with a qt_ quote that lasts 24 hours and books one delivery, or 200 with available: false and a reason when Reeds can't serve the route. When Reeds can't measure the route at all, it is 503 SERVICE_UNAVAILABLE: retry shortly.
  • pickup_date is Lagos today up to 7 days ahead; outside that range is 422 PICKUP_DATE_OUT_OF_RANGE, with the field in error.fields. The quote's schedule counts from that day.

ACCOUNT_ON_HOLD​

ACCOUNT_ON_HOLD now documents error.hold_reason: overdue_invoice (pay the overdue invoice) or reeds (contact Reeds). Branch on it, not on the message.

Nothing is removed or renamed. Clients that ignore unknown fields need no change.