Get Project Settings

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

You can get all of the project settings via one API call using a client_credential token. The response is in object format as shown in the following example.

note

The default calculation_method is line.

Responses

200

OK

application/json

Schema

Schema

data object
typestringrequired
Describes the type of request payload you’re sending. Set this value to settings.
Example: settings
page_lengthinteger
Indicates the number of results per page (max: 100).
Example: 25
list_child_productsboolean
Displays child products or not in product listings.
Example: false
additional_languagesstring[]
Represents an array of alpha2 codes for supported languages.
Example: ["es","fr","de"]
calculation_methodstring
Displays the method used to calculate card and order totals.
Possible values: [line, simple]
Example: line
address_mandatory_fieldsstring[]
Indicates an array of fields that are required for creating an address.
currency_limitinteger
The currency limit.
Example: 10
field_limitinteger
The field limit.
Example: 100
integration_limitinteger
The integration limit.
Example: 100
event_limitinteger
The event limit.
Example: 5
filter_limitinteger
The filter limit.
Example: 10
tax_item_limitinteger
The tax item limit.
Example: 5
promotions_limitinteger
The promotions limit.
Example: 1000
promotion_codes_limitinteger
The promotion codes limit.
Example: 1000
page_offset_limitinteger
The page offset limit.
Example: 10000
meta object
ownerstring
Example: store

Example (auto)

{
  "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"
  }
}

401

Unauthorized

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

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

unauthorized-error

{
  "errors": [
    {
      "title": "Unauthorized",
      "status": "401"
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/settings");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

ResponseClear

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