Skip to main content

Quickstart

Base URL​

Your Fieldkit onboarding will provide your base URL (sandbox and production).

Production:

https://api.fieldkit.cc

Authenticate​

All Public API requests require:

  • X-Public-API-Key: <your_key>

OAuth bearer tokens are also supported:

  • Authorization: Bearer <access_token>

1) List Products​

curl -sS \
  -H "X-Public-API-Key: $FIELDKIT_PUBLIC_API_KEY" \
  "https://api.fieldkit.cc/public/v1/products"

2) Create A Quote​

POST /public/v1/quotes requires an Idempotency-Key header.

curl -sS \
  -X POST \
  -H "X-Public-API-Key: $FIELDKIT_PUBLIC_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"product_id":"stickers","quantity":250}' \
  "https://api.fieldkit.cc/public/v1/quotes"

3) Fetch A Quote​

curl -sS \
  -H "X-Public-API-Key: $FIELDKIT_PUBLIC_API_KEY" \
  "https://api.fieldkit.cc/public/v1/quotes/<quote_id>"

4) Create An Order​

Convert your quote into an order:

curl -sS \
  -X POST \
  -H "X-Public-API-Key: $FIELDKIT_PUBLIC_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"quote_id":"<quote_id>","ship_to":{"name":"Ada Lovelace","company":"Example Co","line1":"123 Main St","city":"San Francisco","state":"CA","postal_code":"94105","country":"US"}}' \
  "https://api.fieldkit.cc/public/v1/orders"

Need Help?​

Include the request_id from the error response (or the X-Request-Id header) when contacting support.