Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. BusinessUnitDivision
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.BusinessUnitDivision

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    business unit type to represent the top level of a business. Contains specific fields and values that differentiate a Division from the generic BusinessUnit.

    See also the business unit API Documentation User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.

    • name (String) The name of the division.

    Create BusinessUnitDivision Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BusinessUnitDivision(name: string, args: BusinessUnitDivisionArgs, opts?: CustomResourceOptions);
    @overload
def BusinessUnitDivision(resource_name: str,
                         args: BusinessUnitDivisionArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def BusinessUnitDivision(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         key: Optional[str] = None,
                         default_billing_address_key: Optional[str] = None,
                         approval_rule_mode: Optional[str] = None,
                         billing_address_keys: Optional[Sequence[str]] = None,
                         contact_email: Optional[str] = None,
                         custom: Optional[BusinessUnitDivisionCustomArgs] = None,
                         addresses: Optional[Sequence[BusinessUnitDivisionAddressArgs]] = None,
                         default_shipping_address_key: Optional[str] = None,
                         associate_mode: Optional[str] = None,
                         name: Optional[str] = None,
                         parent_unit: Optional[BusinessUnitDivisionParentUnitArgs] = None,
                         shipping_address_keys: Optional[Sequence[str]] = None,
                         status: Optional[str] = None,
                         store_mode: Optional[str] = None,
                         stores: Optional[Sequence[BusinessUnitDivisionStoreArgs]] = None)
    func NewBusinessUnitDivision(ctx *Context, name string, args BusinessUnitDivisionArgs, opts ...ResourceOption) (*BusinessUnitDivision, error)
    public BusinessUnitDivision(string name, BusinessUnitDivisionArgs args, CustomResourceOptions? opts = null)
    public BusinessUnitDivision(String name, BusinessUnitDivisionArgs args)
public BusinessUnitDivision(String name, BusinessUnitDivisionArgs args, CustomResourceOptions options)

    type: commercetools:BusinessUnitDivision
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BusinessUnitDivisionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BusinessUnitDivisionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BusinessUnitDivisionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BusinessUnitDivisionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BusinessUnitDivisionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var businessUnitDivisionResource = new Commercetools.BusinessUnitDivision("businessUnitDivisionResource", new()
{
    Key = "string",
    DefaultBillingAddressKey = "string",
    ApprovalRuleMode = "string",
    BillingAddressKeys = new[]
    {
        "string",
    },
    ContactEmail = "string",
    Custom = new Commercetools.Inputs.BusinessUnitDivisionCustomArgs
    {
        Fields = 
        {
            { "string", "string" },
        },
        TypeId = "string",
    },
    Addresses = new[]
    {
        new Commercetools.Inputs.BusinessUnitDivisionAddressArgs
        {
            Country = "string",
            Key = "string",
            Id = "string",
            Title = "string",
            AdditionalAddressInfo = "string",
            Company = "string",
            Apartment = "string",
            Department = "string",
            Email = "string",
            ExternalId = "string",
            Fax = "string",
            LastName = "string",
            City = "string",
            Building = "string",
            FirstName = "string",
            Mobile = "string",
            Phone = "string",
            PoBox = "string",
            PostalCode = "string",
            Region = "string",
            Salutation = "string",
            State = "string",
            StreetName = "string",
            StreetNumber = "string",
            AdditionalStreetInfo = "string",
        },
    },
    DefaultShippingAddressKey = "string",
    AssociateMode = "string",
    Name = "string",
    ParentUnit = new Commercetools.Inputs.BusinessUnitDivisionParentUnitArgs
    {
        Id = "string",
        Key = "string",
    },
    ShippingAddressKeys = new[]
    {
        "string",
    },
    Status = "string",
    StoreMode = "string",
    Stores = new[]
    {
        new Commercetools.Inputs.BusinessUnitDivisionStoreArgs
        {
            Key = "string",
        },
    },
});

    example, err := commercetools.NewBusinessUnitDivision(ctx, "businessUnitDivisionResource", &commercetools.BusinessUnitDivisionArgs{
Key: pulumi.String("string"),
DefaultBillingAddressKey: pulumi.String("string"),
ApprovalRuleMode: pulumi.String("string"),
BillingAddressKeys: pulumi.StringArray{
pulumi.String("string"),
},
ContactEmail: pulumi.String("string"),
Custom: &.BusinessUnitDivisionCustomArgs{
Fields: pulumi.StringMap{
"string": pulumi.String("string"),
},
TypeId: pulumi.String("string"),
},
Addresses: .BusinessUnitDivisionAddressArray{
&.BusinessUnitDivisionAddressArgs{
Country: pulumi.String("string"),
Key: pulumi.String("string"),
Id: pulumi.String("string"),
Title: pulumi.String("string"),
AdditionalAddressInfo: pulumi.String("string"),
Company: pulumi.String("string"),
Apartment: pulumi.String("string"),
Department: pulumi.String("string"),
Email: pulumi.String("string"),
ExternalId: pulumi.String("string"),
Fax: pulumi.String("string"),
LastName: pulumi.String("string"),
City: pulumi.String("string"),
Building: pulumi.String("string"),
FirstName: pulumi.String("string"),
Mobile: pulumi.String("string"),
Phone: pulumi.String("string"),
PoBox: pulumi.String("string"),
PostalCode: pulumi.String("string"),
Region: pulumi.String("string"),
Salutation: pulumi.String("string"),
State: pulumi.String("string"),
StreetName: pulumi.String("string"),
StreetNumber: pulumi.String("string"),
AdditionalStreetInfo: pulumi.String("string"),
},
},
DefaultShippingAddressKey: pulumi.String("string"),
AssociateMode: pulumi.String("string"),
Name: pulumi.String("string"),
ParentUnit: &.BusinessUnitDivisionParentUnitArgs{
Id: pulumi.String("string"),
Key: pulumi.String("string"),
},
ShippingAddressKeys: pulumi.StringArray{
pulumi.String("string"),
},
Status: pulumi.String("string"),
StoreMode: pulumi.String("string"),
Stores: .BusinessUnitDivisionStoreArray{
&.BusinessUnitDivisionStoreArgs{
Key: pulumi.String("string"),
},
},
})

    var businessUnitDivisionResource = new BusinessUnitDivision("businessUnitDivisionResource", BusinessUnitDivisionArgs.builder()
    .key("string")
    .defaultBillingAddressKey("string")
    .approvalRuleMode("string")
    .billingAddressKeys("string")
    .contactEmail("string")
    .custom(BusinessUnitDivisionCustomArgs.builder()
        .fields(Map.of("string", "string"))
        .typeId("string")
        .build())
    .addresses(BusinessUnitDivisionAddressArgs.builder()
        .country("string")
        .key("string")
        .id("string")
        .title("string")
        .additionalAddressInfo("string")
        .company("string")
        .apartment("string")
        .department("string")
        .email("string")
        .externalId("string")
        .fax("string")
        .lastName("string")
        .city("string")
        .building("string")
        .firstName("string")
        .mobile("string")
        .phone("string")
        .poBox("string")
        .postalCode("string")
        .region("string")
        .salutation("string")
        .state("string")
        .streetName("string")
        .streetNumber("string")
        .additionalStreetInfo("string")
        .build())
    .defaultShippingAddressKey("string")
    .associateMode("string")
    .name("string")
    .parentUnit(BusinessUnitDivisionParentUnitArgs.builder()
        .id("string")
        .key("string")
        .build())
    .shippingAddressKeys("string")
    .status("string")
    .storeMode("string")
    .stores(BusinessUnitDivisionStoreArgs.builder()
        .key("string")
        .build())
    .build());

    business_unit_division_resource = commercetools.BusinessUnitDivision("businessUnitDivisionResource",
    key="string",
    default_billing_address_key="string",
    approval_rule_mode="string",
    billing_address_keys=["string"],
    contact_email="string",
    custom={
        "fields": {
            "string": "string",
        },
        "type_id": "string",
    },
    addresses=[{
        "country": "string",
        "key": "string",
        "id": "string",
        "title": "string",
        "additional_address_info": "string",
        "company": "string",
        "apartment": "string",
        "department": "string",
        "email": "string",
        "external_id": "string",
        "fax": "string",
        "last_name": "string",
        "city": "string",
        "building": "string",
        "first_name": "string",
        "mobile": "string",
        "phone": "string",
        "po_box": "string",
        "postal_code": "string",
        "region": "string",
        "salutation": "string",
        "state": "string",
        "street_name": "string",
        "street_number": "string",
        "additional_street_info": "string",
    }],
    default_shipping_address_key="string",
    associate_mode="string",
    name="string",
    parent_unit={
        "id": "string",
        "key": "string",
    },
    shipping_address_keys=["string"],
    status="string",
    store_mode="string",
    stores=[{
        "key": "string",
    }])

    const businessUnitDivisionResource = new commercetools.BusinessUnitDivision("businessUnitDivisionResource", {
    key: "string",
    defaultBillingAddressKey: "string",
    approvalRuleMode: "string",
    billingAddressKeys: ["string"],
    contactEmail: "string",
    custom: {
        fields: {
            string: "string",
        },
        typeId: "string",
    },
    addresses: [{
        country: "string",
        key: "string",
        id: "string",
        title: "string",
        additionalAddressInfo: "string",
        company: "string",
        apartment: "string",
        department: "string",
        email: "string",
        externalId: "string",
        fax: "string",
        lastName: "string",
        city: "string",
        building: "string",
        firstName: "string",
        mobile: "string",
        phone: "string",
        poBox: "string",
        postalCode: "string",
        region: "string",
        salutation: "string",
        state: "string",
        streetName: "string",
        streetNumber: "string",
        additionalStreetInfo: "string",
    }],
    defaultShippingAddressKey: "string",
    associateMode: "string",
    name: "string",
    parentUnit: {
        id: "string",
        key: "string",
    },
    shippingAddressKeys: ["string"],
    status: "string",
    storeMode: "string",
    stores: [{
        key: "string",
    }],
});

    type: commercetools:BusinessUnitDivision
properties:
    addresses:
        - additionalAddressInfo: string
          additionalStreetInfo: string
          apartment: string
          building: string
          city: string
          company: string
          country: string
          department: string
          email: string
          externalId: string
          fax: string
          firstName: string
          id: string
          key: string
          lastName: string
          mobile: string
          phone: string
          poBox: string
          postalCode: string
          region: string
          salutation: string
          state: string
          streetName: string
          streetNumber: string
          title: string
    approvalRuleMode: string
    associateMode: string
    billingAddressKeys:
        - string
    contactEmail: string
    custom:
        fields:
            string: string
        typeId: string
    defaultBillingAddressKey: string
    defaultShippingAddressKey: string
    key: string
    name: string
    parentUnit:
        id: string
        key: string
    shippingAddressKeys:
        - string
    status: string
    storeMode: string
    stores:
        - key: string

    BusinessUnitDivision Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BusinessUnitDivision resource accepts the following input properties:

    Key string
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    Addresses List<BusinessUnitDivisionAddress>
    Addresses used by the Business Unit.
    ApprovalRuleMode string
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    AssociateMode string
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    BillingAddressKeys List<string>
    List of the billing addresses used by the division.
    ContactEmail string
    The email address of the division.
    Custom BusinessUnitDivisionCustom
    Custom fields for this resource.
    DefaultBillingAddressKey string
    Key of the default billing Address.
    DefaultShippingAddressKey string
    Key of the default shipping Address.
    Name string
    The name of the division.
    ParentUnit BusinessUnitDivisionParentUnit
    Reference to a parent business unit by its key or id. One of either is required.
    ShippingAddressKeys List<string>
    List of the shipping addresses used by the division.
    Status string
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    StoreMode string
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    Stores List<BusinessUnitDivisionStore>
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    Key string
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    Addresses []BusinessUnitDivisionAddressArgs
    Addresses used by the Business Unit.
    ApprovalRuleMode string
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    AssociateMode string
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    BillingAddressKeys []string
    List of the billing addresses used by the division.
    ContactEmail string
    The email address of the division.
    Custom BusinessUnitDivisionCustomArgs
    Custom fields for this resource.
    DefaultBillingAddressKey string
    Key of the default billing Address.
    DefaultShippingAddressKey string
    Key of the default shipping Address.
    Name string
    The name of the division.
    ParentUnit BusinessUnitDivisionParentUnitArgs
    Reference to a parent business unit by its key or id. One of either is required.
    ShippingAddressKeys []string
    List of the shipping addresses used by the division.
    Status string
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    StoreMode string
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    Stores []BusinessUnitDivisionStoreArgs
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    key String
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    addresses List<BusinessUnitDivisionAddress>
    Addresses used by the Business Unit.
    approvalRuleMode String
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associateMode String
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billingAddressKeys List<String>
    List of the billing addresses used by the division.
    contactEmail String
    The email address of the division.
    custom BusinessUnitDivisionCustom
    Custom fields for this resource.
    defaultBillingAddressKey String
    Key of the default billing Address.
    defaultShippingAddressKey String
    Key of the default shipping Address.
    name String
    The name of the division.
    parentUnit BusinessUnitDivisionParentUnit
    Reference to a parent business unit by its key or id. One of either is required.
    shippingAddressKeys List<String>
    List of the shipping addresses used by the division.
    status String
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    storeMode String
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores List<BusinessUnitDivisionStore>
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    key string
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    addresses BusinessUnitDivisionAddress[]
    Addresses used by the Business Unit.
    approvalRuleMode string
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associateMode string
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billingAddressKeys string[]
    List of the billing addresses used by the division.
    contactEmail string
    The email address of the division.
    custom BusinessUnitDivisionCustom
    Custom fields for this resource.
    defaultBillingAddressKey string
    Key of the default billing Address.
    defaultShippingAddressKey string
    Key of the default shipping Address.
    name string
    The name of the division.
    parentUnit BusinessUnitDivisionParentUnit
    Reference to a parent business unit by its key or id. One of either is required.
    shippingAddressKeys string[]
    List of the shipping addresses used by the division.
    status string
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    storeMode string
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores BusinessUnitDivisionStore[]
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    key str
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    addresses Sequence[BusinessUnitDivisionAddressArgs]
    Addresses used by the Business Unit.
    approval_rule_mode str
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associate_mode str
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billing_address_keys Sequence[str]
    List of the billing addresses used by the division.
    contact_email str
    The email address of the division.
    custom BusinessUnitDivisionCustomArgs
    Custom fields for this resource.
    default_billing_address_key str
    Key of the default billing Address.
    default_shipping_address_key str
    Key of the default shipping Address.
    name str
    The name of the division.
    parent_unit BusinessUnitDivisionParentUnitArgs
    Reference to a parent business unit by its key or id. One of either is required.
    shipping_address_keys Sequence[str]
    List of the shipping addresses used by the division.
    status str
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    store_mode str
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores Sequence[BusinessUnitDivisionStoreArgs]
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    key String
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    addresses List<Property Map>
    Addresses used by the Business Unit.
    approvalRuleMode String
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associateMode String
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billingAddressKeys List<String>
    List of the billing addresses used by the division.
    contactEmail String
    The email address of the division.
    custom Property Map
    Custom fields for this resource.
    defaultBillingAddressKey String
    Key of the default billing Address.
    defaultShippingAddressKey String
    Key of the default shipping Address.
    name String
    The name of the division.
    parentUnit Property Map
    Reference to a parent business unit by its key or id. One of either is required.
    shippingAddressKeys List<String>
    List of the shipping addresses used by the division.
    status String
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    storeMode String
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores List<Property Map>
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BusinessUnitDivision resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    The current version of the division.
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    The current version of the division.
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    The current version of the division.
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The current version of the division.
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    The current version of the division.
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The current version of the division.

    Look up Existing BusinessUnitDivision Resource

    Get an existing BusinessUnitDivision resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BusinessUnitDivisionState, opts?: CustomResourceOptions): BusinessUnitDivision
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[BusinessUnitDivisionAddressArgs]] = None,
        approval_rule_mode: Optional[str] = None,
        associate_mode: Optional[str] = None,
        billing_address_keys: Optional[Sequence[str]] = None,
        contact_email: Optional[str] = None,
        custom: Optional[BusinessUnitDivisionCustomArgs] = None,
        default_billing_address_key: Optional[str] = None,
        default_shipping_address_key: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        parent_unit: Optional[BusinessUnitDivisionParentUnitArgs] = None,
        shipping_address_keys: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        store_mode: Optional[str] = None,
        stores: Optional[Sequence[BusinessUnitDivisionStoreArgs]] = None,
        version: Optional[float] = None) -> BusinessUnitDivision
    func GetBusinessUnitDivision(ctx *Context, name string, id IDInput, state *BusinessUnitDivisionState, opts ...ResourceOption) (*BusinessUnitDivision, error)
    public static BusinessUnitDivision Get(string name, Input<string> id, BusinessUnitDivisionState? state, CustomResourceOptions? opts = null)
    public static BusinessUnitDivision get(String name, Output<String> id, BusinessUnitDivisionState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:BusinessUnitDivision    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Addresses List<BusinessUnitDivisionAddress>
    Addresses used by the Business Unit.
    ApprovalRuleMode string
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    AssociateMode string
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    BillingAddressKeys List<string>
    List of the billing addresses used by the division.
    ContactEmail string
    The email address of the division.
    Custom BusinessUnitDivisionCustom
    Custom fields for this resource.
    DefaultBillingAddressKey string
    Key of the default billing Address.
    DefaultShippingAddressKey string
    Key of the default shipping Address.
    Key string
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    Name string
    The name of the division.
    ParentUnit BusinessUnitDivisionParentUnit
    Reference to a parent business unit by its key or id. One of either is required.
    ShippingAddressKeys List<string>
    List of the shipping addresses used by the division.
    Status string
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    StoreMode string
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    Stores List<BusinessUnitDivisionStore>
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    Version double
    The current version of the division.
    Addresses []BusinessUnitDivisionAddressArgs
    Addresses used by the Business Unit.
    ApprovalRuleMode string
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    AssociateMode string
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    BillingAddressKeys []string
    List of the billing addresses used by the division.
    ContactEmail string
    The email address of the division.
    Custom BusinessUnitDivisionCustomArgs
    Custom fields for this resource.
    DefaultBillingAddressKey string
    Key of the default billing Address.
    DefaultShippingAddressKey string
    Key of the default shipping Address.
    Key string
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    Name string
    The name of the division.
    ParentUnit BusinessUnitDivisionParentUnitArgs
    Reference to a parent business unit by its key or id. One of either is required.
    ShippingAddressKeys []string
    List of the shipping addresses used by the division.
    Status string
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    StoreMode string
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    Stores []BusinessUnitDivisionStoreArgs
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    Version float64
    The current version of the division.
    addresses List<BusinessUnitDivisionAddress>
    Addresses used by the Business Unit.
    approvalRuleMode String
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associateMode String
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billingAddressKeys List<String>
    List of the billing addresses used by the division.
    contactEmail String
    The email address of the division.
    custom BusinessUnitDivisionCustom
    Custom fields for this resource.
    defaultBillingAddressKey String
    Key of the default billing Address.
    defaultShippingAddressKey String
    Key of the default shipping Address.
    key String
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    name String
    The name of the division.
    parentUnit BusinessUnitDivisionParentUnit
    Reference to a parent business unit by its key or id. One of either is required.
    shippingAddressKeys List<String>
    List of the shipping addresses used by the division.
    status String
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    storeMode String
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores List<BusinessUnitDivisionStore>
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    version Double
    The current version of the division.
    addresses BusinessUnitDivisionAddress[]
    Addresses used by the Business Unit.
    approvalRuleMode string
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associateMode string
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billingAddressKeys string[]
    List of the billing addresses used by the division.
    contactEmail string
    The email address of the division.
    custom BusinessUnitDivisionCustom
    Custom fields for this resource.
    defaultBillingAddressKey string
    Key of the default billing Address.
    defaultShippingAddressKey string
    Key of the default shipping Address.
    key string
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    name string
    The name of the division.
    parentUnit BusinessUnitDivisionParentUnit
    Reference to a parent business unit by its key or id. One of either is required.
    shippingAddressKeys string[]
    List of the shipping addresses used by the division.
    status string
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    storeMode string
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores BusinessUnitDivisionStore[]
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    version number
    The current version of the division.
    addresses Sequence[BusinessUnitDivisionAddressArgs]
    Addresses used by the Business Unit.
    approval_rule_mode str
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associate_mode str
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billing_address_keys Sequence[str]
    List of the billing addresses used by the division.
    contact_email str
    The email address of the division.
    custom BusinessUnitDivisionCustomArgs
    Custom fields for this resource.
    default_billing_address_key str
    Key of the default billing Address.
    default_shipping_address_key str
    Key of the default shipping Address.
    key str
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    name str
    The name of the division.
    parent_unit BusinessUnitDivisionParentUnitArgs
    Reference to a parent business unit by its key or id. One of either is required.
    shipping_address_keys Sequence[str]
    List of the shipping addresses used by the division.
    status str
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    store_mode str
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores Sequence[BusinessUnitDivisionStoreArgs]
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    version float
    The current version of the division.
    addresses List<Property Map>
    Addresses used by the Business Unit.
    approvalRuleMode String
    Determines whether the business unit can inherit Approval Rules from a parent. Defaults to ExplicitAndFromParent.
    associateMode String
    Determines whether the business unit can inherit Associates from a parent. Defaults to ExplicitAndFromParent.
    billingAddressKeys List<String>
    List of the billing addresses used by the division.
    contactEmail String
    The email address of the division.
    custom Property Map
    Custom fields for this resource.
    defaultBillingAddressKey String
    Key of the default billing Address.
    defaultShippingAddressKey String
    Key of the default shipping Address.
    key String
    User-defined unique key for the division. Must be unique within the project. Updating this value is not supported.
    name String
    The name of the division.
    parentUnit Property Map
    Reference to a parent business unit by its key or id. One of either is required.
    shippingAddressKeys List<String>
    List of the shipping addresses used by the division.
    status String
    Indicates whether the business unit can be edited and used in Orders. Defaults to Active.
    storeMode String
    Defines whether the Stores of the business unit are set directly on the business unit or are inherited from a parent. Defaults to FromParent
    stores List<Property Map>
    Sets the Stores the Business Unit is associated with. If the Business Unit has Stores defined, then all of its Carts, Orders, Quotes, or Quote Requests must belong to one of the Business Unit's Stores. If the Business Unit has no Stores, then all of its Carts, Orders, Quotes, or Quote Requests must not belong to any Store.
    version Number
    The current version of the division.

    Supporting Types

    BusinessUnitDivisionAddress, BusinessUnitDivisionAddressArgs

    Country string
    Name of the country
    Key string
    User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
    AdditionalAddressInfo string
    Further information on the Address
    AdditionalStreetInfo string
    Further information on the street address
    Apartment string
    Name or number of the apartment
    Building string
    Name or number of the building
    City string
    Name of the city
    Company string
    Name of the company
    Department string
    Name of the department
    Email string
    Email address
    ExternalId string
    ID for the contact used in an external system
    Fax string
    Fax number
    FirstName string
    First name of the contact
    Id string
    Unique identifier of the Address
    LastName string
    Last name of the contact
    Mobile string
    Mobile phone number
    Phone string
    Phone number
    PoBox string
    Post office box number
    PostalCode string
    Postal code
    Region string
    Name of the region
    Salutation string
    Salutation of the contact, for example Ms., Mr.
    State string
    Name of the state
    StreetName string
    Name of the street
    StreetNumber string
    Street number
    Title string
    Title of the contact, for example Dr., Prof.
    Country string
    Name of the country
    Key string
    User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
    AdditionalAddressInfo string
    Further information on the Address
    AdditionalStreetInfo string
    Further information on the street address
    Apartment string
    Name or number of the apartment
    Building string
    Name or number of the building
    City string
    Name of the city
    Company string
    Name of the company
    Department string
    Name of the department
    Email string
    Email address
    ExternalId string
    ID for the contact used in an external system
    Fax string
    Fax number
    FirstName string
    First name of the contact
    Id string
    Unique identifier of the Address
    LastName string
    Last name of the contact
    Mobile string
    Mobile phone number
    Phone string
    Phone number
    PoBox string
    Post office box number
    PostalCode string
    Postal code
    Region string
    Name of the region
    Salutation string
    Salutation of the contact, for example Ms., Mr.
    State string
    Name of the state
    StreetName string
    Name of the street
    StreetNumber string
    Street number
    Title string
    Title of the contact, for example Dr., Prof.
    country String
    Name of the country
    key String
    User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
    additionalAddressInfo String
    Further information on the Address
    additionalStreetInfo String
    Further information on the street address
    apartment String
    Name or number of the apartment
    building String
    Name or number of the building
    city String
    Name of the city
    company String
    Name of the company
    department String
    Name of the department
    email String
    Email address
    externalId String
    ID for the contact used in an external system
    fax String
    Fax number
    firstName String
    First name of the contact
    id String
    Unique identifier of the Address
    lastName String
    Last name of the contact
    mobile String
    Mobile phone number
    phone String
    Phone number
    poBox String
    Post office box number
    postalCode String
    Postal code
    region String
    Name of the region
    salutation String
    Salutation of the contact, for example Ms., Mr.
    state String
    Name of the state
    streetName String
    Name of the street
    streetNumber String
    Street number
    title String
    Title of the contact, for example Dr., Prof.
    country string
    Name of the country
    key string
    User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
    additionalAddressInfo string
    Further information on the Address
    additionalStreetInfo string
    Further information on the street address
    apartment string
    Name or number of the apartment
    building string
    Name or number of the building
    city string
    Name of the city
    company string
    Name of the company
    department string
    Name of the department
    email string
    Email address
    externalId string
    ID for the contact used in an external system
    fax string
    Fax number
    firstName string
    First name of the contact
    id string
    Unique identifier of the Address
    lastName string
    Last name of the contact
    mobile string
    Mobile phone number
    phone string
    Phone number
    poBox string
    Post office box number
    postalCode string
    Postal code
    region string
    Name of the region
    salutation string
    Salutation of the contact, for example Ms., Mr.
    state string
    Name of the state
    streetName string
    Name of the street
    streetNumber string
    Street number
    title string
    Title of the contact, for example Dr., Prof.
    country str
    Name of the country
    key str
    User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
    additional_address_info str
    Further information on the Address
    additional_street_info str
    Further information on the street address
    apartment str
    Name or number of the apartment
    building str
    Name or number of the building
    city str
    Name of the city
    company str
    Name of the company
    department str
    Name of the department
    email str
    Email address
    external_id str
    ID for the contact used in an external system
    fax str
    Fax number
    first_name str
    First name of the contact
    id str
    Unique identifier of the Address
    last_name str
    Last name of the contact
    mobile str
    Mobile phone number
    phone str
    Phone number
    po_box str
    Post office box number
    postal_code str
    Postal code
    region str
    Name of the region
    salutation str
    Salutation of the contact, for example Ms., Mr.
    state str
    Name of the state
    street_name str
    Name of the street
    street_number str
    Street number
    title str
    Title of the contact, for example Dr., Prof.
    country String
    Name of the country
    key String
    User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
    additionalAddressInfo String
    Further information on the Address
    additionalStreetInfo String
    Further information on the street address
    apartment String
    Name or number of the apartment
    building String
    Name or number of the building
    city String
    Name of the city
    company String
    Name of the company
    department String
    Name of the department
    email String
    Email address
    externalId String
    ID for the contact used in an external system
    fax String
    Fax number
    firstName String
    First name of the contact
    id String
    Unique identifier of the Address
    lastName String
    Last name of the contact
    mobile String
    Mobile phone number
    phone String
    Phone number
    poBox String
    Post office box number
    postalCode String
    Postal code
    region String
    Name of the region
    salutation String
    Salutation of the contact, for example Ms., Mr.
    state String
    Name of the state
    streetName String
    Name of the street
    streetNumber String
    Street number
    title String
    Title of the contact, for example Dr., Prof.

    BusinessUnitDivisionCustom, BusinessUnitDivisionCustomArgs

    Fields Dictionary<string, string>
    CustomValue fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    TypeId string
    The ID of the custom type to use for this resource.
    Fields map[string]string
    CustomValue fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    TypeId string
    The ID of the custom type to use for this resource.
    fields Map<String,String>
    CustomValue fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId String
    The ID of the custom type to use for this resource.
    fields {[key: string]: string}
    CustomValue fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId string
    The ID of the custom type to use for this resource.
    fields Mapping[str, str]
    CustomValue fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    type_id str
    The ID of the custom type to use for this resource.
    fields Map<String>
    CustomValue fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId String
    The ID of the custom type to use for this resource.

    BusinessUnitDivisionParentUnit, BusinessUnitDivisionParentUnitArgs

    Id string
    User-defined unique identifier of the business unit
    Key string
    User-defined unique key of the business unit
    Id string
    User-defined unique identifier of the business unit
    Key string
    User-defined unique key of the business unit
    id String
    User-defined unique identifier of the business unit
    key String
    User-defined unique key of the business unit
    id string
    User-defined unique identifier of the business unit
    key string
    User-defined unique key of the business unit
    id str
    User-defined unique identifier of the business unit
    key str
    User-defined unique key of the business unit
    id String
    User-defined unique identifier of the business unit
    key String
    User-defined unique key of the business unit

    BusinessUnitDivisionStore, BusinessUnitDivisionStoreArgs

    Key string
    User-defined unique identifier of the Store
    Key string
    User-defined unique identifier of the Store
    key String
    User-defined unique identifier of the Store
    key string
    User-defined unique identifier of the Store
    key str
    User-defined unique identifier of the Store
    key String
    User-defined unique identifier of the Store

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools