Skip to content
HallifyDevelopersSearch documentation
Open Hallify
Sections

External orders & POS

Ingest a signed external order revision

POST/external-order-ingress/{sourceId}/orders

Authenticates the exact request body with the source-scoped HMAC secret. Replaying the same revision and payload is safe. Hallify HMAC profile external-orders uses HMAC-SHA256. Canonical input: RFC3339 timestamp + "." + key-sorted stable JSON. Send x-hallify-timestamp as rfc3339; timestamps outside ±300 seconds are stale. Send x-hallify-signature as lowercase hexadecimal; comparison is timing-safe. Secret handling: Use the issued base64url text as the UTF-8 signing secret. Accepted Content-Type: application/json. Malformed input: A malformed signature returns 401 Webhook signature is invalid. Stale input: A timestamp outside the 300-second window returns 401 Webhook timestamp is stale. Repeated delivery: Order revision and payload fingerprint semantics control duplicate and conflicting delivery.

Authentication

x-hallify-signature: <HALLIFY_SIGNATURE>

HMAC-SHA256 signature credential. Each operation documents its exact protocol through x-hallify-hmac metadata and the operation description.

Connection guide

Parameters

sourceIdPath · Required

Configured ingestion or integration source selected within the authenticated parent scope.

string · uuid
Full definition
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}
x-hallify-timestampHeader · Required

rfc3339 timestamp; accepted clock skew is ±300 seconds.

string
Full definition
{
  "type": "string",
  "example": "example"
}

Request body

Required

External order identifier and monotonic revision, service mode, optional label and due time, and one to 200 order items consumed as the signed source revision.

application/json

ExternalOrderIngressDto
Full definition
{
  "$ref": "#/components/schemas/ExternalOrderIngressDto"
}

Responses

201Returns the accepted external revision, mapped native order, and replay result recorded for the source.
ExternalOrderIngressIngestResultDto
Full definition
{
  "$ref": "#/components/schemas/ExternalOrderIngressIngestResultDto"
}
Example response · 201 · application/json
{
  "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
  "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
  "status": "example",
  "externalOrderId": "example-id",
  "externalRevision": 1,
  "duplicate": false
}
400External-order source identifier or order payload is invalid
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401External-order HMAC signature is invalid or stale
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
404External-order source or referenced resource was not found
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
409External-order revision, payload, or order state conflicts with current state
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "HTTP_CONFLICT",
  "message": "errors:http.conflict",
  "translationKey": "errors:http.conflict"
}
503External-order signing secret is unavailable
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Schemas

ExternalOrderIngressDto

Authenticates the exact request body with the source-scoped HMAC secret.

externalOrderIdRequired

Opaque identifier for external order associated with external order ingress; clients must not assume UUID syntax. Accepted values enforce maximum length 191.

string
Full definition
{
  "type": "string",
  "maxLength": 191,
  "description": "Opaque identifier for external order associated with external order ingress; clients must not assume UUID syntax. Accepted values enforce maximum length 191.",
  "example": "example-id"
}
externalRevisionRequired

Monotonic optimistic-concurrency revision for external order ingress. Accepted values enforce minimum 1.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Monotonic optimistic-concurrency revision for external order ingress. Accepted values enforce minimum 1.",
  "example": 1
}
displayLabelOptional

Display label for external order ingress. Accepted values enforce maximum length 120.

string
Full definition
{
  "type": "string",
  "maxLength": 120,
  "description": "Display label for external order ingress. Accepted values enforce maximum length 120.",
  "example": "example"
}
serviceModeRequired

Allowed service mode for external order ingress: PICKUP, DELIVERY, CATERING.

string
Full definition
{
  "type": "string",
  "enum": [
    "PICKUP",
    "DELIVERY",
    "CATERING"
  ],
  "description": "Allowed service mode for external order ingress: PICKUP, DELIVERY, CATERING.",
  "example": "PICKUP"
}
dueAtOptional

RFC 3339 timestamp for due at; offsets represent the same absolute instant.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "RFC 3339 timestamp for due at; offsets represent the same absolute instant.",
  "example": "2026-12-31T18:00:00.000Z"
}
itemsRequired

External order item returned in the external order ingress collection.

