Skip to content

ShippingConfig ​

Type: schema

TypeScript Definition ​

typescript
ShippingConfig: {{
            /**
             * @description - cost - the lowest cost of shipment
             *     - bins_utilization - max. utilization inside packing spaces
             *     - bins_number - the smallest possible number of packing spaces
             * @enum {unknown}
             */
            packaging_optimisation_logic?: "cost" | "bins_utilization" | "bins_number";
            /** @enum {unknown} */
            location_priority?: "manual" | "distance" | "inventory";
            /** @description optional. required only if location_priority = manual. Value should be array of warehouses ids. */
            warehouse_id?: string[] | null;
            /**
             * @default auto
             * @enum {unknown}
             */
            approval_option: "auto" | "manual";
            /**
             * @description Omitted when shipping is not configured for the store.
             * @enum {unknown}
             */
            shipping_option?: "auto" | "manual";
            /** @description Specifies the default weight (in kilograms) used to calculate shipping costs when product packing details are missing. This value ensures that shipping estimates can still be generated in the absence of product packing information. */
            default_weight?: number;
        } & {
            [key: string]: unknown;
        };
        /** ShippingCostAction */
}

OpenAPI Schema ​

json
{
  "title": "ShippingConfig",
  "type": "object",
  "properties": {
    "packaging_optimisation_logic": {
      "description": "- cost - the lowest cost of shipment\n- bins_utilization - max. utilization inside packing spaces\n- bins_number - the smallest possible number of packing spaces",
      "enum": [
        "cost",
        "bins_utilization",
        "bins_number"
      ]
    },
    "location_priority": {
      "enum": [
        "manual",
        "distance",
        "inventory"
      ]
    },
    "warehouse_id": {
      "description": "optional. required only if location_priority = manual. Value should be array of warehouses ids.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "approval_option": {
      "default": "auto",
      "enum": [
        "auto",
        "manual"
      ]
    },
    "shipping_option": {
      "description": "Omitted when shipping is not configured for the store.",
      "enum": [
        "auto",
        "manual"
      ]
    },
    "default_weight": {
      "description": "Specifies the default weight (in kilograms) used to calculate shipping costs when product packing details are missing. This value ensures that shipping estimates can still be generated in the absence of product packing information.",
      "type": "number"
    }
  },
  "additionalProperties": true,
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: