Orders

Create order

Creates a new order.

POSThttps://api.cevoid.com/v2/orders

Request

curl -X POST 'https://api.cevoid.com/v2/orders' \
  -H "Authorization: Bearer ${CEVOID_API_KEY}" \
  -H 'idempotency-key: 01J3RZ0D4Q6J9T1R8M6E2P7W8X' \
  -H 'Content-Type: application/json' \
  -d '{
  "ingestion_mode": "live",
  "source_connection_id": "erp-production",
  "external_order_id": "order_123",
  "order_number": "#1001",
  "domain": "shop.example.com",
  "buyer": {
    "email": "buyer@example.com",
    "external_customer_id": "customer_123"
  },
  "placed_at": "2026-07-24T09:00:00.000Z",
  "currency": "USD",
  "money": {
    "sub_total": 50,
    "discount": 5,
    "tax": 5,
    "shipping": 5,
    "total": 55,
    "refunded": 0
  },
  "fulfillment_status": "PENDING",
  "financial_status": "PAID",
  "paid_at": "2026-07-24T09:00:01.000Z",
  "cancelled": false,
  "lines": [
    {
      "external_line_id": "line_1",
      "product_id": "product_123",
      "variant_id": "variant_456",
      "sku": "TSHIRT-BLACK-M",
      "quantity": 1,
      "unit_price": 50,
      "discount": 0,
      "refund": 0,
      "returned_units": 0,
      "fulfillment_status": "PENDING"
    }
  ]
}'

Show all 43 linesShow fewer lines

fetch("https://api.cevoid.com/v2/orders", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
    "idempotency-key": "01J3RZ0D4Q6J9T1R8M6E2P7W8X",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    ingestion_mode: "live",
    source_connection_id: "erp-production",
    external_order_id: "order_123",
    order_number: "#1001",
    domain: "shop.example.com",
    buyer: {
      email: "buyer@example.com",
      external_customer_id: "customer_123",
    },
    placed_at: "2026-07-24T09:00:00.000Z",
    currency: "USD",
    money: {
      sub_total: 50,
      discount: 5,
      tax: 5,
      shipping: 5,
      total: 55,
      refunded: 0,
    },
    fulfillment_status: "PENDING",
    financial_status: "PAID",
    paid_at: "2026-07-24T09:00:01.000Z",
    cancelled: false,
    lines: [
      {
        external_line_id: "line_1",
        product_id: "product_123",
        variant_id: "variant_456",
        sku: "TSHIRT-BLACK-M",
        quantity: 1,
        unit_price: 50,
        discount: 0,
        refund: 0,
        returned_units: 0,
        fulfillment_status: "PENDING",
      },
    ],
  }),
})
  .then((response) => response.json())
  .then((data) => console.log(data))

Show all 49 linesShow fewer lines

const response = await fetch("https://api.cevoid.com/v2/orders", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
    "idempotency-key": "01J3RZ0D4Q6J9T1R8M6E2P7W8X",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    ingestion_mode: "live",
    source_connection_id: "erp-production",
    external_order_id: "order_123",
    order_number: "#1001",
    domain: "shop.example.com",
    buyer: {
      email: "buyer@example.com",
      external_customer_id: "customer_123",
    },
    placed_at: "2026-07-24T09:00:00.000Z",
    currency: "USD",
    money: {
      sub_total: 50,
      discount: 5,
      tax: 5,
      shipping: 5,
      total: 55,
      refunded: 0,
    },
    fulfillment_status: "PENDING",
    financial_status: "PAID",
    paid_at: "2026-07-24T09:00:01.000Z",
    cancelled: false,
    lines: [
      {
        external_line_id: "line_1",
        product_id: "product_123",
        variant_id: "variant_456",
        sku: "TSHIRT-BLACK-M",
        quantity: 1,
        unit_price: 50,
        discount: 0,
        refund: 0,
        returned_units: 0,
        fulfillment_status: "PENDING",
      },
    ],
  }),
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

Show all 50 linesShow fewer lines

import os

import requests

response = requests.post(
    "https://api.cevoid.com/v2/orders",
    headers={
        "Authorization": f"Bearer {os.environ['CEVOID_API_KEY']}",
        "idempotency-key": "01J3RZ0D4Q6J9T1R8M6E2P7W8X",
    },
    json={
        "ingestion_mode": "live",
        "source_connection_id": "erp-production",
        "external_order_id": "order_123",
        "order_number": "#1001",
        "domain": "shop.example.com",
        "buyer": {
            "email": "buyer@example.com",
            "external_customer_id": "customer_123",
        },
        "placed_at": "2026-07-24T09:00:00.000Z",
        "currency": "USD",
        "money": {
            "sub_total": 50,
            "discount": 5,
            "tax": 5,
            "shipping": 5,
            "total": 55,
            "refunded": 0,
        },
        "fulfillment_status": "PENDING",
        "financial_status": "PAID",
        "paid_at": "2026-07-24T09:00:01.000Z",
        "cancelled": False,
        "lines": [
            {
                "external_line_id": "line_1",
                "product_id": "product_123",
                "variant_id": "variant_456",
                "sku": "TSHIRT-BLACK-M",
                "quantity": 1,
                "unit_price": 50,
                "discount": 0,
                "refund": 0,
                "returned_units": 0,
                "fulfillment_status": "PENDING",
            },
        ],
    },
)
response.raise_for_status()
print(response.json())

