Skip to content

ShippingZoneDetail ​

Type: schema

TypeScript Definition ​

typescript
ShippingZoneDetail: {{
            id?: string;
            name?: string;
            countries?: components["schemas"]["Country"][];
            /** @default true */
            active: boolean;
            is_default?: boolean;
            available_shipping_options?: $Read<components["schemas"]["ShippingOption"][]>;
            shipping_providers?: $Read<components["schemas"]["ShippingOption"][]>;
            manual_methods?: $Read<components["schemas"]["ShippingOption"][]>;
        };
        /**
         * SingleSelectAttribute
         * @description Attribute for single-select values
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["Country"]Country
components["schemas"]["ShippingOption"]ShippingOption

OpenAPI Schema ​

json
{
  "title": "ShippingZoneDetail",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "countries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Country"
      }
    },
    "active": {
      "type": "boolean",
      "default": true
    },
    "is_default": {
      "type": "boolean"
    },
    "available_shipping_options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShippingOption"
      },
      "readOnly": true
    },
    "shipping_providers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShippingOption"
      },
      "readOnly": true
    },
    "manual_methods": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShippingOption"
      },
      "readOnly": true
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: