import ParameterTypes from "@site/src/components/ParameterTypes"

# CreatePriceListDTO

## Properties

<ParameterTypes parameters={[
  {
    "name": "customer_groups",
    "type": "`object`[]",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "ends_at",
    "type": "`string`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "number_rules",
    "type": "`number`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "prices",
    "type": "`object`[]",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "amount",
        "type": "`number`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "currency_code",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "max_quantity",
        "type": "`number`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "min_quantity",
        "type": "`number`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "region_id",
        "type": "`string`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "rules",
    "type": "[PriceListRuleDTO](../../types/interfaces/types.PriceListRuleDTO.mdx)[]",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "id",
        "type": "`string`",
        "description": "The price list rule's ID.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price_list",
        "type": "[PriceListDTO](../../types/interfaces/types.PriceListDTO.mdx)",
        "description": "The associated price list.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "ends_at",
            "type": "`null` \\| `string`",
            "description": "The price list expires after this date.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The price list's ID.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "money_amounts",
            "type": "[MoneyAmountDTO](../../types/interfaces/types.MoneyAmountDTO.mdx)[]",
            "description": "The associated money amounts.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "number_rules",
            "type": "`number`",
            "description": "The number of rules associated with this price list.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "price_list_rules",
            "type": "[PriceListRuleDTO](../../types/interfaces/types.PriceListRuleDTO.mdx)[]",
            "description": "The price set's rules.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "price_set_money_amounts",
            "type": "[PriceSetMoneyAmountDTO](../../types/interfaces/types.PriceSetMoneyAmountDTO.mdx)[]",
            "description": "The associated price set money amounts.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rule_types",
            "type": "[RuleTypeDTO](../../types/interfaces/types.RuleTypeDTO.mdx)[]",
            "description": "The associated rule types.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rules",
            "type": "[PriceListRuleDTO](../../types/interfaces/types.PriceListRuleDTO.mdx)[]",
            "description": "The price set's rules.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "starts_at",
            "type": "`null` \\| `string`",
            "description": "The price list is enabled starting from this date.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[PriceListStatus](../../types/enums/types.PriceListStatus.mdx)",
            "description": "The price list's status.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "title",
            "type": "`string`",
            "description": "The price list's title.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "price_list_rule_values",
        "type": "[PriceListRuleValueDTO](../../types/interfaces/types.PriceListRuleValueDTO.mdx)[]",
        "description": "The associated rule values.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "id",
            "type": "`string`",
            "description": "The price list rule value's ID.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "price_list_rule",
            "type": "[PriceListRuleDTO](../../types/interfaces/types.PriceListRuleDTO.mdx)",
            "description": "The associated price list rule.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "value",
            "type": "`string`",
            "description": "The rule's value.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "rule_type",
        "type": "[RuleTypeDTO](../../types/interfaces/types.RuleTypeDTO.mdx)",
        "description": "The associated rule type.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "default_priority",
            "type": "`number`",
            "description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The display name of the rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "rule_attribute",
            "type": "`string`",
            "description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "value",
        "type": "`string`",
        "description": "The value of the rule.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "starts_at",
    "type": "`string`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "status",
    "type": "[PriceListStatus](../../types/enums/types.PriceListStatus.mdx)",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "ACTIVE",
        "type": "`\"active\"`",
        "description": "The price list is enabled and its prices can be used.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "DRAFT",
        "type": "`\"draft\"`",
        "description": "The price list is disabled, meaning its prices can't be used yet.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
