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

commercetools.ProjectSettings

Explore with Pulumi AI

The project endpoint provides a limited set of information about settings and configuration of the project. Updating the settings is eventually consistent, it may take up to a minute before a change becomes fully active.

See also the Project Settings API Documentation

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  my-project:
    type: commercetools:ProjectSettings
    properties:
      carts:
        - countryTaxRateFallbackEnabled: true
      countries:
        - NL
        - DE
        - US
        - CA
      currencies:
        - EUR
        - USD
        - CAD
      externalOauths:
        - authorizationHeader: Bearer secret
          url: https://example.com/oauth/introspection
      key: my-project-key
      languages:
        - nl
        - de
        - en
        - fr-CA
      messages:
        - enabled: true
      shippingRateCartClassificationValues:
        - key: Small
          label:
            en: Small
            nl: Klein
      shippingRateInputType: CartClassification
Copy

Create ProjectSettings Resource

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

Constructor syntax

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

@overload
def ProjectSettings(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    business_units: Optional[Sequence[ProjectSettingsBusinessUnitArgs]] = None,
                    carts: Optional[Sequence[ProjectSettingsCartArgs]] = None,
                    countries: Optional[Sequence[str]] = None,
                    currencies: Optional[Sequence[str]] = None,
                    enable_search_index_customers: Optional[bool] = None,
                    enable_search_index_orders: Optional[bool] = None,
                    enable_search_index_product_search: Optional[bool] = None,
                    enable_search_index_products: Optional[bool] = None,
                    external_oauths: Optional[Sequence[ProjectSettingsExternalOauthArgs]] = None,
                    languages: Optional[Sequence[str]] = None,
                    messages: Optional[Sequence[ProjectSettingsMessageArgs]] = None,
                    name: Optional[str] = None,
                    shipping_rate_cart_classification_values: Optional[Sequence[ProjectSettingsShippingRateCartClassificationValueArgs]] = None,
                    shipping_rate_input_type: Optional[str] = None)