Show all 52 linesShow fewer lines

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.cevoid.com/v2/orders',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('CEVOID_API_KEY'),
    'idempotency-key: 01J3RZ0D4Q6J9T1R8M6E2P7W8X',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode([
    'ingestion_mode' => 'live',
    'source_connection_id' => 'erp-production',
    'external_order_id' => 'order_123',
    'order_number' => '#1001',
    'domain' => 'shop.example.com',
    'buyer' => [
      'email' => 'buyer@example.com',
      'external_customer_id' => 'customer_123',
    ],
    'placed_at' => '2026-07-24T09:00:00.000Z',
    'currency' => 'USD',
    'money' => [
      'sub_total' => 50,
      'discount' => 5,
      'tax' => 5,
      'shipping' => 5,
      'total' => 55,
      'refunded' => 0,
    ],
    'fulfillment_status' => 'PENDING',
    'financial_status' => 'PAID',
    'paid_at' => '2026-07-24T09:00:01.000Z',
    'cancelled' => false,
    'lines' => [
      [
        'external_line_id' => 'line_1',
        'product_id' => 'product_123',
        'variant_id' => 'variant_456',
        'sku' => 'TSHIRT-BLACK-M',
        'quantity' => 1,
        'unit_price' => 50,
        'discount' => 0,
        'refund' => 0,
        'returned_units' => 0,
        'fulfillment_status' => 'PENDING',
      ],
    ],
  ]),
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Show all 57 linesShow fewer lines

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "ingestion_mode": "live",
  "source_connection_id": "erp-production",
  "external_order_id": "order_123",
  "order_number": "#1001",
  "domain": "shop.example.com",
  "buyer": {
    "email": "buyer@example.com",
    "external_customer_id": "customer_123"
  },
  "placed_at": "2026-07-24T09:00:00.000Z",
  "currency": "USD",
  "money": {
    "sub_total": 50,
    "discount": 5,
    "tax": 5,
    "shipping": 5,
    "total": 55,
    "refunded": 0
  },
  "fulfillment_status": "PENDING",
  "financial_status": "PAID",
  "paid_at": "2026-07-24T09:00:01.000Z",
  "cancelled": false,
  "lines": [
    {
      "external_line_id": "line_1",
      "product_id": "product_123",
      "variant_id": "variant_456",
      "sku": "TSHIRT-BLACK-M",
      "quantity": 1,
      "unit_price": 50,
      "discount": 0,
      "refund": 0,
      "returned_units": 0,
      "fulfillment_status": "PENDING"
    }
  ]
}`)
	req, err := http.NewRequest(http.MethodPost, "https://api.cevoid.com/v2/orders", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer " + os.Getenv("CEVOID_API_KEY"))
	req.Header.Set("idempotency-key", "01J3RZ0D4Q6J9T1R8M6E2P7W8X")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

Show all 70 linesShow fewer lines

require "json"
require "net/http"

uri = URI("https://api.cevoid.com/v2/orders")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CEVOID_API_KEY")}"
request["idempotency-key"] = "01J3RZ0D4Q6J9T1R8M6E2P7W8X"
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "ingestion_mode" => "live",
  "source_connection_id" => "erp-production",
  "external_order_id" => "order_123",
  "order_number" => "\#1001",
  "domain" => "shop.example.com",
  "buyer" => {
    "email" => "buyer@example.com",
    "external_customer_id" => "customer_123",
  },
  "placed_at" => "2026-07-24T09:00:00.000Z",
  "currency" => "USD",
  "money" => {
    "sub_total" => 50,
    "discount" => 5,
    "tax" => 5,
    "shipping" => 5,
    "total" => 55,
    "refunded" => 0,
  },
  "fulfillment_status" => "PENDING",
  "financial_status" => "PAID",
  "paid_at" => "2026-07-24T09:00:01.000Z",
  "cancelled" => false,
  "lines" => [
    {
      "external_line_id" => "line_1",
      "product_id" => "product_123",
      "variant_id" => "variant_456",
      "sku" => "TSHIRT-BLACK-M",
      "quantity" => 1,
      "unit_price" => 50,
      "discount" => 0,
      "refund" => 0,
      "returned_units" => 0,
      "fulfillment_status" => "PENDING",
    },
  ],
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Show all 52 linesShow fewer lines

Response

{
  "data": {
    "id": "ord_abc123",
    "ingestion_mode": "live",
    "source": {
      "type": "PUBLIC_API",
      "connection_id": "erp-production",
      "external_order_id": "order_123"
    },
    "order_number": "#1001",
    "buyer": {
      "email": "buyer@example.com",
      "external_customer_id": "customer_123",
      "profile_id": "prf_sarah"
    },
    "placed_at": "2026-07-24T09:00:00.000Z",
    "currency": "USD",
    "money": {
      "sub_total": 50,
      "discount": 5,
      "tax": 5,
      "shipping": 5,
      "total": 55,
      "refunded": 0
    },
    "fulfillment_status": "PENDING",
    "financial_status": "PAID",
    "paid_at": "2026-07-24T09:00:01.000Z",
    "cancelled": false,
    "market_id": "mar_us",
    "lines": [
      {
        "external_line_id": "line_1",
        "product_id": "product_123",
        "variant_id": "variant_456",
        "sku": "TSHIRT-BLACK-M",
        "quantity": 1,
        "unit_price": 50,
        "discount": 0,
        "refund": 0,
        "returned_units": 0,
        "fulfillment_status": "PENDING"
      }
    ],
    "created_at": "2026-07-24T09:00:01.000Z",
    "updated_at": "2026-07-24T09:00:01.000Z"
  }
}

Show all 48 linesShow fewer lines

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "req_abc123"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Forbidden",
  "request_id": "req_abc123"
}

{
  "status": 409,
  "code": "conflict",
  "message": "Idempotency-Key was already used for a different request",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 422,
  "code": "validation_error",
  "message": "Validation error",
  "request_id": "req_abc123"
}

{
  "status": 429,
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded",
  "request_id": "req_abc123",
  "additional_data": {
    "retry_after_seconds": 1
  }
}

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal server error",
  "request_id": "req_abc123"
}

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your API key.

Headers

idempotency-keystringrequired

Caller-generated key retained for seven days. An identical retry replays the original response; reuse for a different request returns 409.

Length: 1 to 255
Example: 01J3RZ0D4Q6J9T1R8M6E2P7W8X

Body

application/json

ingestion_modeenum<string>Default: live

Use historical to import order history without automatic Flows or purchase-incentive points. Orders created as historical remain excluded from automatic purchase incentives after live updates. Defaults to live.

Allowed values: live historical
Example: live

source_connection_idstringrequired

Caller-owned stable source namespace, retained unchanged across credential rotations.

Length: 1 to 255
Example: erp-production

external_order_idstringrequired

Stable order identifier within source_connection_id.

Length: 1 to 255
Example: order_123

order_numberstring

Customer-facing order number.

Length: 1 to 255
Example: #123

domainstring

Storefront domain or URL the order was placed on. Matched against market domains to assign the order to a market.

Length: 1 to 255
Example: shop.example.com

buyerobject

Buyer details set when you create the order. Cannot be changed through order updates.

Properties (2)

emailstring<email>

Normalized buyer email. When supplied it must be valid.

Example: buyer@example.com

external_customer_idstring

Customer identifier in the source system.

Length: 1 to 255
Example: customer_123

placed_atstring<date-time>required

Timestamp when the order was placed.

Example: 2026-07-24T09:00:00.000Z

currencystringrequired

Three-letter uppercase ISO currency code.

Pattern: ^[A-Z]{3}$
Example: USD

moneyobjectrequired

Properties (6)

totalnumberrequired

Declared order total in the order currency.

Range: 0 <= x
Example: 50

sub_totalnumber

Merchandise subtotal before order-level discount, tax, and shipping.

Range: 0 <= x
Example: 45

discountnumber

Order-level discount total.

Range: 0 <= x
Example: 5

taxnumber

Order-level tax total.

Range: 0 <= x
Example: 5

shippingnumber

Order-level shipping total.

Range: 0 <= x
Example: 5

refundednumber

Cumulative refunded amount.

Range: 0 <= x
Example: 0

fulfillment_statusenum<string>

Order fulfillment state. When omitted, derived from the order lines.

Allowed values: PENDING PARTIALLY_FULFILLED FULFILLED DELIVERED
Example: PENDING

financial_statusenum<string>Default: PENDING

Allowed values: PENDING PAID PARTIALLY_REFUNDED REFUNDED
Example: PAID

fulfilled_atstring<date-time>

Example: 2026-07-25T10:00:00.000Z

delivered_atstring<date-time>

Example: 2026-07-26T14:00:00.000Z

cancelledbooleanDefault: false

Example: false

cancelled_atstring<date-time>

Example: 2026-07-24T10:00:00.000Z

paid_atstring<date-time>

Example: 2026-07-24T09:00:01.000Z

last_refunded_atstring<date-time>

Example: 2026-07-28T11:00:00.000Z

linesobject[]required

Order lines. At least one line is required.

Minimum items: 1

Item properties (11)

external_line_idstringrequired

Stable line identifier within the source order.

Length: 1 to 255
Example: line_123

product_idstring

Product identifier in the source catalog.

Length: 1 to 255
Example: product_123

variant_idstring

Variant identifier in the source catalog.

Length: 1 to 255
Example: variant_123

skustring

Merchant SKU snapshot.

Length: 1 to 255
Example: TSHIRT-BLACK-M

quantityintegerrequired

Absolute ordered quantity.

Range: 0 < x
Example: 2

unit_pricenumberrequired

Non-negative price per unit in the order currency.

Range: 0 <= x
Example: 25

discountnumber

Discount allocated to this line in the order currency.

Range: 0 <= x
Example: 5

refundnumber

Amount refunded for this line in the order currency.

Range: 0 <= x
Example: 0

returned_unitsinteger

Absolute number of returned units.

Range: 0 <= x
Example: 0

fulfillment_statusenum<string>Default: PENDING

Absolute fulfillment state for this line.

Allowed values: PENDING PARTIALLY_FULFILLED FULFILLED DELIVERED
Example: PENDING

delivered_atstring<date-time>

Delivery timestamp. Required when this line is explicitly delivered.

Example: 2026-07-24T10:00:00.000Z

Response

201 Created successfully application/json

dataobjectrequired

Requested resource.

Properties (21)

idstringrequired

Cevoid order ID.

Example: ord_abc123

ingestion_modeenum<string>

Processing mode of the latest order write. Historical mode suppresses automatic Flows. Live mode allows new lifecycle transitions to trigger Flows. Absent for orders without a live or historical mode.

Allowed values: live historical
Example: live

sourceobjectrequired

Properties (3)

typeenum<string>

System that owns this order. Absent when the order has no connected source.

Allowed values: SHOPIFY WOOCOMMERCE MYSTORE NORDISK_EHANDEL VISKAN CENTRA PUBLIC_API OTHER
Example: PUBLIC_API

connection_idstring

Stable source namespace for the order. Absent when the order has no connected source.

Example: erp-production

external_order_idstringrequired

Order identifier in the source system.

Example: order_123

order_numberstring

Customer-facing order number.

Example: #1001

buyerobject

Buyer identity. Absent when the order carries no buyer information.

Properties (3)

emailstring

Buyer email as supplied by the source system.

Example: buyer@example.com

external_customer_idstring

Customer identifier in the source system.

Example: customer_123

profile_idstring

Cevoid profile ID. Absent when no profile is linked to the order.

Example: prf_sarah

placed_atstring<date-time>required

ISO 8601 timestamp when the order was placed.

Example: 2026-07-24T09:00:00.000Z

currencystringrequired

Three-letter uppercase ISO currency code.

Example: USD

moneyobjectrequired

Properties (6)

totalnumberrequired

Current declared order total.

Example: 55

sub_totalnumberrequired

Current merchandise subtotal.

Example: 50

discountnumber

Current order-level discount total.

Example: 5

taxnumber

Current order-level tax total.

Example: 5

shippingnumber

Current order-level shipping total.

Example: 5

refundednumber

Cumulative refunded amount.

Example: 0

fulfillment_statusenum<string>required

Current order fulfillment state.

Allowed values: PENDING PARTIALLY_FULFILLED FULFILLED DELIVERED
Example: PENDING

financial_statusenum<string>required

Current order payment state.

Allowed values: PENDING PAID PARTIALLY_REFUNDED REFUNDED
Example: PAID

fulfilled_atstring<date-time>

ISO 8601 timestamp when the order was fulfilled.

Example: 2026-07-25T10:00:00.000Z

delivered_atstring<date-time>

ISO 8601 timestamp when the order was delivered.

Example: 2026-07-26T14:00:00.000Z

cancelledbooleanrequired

Whether the order is cancelled.

Example: false

cancelled_atstring<date-time>

ISO 8601 timestamp when the order was cancelled.

Example: 2026-07-24T10:00:00.000Z

paid_atstring<date-time>

ISO 8601 timestamp when the order was paid.

Example: 2026-07-24T09:00:01.000Z

last_refunded_atstring<date-time>

ISO 8601 timestamp of the most recent refund.

Example: 2026-07-28T11:00:00.000Z

market_idstring

Cevoid market ID.

Example: mar_us

linesobject[]required

Item properties (12)

external_line_idstringrequired

Stable line identifier within the source order.

Example: line_1

product_idstring

Product identifier in the source catalog. Absent when the line names no product.

Example: product_123

variant_idstring

Variant identifier in the source catalog.

Example: variant_456

skustring

Merchant SKU snapshot.

Example: TSHIRT-BLACK-M

quantityintegerrequired

Absolute ordered quantity.

Range: 0 <= x
Example: 1

unit_pricenumberrequired

Price per unit in the order currency.

Example: 50

discountnumber

Discount allocated to this line.

Example: 0

refundnumber

Cumulative amount refunded for this line.

Example: 0

returned_unitsinteger

Absolute number of returned units.

Range: 0 <= x
Example: 0

fulfillment_statusenum<string>required

Current fulfillment state for this line.

Allowed values: PENDING PARTIALLY_FULFILLED FULFILLED DELIVERED
Example: PENDING

delivered_atstring<date-time>

ISO 8601 timestamp when this line was delivered.

Example: 2026-07-26T14:00:00.000Z

removed_atstring<date-time>

Time the line was removed from the order.

Example: 2026-07-27T14:00:00.000Z

created_atstring<date-time>required

ISO 8601 timestamp when Cevoid created the order.

Example: 2026-07-24T09:00:01.000Z

updated_atstring<date-time>required

ISO 8601 timestamp when Cevoid last updated the order.

Example: 2026-07-24T09:00:01.000Z

removed_atstring<date-time>

Time the order was deleted.

Example: 2026-08-01T09:00:00.000Z

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

403 Forbidden application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

409 Conflict application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobjectrequired

Machine-readable rate-limit details.

Properties (2)

retry_after_secondsintegerrequired

Range: 0 <= x

{key}any

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (6)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available