POST
/api/rest/get/price
Get shipping price estimate
▶
POST
https://api.carlink.pro/api/rest/get/price
Request Body (JSON)
| Field | Type | Description |
|---|---|---|
| lpKey | string | API Key |
| pickupZip | string | Pickup ZIP code |
| dropoffZip | string | Dropoff ZIP code |
| estimatedShipDate | string | Format: mm/dd/yyyy |
| vehicleType | string | Car, SUV, Pickup |
| shipViaId | string | 1 = Open, 2 = Enclosed |
| vehicleRuns | string | 1 = Yes, 0 = No |
Test Request
Sending...
Request
Response
POST
/api/rest/get/lead
Get lead information
▶
POST
https://api.carlink.pro/api/rest/get/lead
Request Body (JSON)
| Field | Type | Description |
|---|---|---|
| api_key required | string | Your API key |
| record required | string | Lead record ID |
Test Request
Sending...
Request
Response
POST
/api/rest/post/lead
Create / update lead
▶
POST
https://api.carlink.pro/api/rest/post/lead
Request Body (JSON)
| Field | Type | Description |
|---|---|---|
| api_key required | string | Your API key |
| id | string | Lead ID (for update) |
| first_name required | string | Customer first name |
| last_name | string | Customer last name |
| phone | string | Phone number |
| string | Email address | |
| company_name | string | Company name |
| billing_address | string | Billing address |
| phone_fax | string | Fax number |
| phone_2 | string | Alt phone number |
| pickup_* | string | address, city, state, zip, country, contact, phone, phone_cell, buyer_number, company_name |
| dropoff_* | string | address, city, state, zip, country, contact, phone, phone_cell, buyer_number, company_name |
| estimated_ship_date | string | Estimated ship date |
| estimated_load_date | string | Estimated load date |
| estimated_delivery_date | string | Estimated delivery date |
| first_pickup_date | string | First pickup date |
| vehicles | string | Vehicles info |
| ship_via_id | string | 1 = Open, 2 = Enclosed |
| vehicle_runs | string | 1 = Yes, 0 = No |
| price_total_total | string | Total price |
| price_deposit_total | string | Deposit amount |
| price_carrier_total | string | Carrier pay |
Test Request
Pickup Information
Dropoff Information
Shipping Details
Pricing
Additional
Sending...
Request
Response
POST
/api/rest/post/cc
Submit credit card info
▶
POST
https://api.carlink.pro/api/rest/post/cc
Request Body (JSON)
| Field | Type | Description |
|---|---|---|
| apiKey | string | Your API key |
| id | string (uuid) | Lead ID |
| ccNumber | string | Card number |
| ccDate | string | Expiration date (MM/YY) |
| ccCvv | string | CVV code |
| ccZip | string | Billing ZIP code |
| ccFirstName | string | Cardholder first name |
| ccLastName | string | Cardholder last name |
| ccAddress | string | Billing address |
| ccCity | string | Billing city |
| ccState | string | Billing state |
Test Request
Sending...
Request
Response