Advance the checkout state machine
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/cart/transition \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cart": {
"cartId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>",
"lineTotal": 123,
"sourceChannels": []
}
],
"lineCount": 123,
"itemCount": 123,
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": true,
"updatedAt": 123
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/cart/transition"
payload = { "cart": {
"cartId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>",
"lineTotal": 123,
"sourceChannels": []
}
],
"lineCount": 123,
"itemCount": 123,
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": True,
"updatedAt": 123
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cart: {
cartId: '<string>',
items: [
{
productRetailerId: '<string>',
name: '<string>',
quantity: 123,
unitPrice: 123,
currency: '<string>',
lineTotal: 123,
sourceChannels: []
}
],
lineCount: 123,
itemCount: 123,
subtotal: 123,
currency: '<string>',
mixedCurrency: true,
updatedAt: 123
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/cart/transition', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/commerce/cart/transition",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cart' => [
'cartId' => '<string>',
'items' => [
[
'productRetailerId' => '<string>',
'name' => '<string>',
'quantity' => 123,
'unitPrice' => 123,
'currency' => '<string>',
'lineTotal' => 123,
'sourceChannels' => [
]
]
],
'lineCount' => 123,
'itemCount' => 123,
'subtotal' => 123,
'currency' => '<string>',
'mixedCurrency' => true,
'updatedAt' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/commerce/cart/transition"
payload := strings.NewReader("{\n \"cart\": {\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\",\n \"lineTotal\": 123,\n \"sourceChannels\": []\n }\n ],\n \"lineCount\": 123,\n \"itemCount\": 123,\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true,\n \"updatedAt\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/commerce/cart/transition")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cart\": {\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\",\n \"lineTotal\": 123,\n \"sourceChannels\": []\n }\n ],\n \"lineCount\": 123,\n \"itemCount\": 123,\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true,\n \"updatedAt\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/cart/transition")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cart\": {\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\",\n \"lineTotal\": 123,\n \"sourceChannels\": []\n }\n ],\n \"lineCount\": 123,\n \"itemCount\": 123,\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true,\n \"updatedAt\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"cartId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>",
"lineTotal": 123,
"sourceChannels": [
"whatsapp"
]
}
],
"lineCount": 123,
"itemCount": 123,
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": true,
"state": "browsing",
"lastChannel": "whatsapp",
"updatedAt": 123
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Commerce
Advance the checkout state machine
Apply one checkout event to the cart. An illegal transition is rejected with VALIDATION_ERROR.
POST
/
api
/
v1
/
commerce
/
cart
/
transition
Advance the checkout state machine
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/cart/transition \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cart": {
"cartId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>",
"lineTotal": 123,
"sourceChannels": []
}
],
"lineCount": 123,
"itemCount": 123,
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": true,
"updatedAt": 123
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/cart/transition"
payload = { "cart": {
"cartId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>",
"lineTotal": 123,
"sourceChannels": []
}
],
"lineCount": 123,
"itemCount": 123,
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": True,
"updatedAt": 123
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cart: {
cartId: '<string>',
items: [
{
productRetailerId: '<string>',
name: '<string>',
quantity: 123,
unitPrice: 123,
currency: '<string>',
lineTotal: 123,
sourceChannels: []
}
],
lineCount: 123,
itemCount: 123,
subtotal: 123,
currency: '<string>',
mixedCurrency: true,
updatedAt: 123
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/cart/transition', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/commerce/cart/transition",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cart' => [
'cartId' => '<string>',
'items' => [
[
'productRetailerId' => '<string>',
'name' => '<string>',
'quantity' => 123,
'unitPrice' => 123,
'currency' => '<string>',
'lineTotal' => 123,
'sourceChannels' => [
]
]
],
'lineCount' => 123,
'itemCount' => 123,
'subtotal' => 123,
'currency' => '<string>',
'mixedCurrency' => true,
'updatedAt' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/commerce/cart/transition"
payload := strings.NewReader("{\n \"cart\": {\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\",\n \"lineTotal\": 123,\n \"sourceChannels\": []\n }\n ],\n \"lineCount\": 123,\n \"itemCount\": 123,\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true,\n \"updatedAt\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/commerce/cart/transition")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cart\": {\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\",\n \"lineTotal\": 123,\n \"sourceChannels\": []\n }\n ],\n \"lineCount\": 123,\n \"itemCount\": 123,\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true,\n \"updatedAt\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/cart/transition")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cart\": {\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"productRetailerId\": \"<string>\",\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"currency\": \"<string>\",\n \"lineTotal\": 123,\n \"sourceChannels\": []\n }\n ],\n \"lineCount\": 123,\n \"itemCount\": 123,\n \"subtotal\": 123,\n \"currency\": \"<string>\",\n \"mixedCurrency\": true,\n \"updatedAt\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"cartId": "<string>",
"items": [
{
"productRetailerId": "<string>",
"name": "<string>",
"quantity": 123,
"unitPrice": 123,
"currency": "<string>",
"lineTotal": 123,
"sourceChannels": [
"whatsapp"
]
}
],
"lineCount": 123,
"itemCount": 123,
"subtotal": 123,
"currency": "<string>",
"mixedCurrency": true,
"state": "browsing",
"lastChannel": "whatsapp",
"updatedAt": 123
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
Serializable omnichannel cart snapshot. Derived fields (subtotal, itemCount, …) are re-computed server-side and never trusted.
Show child attributes
Show child attributes
Available options:
ADD_ITEM, REMOVE_ITEM, INITIATE_CHECKOUT, REQUEST_PAYMENT, PAYMENT_CONFIRMED, FULFILL, ABANDON, CANCEL, RESUME