func NewProjectSettings(ctx *Context, name string, args *ProjectSettingsArgs, opts ...ResourceOption) (*ProjectSettings, error)
public ProjectSettings(string name, ProjectSettingsArgs? args = null, CustomResourceOptions? opts = null)
public ProjectSettings(String name, ProjectSettingsArgs args)
public ProjectSettings(String name, ProjectSettingsArgs args, CustomResourceOptions options)
type: commercetools:ProjectSettings
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 ProjectSettingsArgs
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 ProjectSettingsArgs
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 ProjectSettingsArgs
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 ProjectSettingsArgs
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. ProjectSettingsArgs
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 projectSettingsResource = new Commercetools.ProjectSettings("projectSettingsResource", new()
{
    BusinessUnits = new[]
    {
        new Commercetools.Inputs.ProjectSettingsBusinessUnitArgs
        {
            MyBusinessUnitAssociateRoleKeyOnCreation = "string",
            MyBusinessUnitStatusOnCreation = "string",
        },
    },
    Carts = new[]
    {
        new Commercetools.Inputs.ProjectSettingsCartArgs
        {
            CountryTaxRateFallbackEnabled = false,
            DeleteDaysAfterLastModification = 0,
        },
    },
    Countries = new[]
    {
        "string",
    },
    Currencies = new[]
    {
        "string",
    },
    EnableSearchIndexCustomers = false,
    EnableSearchIndexOrders = false,
    EnableSearchIndexProductSearch = false,
    EnableSearchIndexProducts = false,
    ExternalOauths = new[]
    {
        new Commercetools.Inputs.ProjectSettingsExternalOauthArgs
        {
            AuthorizationHeader = "string",
            Url = "string",
        },
    },
    Languages = new[]
    {
        "string",
    },
    Messages = new[]
    {
        new Commercetools.Inputs.ProjectSettingsMessageArgs
        {
            DeleteDaysAfterCreation = 0,
            Enabled = false,
        },
    },
    Name = "string",
    ShippingRateCartClassificationValues = new[]
    {
        new Commercetools.Inputs.ProjectSettingsShippingRateCartClassificationValueArgs
        {
            Key = "string",
            Label = 
            {
                { "string", "string" },
            },
        },
    },
    ShippingRateInputType = "string",
});
Copy
example, err := commercetools.NewProjectSettings(ctx, "projectSettingsResource", &commercetools.ProjectSettingsArgs{
BusinessUnits: .ProjectSettingsBusinessUnitArray{
&.ProjectSettingsBusinessUnitArgs{
MyBusinessUnitAssociateRoleKeyOnCreation: pulumi.String("string"),
MyBusinessUnitStatusOnCreation: pulumi.String("string"),
},
},
Carts: .ProjectSettingsCartArray{
&.ProjectSettingsCartArgs{
CountryTaxRateFallbackEnabled: pulumi.Bool(false),
DeleteDaysAfterLastModification: pulumi.Float64(0),
},
},
Countries: pulumi.StringArray{
pulumi.String("string"),
},
Currencies: pulumi.StringArray{
pulumi.String("string"),
},
EnableSearchIndexCustomers: pulumi.Bool(false),
EnableSearchIndexOrders: pulumi.Bool(false),
EnableSearchIndexProductSearch: pulumi.Bool(false),
EnableSearchIndexProducts: pulumi.Bool(false),
ExternalOauths: .ProjectSettingsExternalOauthArray{
&.ProjectSettingsExternalOauthArgs{
AuthorizationHeader: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
Languages: pulumi.StringArray{
pulumi.String("string"),
},
Messages: .ProjectSettingsMessageArray{
&.ProjectSettingsMessageArgs{
DeleteDaysAfterCreation: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
ShippingRateCartClassificationValues: .ProjectSettingsShippingRateCartClassificationValueArray{
&.ProjectSettingsShippingRateCartClassificationValueArgs{
Key: pulumi.String("string"),
Label: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
ShippingRateInputType: pulumi.String("string"),
})
Copy
var projectSettingsResource = new ProjectSettings("projectSettingsResource", ProjectSettingsArgs.builder()
    .businessUnits(ProjectSettingsBusinessUnitArgs.builder()
        .myBusinessUnitAssociateRoleKeyOnCreation("string")
        .myBusinessUnitStatusOnCreation("string")
        .build())
    .carts(ProjectSettingsCartArgs.builder()
        .countryTaxRateFallbackEnabled(false)
        .deleteDaysAfterLastModification(0)
        .build())
    .countries("string")
    .currencies("string")
    .enableSearchIndexCustomers(false)
    .enableSearchIndexOrders(false)
    .enableSearchIndexProductSearch(false)
    .enableSearchIndexProducts(false)
    .externalOauths(ProjectSettingsExternalOauthArgs.builder()
        .authorizationHeader("string")
        .url("string")
        .build())
    .languages("string")
    .messages(ProjectSettingsMessageArgs.builder()
        .deleteDaysAfterCreation(0)
        .enabled(false)
        .build())
    .name("string")
    .shippingRateCartClassificationValues(ProjectSettingsShippingRateCartClassificationValueArgs.builder()
        .key("string")
        .label(Map.of("string", "string"))
        .build())
    .shippingRateInputType("string")
    .build());
Copy
project_settings_resource = commercetools.ProjectSettings("projectSettingsResource",
    business_units=[{
        "my_business_unit_associate_role_key_on_creation": "string",
        "my_business_unit_status_on_creation": "string",
    }],
    carts=[{
        "country_tax_rate_fallback_enabled": False,
        "delete_days_after_last_modification": 0,
    }],
    countries=["string"],
    currencies=["string"],
    enable_search_index_customers=False,
    enable_search_index_orders=False,
    enable_search_index_product_search=False,
    enable_search_index_products=False,
    external_oauths=[{
        "authorization_header": "string",
        "url": "string",
    }],
    languages=["string"],
    messages=[{
        "delete_days_after_creation": 0,
        "enabled": False,
    }],
    name="string",
    shipping_rate_cart_classification_values=[{
        "key": "string",
        "label": {
            "string": "string",
        },
    }],
    shipping_rate_input_type="string")
Copy
const projectSettingsResource = new commercetools.ProjectSettings("projectSettingsResource", {
    businessUnits: [{
        myBusinessUnitAssociateRoleKeyOnCreation: "string",
        myBusinessUnitStatusOnCreation: "string",
    }],
    carts: [{
        countryTaxRateFallbackEnabled: false,
        deleteDaysAfterLastModification: 0,
    }],
    countries: ["string"],
    currencies: ["string"],
    enableSearchIndexCustomers: false,
    enableSearchIndexOrders: false,
    enableSearchIndexProductSearch: false,
    enableSearchIndexProducts: false,
    externalOauths: [{
        authorizationHeader: "string",
        url: "string",
    }],
    languages: ["string"],
    messages: [{
        deleteDaysAfterCreation: 0,
        enabled: false,
    }],
    name: "string",
    shippingRateCartClassificationValues: [{
        key: "string",
        label: {
            string: "string",
        },
    }],
    shippingRateInputType: "string",
});
Copy
type: commercetools:ProjectSettings
properties:
    businessUnits:
        - myBusinessUnitAssociateRoleKeyOnCreation: string
          myBusinessUnitStatusOnCreation: string
    carts:
        - countryTaxRateFallbackEnabled: false
          deleteDaysAfterLastModification: 0
    countries:
        - string
    currencies:
        - string
    enableSearchIndexCustomers: false
    enableSearchIndexOrders: false
    enableSearchIndexProductSearch: false
    enableSearchIndexProducts: false
    externalOauths:
        - authorizationHeader: string
          url: string
    languages:
        - string
    messages:
        - deleteDaysAfterCreation: 0
          enabled: false
    name: string
    shippingRateCartClassificationValues:
        - key: string
          label:
            string: string
    shippingRateInputType: string
Copy

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

BusinessUnits List<ProjectSettingsBusinessUnit>
Holds configuration specific to Business Units.
Carts List<ProjectSettingsCart>
Carts Configuration
Countries List<string>
A two-digit country code as per ISO 3166-1 alpha-2
Currencies List<string>
A three-digit currency code as per ISO 4217
EnableSearchIndexCustomers bool
Enable the Search Indexing of customers
EnableSearchIndexOrders bool
Enable the Search Indexing of orders
EnableSearchIndexProductSearch bool
Enable the Search Indexing of products
EnableSearchIndexProducts bool
Enable the Search Indexing of product projections
ExternalOauths List<ProjectSettingsExternalOauth>
External OAUTH
Languages List<string>
IETF Language Tag
Messages List<ProjectSettingsMessage>
The change notifications subscribed to
Name string
The name of the project
ShippingRateCartClassificationValues List<ProjectSettingsShippingRateCartClassificationValue>
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
ShippingRateInputType string
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
BusinessUnits []ProjectSettingsBusinessUnitArgs
Holds configuration specific to Business Units.
Carts []ProjectSettingsCartArgs
Carts Configuration
Countries []string
A two-digit country code as per ISO 3166-1 alpha-2
Currencies []string
A three-digit currency code as per ISO 4217
EnableSearchIndexCustomers bool
Enable the Search Indexing of customers
EnableSearchIndexOrders bool
Enable the Search Indexing of orders
EnableSearchIndexProductSearch bool
Enable the Search Indexing of products
EnableSearchIndexProducts bool
Enable the Search Indexing of product projections
ExternalOauths []ProjectSettingsExternalOauthArgs
External OAUTH
Languages []string
IETF Language Tag
Messages []ProjectSettingsMessageArgs
The change notifications subscribed to
Name string
The name of the project
ShippingRateCartClassificationValues []ProjectSettingsShippingRateCartClassificationValueArgs
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
ShippingRateInputType string
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
businessUnits List<ProjectSettingsBusinessUnit>
Holds configuration specific to Business Units.
carts List<ProjectSettingsCart>
Carts Configuration
countries List<String>
A two-digit country code as per ISO 3166-1 alpha-2
currencies List<String>
A three-digit currency code as per ISO 4217
enableSearchIndexCustomers Boolean
Enable the Search Indexing of customers
enableSearchIndexOrders Boolean
Enable the Search Indexing of orders
enableSearchIndexProductSearch Boolean
Enable the Search Indexing of products
enableSearchIndexProducts Boolean
Enable the Search Indexing of product projections
externalOauths List<ProjectSettingsExternalOauth>
External OAUTH
languages List<String>
IETF Language Tag
messages List<ProjectSettingsMessage>
The change notifications subscribed to
name String
The name of the project
shippingRateCartClassificationValues List<ProjectSettingsShippingRateCartClassificationValue>
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shippingRateInputType String
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
businessUnits ProjectSettingsBusinessUnit[]
Holds configuration specific to Business Units.
carts ProjectSettingsCart[]
Carts Configuration
countries string[]
A two-digit country code as per ISO 3166-1 alpha-2
currencies string[]
A three-digit currency code as per ISO 4217
enableSearchIndexCustomers boolean
Enable the Search Indexing of customers
enableSearchIndexOrders boolean
Enable the Search Indexing of orders
enableSearchIndexProductSearch boolean
Enable the Search Indexing of products
enableSearchIndexProducts boolean
Enable the Search Indexing of product projections
externalOauths ProjectSettingsExternalOauth[]
External OAUTH
languages string[]
IETF Language Tag
messages ProjectSettingsMessage[]
The change notifications subscribed to
name string
The name of the project
shippingRateCartClassificationValues ProjectSettingsShippingRateCartClassificationValue[]
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shippingRateInputType string
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
business_units Sequence[ProjectSettingsBusinessUnitArgs]
Holds configuration specific to Business Units.
carts Sequence[ProjectSettingsCartArgs]
Carts Configuration
countries Sequence[str]
A two-digit country code as per ISO 3166-1 alpha-2
currencies Sequence[str]
A three-digit currency code as per ISO 4217
enable_search_index_customers bool
Enable the Search Indexing of customers
enable_search_index_orders bool
Enable the Search Indexing of orders
enable_search_index_product_search bool
Enable the Search Indexing of products
enable_search_index_products bool
Enable the Search Indexing of product projections
external_oauths Sequence[ProjectSettingsExternalOauthArgs]
External OAUTH
languages Sequence[str]
IETF Language Tag
messages Sequence[ProjectSettingsMessageArgs]
The change notifications subscribed to
name str
The name of the project
shipping_rate_cart_classification_values Sequence[ProjectSettingsShippingRateCartClassificationValueArgs]
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shipping_rate_input_type str
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
businessUnits List<Property Map>
Holds configuration specific to Business Units.
carts List<Property Map>
Carts Configuration
countries List<String>
A two-digit country code as per ISO 3166-1 alpha-2
currencies List<String>
A three-digit currency code as per ISO 4217
enableSearchIndexCustomers Boolean
Enable the Search Indexing of customers
enableSearchIndexOrders Boolean
Enable the Search Indexing of orders
enableSearchIndexProductSearch Boolean
Enable the Search Indexing of products
enableSearchIndexProducts Boolean
Enable the Search Indexing of product projections
externalOauths List<Property Map>
External OAUTH
languages List<String>
IETF Language Tag
messages List<Property Map>
The change notifications subscribed to
name String
The name of the project
shippingRateCartClassificationValues List<Property Map>
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shippingRateInputType String
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier

Outputs

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

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

Look up Existing ProjectSettings Resource

Get an existing ProjectSettings 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?: ProjectSettingsState, opts?: CustomResourceOptions): ProjectSettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        business_units: Optional[Sequence[ProjectSettingsBusinessUnitArgs]] = None,
        carts: Optional[Sequence[ProjectSettingsCartArgs]] = None,
        countries: Optional[Sequence[str]] = None,
        currencies: Optional[Sequence[str]] = None,
        enable_search_index_customers: Optional[bool] = None,
        enable_search_index_orders: Optional[bool] = None,
        enable_search_index_product_search: Optional[bool] = None,
        enable_search_index_products: Optional[bool] = None,
        external_oauths: Optional[Sequence[ProjectSettingsExternalOauthArgs]] = None,
        key: Optional[str] = None,
        languages: Optional[Sequence[str]] = None,
        messages: Optional[Sequence[ProjectSettingsMessageArgs]] = None,
        name: Optional[str] = None,
        shipping_rate_cart_classification_values: Optional[Sequence[ProjectSettingsShippingRateCartClassificationValueArgs]] = None,
        shipping_rate_input_type: Optional[str] = None,
        version: Optional[float] = None) -> ProjectSettings
func GetProjectSettings(ctx *Context, name string, id IDInput, state *ProjectSettingsState, opts ...ResourceOption) (*ProjectSettings, error)
public static ProjectSettings Get(string name, Input<string> id, ProjectSettingsState? state, CustomResourceOptions? opts = null)
public static ProjectSettings get(String name, Output<String> id, ProjectSettingsState state, CustomResourceOptions options)
resources:  _:    type: commercetools:ProjectSettings    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:
BusinessUnits List<ProjectSettingsBusinessUnit>
Holds configuration specific to Business Units.
Carts List<ProjectSettingsCart>
Carts Configuration
Countries List<string>
A two-digit country code as per ISO 3166-1 alpha-2
Currencies List<string>
A three-digit currency code as per ISO 4217
EnableSearchIndexCustomers bool
Enable the Search Indexing of customers
EnableSearchIndexOrders bool
Enable the Search Indexing of orders
EnableSearchIndexProductSearch bool
Enable the Search Indexing of products
EnableSearchIndexProducts bool
Enable the Search Indexing of product projections
ExternalOauths List<ProjectSettingsExternalOauth>
External OAUTH
Key string
The unique key of the project
Languages List<string>
IETF Language Tag
Messages List<ProjectSettingsMessage>
The change notifications subscribed to
Name string
The name of the project
ShippingRateCartClassificationValues List<ProjectSettingsShippingRateCartClassificationValue>
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
ShippingRateInputType string
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
Version double
BusinessUnits []ProjectSettingsBusinessUnitArgs
Holds configuration specific to Business Units.
Carts []ProjectSettingsCartArgs
Carts Configuration
Countries []string
A two-digit country code as per ISO 3166-1 alpha-2
Currencies []string
A three-digit currency code as per ISO 4217
EnableSearchIndexCustomers bool
Enable the Search Indexing of customers
EnableSearchIndexOrders bool
Enable the Search Indexing of orders
EnableSearchIndexProductSearch bool
Enable the Search Indexing of products
EnableSearchIndexProducts bool
Enable the Search Indexing of product projections
ExternalOauths []ProjectSettingsExternalOauthArgs
External OAUTH
Key string
The unique key of the project
Languages []string
IETF Language Tag
Messages []ProjectSettingsMessageArgs
The change notifications subscribed to
Name string
The name of the project
ShippingRateCartClassificationValues []ProjectSettingsShippingRateCartClassificationValueArgs
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
ShippingRateInputType string
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
Version float64
businessUnits List<ProjectSettingsBusinessUnit>
Holds configuration specific to Business Units.
carts List<ProjectSettingsCart>
Carts Configuration
countries List<String>
A two-digit country code as per ISO 3166-1 alpha-2
currencies List<String>
A three-digit currency code as per ISO 4217
enableSearchIndexCustomers Boolean
Enable the Search Indexing of customers
enableSearchIndexOrders Boolean
Enable the Search Indexing of orders
enableSearchIndexProductSearch Boolean
Enable the Search Indexing of products
enableSearchIndexProducts Boolean
Enable the Search Indexing of product projections
externalOauths List<ProjectSettingsExternalOauth>
External OAUTH
key String
The unique key of the project
languages List<String>
IETF Language Tag
messages List<ProjectSettingsMessage>
The change notifications subscribed to
name String
The name of the project
shippingRateCartClassificationValues List<ProjectSettingsShippingRateCartClassificationValue>
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shippingRateInputType String
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
version Double
businessUnits ProjectSettingsBusinessUnit[]
Holds configuration specific to Business Units.
carts ProjectSettingsCart[]
Carts Configuration
countries string[]
A two-digit country code as per ISO 3166-1 alpha-2
currencies string[]
A three-digit currency code as per ISO 4217
enableSearchIndexCustomers boolean
Enable the Search Indexing of customers
enableSearchIndexOrders boolean
Enable the Search Indexing of orders
enableSearchIndexProductSearch boolean
Enable the Search Indexing of products
enableSearchIndexProducts boolean
Enable the Search Indexing of product projections
externalOauths ProjectSettingsExternalOauth[]
External OAUTH
key string
The unique key of the project
languages string[]
IETF Language Tag
messages ProjectSettingsMessage[]
The change notifications subscribed to
name string
The name of the project
shippingRateCartClassificationValues ProjectSettingsShippingRateCartClassificationValue[]
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shippingRateInputType string
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
version number
business_units Sequence[ProjectSettingsBusinessUnitArgs]
Holds configuration specific to Business Units.
carts Sequence[ProjectSettingsCartArgs]
Carts Configuration
countries Sequence[str]
A two-digit country code as per ISO 3166-1 alpha-2
currencies Sequence[str]
A three-digit currency code as per ISO 4217
enable_search_index_customers bool
Enable the Search Indexing of customers
enable_search_index_orders bool
Enable the Search Indexing of orders
enable_search_index_product_search bool
Enable the Search Indexing of products
enable_search_index_products bool
Enable the Search Indexing of product projections
external_oauths Sequence[ProjectSettingsExternalOauthArgs]
External OAUTH
key str
The unique key of the project
languages Sequence[str]
IETF Language Tag
messages Sequence[ProjectSettingsMessageArgs]
The change notifications subscribed to
name str
The name of the project
shipping_rate_cart_classification_values Sequence[ProjectSettingsShippingRateCartClassificationValueArgs]
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shipping_rate_input_type str
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
version float
businessUnits List<Property Map>
Holds configuration specific to Business Units.
carts List<Property Map>
Carts Configuration
countries List<String>
A two-digit country code as per ISO 3166-1 alpha-2
currencies List<String>
A three-digit currency code as per ISO 4217
enableSearchIndexCustomers Boolean
Enable the Search Indexing of customers
enableSearchIndexOrders Boolean
Enable the Search Indexing of orders
enableSearchIndexProductSearch Boolean
Enable the Search Indexing of products
enableSearchIndexProducts Boolean
Enable the Search Indexing of product projections
externalOauths List<Property Map>
External OAUTH
key String
The unique key of the project
languages List<String>
IETF Language Tag
messages List<Property Map>
The change notifications subscribed to
name String
The name of the project
shippingRateCartClassificationValues List<Property Map>
If shippingrateinput*type is set to CartClassification these values are used to create tiers . Only a key defined inside the values array can be used to create a tier, or to set a value for the shippingRateInput on the cart. The keys are checked for uniqueness and the request is rejected if keys are not unique
shippingRateInputType String
Three ways to dynamically select a ShippingRatePriceTier exist. The CartValue type uses the sum of all line item prices, whereas CartClassification and CartScore use the shippingRateInput field on the cart to select a tier
version Number

Supporting Types

ProjectSettingsBusinessUnit
, ProjectSettingsBusinessUnitArgs

MyBusinessUnitAssociateRoleKeyOnCreation string
Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint. Note that this field cannot be unset once assigned!
MyBusinessUnitStatusOnCreation string
Status of Business Units created using the My Business Unit endpoint.
MyBusinessUnitAssociateRoleKeyOnCreation string
Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint. Note that this field cannot be unset once assigned!
MyBusinessUnitStatusOnCreation string
Status of Business Units created using the My Business Unit endpoint.
myBusinessUnitAssociateRoleKeyOnCreation String
Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint. Note that this field cannot be unset once assigned!
myBusinessUnitStatusOnCreation String
Status of Business Units created using the My Business Unit endpoint.
myBusinessUnitAssociateRoleKeyOnCreation string
Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint. Note that this field cannot be unset once assigned!
myBusinessUnitStatusOnCreation string
Status of Business Units created using the My Business Unit endpoint.
my_business_unit_associate_role_key_on_creation str
Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint. Note that this field cannot be unset once assigned!
my_business_unit_status_on_creation str
Status of Business Units created using the My Business Unit endpoint.
myBusinessUnitAssociateRoleKeyOnCreation String
Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint. Note that this field cannot be unset once assigned!
myBusinessUnitStatusOnCreation String
Status of Business Units created using the My Business Unit endpoint.

ProjectSettingsCart
, ProjectSettingsCartArgs

CountryTaxRateFallbackEnabled bool
Indicates if country - no state tax rate fallback should be used when a shipping address state is not explicitly covered in the rates lists of all tax categories of a cart line items
DeleteDaysAfterLastModification double
Number - Optional The default value for the deleteDaysAfterLastModification parameter of the CartDraft. Initially set to 90 for projects created after December 2019.
CountryTaxRateFallbackEnabled bool
Indicates if country - no state tax rate fallback should be used when a shipping address state is not explicitly covered in the rates lists of all tax categories of a cart line items
DeleteDaysAfterLastModification float64
Number - Optional The default value for the deleteDaysAfterLastModification parameter of the CartDraft. Initially set to 90 for projects created after December 2019.
countryTaxRateFallbackEnabled Boolean
Indicates if country - no state tax rate fallback should be used when a shipping address state is not explicitly covered in the rates lists of all tax categories of a cart line items
deleteDaysAfterLastModification Double
Number - Optional The default value for the deleteDaysAfterLastModification parameter of the CartDraft. Initially set to 90 for projects created after December 2019.
countryTaxRateFallbackEnabled boolean
Indicates if country - no state tax rate fallback should be used when a shipping address state is not explicitly covered in the rates lists of all tax categories of a cart line items
deleteDaysAfterLastModification number
Number - Optional The default value for the deleteDaysAfterLastModification parameter of the CartDraft. Initially set to 90 for projects created after December 2019.
country_tax_rate_fallback_enabled bool
Indicates if country - no state tax rate fallback should be used when a shipping address state is not explicitly covered in the rates lists of all tax categories of a cart line items
delete_days_after_last_modification float
Number - Optional The default value for the deleteDaysAfterLastModification parameter of the CartDraft. Initially set to 90 for projects created after December 2019.
countryTaxRateFallbackEnabled Boolean
Indicates if country - no state tax rate fallback should be used when a shipping address state is not explicitly covered in the rates lists of all tax categories of a cart line items
deleteDaysAfterLastModification Number
Number - Optional The default value for the deleteDaysAfterLastModification parameter of the CartDraft. Initially set to 90 for projects created after December 2019.

ProjectSettingsExternalOauth
, ProjectSettingsExternalOauthArgs

AuthorizationHeader string
Partially hidden on retrieval
Url string
AuthorizationHeader string
Partially hidden on retrieval
Url string
authorizationHeader String
Partially hidden on retrieval
url String
authorizationHeader string
Partially hidden on retrieval
url string
authorization_header str
Partially hidden on retrieval
url str
authorizationHeader String
Partially hidden on retrieval
url String

ProjectSettingsMessage
, ProjectSettingsMessageArgs

DeleteDaysAfterCreation double
Specifies the number of days each Message should be available via the Messages Query API
Enabled bool
When true the creation of messages on the Messages Query HTTP API is enabled
DeleteDaysAfterCreation float64
Specifies the number of days each Message should be available via the Messages Query API
Enabled bool
When true the creation of messages on the Messages Query HTTP API is enabled
deleteDaysAfterCreation Double
Specifies the number of days each Message should be available via the Messages Query API
enabled Boolean
When true the creation of messages on the Messages Query HTTP API is enabled
deleteDaysAfterCreation number
Specifies the number of days each Message should be available via the Messages Query API
enabled boolean
When true the creation of messages on the Messages Query HTTP API is enabled
delete_days_after_creation float
Specifies the number of days each Message should be available via the Messages Query API
enabled bool
When true the creation of messages on the Messages Query HTTP API is enabled
deleteDaysAfterCreation Number
Specifies the number of days each Message should be available via the Messages Query API
enabled Boolean
When true the creation of messages on the Messages Query HTTP API is enabled

ProjectSettingsShippingRateCartClassificationValue
, ProjectSettingsShippingRateCartClassificationValueArgs

Key This property is required. string
Label Dictionary<string, string>
Key This property is required. string
Label map[string]string
key This property is required. String
label Map<String,String>
key This property is required. string
label {[key: string]: string}
key This property is required. str
label Mapping[str, str]
key This property is required. String
label Map<String>

Package Details

Repository
commercetools labd/terraform-provider-commercetools
License
Notes
This Pulumi package is based on the commercetools Terraform Provider.