Product Hierarchy: Overview

Swagger Definition

The Swagger definition for this version of the Product Hierarchy API can be found at: https://app.swaggerhub.com/apis/Triquestra/product_hierarchy/1.0.3.

Overview

The Product Hierarchy API enables the creation, update, deletion and retrieval of product hierarchy information.

Using the Product Hierarchy API you can:

• Retrieve the entire product hierarchy.
• Create a new product hierarchy object.
• Update an existing product hierarchy object.
• Retrieve the entire product hierarchy.
• Archive an existing product hierarchy node.

The Product Hierarchy API is composed of the following:

• Hierarchy: defines a hierarchy for your products, including node and child hierarchies up to three levels, including a code, external code and a name for each:

Node
	Child
		Child

• Target Margins and Mark-ups: defines the target margins or mark-ups for the hierarchy node or child.
• Min and Max Retail Pricing: a limit to the price of products which exist in the hierarchy node or child.

Examples

Retrieve the entire product hierarchy to the specified depth:

GET /products/product_hierarchy

Create a new product hierarchy object:

POST /products/product_hierarchy

Update an existing product hierarchy object:

PUT /products/product_hierarchy

Retrieve the entire product hierarchy to the specified depth:

GET /products/product_hierarchy/{hierarchy_code}

Archive an existing product hierarchy node and all of its descendants:

DELETE /products/product_hierarchy/{hierarchy_code}

Health check endpoint for this API:

GET /health

Scope Controls

Scope controls apply to Read and the ReadWrite scopes.

• GET endpoints are accessible by clients with the Read and/or ReadWrite scopes.
• PUT, DELETE and POST endpoints are accessible only by clients with the ReadWrite scope.

Security Risk Profile

Financial Data 0: no financial data is exposed.

Personal Data 0: no personal data is exposed.

Business Data 2: margin and mark-up targets on the product hierarchy is exposed.