Lead Source API with pickup windows

This page applies only to editions with the Pickup windows feature. Check your CRM for Settings → Feature Flags with a Pickup windows switch. If that page is not there, your edition takes the single ship_date only, the pickup fields below are silently ignored, and the quote-config endpoint answers 404. Nothing here is required — every pickup field on this page is optional everywhere.

This page is self-contained: it has everything a form of your own needs, from the first request to the customer landing on the booking page. The generic Lead source API reference lists every optional field the save endpoint accepts if you need more than is shown here.

1. Your endpoint URLs

Create a lead source for the form

Settings → Lead Management → Lead sources → + Add new source. Only the name is required. Set Per Lead Price to 0 for your own website. One source per form or page if you want their leads and cost tracked separately.

The Add new source dialog in Settings → Lead Management

Copy its Lead save URL

Back on the Lead sources tab, click the copy icon next to Lead save URL in the URLs column. The tooltip says Copied! — that URL is the whole credential.

Copying the Lead save URL from the URLs column of the Lead sources table

The URL looks like:

https://app.berocker.com/api/v1/auto-logistics/client/webhooks/lead/<your-api-key>/save

The key in the URL is the authentication — there is no separate token. Every endpoint on this page lives under the same prefix; replace the trailing /save with the path shown.

Endpoint	Method	What it does
`…/<key>/quote-config`	GET	Which pickup question this account asks. Call on form load.
`…/<key>/save`	POST	Create the lead. Returns the lead id and the booking link.
`…/<key>/<lead-id>/booking-status`	GET	Whether the automatic quote is ready, plus the booking link again.

Treat the URL like a password. Anyone who has it can create leads in your account. Create one lead source per form or page if you want their leads and cost tracked separately.

2. Ask what to show — `quote-config`

GET /api/v1/auto-logistics/client/webhooks/lead/<api-key>/quote-config

{
  "pickupTimeframes": [
    { "value": "asap",           "label": "As soon as possible", "isDefault": true  },
    { "value": "within_1_week",  "label": "Within 1 week",       "isDefault": false },
    { "value": "within_2_weeks", "label": "Within 2 weeks",      "isDefault": false },
    { "value": "beyond_2_weeks", "label": "More than 2 weeks",   "isDefault": false }
  ],
  "pickupWindow": {
    "earliestDate": "2026-09-16",
    "defaultWindowDays": 1,
    "timezone": "America/New_York"
  }
}

Each key is null when the account does not ask that question, so the rendering rule is simple:

pickupTimeframes is a list → show a dropdown built from it, verbatim. Pre-select the option with isDefault: true. Do not add, rename or reorder options — the values are what pricing keys off, and the labels are what the account configured.
pickupWindow is an object → you may show two date fields. Set the picker’s minimum to earliestDate (today on the account’s own calendar, which may not be today where the visitor is). If you only ask for one date, send it as pickup_window_start and BeRocker adds defaultWindowDays to make the window.
Both are null, or the request fails (including a 404 on an edition without the feature) → show the single pickup date field (ship_date).

The switches behind these are Settings → Feature Flags → Pickup windows and Timeframe pricing (which needs Pickup windows on). They are account-wide, so every form and lead source of one account gets the same answer.

The Settings page with the Finance group showing Pricing, Feature Flags and Pickup SOP — Feature Flags and Pickup SOP live under Finance on the Settings page.

The Feature Flags page with Pickup windows and Timeframe pricing switched on — Both switches on. Timeframe pricing is greyed out until Pickup windows is on.

Render the single date field by default and only swap it out after quote-config answers. A form that waits for this call before rendering anything is blank while the request is slow.

3. Send the lead — `save`

POST /api/v1/auto-logistics/client/webhooks/lead/<api-key>/save
Content-Type: application/json

Required

Field	Type	Notes
`first_name`	string	Must not be empty.
`phone`	string	Any common US format; normalised on arrival.
`vehicles`	array	At least one vehicle (fields below).

Customer and route

Field	Type	Notes
`last_name`, `email`, `additional_phone`	string
`origin_postal_code`, `destination_postal_code`	string	A ZIP on each end is enough — city and state are filled in from it.
`origin_city`, `origin_state`, `destination_city`, `destination_state`	string	Optional when you send ZIPs.
`origin_address`, `destination_address`	string	Full street address if you have it.
`transport_type`	string	`open` (default) or `enclosed`.
`comment_from_shipper`, `customer_comments`	string	Free text from the customer.
`secondary_id`	string	Your own reference — shown as Secondary ID in the CRM.

Each vehicle

Field	Type	Notes
`vehicle_model_year`	integer
`vehicle_make`, `vehicle_model`	string
`vehicle_type`	string	`Car`, `SUV`, `Van`, `Pickup`, `Motorcycle`, `ATV`, `Boat`, `RV`, `Travel Trailer`, `Other`.
`vehicle_inop`	boolean	`true` if the vehicle does not run.
`is_custom`	boolean	`true` for a free-text vehicle that is not in the catalogue. Such leads skip the automatic quote and go to an agent for manual pricing.

Pickup — pick one of the three

Question	Field(s)	Needs	Notes
A single date	`ship_date`	nothing	Always accepted.
A pickup window	`pickup_window_start`, `pickup_window_end`	Pickup windows on	First available day and last promised day, `YYYY-MM-DD`. Also accepted as `pickupWindowStart` / `pickupWindowEnd`. Leave the end out and BeRocker fills in the account’s default window length. The same date twice is a one-day pickup.
A timeframe	`pickup_timeframe`	Timeframe pricing on	One of `asap`, `within_1_week`, `within_2_weeks`, `beyond_2_weeks`. The option’s label (“Within 1 week”) is accepted too, in any case, with spaces or hyphens.

A field whose switch is off is ignored, never rejected, so one form works for every account. When a window is recorded it becomes the lead’s pickup window — the same thing a rep enters on Add Shipment or the customer picks on the booking page — it is logged on the lead as set by the customer, and ship_date is set to the window’s first day. A timeframe is recorded as what the customer chose, and the deposit is quoted from that timeframe’s own schedule in Pricing — sooner costs more, the carrier’s pay is the same either way.

Window rules

A window is checked before the lead is created, so a broken date picker cannot fill your CRM:

Rule	Error field
Both dates today or later on the account’s calendar	the offending date
End on or after the start	`pickup_window_end`
An end needs a start	`pickup_window_start`
A value that is not a date	the offending date

Any breach answers 422 with errors naming the field and a message you can show under it, and no lead is saved. A timeframe that names none of the four options is refused the same way.

If your form shows the timeframe dropdown, treat the selection as required and refuse to submit without one. Never fall back to “as soon as possible” silently — it is the highest deposit, and a customer who did not choose it should not be quoted it.

Examples

With a pickup window:

curl -X POST "https://app.berocker.com/api/v1/auto-logistics/client/webhooks/lead/<api-key>/save" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Dana",
    "last_name": "Reyes",
    "email": "dana@example.com",
    "phone": "3055550101",
    "origin_postal_code": "33101",
    "destination_postal_code": "75201",
    "transport_type": "open",
    "pickup_window_start": "2026-09-23",
    "pickup_window_end": "2026-09-25",
    "secondary_id": "WEB-10482",
    "vehicles": [
      { "vehicle_model_year": 2021, "vehicle_make": "Honda", "vehicle_model": "Civic", "vehicle_type": "Car", "vehicle_inop": false }
    ]
  }'

With a timeframe: send "pickup_timeframe": "within_1_week" instead of the two window fields. With a single date: send "ship_date": "2026-09-23".

4. What comes back — including the booking link

A successful save answers 200 with the lead as created:

{
  "id": 48213,
  "bookingLink": "https://app.berocker.com/booking/…",
  "price": null,
  "deposit": null,
  "pickupTimeframe": null,
  "pickupWindowStart": "2026-09-23",
  "pickupWindowEnd": "2026-09-25",
  "leadProvider": "Main Website",
  "firstName": "Dana",
  "lastName": "Reyes",
  "phone": "3055550101",
  "email": "dana@example.com"
}

Field	Notes
`id`	The lead’s id in BeRocker. Needed for `booking-status`.
`bookingLink`	The customer’s booking page for this lead. Available immediately, even before a price exists.
`price`, `deposit`	Usually `null` right after the save — pricing runs in the background. See the next step.
`pickupTimeframe`	What was recorded, or `null` when none was sent or the account has timeframe pricing off.
`pickupWindowStart`, `pickupWindowEnd`	The recorded window as `YYYY-MM-DD`, or `null` when none was sent or the account has pickup windows off.
`leadProvider`	The name of the lead source the URL belongs to.

null back for a pickup field you sent is how you tell it was dropped rather than saved. A validation failure answers 422:

{ "message": "Validation error", "errors": { "pickup_window_end": "The last pickup date cannot be before the first available date." } }

5. Wait for the price, then send the customer to the booking page

The booking link works straight away, but the automatic quote is computed in the background, so a customer sent there instantly may land on a page with no price yet. To send them with a price on it, poll:

GET /api/v1/auto-logistics/client/webhooks/lead/<api-key>/<lead-id>/booking-status

{ "id": 48213, "price": 1250, "priceReady": true, "priceFailed": false, "manualReview": false, "bookingLink": "https://…" }

Field	Meaning
`priceReady`	A usable price exists. Send the customer to `bookingLink`.
`manualReview`	The lead has a custom vehicle; an agent prices it by hand. Stop polling and show your own “we’ll be in touch with your quote” message.
`priceFailed`	Pricing gave up. Stop polling and show a message.
`bookingLink`	The same link the save returned.

Poll every couple of seconds for up to a minute or so, then give up gracefully — the lead is already in the CRM and assigned either way. On the booking page:

a lead saved with a window opens with that window already filled in;
a lead saved with a timeframe opens on the first available date that timeframe implies (as soon as possible → today, or tomorrow once the account’s day has closed; within 1 week → a week out, and so on — the offsets are set in Settings → Pickup SOP), and the customer confirms real dates there;
a lead saved with a single date opens on it.

Whatever the customer confirms there — dates, signature, payment — flows into the lead exactly as it would for a widget lead.

The Timeframes and Expedite tab of Pickup SOP, with the seed days for each of the four timeframes — Settings → Pickup SOP → Timeframes & Expedite: the seed days behind each timeframe.

Checklist

Copy your Lead save URL

Settings → Lead Management → Lead sources → URLs. One source per form or page if you want them tracked separately.

Turn on the pickup question you want

Settings → Feature Flags: Pickup windows for the two-date question, plus Timeframe pricing for the how-soon question. Then check the per-timeframe deposit schedules in Pricing.

Call quote-config on load

Render the timeframe dropdown, the window fields, or the single date — from the answer, never from an assumption.

Post to /save, keep bookingLink

Handle a 422 by showing the field message and keeping the visitor’s input.

Poll booking-status, then hand off

Send the customer to bookingLink once priceReady is true.

Send one test lead

Use your own name and number, watch it land in Inbox, and open the lead to see the window on it and the history entry saying the customer set it.

Troubleshooting

Symptom	Check
`404` on save	The URL, including the key and the trailing `/save`.
`404` on `quote-config`	Your edition does not have the feature. Show the single date field.
Both `quote-config` keys are `null`	The switches are off in Settings → Feature Flags. Show the single date field.
Window or timeframe `null` in the response	The matching switch is off; the field was ignored on purpose.
`422` naming `pickup_window_start` or `pickup_window_end`	Dates in the past, out of order, an end without a start, or not a date.
`422` naming `pickup_timeframe`	The value names none of the four options. Use the `value` from `quote-config`.
Lead arrives but is not assigned	Distribution quotas are 0, or you are outside shift hours with no fallback.
Nothing arrived at all	Settings → Lead Management → Logs records the raw payload.

Lead source API

Every optional field the save endpoint accepts.

Lead sources

Create the source and get the URL.

Pricing

Deposit schedules, including the per-timeframe ones.

Booking page

Where the customer confirms dates, signs and pays.

Phone, SMS and WhatsApp

Email

Load boards

Payments

Leads and AI

1. Your endpoint URLs

2. Ask what to show — `quote-config`

3. Send the lead — `save`

Required

Customer and route

Each vehicle

Pickup — pick one of the three

Window rules

Examples

4. What comes back — including the booking link

5. Wait for the price, then send the customer to the booking page

Checklist

Troubleshooting

Lead source API

Lead sources

Pricing

Booking page

​1. Your endpoint URLs

​2. Ask what to show — quote-config

​3. Send the lead — save

​Required

​Customer and route

​Each vehicle

​Pickup — pick one of the three

​Window rules

​Examples

​4. What comes back — including the booking link

​5. Wait for the price, then send the customer to the booking page

​Checklist

​Troubleshooting

​Related

Lead source API

Lead sources

Pricing

Booking page

1. Your endpoint URLs

2. Ask what to show — `quote-config`

3. Send the lead — `save`

Required

Customer and route

Each vehicle

Pickup — pick one of the three

Window rules

Examples

4. What comes back — including the booking link

5. Wait for the price, then send the customer to the booking page

Checklist

Troubleshooting

Related