Project

The Project endpoint is used to retrieve certain information from a project.

The Endpoint is responding a limited set of information about settings and configuration of the project.

Representations

Project

ShippingRateInputType

There are three ways to dynamically select a ShippingRatePriceTier. 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

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

Cart Classification is used when the shipping rate maps to an abstract cart categorization expressed through a string, e.g. 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 keys are checked for uniqueness and the request is rejected if keys 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

Cart Score is used when the shipping rate maps to an abstract cart categorization expressed through an integer, e.g. shipping score or weight ranges.

The range starts at 0. The default price covers the 0, tiers start at 1.

Get Project

Endpoint: /{projectKey}
Method: GET
OAuth2 Scopes: view_project_settings:{projectKey}
Response Representation: Project

Update Project

Endpoint: /{projectKey}
Method: POST
OAuth2 Scopes: manage_project:{projectKey}
Response Representation: Project
Fields:

Update Actions
Please find below the individual update actions provided on this endpoint.


Change Name

Change Currencies

A project needs at least one currency.

Change Countries

Change Languages

A project needs at least one language.

Change Messages Enabled

Set ShippingRateInputType