array
Full definition
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ExternalOrderItemDto"
  },
  "description": "External order item returned in the external order ingress collection.",
  "example": [
    {
      "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
      "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "quantity": 1
    }
  ]
}
Full definition
{
  "type": "object",
  "properties": {
    "externalOrderId": {
      "type": "string",
      "maxLength": 191,
      "description": "Opaque identifier for external order associated with external order ingress; clients must not assume UUID syntax. Accepted values enforce maximum length 191.",
      "example": "example-id"
    },
    "externalRevision": {
      "type": "integer",
      "minimum": 1,
      "description": "Monotonic optimistic-concurrency revision for external order ingress. Accepted values enforce minimum 1.",
      "example": 1
    },
    "displayLabel": {
      "type": "string",
      "maxLength": 120,
      "description": "Display label for external order ingress. Accepted values enforce maximum length 120.",
      "example": "example"
    },
    "serviceMode": {
      "type": "string",
      "enum": [
        "PICKUP",
        "DELIVERY",
        "CATERING"
      ],
      "description": "Allowed service mode for external order ingress: PICKUP, DELIVERY, CATERING.",
      "example": "PICKUP"
    },
    "dueAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 timestamp for due at; offsets represent the same absolute instant.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExternalOrderItemDto"
      },
      "description": "External order item returned in the external order ingress collection.",
      "example": [
        {
          "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
          "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "quantity": 1
        }
      ]
    }
  },
  "required": [
    "externalOrderId",
    "externalRevision",
    "serviceMode",
    "items"
  ],
  "description": "Authenticates the exact request body with the source-scoped HMAC secret.",
  "example": {
    "externalOrderId": "example-id",
    "externalRevision": 1,
    "serviceMode": "PICKUP",
    "items": [
      {
        "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
        "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "quantity": 1
      }
    ]
  }
}
ExternalOrderItemDto

External order entry embedded in a operations collection or aggregate.

salesChannelIdOptional

Venue sales channel id used to resolve the active menu.

string · uuid
Full definition
{
  "type": "string",
  "description": "Venue sales channel id used to resolve the active menu.",
  "format": "uuid",
  "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
}
clientMenuVersionIdRequired

Menu version id that the client used while composing the item.

string · uuid
Full definition
{
  "type": "string",
  "description": "Menu version id that the client used while composing the item.",
  "format": "uuid",
  "example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05"
}
clientGraphHashRequired

Opaque published menu graph token that the client used while composing the item.

