Update Project Settings

PUT 
https://useast.api.elasticpath.com/v2/settings

You can use the Settings endpoint to update your project settings at any time. These global settings take immediate effect.

Request

application/json

Body

type stringrequired

Describes the type of request payload you’re sending. Set this value to settings.

page_length integer

Indicates the number of results per page (max: 100).

list_child_products boolean

Displays child products or not in product listings.

additional_languages string[]

Represents an array of alpha2 codes for supported languages.

calculation_method string

Possible values: [line, simple]

Displays the method used to calculate card and order totals.

address_mandatory_fields string[]

Indicates an array of fields that are required for creating an address.

Responses

200

OK

application/json

Schema

Schema

data object

type stringrequired

Describes the type of request payload you’re sending. Set this value to settings.

page_length integer

Indicates the number of results per page (max: 100).

list_child_products boolean

Displays child products or not in product listings.

additional_languages string[]

Represents an array of alpha2 codes for supported languages.

calculation_method string

Possible values: [line, simple]

Displays the method used to calculate card and order totals.

address_mandatory_fields string[]

Indicates an array of fields that are required for creating an address.

currency_limit integer

The currency limit.

field_limit integer

The field limit.

integration_limit integer

The integration limit.

event_limit integer

The event limit.

filter_limit integer

The filter limit.

tax_item_limit integer

The tax item limit.

promotions_limit integer

The promotions limit.

promotion_codes_limit integer

The promotion codes limit.

page_offset_limit integer

The page offset limit.

meta object
owner string

Example (from schema)

{
  "data": {
    "type": "settings",
    "page_length": 25,
    "list_child_products": false,
    "additional_languages": [
      "es",
      "fr",
      "de"
    ],
    "calculation_method": "line",
    "address_mandatory_fields": [
      [
        "first_name",
        "last_name",
        "line_1",
        "city",
        "region",
        "postcode",
        "country",
        "instructions"
      ]
    ],
    "currency_limit": 10,
    "field_limit": 100,
    "integration_limit": 100,
    "event_limit": 5,
    "filter_limit": 10,
    "tax_item_limit": 5,
    "promotions_limit": 1000,
    "promotion_codes_limit": 1000,
    "page_offset_limit": 10000
  },
  "meta": {
    "owner": "store"
  }
}

400

Bad Request

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

bad-request-error

{
  "errors": [
    {
      "title": "enum",
      "source": "data.type",
      "detail": "data.type must be one of the following: \"settings\""
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://useast.api.elasticpath.com/v2/settings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "type": "settings",
  "page_length": 25,
  "list_child_products": false,
  "additional_languages": [
    "es",
    "fr",
    "de"
  ],
  "calculation_method": "line",
  "address_mandatory_fields": [
    [
      "first_name",
      "last_name",
      "line_1",
      "city",
      "region",
      "postcode",
      "country",
      "instructions"
    ]
  ]
}'

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Body

{
  "type": "settings",
  "page_length": 25,
  "list_child_products": false,
  "additional_languages": [
    "es",
    "fr",
    "de"
  ],
  "calculation_method": "line",
  "address_mandatory_fields": [
    [
      "first_name",
      "last_name",
      "line_1",
      "city",
      "region",
      "postcode",
      "country",
      "instructions"
    ]
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!