Orders
Download the complete public OpenAPI schema
Orders
Receive authenticated order snapshots used to reconcile buyer-side purchases across agentic commerce protocols.
POST /api/webhooks/ucp/orders
Receive a signed UCP Order snapshot
Verify a business-signed UCP Order snapshot, durably audit its exact body, and queue non-financial purchase reconciliation.
Parameters, request, responses, and security
{
"tags": [
"orders"
],
"summary": "Receive a signed UCP Order snapshot",
"description": "Verify a business-signed UCP Order snapshot, durably audit its exact body, and queue non-financial purchase reconciliation.",
"operationId": "receive_ucp_order_webhook",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$defs": {
"CountryCode": {
"type": "string",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"title": "CountryCode",
"description": "ISO 3166-1 alpha-2 country code used by profile identity/address records."
},
"CurrencyCode": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLE",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VED",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"title": "CurrencyCode",
"description": "ISO 4217 currency codes accepted by persisted monetary surfaces."
},
"UcpAvailableInstrument": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"type": {
"type": "string",
"title": "Type"
},
"constraints": {
"additionalProperties": true,
"type": "object",
"title": "Constraints"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"type"
],
"title": "UcpAvailableInstrument",
"description": "Instrument family a UCP payment handler can accept."
},
"UcpCapabilityDeclaration": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"version": {
"type": "string",
"title": "Version"
},
"spec": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Spec"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Schema"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"config": {
"additionalProperties": true,
"type": "object",
"title": "Config"
},
"extends": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Extends"
},
"requires": {
"anyOf": [
{
"$ref": "#/$defs/UcpCapabilityRequirements"
},
{
"type": "null"
}
]
}
},
"additionalProperties": true,
"type": "object",
"required": [
"version"
],
"title": "UcpCapabilityDeclaration",
"description": "One versioned UCP capability or vendor extension declaration."
},
"UcpCapabilityRequirements": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"protocol": {
"anyOf": [
{
"$ref": "#/$defs/UcpVersionRequirement"
},
{
"type": "null"
}
]
},
"capabilities": {
"additionalProperties": {
"$ref": "#/$defs/UcpVersionRequirement"
},
"type": "object",
"title": "Capabilities"
}
},
"additionalProperties": true,
"type": "object",
"title": "UcpCapabilityRequirements",
"description": "Protocol and parent-capability requirements for one declaration."
},
"UcpFulfillmentDestination": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Name"
},
"phone_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Phone Number"
},
"street_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Street Address"
},
"extended_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extended Address"
},
"address_locality": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Address Locality"
},
"address_region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Address Region"
},
"postal_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Postal Code"
},
"address_country": {
"anyOf": [
{
"$ref": "#/$defs/CountryCode"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Address Country"
}
},
"additionalProperties": true,
"type": "object",
"title": "UcpFulfillmentDestination",
"description": "Postal address accepted from or sent to the fulfillment extension.\n\nThe base UCP postal-address schema makes every address component optional.\nOpenMerchant still validates all required ship-to fields before constructing an\noutbound destination; keeping the response model permissive allows partial\nbilling addresses and merchant-managed pickup destinations to round-trip."
},
"UcpFulfillmentMethodType": {
"type": "string",
"enum": [
"shipping",
"pickup",
"digital"
],
"title": "UcpFulfillmentMethodType",
"description": "Fulfillment method vocabulary supported by UCP checkout."
},
"UcpItemReference": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"price": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Price"
},
"image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Url"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id"
],
"title": "UcpItemReference",
"description": "Merchant-recognized product-variant identifier."
},
"UcpMessage": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"type": {
"$ref": "#/$defs/UcpMessageType"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code"
},
"content": {
"type": "string",
"title": "Content"
},
"severity": {
"anyOf": [
{
"$ref": "#/$defs/UcpMessageSeverity"
},
{
"type": "null"
}
]
}
},
"additionalProperties": true,
"type": "object",
"required": [
"type",
"content"
],
"title": "UcpMessage",
"description": "Typed checkout or protocol message prescribing a recovery action."
},
"UcpMessageSeverity": {
"type": "string",
"enum": [
"recoverable",
"requires_buyer_input",
"requires_buyer_review",
"unrecoverable"
],
"title": "UcpMessageSeverity",
"description": "Recovery action prescribed by a UCP checkout message."
},
"UcpMessageType": {
"type": "string",
"enum": [
"error",
"warning",
"info"
],
"title": "UcpMessageType",
"description": "Message types returned on UCP resources and protocol errors."
},
"UcpOrderAdjustment": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"type": {
"type": "string",
"title": "Type"
},
"occurred_at": {
"type": "string",
"format": "date-time",
"title": "Occurred At"
},
"status": {
"$ref": "#/$defs/UcpOrderAdjustmentStatus"
},
"line_items": {
"items": {
"$ref": "#/$defs/UcpOrderAdjustmentLine"
},
"type": "array",
"title": "Line Items"
},
"totals": {
"items": {
"$ref": "#/$defs/UcpTotal"
},
"type": "array",
"title": "Totals"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"type",
"occurred_at",
"status"
],
"title": "UcpOrderAdjustment",
"description": "Post-order refund, return, cancellation, dispute, or other adjustment."
},
"UcpOrderAdjustmentLine": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"quantity": {
"type": "integer",
"title": "Quantity"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"quantity"
],
"title": "UcpOrderAdjustmentLine",
"description": "Signed line quantity added or removed by a post-order adjustment."
},
"UcpOrderAdjustmentStatus": {
"type": "string",
"enum": [
"pending",
"completed",
"failed"
],
"title": "UcpOrderAdjustmentStatus",
"description": "Protocol-defined lifecycle of one post-order adjustment."
},
"UcpOrderAttribution": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
}
},
"additionalProperties": true,
"type": "object",
"title": "UcpOrderAttribution",
"description": "Extensible attribution snapshot copied from the originating checkout."
},
"UcpOrderExpectation": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"line_items": {
"items": {
"$ref": "#/$defs/UcpOrderFulfillmentLine"
},
"type": "array",
"title": "Line Items"
},
"method_type": {
"$ref": "#/$defs/UcpFulfillmentMethodType"
},
"destination": {
"$ref": "#/$defs/UcpFulfillmentDestination"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"fulfillable_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fulfillable On"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"line_items",
"method_type",
"destination"
],
"title": "UcpOrderExpectation",
"description": "Buyer-facing expectation for how an order subset will arrive."
},
"UcpOrderFulfillment": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"expectations": {
"items": {
"$ref": "#/$defs/UcpOrderExpectation"
},
"type": "array",
"title": "Expectations"
},
"events": {
"items": {
"$ref": "#/$defs/UcpOrderFulfillmentEvent"
},
"type": "array",
"title": "Events"
}
},
"additionalProperties": true,
"type": "object",
"title": "UcpOrderFulfillment",
"description": "Current expectations plus append-only fulfillment events."
},
"UcpOrderFulfillmentEvent": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"occurred_at": {
"type": "string",
"format": "date-time",
"title": "Occurred At"
},
"type": {
"type": "string",
"title": "Type"
},
"line_items": {
"items": {
"$ref": "#/$defs/UcpOrderFulfillmentLine"
},
"type": "array",
"title": "Line Items"
},
"tracking_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tracking Number"
},
"tracking_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tracking Url"
},
"carrier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Carrier"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"occurred_at",
"type",
"line_items"
],
"title": "UcpOrderFulfillmentEvent",
"description": "Append-only fulfillment event supplied by the merchant.\n\nThe protocol deliberately leaves ``type`` open for carrier- and\nmerchant-specific lifecycle values, so it remains a validated string\nrather than a closed enum."
},
"UcpOrderFulfillmentLine": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"quantity": {
"type": "integer",
"minimum": 1.0,
"title": "Quantity"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"quantity"
],
"title": "UcpOrderFulfillmentLine",
"description": "Line quantity referenced by an expectation or fulfillment event."
},
"UcpOrderLine": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"item": {
"$ref": "#/$defs/UcpItemReference"
},
"quantity": {
"$ref": "#/$defs/UcpOrderQuantity"
},
"totals": {
"items": {
"$ref": "#/$defs/UcpTotal"
},
"type": "array",
"title": "Totals"
},
"status": {
"$ref": "#/$defs/UcpOrderLineStatus"
},
"parent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"item",
"quantity",
"status"
],
"title": "UcpOrderLine",
"description": "Current post-purchase state of one merchant order line."
},
"UcpOrderLineStatus": {
"type": "string",
"enum": [
"processing",
"partial",
"fulfilled",
"removed"
],
"title": "UcpOrderLineStatus",
"description": "Protocol-defined derived status of one UCP order line."
},
"UcpOrderQuantity": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"original": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Original"
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total"
},
"fulfilled": {
"type": "integer",
"minimum": 0.0,
"title": "Fulfilled"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"total",
"fulfilled"
],
"title": "UcpOrderQuantity",
"description": "Original, active, and fulfilled quantities for one order line."
},
"UcpPaymentHandler": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"id": {
"type": "string",
"title": "Id"
},
"version": {
"type": "string",
"title": "Version"
},
"spec": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Spec"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Schema"
},
"available_instruments": {
"items": {
"$ref": "#/$defs/UcpAvailableInstrument"
},
"type": "array",
"title": "Available Instruments"
},
"config": {
"additionalProperties": true,
"type": "object",
"title": "Config"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"version"
],
"title": "UcpPaymentHandler",
"description": "A tokenized payment handler advertised by a UCP participant."
},
"UcpProtocolProfile": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"version": {
"type": "string",
"title": "Version"
},
"supported_versions": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Supported Versions"
},
"services": {
"additionalProperties": {
"items": {
"$ref": "#/$defs/UcpServiceDeclaration"
},
"type": "array"
},
"type": "object",
"title": "Services"
},
"capabilities": {
"additionalProperties": {
"items": {
"$ref": "#/$defs/UcpCapabilityDeclaration"
},
"type": "array"
},
"type": "object",
"title": "Capabilities"
},
"payment_handlers": {
"additionalProperties": {
"items": {
"$ref": "#/$defs/UcpPaymentHandler"
},
"type": "array"
},
"type": "object",
"title": "Payment Handlers"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"version"
],
"title": "UcpProtocolProfile",
"description": "The nested ``ucp`` object in a discovery profile or response."
},
"UcpServiceDeclaration": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"version": {
"type": "string",
"title": "Version"
},
"spec": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Spec"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Schema"
},
"transport": {
"$ref": "#/$defs/UcpTransport"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Endpoint"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"config": {
"additionalProperties": true,
"type": "object",
"title": "Config"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"version",
"transport"
],
"title": "UcpServiceDeclaration",
"description": "One transport binding in a UCP business or platform profile."
},
"UcpTotal": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"type": {
"type": "string",
"title": "Type"
},
"amount": {
"type": "integer",
"title": "Amount"
},
"display_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Display Text"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"type",
"amount"
],
"title": "UcpTotal",
"description": "One authoritative minor-unit total returned by the merchant."
},
"UcpTransport": {
"type": "string",
"enum": [
"mcp",
"rest",
"a2a",
"embedded"
],
"title": "UcpTransport",
"description": "Transport bindings understood by the UCP discovery client."
},
"UcpVersionRequirement": {
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"min": {
"type": "string",
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Max"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"min"
],
"title": "UcpVersionRequirement",
"description": "Inclusive version range declared by a UCP extension schema."
}
},
"properties": {
"additional_fields": {
"additionalProperties": true,
"type": "object",
"title": "Additional Fields"
},
"ucp": {
"$ref": "#/$defs/UcpProtocolProfile"
},
"id": {
"type": "string",
"title": "Id"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Label"
},
"checkout_id": {
"type": "string",
"title": "Checkout Id"
},
"permalink_url": {
"type": "string",
"title": "Permalink Url"
},
"line_items": {
"items": {
"$ref": "#/$defs/UcpOrderLine"
},
"type": "array",
"title": "Line Items"
},
"fulfillment": {
"$ref": "#/$defs/UcpOrderFulfillment"
},
"adjustments": {
"items": {
"$ref": "#/$defs/UcpOrderAdjustment"
},
"type": "array",
"title": "Adjustments"
},
"currency": {
"anyOf": [
{
"$ref": "#/$defs/CurrencyCode"
},
{
"type": "string"
}
],
"title": "Currency"
},
"totals": {
"items": {
"$ref": "#/$defs/UcpTotal"
},
"type": "array",
"title": "Totals"
},
"messages": {
"items": {
"$ref": "#/$defs/UcpMessage"
},
"type": "array",
"title": "Messages"
},
"attribution": {
"anyOf": [
{
"$ref": "#/$defs/UcpOrderAttribution"
},
{
"type": "null"
}
]
}
},
"additionalProperties": true,
"type": "object",
"required": [
"ucp",
"id",
"checkout_id",
"permalink_url",
"line_items",
"fulfillment",
"currency",
"totals"
],
"title": "UcpOrder",
"description": "Full UCP Order snapshot returned synchronously or by webhook."
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UcpOrderWebhookReceipt"
}
}
}
}
},
"security": [],
"x-api-audience": "public_unauthenticated",
"x-api-authentication": "none",
"x-operation-id": "receive_ucp_order_webhook",
"x-mcp-exposed": false,
"x-public-path": "/api/webhooks/ucp/orders",
"x-docs-kind": "other",
"x-docs-order": 100,
"x-docs-depth": 2,
"x-docs-action-order": 1000
}