ShipmentInfo

Type: schema

TypeScript Definition

ShipmentInfo: {{
            order_number?: string;
            order_status?: string;
            shipment_number?: string;
            warehouse_id?: string;
            warehouse_name?: string;
            status?: string;
            total_weight?: number;
            total_boxes?: number;
            shipment_items_count?: number;
            /** Format: double */
            shipping_amount?: number;
            /** Format: double */
            shipping_tax_amount?: number;
            /** Format: double */
            shipping_amount_including_tax?: number;
            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;
            shipped_date?: string | null;
            delivered_date?: string | null;
            slo?: {
                /** Format: date */
                expected_date?: string;
                /** Format: date */
                actual_date?: string;
                difference?: string;
            };
            cancellation_reason?: string | null;
            customer_id?: string;
            customer_name?: string;
            shipping_address_line1?: string;
            shipping_address_line2?: string;
            shipping_landmark?: string;
            shipping_pincode?: string;
            shipping_city?: string;
            shipping_state?: string;
            created_at?: string;
            modified_at?: string;
        };
        /**
         * ShipmentItem
         * @description Shipment item model
         */
}

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"
    },
    "status": {
      "type": "string"
    },
    "total_weight": {
      "type": "number"
    },
    "total_boxes": {
      "type": "integer"
    },
    "shipment_items_count": {
      "type": "integer"
    },
    "shipping_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_tax_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount_including_tax": {
      "type": "number",
      "format": "double"
    },
    "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"
      ]
    },
    "shipped_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "delivered_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "slo": {
      "type": "object",
      "properties": {
        "expected_date": {
          "type": "string",
          "format": "date"
        },
        "actual_date": {
          "type": "string",
          "format": "date"
        },
        "difference": {
          "type": "string"
        }
      }
    },
    "cancellation_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "customer_id": {
      "type": "string"
    },
    "customer_name": {
      "type": "string"
    },
    "shipping_address_line1": {
      "type": "string"
    },
    "shipping_address_line2": {
      "type": "string"
    },
    "shipping_landmark": {
      "type": "string"
    },
    "shipping_pincode": {
      "type": "string"
    },
    "shipping_city": {
      "type": "string"
    },
    "shipping_state": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "modified_at": {
      "type": "string"
    }
  },
  "title": "ShipmentInfo",
  "x-tags": [
    "Shipping"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions