Sign up a buyer
Sign up a buyer so you can quote them.
The buyer is connected to you and emailed a way to sign in. What you send, and what happens, depends on the email address:
- New to CoverPort: send
email,firstNameandlastName. We create their account and email them a temporary password. Response:201. - Already has a CoverPort account: send
email. We connect them to you and email them that they can now buy from you. Response:200. - New, but you didn't send a name: nothing is created. Response:
422witherror.codename_required. Ask for their name and try again.
Good to know
- This sends email, so call it once per sign-up. To look a buyer up, use
GET /buyers. Send anIdempotency-Keyso a retry cannot email twice. - Each key can sign up 30 buyers an hour and 100 a day. Over that, you get
429witherror.codesignup_limitand aRetry-Afterheader.
Authorization
SecretKey Your secret API key from the developer portal (API Keys). Keep it on your server: never put it in browser or mobile code.
In: header
Header Parameters
The API version you built against, as a date. Send it on every request. Without it you get the oldest
version still supported. An unknown version is 400 unsupported_version.
"2026-11-20"Value in
- "2026-11-20"
Any unique string up to 255 characters (a UUID, or your order id), no spaces. A retry with the same key and the
same body within 24 hours gets the first answer back, with Idempotent-Replayed: true, and nothing is done twice.
The same key with a different body is 422 idempotency_key_reused; while the first request is still running it
is 409 idempotency_in_progress. After a 4xx nothing was done and the key is free for a corrected retry. After
a 5xx or no answer the request may have been done, so the key answers 409 idempotency_outcome_unknown:
check, then use a new key.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/buyers" \ -H "Content-Type: application/json" \ -d '{ "email": "dispatch@acme-freight.com", "firstName": "Dana", "lastName": "Reyes" }'{ "id": "9f1c4e2a-3b7d-4c1e-8f2a-5d6b7c8e9f01", "email": "dispatch@acme-freight.com", "firstName": "Dana", "lastName": "Reyes", "created": false}Find a buyer by email GET
Look up a buyer you've already signed up, by their email. Safe to call at any time: it never changes anything or sends email. **What you get back** - The buyer, if you've signed them up. - An empty list if you haven't. The person may still have a CoverPort account through someone else. To sign them up with you, use `POST /buyers`.
Get a product, with a quote template GET
Get one product, with a quote request ready for you to fill in. You get everything from the product list, plus `quoteTemplate`: a complete request body for `POST /quotes`. **To quote this product** 1. Take `quoteTemplate` from the response. 2. Fill in each answer's `value`. Answers marked `required: true` can't be left blank. 3. Set `startDate`, and `units`: the number of days or trips to cover (the product's `unit` says which). 4. Send it to `POST /quotes`. You can leave the `question` and `required` fields in the template when you send it back; they're ignored.