Commerce Checkout
List Order Push Configs
Public API endpoint: ecomCheckout.listOrderPushConfigs
Required scopes: org:ecom:checkout:read, org:ecom:settings:read
Authorization
bearerAuth AuthorizationBearer <token>
API key (prefix: cogn_) from Account → Developer
In: header
Path Parameters
orgId*string
Organization ID (prefix: org_)
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:3013/api/v1/org/string/ecom/checkout-order-push/configs"{
"success": true,
"data": [
{
"id": "cop_abc123",
"brandId": "br_def456",
"shopifyIntegrationId": "int_ghi789",
"enabled": true,
"pushOnPaymentSuccess": true,
"completeShopifyDraftOrder": true,
"markShopifyOrderAsPaid": true,
"includePaymentProviderLinks": true,
"includeCognisOrderLink": true,
"includeAttributionAttributes": true,
"shopifySourceName": "cognis",
"notifyShopifyCustomer": false,
"shopHandle": "example-store",
"brandName": "Example Brand",
"thankYouOrderNumberSource": "shopify"
}
],
"message": "Success",
"traceId": "req_abc123"
}{
"success": false,
"message": "Invalid data",
"errors": [
{
"code": 400,
"message": "Invalid data"
}
],
"traceId": "req_xxx"
}{
"success": false,
"message": "Unauthorized",
"errors": [
{
"code": 401,
"message": "Unauthorized"
}
],
"traceId": "req_xxx"
}{
"success": false,
"message": "Forbidden",
"errors": [
{
"code": 403,
"message": "Forbidden"
}
],
"traceId": "req_xxx"
}{
"success": false,
"message": "Not found",
"errors": [
{
"code": 404,
"message": "Not found"
}
],
"traceId": "req_xxx"
}{
"success": false,
"message": "Conflict",
"errors": [
{
"code": 409,
"message": "Conflict"
}
],
"traceId": "req_xxx"
}{
"success": false,
"message": "string",
"errors": [
{
"code": 0,
"message": "string",
"details": {}
}
],
"traceId": "string",
"params": {},
"readableMessage": "string"
}{
"success": false,
"message": "Rate limit exceeded",
"errors": [],
"traceId": "req_xxx"
}{
"success": false,
"message": "Unexpected error",
"errors": [
{
"code": 500,
"message": "Unexpected error"
}
],
"traceId": "req_xxx"
}