Project
The Project endpoint is used to retrieve certain information from a project.
The endpoint is providing 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.
Representations
Project
version
- Number
The current version of the project.key
- String
The unique key of the project.createdAt
- DateTimecreatedBy
- CreatedBy BETA
Present on resources created after 2019-02-01 except for events not tracked.lastModifiedAt
- DateTimelastModifiedBy
- LastModifiedBy BETA
Present on resources updated after 2019-02-01 except for events not tracked.name
- String
The name of the project.countries
- Array of Strings
A two-digit country code as per ISO 3166-1 alpha-2.currencies
- Array of Strings
A three-digit currency code as per ISO 4217.languages
- Array of Strings
IETF language tag.trialUntil
- String - Optional
The time is in the format Year-MonthYYYY-MM
.messages
- MessagesConfigurationcarts
- CartsConfigurationshoppingLists
- ShoppingListsConfigurationshippingRateInputType
- ShippingRateInputType - OptionalexternalOAuth
- ExternalOAuth - Optional
Messages Configuration
This object is used to configure the Messages Query HTTP API feature for the project.
enabled
- Boolean
Whentrue
the creation of messages on the Messages Query HTTP API is enabled.deleteDaysAfterCreation
- Number - Optional, defaults to15
Specifies after how many days messages will be deleted from the Messages Query HTTP API. Must not be larger than 90 days. Optional for backwards compatibility reasons only.
Messages Configuration Draft
In the draft of the Messages Configuration, deleteDaysAfterCreation
is required.
enabled
- BooleandeleteDaysAfterCreation
- Number
Carts Configuration
deleteDaysAfterLastModification
- Number - Optional The default value for thedeleteDaysAfterLastModification
parameter of the CartDraft. Initially set to90
for projects created after December 2019.countryTaxRateFallbackEnabled
- Boolean - Optional 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. This feature can be enabled by changeCountryTaxRateFallbackEnabled operations and it is initially set tofalse
for projects created after May 2020.
ShoppingLists Configuration
deleteDaysAfterLastModification
- Number - Optional The default value for thedeleteDaysAfterLastModification
parameter of the ShoppingListDraft. Initially set to360
for projects created after December 2019.
ShippingRateInputType
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 shipppingRateInput
field on the cart to select a tier.
CartValue
type
- String -"CartValue"
Cart Value is used when the shipping rate maps to the sum of the line item prices.
The value of the cart is used to select a tier. If chosen, it is not possible to set a value for the shippingRateInput
on the cart. Tiers contain the centAmount
(a value of 100
in the currency USD
corresponds to $ 1.00
), and start at 1
.
CartClassification
type
- String -"CartClassification"
values
- Array of LocalizedEnumValue
Cart Classification is used when the shipping rate maps to an abstract cart categorization expressed through a string, for example green, yellow, red, or light, medium, heavy.
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 key
s are checked for uniqueness and the request is rejected if key
s are not unique.
Here is an example of a "ShippingRateInputType"
of type "CartClassification"
:
{"shippingRateInputType": {"type": "CartClassification","values": [{ "key": "Small", "label": { "en": "Small", "de": "Klein" } },{ "key": "Medium", "label": { "en": "Medium", "de": "Mittel" } },{ "key": "Heavy", "label": { "en": "Heavy", "de": "Schwergut" } }]}}
CartScore
type
- String -"CartScore"
Cart Score is used when the shipping rate maps to an abstract cart categorization expressed through an integer, for example shipping score or weight ranges.
The range starts at 0
. The default price covers the 0
, tiers start at 1
.
ExternalOAuth
Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint. For more information, see Requesting an access token using an external OAuth 2.0 server.
You can only configure one external OAuth 2.0 endpoint per project. If you want to authenticate using multiple external services (for example Social network logins), use a middle layer authentication service.
url
- StringauthorizationHeader
- String - Partially hidden on retrieval
Get Project
Endpoint: /{projectKey}
Method: GET
OAuth 2.0 Scopes: view_project_settings:{projectKey}
Response Representation: Project
Update Project
Endpoint: /{projectKey}
Method: POST
OAuth 2.0 Scopes: manage_project:{projectKey}
Response Representation: Project
Fields:
version
- Number - Required
The expected version of the project on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.actions
- Array of UpdateAction - Required
The list of update actions to be performed on the project.
Updates of the project are eventually consistent, it may take up to a minute before a change becomes fully active.
Update Actions
Change Name
action
- String -"changeName"
name
- String - Required
Change Currencies
action
- String -"changeCurrencies"
currencies
- Array of Strings
A three-digit currency code as per ISO 4217.
A project needs at least one currency.
Change Countries
action
- String -"changeCountries"
countries
- Array of Strings
A two-digit country code as per ISO 3166-1 alpha-2.
Change Languages
action
- String -"changeLanguages"
languages
- Array of Strings
IETF language tag.
A project needs at least one language.
If a language is used by a Store, it cannot be deleted. Attempts to delete such language will lead to LanguageUsedInStores errors.
Change Messages Configuration
action
- String -"changeMessagesConfiguration"
messagesConfiguration
- Messages Configuration Draft
Change Carts Configuration
action
- String -"changeCartsConfiguration"
cartsConfiguration
- Carts Configuration
Change CountryTaxRateFallbackEnabled
Sets countryTaxRateFallbackEnabled
. For carts where a line item tax rate is missing for the
country - state combination present in the shipping address, the country without state tax rate in the tax rates list of each tax category is meant to be used.
action
- String -"changeCountryTaxRateFallbackEnabled"
countryTaxRateFallbackEnabled
- Boolean Whentrue
, country - no state tax rate is used as fallback.
Change ShoppingLists Configuration
action
- String -"changeShoppingListsConfiguration"
shoppingListsConfiguration
- ShoppingLists Configuration
Set ShippingRateInputType
action
- String -"setShippingRateInputType"
shippingRateInputType
- ShippingRateInputType - Optional
If not set, removes existing shippingRateInputType.
Set ExternalOAuth
action
- String -"setExternalOAuth"
externalOAuth
- ExternalOAuth - Optional If you do not provide theexternalOAuth
field or provide a value ofnull
, the update action unsets the External OAuth provider.