{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c8f74257-0ecb-42c4-be6d-258076f7cf6d","name":"PIM REST API","description":"A Collection of APIs to access data in Data Sync Direct and to optionally retrieve GTIN attribute values or Export GTIN attribute values as XML documents.\n\nEach API below is documented with request and response examples that can be shown in multiple programming languages.\n\nThis collection can also be downloaded for testing against any PIM system at version 8.6.4 and above.\n\n# What's new in 8.7.1\n\n- All GTIN/GLN/TM data returned will now include GTIN Status\n    \n- New fileUpload API to upload ERPXML files to the ERPXML Inbound folder on the PIM server\n    \n\n# What's new in 8.7.2\n\n- fileUpload API now allows 3 upload types: ERPXML, HORIZXLS and INBCIN\n    \n- Refer fileUpload API\n    \n\n# What's new in 8.7.3\n\n- New publish API to publish 1 or more GTINs\n    \n- Refer publish API\n    \n- New PIM User CRUD APIs\n    \n- Refer user/fetch, user/create, user/update, user/clone and user/authorizedObject APIs\n    \n\n# What's new in 8.7.4\n\n- User Access Authority Added to the following APIs\n    \n    - **Publish**\n        \n        - Send Item Publish Transaction (DSDOCTL05)\n            \n    - **User create/update/delete/clone/authorizedObject**\n        \n        - Security/User Manager (LW3OCTL67)\n            \n    - **fileUpload**\n        \n        - Enable File Upload Button (LW3OCTL13)\n            \n\n# What's new in 8.7.6\n\n- New hierarchy API to retrieve the hierarchy for one or more GTINs\n    \n- Refer hierarchy API\n    \n\n# What's new in 8.8.3\n\n- GET netChange API Expanded Search For Attribute Lists, View and Layout\n    \n- Refer netChange API\n    \n    - attributeName : \\*LIST, \\*VIEW or Attribute Name: validValues?attributeName=ATTNAME. If \\*LIST , then \"attributeNameList\" is Used. If \\*VIEW, then \"viewid\" and \"layoutID\" are used. \"attributeNameType\" is optional to also use for the output.\n        \n\n# Overview\n\nThis collection provides access to the PIM Quick Browse Search Engine to access GTIN data.\n\nSearches can be performed over:\n\n- GTIN and Attribute data\n    \n- Workflow Events\n    \n- Messaging and Transactions\n    \n- Net Change and Logging\n    \n- Validation Errors and Warnings\n    \n- Publications\n    \n- Confirmations.\n    \n- GTIN Hierarchy\n    \n\nThe resultant search data can be used to:\n\n- Retrieve GTIN Attribute values\n    \n- Generate XML Documents of the GTIN Attribute values\n    \n\nRetrieving the Attribute values or Generating the XML Documents can be processed independent of the search engine or as part of the search request itself. Both APIs can accept a list of one or more GTINs to process.\n\nValid Values for attributes and search parameters can be retrieved via the validValues API.\n\nAttribute Names including GDSN and PIM Layout structural information can be retrieved using the attributeList API.\n\nThe hierarchy API can be invoked to return all GTINs that are contained in the same hierarchies as the GTIN passed in. The returned GTIN list can then be used to invoke any of the APIs that can accept a list of GTINs.\n\n# GTIN Unique Identifier\n\nThis collection of APIs introduces a unique pointer to a GTIN.  \nInside PIM, a GTIN is uniquely defined by:\n\n- User Environment (PIM can have multiple environments) - Determined by the Authenticated User\n    \n- GTIN# - 14-digit GTIN Number\n    \n- IPGLN - Information Provider GLN\n    \n- TM - Target Market\n    \n\nThe Search Engine also returns a single internal unique identifier for a GTIN:\n\n- GTINUniqueID - Numeric ID\n    \n- GTINUniqueIDList - Comma delimited list of Numeric IDs\n    \n\nRequests for Attribute Values, Publication or XML Generation can use one or more GTIN# combined with IPGLN and TM, or one or more GTINUniqueID numbers.\n\n# Authentication\n\nThe authenticate API is the initial access point to acquire a session Id and session Hash with a valid PIM user Id and password.\n\nAfter that , all other APIs must be accessed with user Id, session Id, and session Hash sent in the Request Header.\n\nPassword and Session rules follow the same PIM rules that are configurable inside the PIM Administration Portal.\n\n# Search Engine APIs\n\nThe seven search APIs have some global parameters and functionality described in more detail in this section.\n\nDefaults are applied if the parameter is not included or has a blank value. Default = blank or zero when not specified.\n\n## Global Search Parameters\n\n- resultLimitLimit the initial search return list prior to any GTIN grouping specified in the outputType  \n    parameter. Use 999999 for unlimited. Default = 200.\n    \n- exactMatchUsed for Search parameters that are an entered string and not dates or valid values.  \n    If \"Y\", then the string must be an exact match. Default = Y.\n    \n- GTINGTIN#  \n    Full or Partial String when exactMatch = N.\n    \n- IPGLNInformation Provider GLN  \n    validValues?attributeName=IPGLN\n    \n- TMTarget Market  \n    validValues?attributeName=TM\n    \n- catalogDSD Catalog Identifier  \n    validValues?attributeName=S1FVCATID\n    \n- productTypeProduct Type  \n    validValues?attributeName=S1PRDTYP\n    \n- productIdUser Defined Product Id  \n    Full or Partial String when exactMatch = N.\n    \n- brandName  \n    Brand Name  \n    validValues?attributeName=ITMBRN\n    \n\n## Global Search Formatting and Action Parameters\n\n- outputType\n    \n    - blank=PIM Quick Browse List Details (No Action. Parameter actionCode is ignored).\n        \n    - DETAIL=Accumulated GTIN Details. PIM Quick Browse GTIN List Details.\n        \n    - SUMMARY=Accumulated GTIN Summary. UniqueID, GTIN, IPGLN, TM.\n        \n    - KEY=Accumulated GTIN Key. UniqueID.\n        \n    - NONE=No GTIN Info._note the output will always include a comma delimited string of unique identifiers____________**(gtinUniqueIDList) e.g. \"gtinCount\": 10,**__**__**__\"GTINUniqueIdList\": \"2,27902,3,4,5,6,7,8,9,27887\",_\n        \n- actionCode\n    \n    - blank - No Action.\n        \n    - \"VALUE\" - Get GTIN Attribute Values. Refer gtinValues API.\n        \n    - \"EXPORT\" - Export 1 Gtin per file. Refer gtinExport API.\n        \n    - \"EXPORTALL\" - Export All Gtins in 1 File. Refer gtinExport API.\n        \n- viewId\n    \n    - PIM View identifier that contains the attributes to process for the actionCode parameter specified.\n        \n    - Default = View assigned to the authenticated user.\n        \n- layoutId\n    \n    - PIM Layout Identifier that contains attributes to process for the actionCode parameter.\n        \n    - Default = All layouts in the view.\n        \n    - If entered, layoutId overrides viewId.\n        \n- attributeNameType\n    \n    - _Only used for actionCode=VALUE_.\n        \n    - Attribute Name - A single Attribute Name will get values for that attribute.\n        \n    - Blank (for ALL) - Values will be retrieved for ALL attributes (irrespective of View and Layout).\n        \n    - \"\\*LIST\" - use parameter attributeNameList (comma delimited list of attribute names).\n        \n    - \"\\*VIEW\" - use View or Layout specified in viewId or layoutId.\n        \n- attributeNameList\n    \n    - _Only used for actionCode=VALUE_.\n        \n    - Attribute Name single quoted list separated by comma.\n        \n    - e.g. 'S1NETCNT','S1NETUOM'.\n        \n- getAttributeDetails\n    \n    - _Only used for actionCode=VALUE_.\n        \n    - Return attribute details with each value.\n        \n    - Attribute details are the same that are returned from API attributeList.\n        \n\n# Error Codes\n\n401 - Unauthorized access","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9015441","collectionId":"c8f74257-0ecb-42c4-be6d-258076f7cf6d","publishedId":"2sB3BDKBGR","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9015441/2sB3BDKBGR","privateUrl":"https://go.postman.co/documentation/9015441-c8f74257-0ecb-42c4-be6d-258076f7cf6d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-08-07T15:48:55.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB3BDKBGR"}