Creating Orders with Gate Pass

Attach gate pass documents to vehicles when creating an order, with or without a quote.

Builds on: Creating Orders with a Quote. Gate passes can also be used with direct orders (without a quote). Customer identification follows the same billing rules as Creating Orders.

Gate Pass Options

Each vehicle supports one of two gate pass methods. You cannot provide both for the same vehicle.

Field	Type	Description
gate_pass	URL	A publicly accessible HTTP/HTTPS URL pointing to the gate pass file. The system will download the file.
gate_pass_base64	string	Base64-encoded file content of the gate pass document.

File Requirements

Requirement	Value
Maximum file size	5 MB
Allowed file types (URL)	jpg, jpeg, png, pdf, bin, heic, docx, doc
Allowed file types (base64)	jpg, jpeg, png, pdf, bin, heic, heif, docx, doc
URL download timeout	5 seconds (no redirects)

With a Quote

When using a quote_id, gate pass fields are the only vehicle fields you can include. The vehicles array must have the same count as the quote's vehicles.

This example bills an external party using customer_id. To bill your own account, use top-level provider_id instead. See Choosing the right field.

POST /api/orders
Content-Type: application/json
Authorization: Bearer your-api-token

{
  "customer_id": "a1b2c3d4e5f6",
  "quote_id": "q7k3m9x2n4p1q",
  "price_option": "economy",
  "origin": {
    "type": "auction",
    "name": "Atlanta Auto Auction",
    "address": "789 Auction Lane",
    "city": "Atlanta",
    "state": "GA",
    "postal_code": "30301",
    "contact_name": "Front Desk",
    "contact_phone": "+14045550000"
  },
  "destination": {
    "type": "dealer",
    "name": "Miami Motors",
    "address": "321 Beach Blvd",
    "city": "Miami",
    "state": "FL",
    "postal_code": "33101",
    "contact_name": "Sales Dept",
    "contact_phone": "+13055550000"
  },
  "vehicles": [
    {
      "gate_pass": "https://example.com/documents/gate-pass-vehicle-1.pdf"
    }
  ]
}

Without a Quote (Direct Order)

When creating an order without a quote, include the gate pass alongside the full vehicle details.

{
  "vehicles": [
    {
      "vehicle_type": "car",
      "year": 2024,
      "make": "Honda",
      "model": "Accord",
      "vin": "1HGBH41JXMN109186",
      "operable": true,
      "gate_pass": "https://example.com/gate-pass.pdf"
    }
  ]
}

Using Base64

If the gate pass file is not hosted at a URL, encode it as base64:

{
  "vehicles": [
    {
      "gate_pass_base64": "JVBERi0xLjQKMSAwIG9iago8PAovVHlwZSAv..."
    }
  ]
}

Important: You cannot provide both gate_pass and gate_pass_base64 for the same vehicle. The request will be rejected.

Common Errors

Error	Cause
Both gate_pass and gate_pass_base64 provided	Only one method per vehicle is allowed.
File exceeds 5 MB	Reduce file size or compress before upload.
Unsupported file type	Use one of the supported formats listed above.
URL not reachable	The gate_pass URL must be publicly accessible and respond within 5 seconds.

Next Steps

→ Set up webhooks to receive real-time order and vehicle status updates