Skip to main content

Orders

Create Order​

Convert a quote into an order.

POST /public/v1/orders

Headers:

  • X-Public-API-Key: <key> (or Authorization: Bearer <token>)
  • Idempotency-Key: <uuid>

Body:

{
  "quote_id": "<quote_id>",
  "ship_to": {
    "name": "Ada Lovelace",
    "company": "Example Co",
    "line1": "123 Main St",
    "line2": null,
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US",
    "phone": "+14155551212",
    "email": "ada@example.com"
  }
}

Notes:

  • quote_id is required.
  • ship_to is optional if the quote already has a shipping address. If the quote does not have ship_to, you must provide it here.

Example:

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"

Response:

{
  "id": "7e7a1d1e-9c1a-4fef-b1f9-9c9a0e6d5f20",
  "quote_id": "6e6d1c7a-8b0a-4a73-9e3a-0f24b1e6d7c0",
  "order_number": "SO-100001",
  "status": "received",
  "created_at": "2026-02-09T19:12:34.567Z",
  "pricing": {
    "subtotal": 10.0,
    "tax": 0.0,
    "shipping": 0.0,
    "total": 10.0,
    "currency": "usd",
    "line_items": []
  },
  "ship_to": {
    "name": "Ada Lovelace",
    "company": "Example Co",
    "line1": "123 Main St",
    "line2": null,
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US",
    "phone": null,
    "email": null
  }
}

Order Status​

Public API v1 returns simplified order statuses:

  • received
  • in_review
  • in_production
  • shipped
  • completed
  • cancelled

Get Order​

GET /public/v1/orders/{order_id}

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

List Shipments​

GET /public/v1/orders/{order_id}/shipments

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

Response:

[
  {
    "id": "d4f7a9f2-1c5b-4f2b-b6b8-447f2d55c7de",
    "carrier": "UPS",
    "service": "Ground",
    "tracking_number": "1Z9999999999999999",
    "tracking_url": "https://www.ups.com/track?...",
    "status": "shipped",
    "ship_date": "2026-02-09",
    "in_hand_date": "2026-02-12"
  }
]