Skip to content

ShipmentDetail

Type: schema

TypeScript Definition

typescript
ShipmentDetail: {{
            order_number?: string;
            /** Format: date-time */
            order_date?: string;
            order_status?: string;
            /** @enum {unknown} */
            payment_status?: "pending" | "success" | "failed";
            customer_name?: string;
            shipments?: components["schemas"]["Shipment"][];
            /** @description dynamic values as per current status of the shipment. */
            allowed_actions?: string[];
        };
        /** ShipmentInfo */
}

Component References

ReferenceResolves To
components["schemas"]["Shipment"]Shipment

OpenAPI Schema

json
{
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string"
    },
    "order_date": {
      "type": "string",
      "format": "date-time"
    },
    "order_status": {
      "type": "string"
    },
    "payment_status": {
      "enum": [
        "pending",
        "success",
        "failed"
      ]
    },
    "customer_name": {
      "type": "string"
    },
    "shipments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Shipment"
      }
    },
    "allowed_actions": {
      "description": "dynamic values as per current status of the shipment.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "title": "ShipmentDetail",
  "x-tags": [
    "Shipping"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: