Skip to content

StoreConfigWarehouseManualMethod ​

Type: schema

Description ​

Manual shipping method on a warehouse as returned in StoreConfig.

TypeScript Definition ​

typescript
StoreConfigWarehouseManualMethod: {{
            id?: string;
            name?: string;
            description?: string | null;
            is_connected?: boolean;
            is_forward_shipping?: boolean;
            is_return_shipping?: boolean;
            logo_dark?: $Read<string | null>;
            logo_light?: $Read<string | null>;
            logo?: $Read<string | null>;
            /** @enum {unknown} */
            fulfillment_type?: $Read<"delivery" | "collect-in-store">;
            sort_order?: $Read<number>;
            /** @enum {unknown} */
            status?: "active" | "inactive";
            /** @enum {unknown} */
            shipping_method_type?: "manual" | "local-pickup";
            shipping_rate_name?: string | null;
            /** @description `null` when `shipping_rate_condition` is set. */
            shipping_rate_fixed_price?: number | null;
            /** @description `null` when `shipping_rate_fixed_price` is set. */
            shipping_rate_condition?: components["schemas"]["ManualShippingRateCondition"] | null;
            /** @description `null` when there is no weight limit. */
            maximum_weight?: number | null;
            /** @description In days. */
            delivery_leadtime_minimum?: number;
            /** @description In days. */
            delivery_leadtime_maximum?: number;
        };
        /**
         * StoreConfigWarehouseSalesChannel
         * @description Sales channel on a warehouse as returned in `StoreConfig`.
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["ManualShippingRateCondition"]ManualShippingRateCondition

OpenAPI Schema ​

json
{
  "title": "StoreConfigWarehouseManualMethod",
  "description": "Manual shipping method on a warehouse as returned in `StoreConfig`.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_connected": {
      "type": "boolean"
    },
    "is_forward_shipping": {
      "type": "boolean"
    },
    "is_return_shipping": {
      "type": "boolean"
    },
    "logo_dark": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "logo_light": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "logo": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "fulfillment_type": {
      "enum": [
        "delivery",
        "collect-in-store"
      ],
      "readOnly": true
    },
    "sort_order": {
      "type": "integer",
      "readOnly": true
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ]
    },
    "shipping_method_type": {
      "enum": [
        "manual",
        "local-pickup"
      ]
    },
    "shipping_rate_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_rate_fixed_price": {
      "description": "`null` when `shipping_rate_condition` is set.",
      "type": [
        "number",
        "null"
      ]
    },
    "shipping_rate_condition": {
      "description": "`null` when `shipping_rate_fixed_price` is set.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/ManualShippingRateCondition"
        },
        {
          "type": "null"
        }
      ]
    },
    "maximum_weight": {
      "description": "`null` when there is no weight limit.",
      "type": [
        "number",
        "null"
      ]
    },
    "delivery_leadtime_minimum": {
      "description": "In days.",
      "type": "integer"
    },
    "delivery_leadtime_maximum": {
      "description": "In days.",
      "type": "integer"
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: