612 lines
15 KiB
Plaintext
612 lines
15 KiB
Plaintext
---
|
|
displayed_sidebar: entitiesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# ShippingOptionRequirement
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"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": "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": "shipping_option_id",
|
|
"type": "`string`",
|
|
"description": "",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "[`RequirementType`](../enums/RequirementType.mdx)",
|
|
"description": "",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"children": [
|
|
{
|
|
"name": "MAX_SUBTOTAL",
|
|
"type": "``\"max_subtotal\"``",
|
|
"description": "",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "MIN_SUBTOTAL",
|
|
"type": "``\"min_subtotal\"``",
|
|
"description": "",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"children": []
|
|
}
|
|
]
|
|
}
|
|
]} />
|