Create an order

post

https://api.clakta.com/v1/orders

Record a new order for a project. The owning project is resolved from the `projectId` field in the request body. Orders count towards your team's monthly order limit.

Projects using the `privacy_friendly` tracking mode must omit every personal field from `customer` and send only `ip` and `userAgent` — the order is then attached to an anonymous visitor derived from a server-computed daily session hash.

Authentication

Send your API key as a bearer token in the Authorization header.

See Authentication for how to create and scope an API key.

Bodyapplication/json

projectIdstringrequired

The project ID (e.g. proj_xxx) or slug that owns the order

orderIdstringrequired

The order ID in your system

platformstringrequired

The platform (e.g. shopify, woocommerce, etc.)

paymentMethodenum<string>required

The payment method

Allowed values:credit_carddebit_cardpixboletopaypalapple_paygoogle_paysamsung_paystripe_link

statusenum<string>required

The status

Allowed values:paidpendingrejectedrefundedcanceled

currencystring | nulloptional

The currency in ISO 4217 format (e.g. USD, BRL, etc.) - defaults to the project currency if not provided

totalPricenumberrequired

The total order price in floating point number (e.g. 10.4 for $10.40)

productsobject[]required

trackingobjectrequired

createdAtdate-time | nulloptional

The order created at, defaults to the current date

approvedDatedate-time | nulloptional

The order approved date

refundedAtdate-time | nulloptional

The order refunded at

customerobjectrequired

The customer

Response

The created order

messagestringrequired

A confirmation message.

dataobjectrequired

Request

curl -X POST "https://api.clakta.com/v1/orders" \
  -H "Authorization: Bearer $CLAKTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "proj_3c17f5a2",
    "orderId": "1042",
    "platform": "shopify",
    "paymentMethod": "credit_card",
    "status": "paid",
    "totalPrice": 10.4,
    "products": [
      {
        "id": "sku-1042",
        "name": "Blue shirt",
        "quantity": 1,
        "price": 10.4
      }
    ],
    "tracking": {
      "clkt": "clkt_7d41e0b9",
      "utm_source": "facebook",
      "utm_medium": "cpc",
      "utm_campaign": "summer-sale",
      "utm_content": "video-a"
    },
    "customer": {
      "name": "John Doe",
      "email": "john.doe@example.com",
      "phone": "+5511999999999",
      "gender": "male",
      "address": {
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "01310-100",
        "country": "br"
      },
      "ip": "203.0.113.42"
    }
  }'

Response

201

{
  "message": "Order created successfully",
  "data": {
    "id": "ord_5b93e17a",
    "projectId": "proj_3c17f5a2",
    "customerId": "cust_8f2a91c4",
    "externalId": "1042",
    "platform": "shopify",
    "paymentMethod": "credit_card",
    "status": "paid",
    "currency": "USD",
    "totalPrice": 1040,
    "products": [
      {
        "id": "prod_44c1e8b0",
        "name": "Blue shirt",
        "quantity": 1,
        "price": 1040
      }
    ],
    "tracking": {
      "clkt": "clkt_7d41e0b9",
      "utm_source": "facebook",
      "utm_medium": "cpc",
      "utm_campaign": "summer-sale",
      "utm_content": "video-a",
      "domain": null,
      "sessionId": null
    },
    "adPlatform": "meta",
    "campaignId": "120210000000000000",
    "adSetId": "120210000000000001",
    "adId": "120210000000000002",
    "createdAt": "2026-01-30T12:00:00.000Z",
    "updatedAt": "2026-01-30T12:04:21.000Z",
    "approvedDate": "2026-01-30T12:04:21.000Z",
    "refundedAt": null
  }
}