1W1worldsync
FetchProduct

This method will return list of products for a given search criteria.

This method will search for products on a given search criteria and will return data in paged way. Page size can be mentioned in the request parameter. Using of "searchAfter" in request body will give you next page data.

post/V1/product/fetch

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

gtinsstring[]
pullHierarchyboolean nullable

Flag to indicate whether to include hierarchy in the response

gtinstring[] nullable

Item GTIN array

ipGlnstring d{14} nullable

Information Provider GLN

targetMarketstring nullable

Target Market

brandNamestring nullable

Brand name (supports wildcard)

productTypestring nullable

Product Type

isConsumerUnitstring nullable

Consumer Unit

gpcCodestring nullable

GPC code or name (supports wildcard)

upcCodestring nullable

UPC code (supports wildcard)

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",
  "targetMarket": "US",
  "lastModifiedDate": {
    "from": {
      "date": "2023-01-01",
      "op": "GTE"
    },
    "to": {
      "date": "2023-01-31",
      "op": "LTE"
    }
  },
  "brandName": "Brand Name",
  "productType": "EA",
  "isConsumerUnit": "false",
  "gpcCode": "10000248",
  "upcCode": "123456789128",
  "sortFields": [
    {
      "field": "lastModifiedDate",
      "desc": "true"
    },
    {
      "field": "gtin",
      "desc": "false"
    }
  ],
  "fields": {
    "include": [],
    "exclude": []
  },
  "searchAfter": []
}

Response

Will return list of products.

totalPagesinteger

This field used to set total page number for given search criteria.

currentPageinteger

This field used to set pagination page number.

messagestring

This field used to set any warning message.

totalCountinteger

This field used to set total count.

searchAfterobject[]

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

Example response

{
  "items": [
    {
      "objId": "2334322",
      "gln": "0838016005012",
      "dataPoolType": "SDP",
      "item": {}
    }
  ],
  "message": "Warning message"
}

Changes

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