BrainerceList checkout custom fields
Lists the checkout custom field definitions that apply to this checkout (merchant-defined questions that can carry a surcharge). Render them and send the answers to checkout/{checkoutId}/custom-fields.
For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.
In: header
Path Parameters
Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.
Checkout id, returned by checkout (create checkout).
Header Parameters
Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.
Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.
curl -X GET "https://api.brainerce.com/api/vc/string/checkout/string/custom-fields" \ -H "origin: string" \ -H "X-SDK-Version: string"[
{
"id": "clx1234567890",
"storeId": "clstore_abc123",
"key": "giftMessage",
"name": "string",
"description": "string",
"type": "TEXT",
"required": false,
"isActive": true,
"position": 0,
"visibility": {
"show": "always"
},
"pricing": {
"type": "none"
},
"options": [
{
"value": "string",
"label": "string"
}
],
"minLength": 0,
"maxLength": 0,
"minValue": "10",
"maxValue": "100",
"dateAvailability": {},
"translations": {},
"createdAt": "string",
"updatedAt": "string"
}
]{
"statusCode": 403,
"code": "INSUFFICIENT_SCOPE",
"message": "API key does not have the required scope: products:write",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/checkout/{checkoutId}/custom-fields"
}{
"statusCode": 404,
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/checkout/{checkoutId}/custom-fields"
}{
"statusCode": 429,
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": {
"retryAfterSeconds": 12
},
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/checkout/{checkoutId}/custom-fields"
}