string
Full definition
{
  "type": "string",
  "description": "Opaque published menu graph token that the client used while composing the item.",
  "pattern": "^menu-cost-v1\\.graph\\.[A-Za-z0-9_-]{43}$",
  "maxLength": 128,
  "example": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
expectedUnitPriceOptional

Unit price that the client displayed while composing this item.

number
Full definition
{
  "type": "number",
  "description": "Unit price that the client displayed while composing this item.",
  "example": 12,
  "minimum": 0,
  "maximum": 9999999999.99
}
expectedTotalOptional

Total line price that the client displayed while composing this item.

number
Full definition
{
  "type": "number",
  "description": "Total line price that the client displayed while composing this item.",
  "example": 24,
  "minimum": 0,
  "maximum": 9999999999.99
}
enteredUnitPriceOptional

Explicit service-time unit amount for an open-price item. This is separate from the client price-consistency fields.

number
Full definition
{
  "type": "number",
  "description": "Explicit service-time unit amount for an open-price item. This is separate from the client price-consistency fields.",
  "example": 45,
  "minimum": 0,
  "maximum": 9999999999.99
}
priceEntryNoteOptional

Operational audit note for an open-price entry. Required when the published policy requires a note.

string
Full definition
{
  "type": "string",
  "description": "Operational audit note for an open-price entry. Required when the published policy requires a note.",
  "maxLength": 500,
  "example": "Synthetic example"
}
openPriceApprovalCredentialOptional

Deliberate staff credential required only when the effective open price crosses its approval policy.

allOf
Full definition
{
  "description": "Deliberate staff credential required only when the effective open price crosses its approval policy.",
  "allOf": [
    {
      "$ref": "#/components/schemas/OrderItemOpenPriceApprovalCredentialDto"
    }
  ],
  "example": {
    "employeeNumber": "1.00",
    "pin": "example"
  }
}
measuredQuantityOptional

Explicit measured amount for a measured item. Send a decimal string in the published measurement unit; measured order lines always use quantity 1.

string
Full definition
{
  "type": "string",
  "description": "Explicit measured amount for a measured item. Send a decimal string in the published measurement unit; measured order lines always use quantity 1.",
  "example": "350",
  "pattern": "^(?:0|[1-9]\\d{0,8})(?:\\.\\d{1,3})?$"
}
menuItemIdOptional

Menu item id. Provide this OR menuVariantId.

string · uuid
Full definition
{
  "type": "string",
  "description": "Menu item id. Provide this OR menuVariantId.",
  "format": "uuid",
  "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
}
menuVariantIdOptional

Menu variant id. Provide this OR menuItemId.

string · uuid
Full definition
{
  "type": "string",
  "description": "Menu variant id. Provide this OR menuItemId.",
  "format": "uuid",
  "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
}
quantityRequired

Quantity for the new historical order item line.

integer
Full definition
{
  "type": "integer",
  "description": "Quantity for the new historical order item line.",
  "minimum": 1,
  "example": 1
}
modifierOptionIdsOptional

Selected modifier option ids for this order item.

array
Full definition
{
  "description": "Selected modifier option ids for this order item.",
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid",
    "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  },
  "example": [
    "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  ]
}
componentSelectionsOptional

Selections for component groups owned by the published item structure.

array
Full definition
{
  "description": "Selections for component groups owned by the published item structure.",
  "maxItems": 50,
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OrderItemComponentSelectionDto"
  },
  "example": [
    {
      "groupId": "example-id",
      "choiceId": "example-id"
    }
  ]
}
serviceFlagsOptional

Structured service flags for the item.

array
Full definition
{
  "type": "array",
  "description": "Structured service flags for the item.",
  "items": {
    "type": "string",
    "enum": [
      "VIP",
      "RUSH",
      "FIRE_LATER"
    ],
    "example": "VIP"
  },
  "example": [
    "VIP"
  ]
}
specialRequestOptional

Free-text special request shown to the kitchen.

string
Full definition
{
  "type": "string",
  "description": "Free-text special request shown to the kitchen.",
  "maxLength": 500,
  "example": "example"
}
Full definition
{
  "type": "object",
  "properties": {
    "salesChannelId": {
      "type": "string",
      "description": "Venue sales channel id used to resolve the active menu.",
      "format": "uuid",
      "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
    },
    "clientMenuVersionId": {
      "type": "string",
      "description": "Menu version id that the client used while composing the item.",
      "format": "uuid",
      "example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05"
    },
    "clientGraphHash": {
      "type": "string",
      "description": "Opaque published menu graph token that the client used while composing the item.",
      "pattern": "^menu-cost-v1\\.graph\\.[A-Za-z0-9_-]{43}$",
      "maxLength": 128,
      "example": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "expectedUnitPrice": {
      "type": "number",
      "description": "Unit price that the client displayed while composing this item.",
      "example": 12,
      "minimum": 0,
      "maximum": 9999999999.99
    },
    "expectedTotal": {
      "type": "number",
      "description": "Total line price that the client displayed while composing this item.",
      "example": 24,
      "minimum": 0,
      "maximum": 9999999999.99
    },
    "enteredUnitPrice": {
      "type": "number",
      "description": "Explicit service-time unit amount for an open-price item. This is separate from the client price-consistency fields.",
      "example": 45,
      "minimum": 0,
      "maximum": 9999999999.99
    },
    "priceEntryNote": {
      "type": "string",
      "description": "Operational audit note for an open-price entry. Required when the published policy requires a note.",
      "maxLength": 500,
      "example": "Synthetic example"
    },
    "openPriceApprovalCredential": {
      "description": "Deliberate staff credential required only when the effective open price crosses its approval policy.",
      "allOf": [
        {
          "$ref": "#/components/schemas/OrderItemOpenPriceApprovalCredentialDto"
        }
      ],
      "example": {
        "employeeNumber": "1.00",
        "pin": "example"
      }
    },
    "measuredQuantity": {
      "type": "string",
      "description": "Explicit measured amount for a measured item. Send a decimal string in the published measurement unit; measured order lines always use quantity 1.",
      "example": "350",
      "pattern": "^(?:0|[1-9]\\d{0,8})(?:\\.\\d{1,3})?$"
    },
    "menuItemId": {
      "type": "string",
      "description": "Menu item id. Provide this OR menuVariantId.",
      "format": "uuid",
      "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
    },
    "menuVariantId": {
      "type": "string",
      "description": "Menu variant id. Provide this OR menuItemId.",
      "format": "uuid",
      "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity for the new historical order item line.",
      "minimum": 1,
      "example": 1
    },
    "modifierOptionIds": {
      "description": "Selected modifier option ids for this order item.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      },
      "example": [
        "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      ]
    },
    "componentSelections": {
      "description": "Selections for component groups owned by the published item structure.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItemComponentSelectionDto"
      },
      "example": [
        {
          "groupId": "example-id",
          "choiceId": "example-id"
        }
      ]
    },
    "serviceFlags": {
      "type": "array",
      "description": "Structured service flags for the item.",
      "items": {
        "type": "string",
        "enum": [
          "VIP",
          "RUSH",
          "FIRE_LATER"
        ],
        "example": "VIP"
      },
      "example": [
        "VIP"
      ]
    },
    "specialRequest": {
      "type": "string",
      "description": "Free-text special request shown to the kitchen.",
      "maxLength": 500,
      "example": "example"
    }
  },
  "required": [
    "clientMenuVersionId",
    "clientGraphHash",
    "quantity"
  ],
  "description": "External order entry embedded in a operations collection or aggregate.",
  "example": {
    "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
    "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "quantity": 1
  }
}
OrderItemOpenPriceApprovalCredentialDto

Employee number and sensitive PIN consumed to approve an open price on an order item.

employeeNumberRequired

Employee number of the worker approving the open price.

string
Full definition
{
  "type": "string",
  "description": "Employee number of the worker approving the open price.",
  "maxLength": 64,
  "example": "1.00"
}
pinRequired

Staff PIN used only for server-side approval verification. It is never persisted or returned.

string
Full definition
{
  "type": "string",
  "description": "Staff PIN used only for server-side approval verification. It is never persisted or returned.",
  "minLength": 4,
  "maxLength": 8,
  "example": "example"
}
Full definition
{
  "type": "object",
  "properties": {
    "employeeNumber": {
      "type": "string",
      "description": "Employee number of the worker approving the open price.",
      "maxLength": 64,
      "example": "1.00"
    },
    "pin": {
      "type": "string",
      "description": "Staff PIN used only for server-side approval verification. It is never persisted or returned.",
      "minLength": 4,
      "maxLength": 8,
      "example": "example"
    }
  },
  "required": [
    "employeeNumber",
    "pin"
  ],
  "description": "Employee number and sensitive PIN consumed to approve an open price on an order item.",
  "example": {
    "employeeNumber": "1.00",
    "pin": "example"
  }
}
OrderItemComponentSelectionDto

Order item component selection selected component identities applied to the parent item configuration.

groupIdRequired

Stable component group id from the published structure.

string
Full definition
{
  "type": "string",
  "description": "Stable component group id from the published structure.",
  "maxLength": 96,
  "example": "example-id"
}
choiceIdRequired

Stable component choice id from the published structure.

string
Full definition
{
  "type": "string",
  "description": "Stable component choice id from the published structure.",
  "maxLength": 160,
  "example": "example-id"
}
menuVariantIdOptional

Selected sellable version when the component item has versions.

string · uuid
Full definition
{
  "type": "string",
  "description": "Selected sellable version when the component item has versions.",
  "format": "uuid",
  "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
}
modifierOptionIdsOptional

Modifier option ids selected for this component.

array
Full definition
{
  "description": "Modifier option ids selected for this component.",
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid",
    "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  },
  "example": [
    "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  ]
}
Full definition
{
  "type": "object",
  "properties": {
    "groupId": {
      "type": "string",
      "description": "Stable component group id from the published structure.",
      "maxLength": 96,
      "example": "example-id"
    },
    "choiceId": {
      "type": "string",
      "description": "Stable component choice id from the published structure.",
      "maxLength": 160,
      "example": "example-id"
    },
    "menuVariantId": {
      "type": "string",
      "description": "Selected sellable version when the component item has versions.",
      "format": "uuid",
      "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
    },
    "modifierOptionIds": {
      "description": "Modifier option ids selected for this component.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      },
      "example": [
        "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      ]
    }
  },
  "required": [
    "groupId",
    "choiceId"
  ],
  "description": "Order item component selection selected component identities applied to the parent item configuration.",
  "example": {
    "groupId": "example-id",
    "choiceId": "example-id"
  }
}
ExternalOrderIngressIngestResultDto

Returns the accepted external revision, mapped native order, and replay result recorded for the source.

Full definition
{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "id",
        "orderId",
        "status",
        "externalOrderId",
        "externalRevision",
        "duplicate"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Hallify UUID identifying external order ingress ingest.",
          "example": "a42073ae-5313-4ace-86d8-86fb33fde1a9"
        },
        "orderId": {
          "type": "string",
          "format": "uuid",
          "description": "Hallify UUID identifying order associated with external order ingress ingest.",
          "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
        },
        "status": {
          "type": "string",
          "description": "Current lifecycle status of external order ingress ingest.",
          "example": "example"
        },
        "externalOrderId": {
          "type": "string",
          "description": "Opaque identifier for external order associated with external order ingress ingest; clients must not assume UUID syntax.",
          "example": "example-id"
        },
        "externalRevision": {
          "type": "integer",
          "minimum": 0,
          "description": "Monotonic optimistic-concurrency revision for external order ingress ingest. Accepted values enforce minimum 0.",
          "example": 1
        },
        "duplicate": {
          "type": "boolean",
          "enum": [
            false
          ],
          "description": "Allowed duplicate for external order ingress ingest: false.",
          "example": false
        }
      },
      "example": {
        "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
        "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
        "status": "example",
        "externalOrderId": "example-id",
        "externalRevision": 1,
        "duplicate": false
      }
    },
    {
      "type": "object",
      "required": [
        "id",
        "orderId",
        "payloadHash",
        "status",
        "duplicate"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Hallify UUID identifying external order ingress ingest.",
          "example": "a7476fce-e842-42a4-896a-c23b0e88b420"
        },
        "orderId": {
          "type": "string",
          "format": "uuid",
          "description": "Hallify UUID identifying order associated with external order ingress ingest.",
          "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
        },
        "payloadHash": {
          "type": "string",
          "description": "Opaque digest of the canonical payload used by external order ingress ingest for replay detection and evidence comparison.",
          "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
        },
        "status": {
          "type": "string",
          "description": "Current lifecycle status of external order ingress ingest.",
          "example": "example"
        },
        "duplicate": {
          "type": "boolean",
          "enum": [
            true
          ],
          "description": "Allowed duplicate for external order ingress ingest: true.",
          "example": true
        }
      },
      "example": {
        "id": "a7476fce-e842-42a4-896a-c23b0e88b420",
        "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
        "payloadHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
        "status": "example",
        "duplicate": true
      }
    }
  ],
  "description": "Returns the accepted external revision, mapped native order, and replay result recorded for the source.",
  "example": {
    "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
    "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
    "status": "example",
    "externalOrderId": "example-id",
    "externalRevision": 1,
    "duplicate": false
  }
}
TranslatedErrorDto

Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.

statusCodeRequired

HTTP status code repeated from the response.

integer
Full definition
{
  "type": "integer",
  "description": "HTTP status code repeated from the response.",
  "example": 400
}
errorRequired

Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.

string
Full definition
{
  "type": "string",
  "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
  "example": "errors.request.invalid"
}
codeRequired

Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.

string
Full definition
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
}
messageRequired

Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
}
translationKeyRequired

Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsOptional

Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.

array
Full definition
{
  "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsOptional

Optional domain-specific blocker or validation details

oneOf
Full definition
{
  "description": "Optional domain-specific blocker or validation details",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Full definition
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code repeated from the response.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Optional domain-specific blocker or validation details",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.

fieldRequired

Public field path. Nested properties and array indices are separated by dots.

string
Full definition
{
  "type": "string",
  "example": "email",
  "description": "Public field path. Nested properties and array indices are separated by dots."
}
translationKeyRequired

Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
}
codeRequired

Stable validator identifier for this field failure. Custom validators may define additional identifiers.

string
Full definition
{
  "type": "string",
  "example": "isEmail",
  "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
}
messageRequired

Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
Full definition
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Public field path. Nested properties and array indices are separated by dots."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.

Full definition
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
  "example": "example"
}

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.