ShipmentInfo

Type: schema

TypeScript Definition

ShipmentInfo: {{
            order_number: string;
            order_status: string;
            shipment_number: string;
            warehouse_id: string;
            warehouse_name: string | null;
            status: components["schemas"]["ShipmentStatus"];
            total_weight: number;
            total_boxes: number | null;
            shipment_items_count: number;
            /** Format: double */
            shipping_estimated_cost: number;
            /** Format: double */
            shipping_discount_amount: number;
            /** Format: double */
            shipping_amount: number;
            /** Format: double */
            shipping_tax_rate: number;
            /** Format: double */
            shipping_tax_amount: number;
            /** Format: double */
            shipping_amount_including_tax: number;
            shipping_provider_id: string | null;
            shipping_provider_name: string | null;
            courier_company_id: string | null;
            courier_company_name: string | null;
            courier_company_image_url: string | null;
            awb_no: string | null;
            shipping_label_url: string | null;
            eta_delivery: string | null;
            estimated_delivery_date: string | null;
            promised_delivery_date: string | null;
            out_for_delivery_date?: string | null;
            shipped_date: string | null;
            delivered_date: string | null;
            returned_date: string | null;
            /** @enum {unknown} */
            fulfillment_type: "delivery" | "collect-in-store";
            slo: {
                /** Format: date */
                expected_date?: string;
                /** Format: date */
                actual_date?: string;
                difference?: string;
                /** @enum {unknown} */
                slo_status?: "on-time" | "delay" | "early";
            };
            cancellation_reason: string | null;
            customer_id: string;
            customer_name: string;
            shipping_address_line1: string;
            shipping_address_line2: string | null;
            shipping_landmark: string | null;
            shipping_pincode: string;
            shipping_city: string;
            shipping_state: string;
            created_at: string;
            modified_at: string;
        };
        /**
         * ShipmentItem
         * @description Shipment item model
         */
}

Component References

Reference	Resolves To
components["schemas"]["ShipmentStatus"]	ShipmentStatus

OpenAPI Schema

{
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string"
    },
    "order_status": {
      "type": "string"
    },
    "shipment_number": {
      "type": "string"
    },
    "warehouse_id": {
      "type": "string"
    },
    "warehouse_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "$ref": "#/components/schemas/ShipmentStatus"
    },
    "total_weight": {
      "type": "number"
    },
    "total_boxes": {
      "type": [
        "integer",
        "null"
      ]
    },
    "shipment_items_count": {
      "type": "integer"
    },
    "shipping_estimated_cost": {
      "type": "number",
      "format": "double"
    },
    "shipping_discount_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_tax_rate": {
      "type": "number",
      "format": "double"
    },
    "shipping_tax_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount_including_tax": {
      "type": "number",
      "format": "double"
    },
    "shipping_provider_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_provider_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "courier_company_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "courier_company_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "courier_company_image_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "awb_no": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_label_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "eta_delivery": {
      "type": [
        "string",
        "null"
      ]
    },
    "estimated_delivery_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "promised_delivery_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "out_for_delivery_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipped_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "delivered_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "returned_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "fulfillment_type": {
      "enum": [
        "delivery",
        "collect-in-store"
      ]
    },
    "slo": {
      "type": "object",
      "properties": {
        "expected_date": {
          "type": "string",
          "format": "date"
        },
        "actual_date": {
          "type": "string",
          "format": "date"
        },
        "difference": {
          "type": "string"
        },
        "slo_status": {
          "enum": [
            "on-time",
            "delay",
            "early"
          ]
        }
      }
    },
    "cancellation_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "customer_id": {
      "type": "string"
    },
    "customer_name": {
      "type": "string"
    },
    "shipping_address_line1": {
      "type": "string"
    },
    "shipping_address_line2": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_landmark": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_pincode": {
      "type": "string"
    },
    "shipping_city": {
      "type": "string"
    },
    "shipping_state": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "modified_at": {
      "type": "string"
    }
  },
  "required": [
    "order_number",
    "order_status",
    "shipment_number",
    "warehouse_id",
    "warehouse_name",
    "status",
    "total_weight",
    "total_boxes",
    "shipment_items_count",
    "shipping_estimated_cost",
    "shipping_discount_amount",
    "shipping_amount",
    "shipping_tax_rate",
    "shipping_tax_amount",
    "shipping_amount_including_tax",
    "shipping_provider_id",
    "shipping_provider_name",
    "courier_company_id",
    "courier_company_name",
    "courier_company_image_url",
    "awb_no",
    "shipping_label_url",
    "eta_delivery",
    "estimated_delivery_date",
    "promised_delivery_date",
    "shipped_date",
    "delivered_date",
    "returned_date",
    "fulfillment_type",
    "slo",
    "cancellation_reason",
    "customer_id",
    "customer_name",
    "shipping_address_line1",
    "shipping_address_line2",
    "shipping_landmark",
    "shipping_pincode",
    "shipping_city",
    "shipping_state",
    "created_at",
    "modified_at"
  ],
  "title": "ShipmentInfo",
  "x-tags": [
    "Shipping"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions