Read a partner preorder order

{
  "type": "object",
  "nullable": true,
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Hallify UUID identifying preorder external order.",
      "example": "dadd2857-b22c-4e95-8ed2-2a29c5a47f42"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Monotonic optimistic-concurrency revision for preorder external order. Accepted values enforce minimum 1.",
      "example": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "OPEN",
        "SUSPENDED",
        "SUBMITTED",
        "PAID",
        "CANCELED"
      ],
      "description": "Current lifecycle status of preorder external order; allowed values are OPEN, SUSPENDED, SUBMITTED, PAID, CANCELED.",
      "example": "OPEN"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "ISO 4217 currency code for the monetary values carried by preorder external order.",
      "example": "GEL"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 timestamp for created at; offsets represent the same absolute instant.",
      "example": "2026-01-15T10:00:00.000Z"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 timestamp for updated at; offsets represent the same absolute instant.",
      "example": "2026-01-15T13:00:00.000Z"
    },
    "fulfillment": {
      "type": "object",
      "nullable": true,
      "properties": {
        "revision": {
          "type": "integer",
          "minimum": 1,
          "description": "Monotonic optimistic-concurrency revision for preorder external order fulfillment. Accepted values enforce minimum 1.",
          "example": 1
        },
        "status": {
          "type": "string",
          "enum": [
            "DRAFT",
            "HELD",
            "CONFIRMED",
            "IN_PREPARATION",
            "READY_FOR_HANDOFF",
            "OUT_FOR_DELIVERY",
            "COMPLETED",
            "CANCELED",
            "EXPIRED"
          ],
          "description": "Current lifecycle status of preorder external order fulfillment; allowed values are DRAFT, HELD, CONFIRMED, IN_PREPARATION, READY_FOR_HANDOFF, OUT_FOR_DELIVERY, COMPLETED, CANCELED, EXPIRED.",
          "example": "DRAFT"
        },
        "serviceMode": {
          "type": "string",
          "enum": [
            "DINE_IN",
            "PICKUP",
            "DELIVERY",
            "CATERING"
          ],
          "description": "Allowed service mode for preorder external order fulfillment: DINE_IN, PICKUP, DELIVERY, CATERING.",
          "example": "DINE_IN"
        },
        "scheduledFor": {
          "type": "string",
          "format": "date-time",
          "description": "RFC 3339 timestamp for scheduled for; offsets represent the same absolute instant.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "deliveryMethod": {
          "type": "string",
          "nullable": true,
          "enum": [
            "SELF",
            "UBER_DIRECT",
            "WOLT_DRIVE",
            null
          ],
          "description": "Method of the accepted native delivery pair, SELF for legacy delivery, or null for another service mode.",
          "example": "SELF"
        },
        "deliveryFeeAmount": {
          "type": "string",
          "pattern": "^\\d+\\.\\d{2}$",
          "description": "Native customer delivery-fee snapshot as a fixed-precision decimal string in the order currency. Carrier costs and credentials are not disclosed.",
          "example": "1.00"
        },
        "deliveryTracking": {
          "type": "object",
          "nullable": true,
          "description": "Verified courier progress for the current accepted customer quote pair, or null before any shipment exists. It is independent of the meal and deposit lifecycle.",
          "properties": {
            "shipmentId": {
              "type": "string",
              "format": "uuid",
              "description": "Shipment belonging to the current accepted quote pair.",
              "example": "107f0aae-41ba-4259-84aa-b07de763733f"
            },
            "revision": {
              "type": "integer",
              "minimum": 1,
              "description": "Monotonic courier projection revision.",
              "example": 1
            },
            "provider": {
              "type": "string",
              "enum": [
                "UBER_DIRECT",
                "WOLT_DRIVE"
              ],
              "description": "Delivery provider retained in the accepted delivery demand.",
              "example": "UBER_DIRECT"
            },
            "state": {
              "type": "string",
              "enum": [
                "PREPARED",
                "DISPATCHING",
                "UNKNOWN",
                "CONFIRMED",
                "PICKUP_STARTED",
                "PICKED_UP",
                "IN_TRANSIT",
                "DELIVERED",
                "CANCELED",
                "NOT_DELIVERED",
                "RETURNING",
                "RETURNED",
                "REJECTED",
                "RECONCILIATION_REQUIRED"
              ],
              "description": "Verified courier lifecycle, including explicit uncertainty and reconciliation states.",
              "example": "PREPARED"
            },
            "trackingUrl": {
              "type": "string",
              "nullable": true,
              "format": "uri",
              "maxLength": 2048,
              "description": "Always null for partner orders:read, which does not grant recipient or tracking-link PII access.",
              "example": "https://example.test/resource"
            },
            "pickupEta": {
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "description": "Latest provider pickup estimate as a UTC instant, or null.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "dropoffEtaMin": {
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "description": "Earliest provider dropoff estimate as a UTC instant, or null.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "dropoffEtaMax": {
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "description": "Latest provider dropoff estimate as a UTC instant, or null.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "requiresAttention": {
              "type": "boolean",
              "description": "Courier evidence or native application requires staff attention; it grants no payment or meal-cancellation authority.",
              "example": true
            }
          },
          "required": [
            "shipmentId",
            "revision",
            "provider",
            "state",
            "trackingUrl",
            "pickupEta",
            "dropoffEtaMin",
            "dropoffEtaMax",
            "requiresAttention"
          ],
          "example": {
            "shipmentId": "107f0aae-41ba-4259-84aa-b07de763733f",
            "revision": 1,
            "provider": "UBER_DIRECT",
            "state": "PREPARED",
            "trackingUrl": null,
            "pickupEta": null,
            "dropoffEtaMin": null,
            "dropoffEtaMax": null,
            "requiresAttention": true
          }
        },
        "depositStatus": {
          "type": "string",
          "enum": [
            "NOT_REQUIRED",
            "REQUIRED",
            "PARTIALLY_PAID",
            "PAID",
            "OVERDUE"
          ],
          "description": "Current lifecycle status of preorder external order fulfillment; allowed values are NOT_REQUIRED, REQUIRED, PARTIALLY_PAID, PAID, OVERDUE.",
          "example": "NOT_REQUIRED"
        },
        "depositRequiredAmount": {
          "type": "string",
          "pattern": "^\\d+\\.\\d{2}$",
          "description": "Decimal monetary deposit required amount serialized as a string in the currency identified by the `currency` field; zero is a recorded amount, not absence.",
          "example": "1.00"
        },
        "depositPaidAmount": {
          "type": "string",
          "pattern": "^\\d+\\.\\d{2}$",
          "description": "Decimal monetary deposit paid amount serialized as a string in the currency identified by the `currency` field; zero is a recorded amount, not absence.",
          "example": "1.00"
        },
        "stockReservationState": {
          "type": "string",
          "enum": [
            "NOT_REQUIRED",
            "PENDING",
            "RESERVED",
            "SHORTFALL",
            "CONSUMED",
            "RELEASED"
          ],
          "description": "Allowed stock reservation state for preorder external order fulfillment: NOT_REQUIRED, PENDING, RESERVED, SHORTFALL, CONSUMED, RELEASED.",
          "example": "NOT_REQUIRED"
        },
        "handoffOutcome": {
          "type": "string",
          "nullable": true,
          "enum": [
            "PICKED_UP",
            "DELIVERED",
            "CATERING_HANDOFF",
            null
          ],
          "description": "Allowed handoff outcome for preorder external order fulfillment: PICKED_UP, DELIVERED, CATERING_HANDOFF. Null means no value is recorded for this representation.",
          "example": "PICKED_UP"
        },
        "completedAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "RFC 3339 timestamp for completed at; offsets represent the same absolute instant. Null means no value is recorded for this representation.",
          "example": "2026-01-15T13:00:00.000Z"
        },
        "canceledAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "RFC 3339 timestamp for canceled at; offsets represent the same absolute instant. Null means no value is recorded for this representation.",
          "example": "2026-01-15T12:00:00.000Z"
        }
      },
      "required": [
        "revision",
        "status",
        "serviceMode",
        "scheduledFor",
        "deliveryMethod",
        "deliveryFeeAmount",
        "deliveryTracking",
        "depositStatus",
        "depositRequiredAmount",
        "depositPaidAmount",
        "stockReservationState",
        "handoffOutcome",
        "completedAt",
        "canceledAt"
      ],
      "description": "Fulfillment details embedded in preorder external order containing revision, status, service mode, scheduled for, deposit status, and deposit required amount. Null means no value is recorded for this representation.",
      "example": {
        "revision": 1,
        "status": "DRAFT",
        "serviceMode": "DINE_IN",
        "scheduledFor": "2026-01-15T12:00:00.000Z",
        "deliveryMethod": null,
        "deliveryFeeAmount": "1.00",
        "deliveryTracking": null,
        "depositStatus": "NOT_REQUIRED",
        "depositRequiredAmount": "1.00",
        "depositPaidAmount": "1.00",
        "stockReservationState": "NOT_REQUIRED",
        "handoffOutcome": null,
        "completedAt": null,
        "canceledAt": null
      }
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Hallify UUID identifying preorder external order item.",
            "example": "dadd2857-b22c-4e95-8ed2-2a29c5a47f42"
          },
          "nameSnapshot": {
            "type": "string",
            "description": "Name snapshot for preorder external order item.",
            "example": "Example name"
          },
          "quantity": {
            "type": "number",
            "minimum": 0,
            "description": "Fraction-capable quantity measured in the unit established by the item or line that embeds preorder external order item. Accepted values enforce minimum 0.",
            "example": 1
          },
          "unitPrice": {
            "type": "string",
            "pattern": "^\\d+\\.\\d{2}$",
            "description": "Decimal monetary unit price serialized as a string in the currency identified by the `currency` field; zero is a recorded amount, not absence.",
            "example": "1.00"
          },
          "kitchenStatus": {
            "type": "string",
            "description": "Current lifecycle status of preorder external order item.",
            "example": "example"
          },
          "fullyVoidedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "RFC 3339 timestamp for fully voided at; offsets represent the same absolute instant. Null means no value is recorded for this representation.",
            "example": "2026-01-15T12:00:00.000Z"
          }
        },
        "required": [
          "id",
          "nameSnapshot",
          "quantity",
          "unitPrice",
          "kitchenStatus",
          "fullyVoidedAt"
        ],
        "example": {
          "id": "dadd2857-b22c-4e95-8ed2-2a29c5a47f42",
          "nameSnapshot": "Example name",
          "quantity": 1,
          "unitPrice": "1.00",
          "kitchenStatus": "example",
          "fullyVoidedAt": null
        }
      },
      "description": "Items returned in the preorder external order collection.",
      "example": [
        {
          "id": "dadd2857-b22c-4e95-8ed2-2a29c5a47f42",
          "nameSnapshot": "Example name",
          "quantity": 1,
          "unitPrice": "1.00",
          "kitchenStatus": "example",
          "fullyVoidedAt": null
        }
      ]
    }
  },
  "required": [
    "id",
    "revision",
    "status",
    "currency",
    "createdAt",
    "updatedAt",
    "fulfillment",
    "items"
  ],
  "description": "Returns the partner-visible preorder or the documented absent result when it is outside the credential scope.",
  "example": {
    "id": "dadd2857-b22c-4e95-8ed2-2a29c5a47f42",
    "revision": 1,
    "status": "OPEN",
    "currency": "GEL",
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T13:00:00.000Z",
    "fulfillment": null,
    "items": [
      {
        "id": "dadd2857-b22c-4e95-8ed2-2a29c5a47f42",
        "nameSnapshot": "Example name",
        "quantity": 1,
        "unitPrice": "1.00",
        "kitchenStatus": "example",
        "fullyVoidedAt": null
      }
    ]
  }
}

{
  "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"
  }
}

{
  "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"
  }
}

{
  "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"
}