Create a hierarchy

POST 
https://euwest.api.elasticpath.com/pcm/hierarchies

Creates a hierarchy with a name, description, and slug to organize products in your catalog.

Custom Attributes

Custom attributes allow you to extend the data model with your own key-value data.

You can define up to 100 custom attributes in each group (shopper_attributes and admin_attributes). Both keys and values must be strings.

• shopper_attributes are visible in shopper-facing catalogs and accessible to both shoppers and administrators. Ideal for customer-facing data, such as promotional labels or product tags.
• admin_attributes are private and not visible in catalogs. Best suited for internal operational data, such as cost tracking or workflow metadata.

See Custom Attributes.

Request

Responses

201

Returns a created hierarchy with the following attributes.

422

Bad request. The request failed validation.

500

Internal server error. There was a system failure in the platform.

Authorization: http

name: bearerAuthtype: 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.Post, "https://euwest.api.elasticpath.com/pcm/hierarchies");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"hierarchy\",\n    \"attributes\": {\n      \"name\": \"string\",\n      \"description\": \"string\",\n      \"slug\": \"string\",\n      \"admin_attributes\": {\n        \"cost_of_goods\": \"42.0\",\n        \"charge_type\": \"credit card\"\n      },\n      \"shopper_attributes\": {\n        \"cost_of_goods\": \"42.0\",\n        \"charge_type\": \"credit card\"\n      },\n      \"locales\": {}\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Body required

• Example (from schema)
• create-hierarchy

{
  "data": {
    "type": "hierarchy",
    "attributes": {
      "name": "string",
      "description": "string",
      "slug": "string",
      "admin_attributes": {
        "cost_of_goods": "42.0",
        "charge_type": "credit card"
      },
      "shopper_attributes": {
        "cost_of_goods": "42.0",
        "charge_type": "credit card"
      },
      "locales": {}
    }
  }
}

ResponseClear

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