Hierarchy Information – 1WorldSync Developer

The ability to retrieve Hierarchy Information from the Read API 2.0 was released on 2/24/2024. Two things were added as part of this change.

Fetch Endpoint

First, the existing fetch endpoint will display Hierarchy Information for each item if requested. To include Hierarchy Information in the fetch endpoint, include the “pullHierarchy” parameter in your Json payload:

{
  "pullHierarchy": true
}

The “hierarchy” node will be included in each items result as follows:

“hierarchy”: [
	{
		“gtin”: “20072714036501”,
		“children”: [{
				“gtin”: “10072714036504”,
				“quantity”: “72”,
				“children”: [{
						“gtin”: “00072714036507”,
						“quantity”: “12”
					}
				]
			}
		]
	}
]

Hierarchy Endpoint

Second, a new endpoint was added to retrieve only Hierarchy Information for each item. The new endpoint (for production) is:

https://content1-api.1worldsync.com/V1/product/hierarchy

An example of the information returned will appear as follows:

{
    “hierarchies”: [
        {
            “gtin”: “00072714036507”,
            “informationProviderGLN”: “0072714012402”,
            “targetMarket”: “US”,
            “hierarchy”: [
                {
                    “gtin”: “20072714036501”,
                    “children”: [
                        {
                            “gtin”: “10072714036504”,
                            “quantity”: “72”,
                            “children”: [
                                {
                                    “gtin”: “00072714036507”,
                                    “quantity”: “12”
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            “gtin”: “00884912434968”,
            “informationProviderGLN”: “0042400000013”,
            “targetMarket”: “US”,
            “hierarchy”: [
                {
                    “gtin”: “10884912434965”,
                    “children”: [
                        {
                            “gtin”: “00884912434968”,
                            “quantity”: “8”
                        }
                    ]
                }
            ]
        }
    ]
}

Notes

When fetching an item, all hierarchies that the item is a part of will be included in the results. Most items follow a simple Pallet, Case, Each hierarchy, but there are items which can be part of many hierarchies at once. Because of this, the default if the “pullHierarchy” parameter is not included is false.