--- displayed_sidebar: entitiesSidebar --- import ParameterTypes from "@site/src/components/ParameterTypes" # ShippingProfile ## Properties ", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "products", "type": "[`Product`](Product.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Product`](Product.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "categories", "type": "[`ProductCategory`](ProductCategory.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ProductCategory`](ProductCategory.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "category_children", "type": "[`ProductCategory`](ProductCategory.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "description", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "handle", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_active", "type": "`Boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_internal", "type": "`Boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "parent_category", "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "parent_category_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "products", "type": "[`Product`](Product.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "rank", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "productCategoryProductJoinTable", "type": "`string`", "description": "", "optional": false, "defaultValue": "`\"product_category_product\"`", "children": [] }, { "name": "treeRelations", "type": "`string`[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "collection", "type": "[`ProductCollection`](ProductCollection.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ProductCollection`](ProductCollection.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "handle", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "products", "type": "[`Product`](Product.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "createHandleIfNotProvided", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "collection_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discountable", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "handle", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "images", "type": "[`Image`](Image.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Image`](Image.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "url", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "is_giftcard", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "options", "type": "[`ProductOption`](ProductOption.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ProductOption`](ProductOption.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "product", "type": "[`Product`](Product.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "product_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "values", "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "profile", "type": "[`ShippingProfile`](ShippingProfile.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "products", "type": "[`Product`](Product.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_options", "type": "[`ShippingOption`](ShippingOption.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "profile_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "profiles", "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "products", "type": "[`Product`](Product.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_options", "type": "[`ShippingOption`](ShippingOption.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "sales_channels", "type": "[`SalesChannel`](SalesChannel.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`SalesChannel`](SalesChannel.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "status", "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "DRAFT", "type": "``\"draft\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PROPOSED", "type": "``\"proposed\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PUBLISHED", "type": "``\"published\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "REJECTED", "type": "``\"rejected\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "subtitle", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tags", "type": "[`ProductTag`](ProductTag.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ProductTag`](ProductTag.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "value", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`ProductType`](ProductType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ProductType`](ProductType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "value", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "type_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variants", "type": "[`ProductVariant`](ProductVariant.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ProductVariant`](ProductVariant.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "product", "type": "[`Product`](Product.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "product_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "afterLoad", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeUpdate", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "shipping_options", "type": "[`ShippingOption`](ShippingOption.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ShippingOption`](ShippingOption.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "admin_only", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "price_type", "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "CALCULATED", "type": "``\"calculated\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "FLAT_RATE", "type": "``\"flat_rate\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "profile", "type": "[`ShippingProfile`](ShippingProfile.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "products", "type": "[`Product`](Product.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_options", "type": "[`ShippingOption`](ShippingOption.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "profile_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "provider_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "automatic_taxes", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "countries", "type": "[`Country`](Country.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "currency", "type": "[`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "currency_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](TaxProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "requirements", "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](ShippingOption.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`RequirementType`](../enums/RequirementType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "type", "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "CUSTOM", "type": "``\"custom\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "DEFAULT", "type": "``\"default\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "GIFT_CARD", "type": "``\"gift_card\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] } ]} />