Skip to content

RelatedShipmentSummary ​

Type: schema

Description ​

Summary of a related shipment (the base shipment of a replacement, or the replacement of a base). Included on a shipment detail only when the shipment is part of a replacement.

TypeScript Definition ​

typescript
RelatedShipmentSummary: {{
            reference_number?: string;
            status?: string;
            fulfillment_type?: string;
            warehouse_id?: string | null;
            warehouse_name?: string | null;
            items?: components["schemas"]["AdminShipmentItem"][];
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            modified_at?: string;
        };
        /** SalesChannel */
}

Component References ​

ReferenceResolves To
components["schemas"]["AdminShipmentItem"]AdminShipmentItem

OpenAPI Schema ​

json
{
  "description": "Summary of a related shipment (the base shipment of a replacement, or the replacement of a base). Included on a shipment detail only when the shipment is part of a replacement.",
  "type": "object",
  "properties": {
    "reference_number": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "fulfillment_type": {
      "type": "string"
    },
    "warehouse_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "warehouse_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AdminShipmentItem"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "title": "RelatedShipmentSummary"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: