Skip to content

CreateReplacementShipmentWithManualMethod ​

Type: schema

Description ​

Replacement shipment payload when fulfilling through a manual courier (no carrier integration).

TypeScript Definition ​

typescript
CreateReplacementShipmentWithManualMethod: {{
            /**
             * @description Set to `delivery` when the replacement is shipped to the customer.
             * @constant
             */
            fulfillment_type?: "delivery";
            /** @description The warehouse from which the replacement items will be shipped. */
            warehouse_id: string;
            shipment_items: components["schemas"]["AdminShipmentItem"][];
            /**
             * @description Set to `manual` to dispatch the shipment outside of an integrated carrier.
             * @enum {unknown}
             */
            shipping_option: "manual";
            /** @description The manual shipping provider used to fulfill the replacement. */
            shipping_provider_id: string;
            /**
             * @description The packing option for the replacement shipment.
             * @enum {unknown}
             */
            packing_option: "manual" | "auto";
            /** @description The boxes for the replacement shipment. */
            boxes?: components["schemas"]["ShipmentBox"][];
            /** @description Total shipment weight in kilograms, used for rate calculation by the carrier. */
            total_weight: number;
            /**
             * Format: date
             * @description The expected delivery date communicated to the customer.
             */
            expected_delivery_date: string | null;
            /** @description Optional tracking URL shared with the customer. */
            tracking_link: string | null;
            /** @description Shipping charges incurred for the manual dispatch. */
            manual_shipping_charges: number | null;
            /** @description The reason for the replacement shipment. */
            reason?: string;
        };
}

Component References ​

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

OpenAPI Schema ​

json
{
  "description": "Replacement shipment payload when fulfilling through a manual courier (no carrier integration).",
  "type": "object",
  "properties": {
    "fulfillment_type": {
      "description": "Set to `delivery` when the replacement is shipped to the customer.",
      "type": "string",
      "const": "delivery"
    },
    "warehouse_id": {
      "description": "The warehouse from which the replacement items will be shipped.",
      "type": "string"
    },
    "shipment_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AdminShipmentItem"
      }
    },
    "shipping_option": {
      "description": "Set to `manual` to dispatch the shipment outside of an integrated carrier.",
      "enum": [
        "manual"
      ]
    },
    "shipping_provider_id": {
      "description": "The manual shipping provider used to fulfill the replacement.",
      "type": "string"
    },
    "packing_option": {
      "description": "The packing option for the replacement shipment.",
      "enum": [
        "manual",
        "auto"
      ]
    },
    "boxes": {
      "description": "The boxes for the replacement shipment.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShipmentBox"
      }
    },
    "total_weight": {
      "description": "Total shipment weight in kilograms, used for rate calculation by the carrier.",
      "type": "number"
    },
    "expected_delivery_date": {
      "description": "The expected delivery date communicated to the customer.",
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "tracking_link": {
      "description": "Optional tracking URL shared with the customer.",
      "type": [
        "string",
        "null"
      ]
    },
    "manual_shipping_charges": {
      "description": "Shipping charges incurred for the manual dispatch.",
      "type": [
        "number",
        "null"
      ]
    },
    "reason": {
      "description": "The reason for the replacement shipment.",
      "type": "string"
    }
  },
  "required": [
    "warehouse_id",
    "shipment_items",
    "shipping_option",
    "shipping_provider_id",
    "packing_option",
    "total_weight",
    "expected_delivery_date",
    "tracking_link",
    "manual_shipping_charges"
  ],
  "title": "CreateReplacementShipmentWithManualMethod",
  "x-tags": [
    "Shipping"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: