1. Packages
  2. Commercetools Provider
  3. API Docs
  4. BusinessUnitCompany
commercetools 1.19.3 published on Friday, Apr 4, 2025 by labd

commercetools.BusinessUnitCompany

Explore with Pulumi AI

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

See also the Business Unit API Documentation User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.

  • name (String) The name of the company.

Create BusinessUnitCompany Resource

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

Constructor syntax

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

@overload
def BusinessUnitCompany(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        key: Optional[str] = None,
                        addresses: Optional[Sequence[BusinessUnitCompanyAddressArgs]] = None,
                        billing_address_keys: Optional[Sequence[str]] = None,
                        contact_email: Optional[str] = None,
                        custom: Optional[BusinessUnitCompanyCustomArgs] = None,
                        default_billing_address_key: Optional[str] = None,
                        default_shipping_address_key: Optional[str] = None,
                        name: Optional[str] = None,
                        shipping_address_keys: Optional[Sequence[str]] = None,
                        status: Optional[str] = None,
                        stores: Optional[Sequence[BusinessUnitCompanyStoreArgs]] = None)
func NewBusinessUnitCompany(ctx *Context, name string, args BusinessUnitCompanyArgs, opts ...ResourceOption) (*BusinessUnitCompany, error)
public BusinessUnitCompany(string name, BusinessUnitCompanyArgs args, CustomResourceOptions? opts = null)
public BusinessUnitCompany(String name, BusinessUnitCompanyArgs args)
public BusinessUnitCompany(String name, BusinessUnitCompanyArgs args, CustomResourceOptions options)
type: commercetools:BusinessUnitCompany
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BusinessUnitCompanyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BusinessUnitCompanyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BusinessUnitCompanyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BusinessUnitCompanyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BusinessUnitCompanyArgs
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 businessUnitCompanyResource = new Commercetools.BusinessUnitCompany("businessUnitCompanyResource", new()
{
    Key = "string",
    Addresses = new[]
    {
        new Commercetools.Inputs.BusinessUnitCompanyAddressArgs
        {
            Country = "string",
            Key = "string",
            Id = "string",
            Fax = "string",
            City = "string",
            Company = "string",
            Apartment = "string",
            Department = "string",
            Email = "string",
            LastName = "string",
            AdditionalStreetInfo = "string",
            FirstName = "string",
            Building = "string",
            AdditionalAddressInfo = "string",
            ExternalId = "string",
            Mobile = "string",
            Phone = "string",
            PoBox = "string",
            PostalCode = "string",
            Region = "string",
            Salutation = "string",
            State = "string",
            StreetName = "string",
            StreetNumber = "string",
            Title = "string",
        },
    },
    BillingAddressKeys = new[]
    {
        "string",
    },
    ContactEmail = "string",
    Custom = new Commercetools.Inputs.BusinessUnitCompanyCustomArgs
    {
        Fields = 
        {
            { "string", "string" },
        },
        TypeId = "string",
    },
    DefaultBillingAddressKey = "string",
    DefaultShippingAddressKey = "string",
    Name = "string",
    ShippingAddressKeys = new[]
    {
        "string",
    },
    Status = "string",
    Stores = new[]
    {
        new Commercetools.Inputs.BusinessUnitCompanyStoreArgs
        {
            Key = "string",
        },
    },
});
Copy
example, err := commercetools.NewBusinessUnitCompany(ctx, "businessUnitCompanyResource", &commercetools.BusinessUnitCompanyArgs{
	Key: pulumi.String("string"),
	Addresses: commercetools.BusinessUnitCompanyAddressArray{
		&commercetools.BusinessUnitCompanyAddressArgs{
			Country:               pulumi.String("string"),
			Key:                   pulumi.String("string"),
			Id:                    pulumi.String("string"),
			Fax:                   pulumi.String("string"),
			City:                  pulumi.String("string"),
			Company:               pulumi.String("string"),
			Apartment:             pulumi.String("string"),
			Department:            pulumi.String("string"),
			Email:                 pulumi.String("string"),
			LastName:              pulumi.String("string"),
			AdditionalStreetInfo:  pulumi.String("string"),
			FirstName:             pulumi.String("string"),
			Building:              pulumi.String("string"),
			AdditionalAddressInfo: pulumi.String("string"),
			ExternalId:            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"),
			Title:                 pulumi.String("string"),
		},
	},
	BillingAddressKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	ContactEmail: pulumi.String("string"),
	Custom: &commercetools.BusinessUnitCompanyCustomArgs{
		Fields: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		TypeId: pulumi.String("string"),
	},
	DefaultBillingAddressKey:  pulumi.String("string"),
	DefaultShippingAddressKey: pulumi.String("string"),
	Name:                      pulumi.String("string"),
	ShippingAddressKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	Status: pulumi.String("string"),
	Stores: commercetools.BusinessUnitCompanyStoreArray{
		&commercetools.BusinessUnitCompanyStoreArgs{
			Key: pulumi.String("string"),
		},
	},
})
Copy
var businessUnitCompanyResource = new BusinessUnitCompany("businessUnitCompanyResource", BusinessUnitCompanyArgs.builder()
    .key("string")
    .addresses(BusinessUnitCompanyAddressArgs.builder()
        .country("string")
        .key("string")
        .id("string")
        .fax("string")
        .city("string")
        .company("string")
        .apartment("string")
        .department("string")
        .email("string")
        .lastName("string")
        .additionalStreetInfo("string")
        .firstName("string")
        .building("string")
        .additionalAddressInfo("string")
        .externalId("string")
        .mobile("string")
        .phone("string")
        .poBox("string")
        .postalCode("string")
        .region("string")
        .salutation("string")
        .state("string")
        .streetName("string")
        .streetNumber("string")
        .title("string")
        .build())
    .billingAddressKeys("string")
    .contactEmail("string")
    .custom(BusinessUnitCompanyCustomArgs.builder()
        .fields(Map.of("string", "string"))
        .typeId("string")
        .build())
    .defaultBillingAddressKey("string")
    .defaultShippingAddressKey("string")
    .name("string")
    .shippingAddressKeys("string")
    .status("string")
    .stores(BusinessUnitCompanyStoreArgs.builder()
        .key("string")
        .build())
    .build());
Copy
business_unit_company_resource = commercetools.BusinessUnitCompany("businessUnitCompanyResource",
    key="string",
    addresses=[{
        "country": "string",
        "key": "string",
        "id": "string",
        "fax": "string",
        "city": "string",
        "company": "string",
        "apartment": "string",
        "department": "string",
        "email": "string",
        "last_name": "string",
        "additional_street_info": "string",
        "first_name": "string",
        "building": "string",
        "additional_address_info": "string",
        "external_id": "string",
        "mobile": "string",
        "phone": "string",
        "po_box": "string",
        "postal_code": "string",
        "region": "string",
        "salutation": "string",
        "state": "string",
        "street_name": "string",
        "street_number": "string",
        "title": "string",
    }],
    billing_address_keys=["string"],
    contact_email="string",
    custom={
        "fields": {
            "string": "string",
        },
        "type_id": "string",
    },
    default_billing_address_key="string",
    default_shipping_address_key="string",
    name="string",
    shipping_address_keys=["string"],
    status="string",
    stores=[{
        "key": "string",
    }])
Copy
const businessUnitCompanyResource = new commercetools.BusinessUnitCompany("businessUnitCompanyResource", {
    key: "string",
    addresses: [{
        country: "string",
        key: "string",
        id: "string",
        fax: "string",
        city: "string",
        company: "string",
        apartment: "string",
        department: "string",
        email: "string",
        lastName: "string",
        additionalStreetInfo: "string",
        firstName: "string",
        building: "string",
        additionalAddressInfo: "string",
        externalId: "string",
        mobile: "string",
        phone: "string",
        poBox: "string",
        postalCode: "string",
        region: "string",
        salutation: "string",
        state: "string",
        streetName: "string",
        streetNumber: "string",
        title: "string",
    }],
    billingAddressKeys: ["string"],
    contactEmail: "string",
    custom: {
        fields: {
            string: "string",
        },
        typeId: "string",
    },
    defaultBillingAddressKey: "string",
    defaultShippingAddressKey: "string",
    name: "string",
    shippingAddressKeys: ["string"],
    status: "string",
    stores: [{
        key: "string",
    }],
});
Copy
type: commercetools:BusinessUnitCompany
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
    billingAddressKeys:
        - string
    contactEmail: string
    custom:
        fields:
            string: string
        typeId: string
    defaultBillingAddressKey: string
    defaultShippingAddressKey: string
    key: string
    name: string
    shippingAddressKeys:
        - string
    status: string
    stores:
        - key: string
Copy

BusinessUnitCompany 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 BusinessUnitCompany resource accepts the following input properties:

Key This property is required. string
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
Addresses List<BusinessUnitCompanyAddress>
Addresses used by the Business Unit.
BillingAddressKeys List<string>
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
ContactEmail string
The email address of the company.
Custom BusinessUnitCompanyCustom
Custom fields for this resource.
DefaultBillingAddressKey string
Index of the entry in addresses to set as the default billing address.
DefaultShippingAddressKey string
Index of the entry in addresses to set as the default shipping address.
Name string
The name of the company.
ShippingAddressKeys List<string>
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
Status string
The status of the company.
Stores List<BusinessUnitCompanyStore>
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 This property is required. string
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
Addresses []BusinessUnitCompanyAddressArgs
Addresses used by the Business Unit.
BillingAddressKeys []string
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
ContactEmail string
The email address of the company.
Custom BusinessUnitCompanyCustomArgs
Custom fields for this resource.
DefaultBillingAddressKey string
Index of the entry in addresses to set as the default billing address.
DefaultShippingAddressKey string
Index of the entry in addresses to set as the default shipping address.
Name string
The name of the company.
ShippingAddressKeys []string
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
Status string
The status of the company.
Stores []BusinessUnitCompanyStoreArgs
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 This property is required. String
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
addresses List<BusinessUnitCompanyAddress>
Addresses used by the Business Unit.
billingAddressKeys List<String>
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contactEmail String
The email address of the company.
custom BusinessUnitCompanyCustom
Custom fields for this resource.
defaultBillingAddressKey String
Index of the entry in addresses to set as the default billing address.
defaultShippingAddressKey String
Index of the entry in addresses to set as the default shipping address.
name String
The name of the company.
shippingAddressKeys List<String>
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status String
The status of the company.
stores List<BusinessUnitCompanyStore>
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 This property is required. string
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
addresses BusinessUnitCompanyAddress[]
Addresses used by the Business Unit.
billingAddressKeys string[]
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contactEmail string
The email address of the company.
custom BusinessUnitCompanyCustom
Custom fields for this resource.
defaultBillingAddressKey string
Index of the entry in addresses to set as the default billing address.
defaultShippingAddressKey string
Index of the entry in addresses to set as the default shipping address.
name string
The name of the company.
shippingAddressKeys string[]
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status string
The status of the company.
stores BusinessUnitCompanyStore[]
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 This property is required. str
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
addresses Sequence[BusinessUnitCompanyAddressArgs]
Addresses used by the Business Unit.
billing_address_keys Sequence[str]
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contact_email str
The email address of the company.
custom BusinessUnitCompanyCustomArgs
Custom fields for this resource.
default_billing_address_key str
Index of the entry in addresses to set as the default billing address.
default_shipping_address_key str
Index of the entry in addresses to set as the default shipping address.
name str
The name of the company.
shipping_address_keys Sequence[str]
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status str
The status of the company.
stores Sequence[BusinessUnitCompanyStoreArgs]
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 This property is required. String
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
addresses List<Property Map>
Addresses used by the Business Unit.
billingAddressKeys List<String>
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contactEmail String
The email address of the company.
custom Property Map
Custom fields for this resource.
defaultBillingAddressKey String
Index of the entry in addresses to set as the default billing address.
defaultShippingAddressKey String
Index of the entry in addresses to set as the default shipping address.
name String
The name of the company.
shippingAddressKeys List<String>
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status String
The status of the company.
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 BusinessUnitCompany resource produces the following output properties:

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

Look up Existing BusinessUnitCompany Resource

Get an existing BusinessUnitCompany 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?: BusinessUnitCompanyState, opts?: CustomResourceOptions): BusinessUnitCompany
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[BusinessUnitCompanyAddressArgs]] = None,
        billing_address_keys: Optional[Sequence[str]] = None,
        contact_email: Optional[str] = None,
        custom: Optional[BusinessUnitCompanyCustomArgs] = None,
        default_billing_address_key: Optional[str] = None,
        default_shipping_address_key: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        shipping_address_keys: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        stores: Optional[Sequence[BusinessUnitCompanyStoreArgs]] = None,
        version: Optional[float] = None) -> BusinessUnitCompany
func GetBusinessUnitCompany(ctx *Context, name string, id IDInput, state *BusinessUnitCompanyState, opts ...ResourceOption) (*BusinessUnitCompany, error)
public static BusinessUnitCompany Get(string name, Input<string> id, BusinessUnitCompanyState? state, CustomResourceOptions? opts = null)
public static BusinessUnitCompany get(String name, Output<String> id, BusinessUnitCompanyState state, CustomResourceOptions options)
resources:  _:    type: commercetools:BusinessUnitCompany    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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<BusinessUnitCompanyAddress>
Addresses used by the Business Unit.
BillingAddressKeys List<string>
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
ContactEmail string
The email address of the company.
Custom BusinessUnitCompanyCustom
Custom fields for this resource.
DefaultBillingAddressKey string
Index of the entry in addresses to set as the default billing address.
DefaultShippingAddressKey string
Index of the entry in addresses to set as the default shipping address.
Key string
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
Name string
The name of the company.
ShippingAddressKeys List<string>
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
Status string
The status of the company.
Stores List<BusinessUnitCompanyStore>
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 company.
Addresses []BusinessUnitCompanyAddressArgs
Addresses used by the Business Unit.
BillingAddressKeys []string
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
ContactEmail string
The email address of the company.
Custom BusinessUnitCompanyCustomArgs
Custom fields for this resource.
DefaultBillingAddressKey string
Index of the entry in addresses to set as the default billing address.
DefaultShippingAddressKey string
Index of the entry in addresses to set as the default shipping address.
Key string
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
Name string
The name of the company.
ShippingAddressKeys []string
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
Status string
The status of the company.
Stores []BusinessUnitCompanyStoreArgs
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 company.
addresses List<BusinessUnitCompanyAddress>
Addresses used by the Business Unit.
billingAddressKeys List<String>
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contactEmail String
The email address of the company.
custom BusinessUnitCompanyCustom
Custom fields for this resource.
defaultBillingAddressKey String
Index of the entry in addresses to set as the default billing address.
defaultShippingAddressKey String
Index of the entry in addresses to set as the default shipping address.
key String
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
name String
The name of the company.
shippingAddressKeys List<String>
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status String
The status of the company.
stores List<BusinessUnitCompanyStore>
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 company.
addresses BusinessUnitCompanyAddress[]
Addresses used by the Business Unit.
billingAddressKeys string[]
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contactEmail string
The email address of the company.
custom BusinessUnitCompanyCustom
Custom fields for this resource.
defaultBillingAddressKey string
Index of the entry in addresses to set as the default billing address.
defaultShippingAddressKey string
Index of the entry in addresses to set as the default shipping address.
key string
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
name string
The name of the company.
shippingAddressKeys string[]
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status string
The status of the company.
stores BusinessUnitCompanyStore[]
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 company.
addresses Sequence[BusinessUnitCompanyAddressArgs]
Addresses used by the Business Unit.
billing_address_keys Sequence[str]
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contact_email str
The email address of the company.
custom BusinessUnitCompanyCustomArgs
Custom fields for this resource.
default_billing_address_key str
Index of the entry in addresses to set as the default billing address.
default_shipping_address_key str
Index of the entry in addresses to set as the default shipping address.
key str
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
name str
The name of the company.
shipping_address_keys Sequence[str]
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status str
The status of the company.
stores Sequence[BusinessUnitCompanyStoreArgs]
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 company.
addresses List<Property Map>
Addresses used by the Business Unit.
billingAddressKeys List<String>
Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.
contactEmail String
The email address of the company.
custom Property Map
Custom fields for this resource.
defaultBillingAddressKey String
Index of the entry in addresses to set as the default billing address.
defaultShippingAddressKey String
Index of the entry in addresses to set as the default shipping address.
key String
User-defined unique key for the company. Must be unique within the project. Updating this value is not supported.
name String
The name of the company.
shippingAddressKeys List<String>
Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.
status String
The status of the company.
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 company.

Supporting Types

BusinessUnitCompanyAddress
, BusinessUnitCompanyAddressArgs

Country This property is required. string
Name of the country
Key This property is required. 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 This property is required. string
Name of the country
Key This property is required. 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 This property is required. String
Name of the country
key This property is required. 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 This property is required. string
Name of the country
key This property is required. 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 This property is required. str
Name of the country
key This property is required. 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 This property is required. String
Name of the country
key This property is required. 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.

BusinessUnitCompanyCustom
, BusinessUnitCompanyCustomArgs

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.

BusinessUnitCompanyStore
, BusinessUnitCompanyStoreArgs

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.