Skip to main content

Update a hierarchy

PUT 

/pcm/hierarchies/:hierarchyID

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the hierarchy is not updated.

Request

Path Parameters

    hierarchyID stringrequired

    A unique identifier for the hierarchy.

Body

required
    data objectrequired
    id stringrequired

    The unique identifier of the hierarchy. Must match the hierarchy ID specified in the request path.

    type stringrequired

    Possible values: [hierarchy]

    This represents the type of resource object being returned. Always hierarchy.

    attributes objectrequired
    name string

    The name of the hierarchy, such as Major Appliances.

    description string

    A description of the hierarchy.

    slug string

    A unique slug for the hierarchy.

    locales object

    Product Experience Manager supports localization of products and hierarchies. If your store supports multiple languages, you can localize product names and descriptions. You can have as many locales as you want.

    property name* object

    A three-letter language code that represents the name of language you have used.

    name string

    A localized name for the hierarchy.

    description string

    A localized description for the hierarchy.

Responses

Successfully returns the updated hierarchy

Schema
    data object
    id string

    A unique identifier generated when a hierarchy is created.

    type string

    Possible values: [hierarchy]

    This represents the type of resource object being returned. Always hierarchy.

    attributes object
    name string

    The name of a hierarchy, such as Major Appliances.

    description string

    A description for a hierarchy.

    slug string

    A unique slug for a hierarchy.

    locales object

    Product Experience Manager supports localization of hierarchies and nodes. If you store supports multiple languages, you can localize hierarchy and node names and descriptions.

    property name* object

    A three-letter language code that represents the name of language you have used.

    name string

    A localized hierarchy or node name.

    description string

    A localized hierarchy or node description.

    relationships object
    children object

    The child nodes related to the hierarchy.

    data array

    An array of child nodes.

    links object

    Links allow you to move between requests.

    related string

    A link to a related resource.

    meta object
    created_at date-time

    The date and time a hierarchy is created.

    updated_at date-time

    The date and time a hierarchy is updated.

    owner string

    Possible values: [store, organization]

    The owner of a resource, either organization or store.

Loading...