1W1worldsync
FetchProduct

Fetch item hierarchy details.

This method will return item hierarchy details based on a given search criteria and will return data with pagination. Page size can be mentioned in the "size" parameter. Using of "searchAfter" in request body loads next page.

post/V1/product/hierarchy

Request

Query parameters

timestampstring required

Current Timestamp in YYYY-MM-DDTHH:mm:ssZ format

pageSizeinteger required

Page size, default to 1000

Headers

appidstring required

API User App Id

hashcodestring required

Hash of secret key, URL and timestamp

glnunknown

Data requested for the GLNs (comma separated for multiple, no space required or Click the "Add Item" button)

Request body

gtinstring[] nullable

Item GTIN array

ipGlnstring d{14} nullable

Information Provider GLN

searchAfterobject[] nullable

This field is used to fetch item in batch. To retrieve the next page of the items. You need to set searchAfter in search criteria from previous result.

Example request

{
  "gtin": [],
  "ipGln": "0838016005012",
  "lastModifiedDate": {
    "from": {
      "date": "2023-01-01",
      "op": "GTE"
    },
    "to": {
      "date": "2023-01-31",
      "op": "LTE"
    }
  },
  "sortFields": [
    {
      "field": "lastModifiedDate",
      "desc": "true"
    },
    {
      "field": "gtin",
      "desc": "false"
    }
  ],
  "searchAfter": []
}

Response

Returns item hierarchy details.

messagestring

Response message.

searchAfterobject[]

This value is used to fetch next page of hierarchies.

Example response

{
  "hierarchies": [
    {
      "gtin": "03007687545289"
    }
  ],
  "message": "To retrieve the next page of products, pick what you have received in searchAfter and set it in next request."
}

Changes

No recorded changes to this operation across all 1 revision of this API.