{"info":{"_postman_id":"8091d0de-9f92-46ec-a1db-82d6857c8146","name":"IntelligentReach API","description":"

Welcome to the Intelligent Reach API documentation. These APIs allow authorized clients to manage and access product information, inventories, pricing, and more.

Getting Started

To begin using the Intelligent Reach APIs, follow these steps:

Generate Credentials: Within the Developer API Admin screen of the application, create your credentials. You will receive a Client ID and Client Secret. Be sure to keep these credentials secure, as they allow access to API endpoints.
\n
Assign Permissions: Assign read or write permissions to specific scopes, such as Ir.Pim, based on your access needs. These scopes govern the level of access each client has within the PIM API suite.
\n
Authenticate via OAuth2: Use the client_credentials grant type to obtain an access token. Make an HTTP POST request to the following authentication endpoint:
https://api.intelligentreach.io/security-auth/oauth2
Include your Client ID and Client Secret in the request body. This will return an access token, which you’ll include in the authentication header of subsequent API requests to authenticate.
\n
Begin Using Intelligent Reach APIs: With a valid access token, you can now access the APIs described in this documentation. Use these APIs to manage and retrieve product data, inventory details, and pricing information.
\n

\n
Note: Each API endpoint may require specific permissions, so ensure that the necessary permissions are assigned to your client in the Developer API Admin screen.
\n

\n
Note: These Credentials Expire within one year and will need to be renewed periodically.
\n

Rate Limits

There are two types of rate limits that our APIs can have - requests and bandwidth quota.

In the response header the API will return:

RateLimit-Policy: the number of calls and bandiwdth quote (if any). i.e. response of \"50;w=1, bandwidth=102400;w=300\" implies 50 calls/s and 100MB/300s

Requests

When calls are exceeded the API will return \"429 Too Many Requests\". In the response header the API will return:

RateLimit-Reset: will contain the seconds to wait before making a new call
\n
RateLimit-Limit: the number of calls that can be made in the time
\n
RateLimit-Remaining: the number of calls that are remaining
\n

Bandwidth Quota

When bandwidth quotas are exceeded the API will return \"403 Quota Exceeded\". In the response header the API will return:

Retry-After: will contain the seconds to wait before before making a new call

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1773013","collectionId":"8091d0de-9f92-46ec-a1db-82d6857c8146","publishedId":"U16bxpKi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-12-19T00:38:36.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Token","event":[{"listen":"test","script":{"id":"1332b7df-25f4-4c5a-943f-a165afe57ad4","exec":["pm.globals.set(\"token\", pm.response.json().accessToken);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e39cb6a2-ad97-489a-8262-082fa9e272f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"","type":"text"},{"key":"client_secret","value":"","type":"text"}]},"url":"https://api.intelligentreach.io/security-auth/oauth2","description":"

This endpoint performs an HTTP POST request to obtain an OAuth2 access token for authentication. The request body is sent as x-www-form-urlencoded and includes the following parameters:

grant_type (string): Specifies the grant type, \"client_credentials\".
\n
client_id (string): The application's client ID.
\n
client_secret (string): The application's client secret.
\n

Rate Limits

2 requests per second

\n
Note: These credentials expire within one year and will need to be renewed periodically.
\n

\n","urlObject":{"protocol":"https","path":["security-auth","oauth2"],"host":["api","intelligentreach","io"],"query":[],"variable":[]}},"response":[{"id":"c4f02487-53e0-49ad-ba3b-ca5e51b03314","name":"200","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"{clientId}","type":"text"},{"key":"client_secret","value":"{client_secret}","type":"text"}]},"url":"https://api.intelligentreach.io/security-auth/oauth2"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhb......\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}"},{"id":"80d53526-f700-466f-b88e-2704117e35b4","name":"401","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"{client_id}","type":"text"},{"key":"client_secret","value":"{client_secret}","type":"text"}]},"url":"https://api.intelligentreach.io/security-auth/oauth2"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"reference\": \"0HMSUPT0D4FF1:00000003\"\n}"},{"id":"032d2047-d458-489b-948c-971e8574b868","name":"400","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"{client_id}","type":"text"},{"key":"client_secret","value":"{client_secret}","type":"text"}]},"url":"https://api.intelligentreach.io/security-auth/oauth2"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalidData\",\n \"message\": \"The grant_type is not supported.\",\n \"reference\": \"0HMSUPT0D4FF1:00000004\"\n}"}],"_postman_id":"e39cb6a2-ad97-489a-8262-082fa9e272f4"}],"id":"71f4ab74-6375-4966-b30d-832ae8b744e3","_postman_id":"71f4ab74-6375-4966-b30d-832ae8b744e3","description":""},{"name":"PIM Sync","item":[{"name":"Create Products","id":"d144ad99-ad2f-4bab-a772-3cc9e1cc126f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"uniqueId\": \"108883\",\r\n \"meta\": {\r\n \"productCode\": \"108883\",\r\n \"parentProductCode\": \"108883\",\r\n \"productType\": \"Sales Inventory\",\r\n \"productStructure\": \"Product\",\r\n \"productName\": \"My Family Backpack Space Monkey\",\r\n \"productPageURL\": \"https://www.babybunting.com.au/product/108883\",\r\n \"priceDetails\": {\r\n \"retailPrice\": \"39.95\",\r\n \"taxable\": \"true\"\r\n },\r\n \"brandDetails\": {\r\n \"referenceId\": \"MY FAMILY\",\r\n \"brandName\": \"MY FAMILY\"\r\n },\r\n \"supplierDetails\": {\r\n \"referenceId\": \"605\",\r\n \"productCode\": \"amyfambpmonkey\"\r\n },\r\n \"promotionDetails\": [\r\n {\r\n \"referenceId\": \"8141\",\r\n \"promotionName\": \"Price Promotion\",\r\n \"promotionPrice\": \"29.860000\",\r\n \"promotionStartDate\": \"2019-06-28\",\r\n \"promotionEndDate\": \"2020-12-31\"\r\n }\r\n ],\r\n \"attributeFlags\": {\r\n \"availability\": {\r\n \"web\": \"true\",\r\n \"erp\": \"true\",\r\n \"app\": \"true\",\r\n \"pos\": \"true\",\r\n \"oms\": \"true\",\r\n \"digitalFeed\": \"true\"\r\n },\r\n \"visibility\": {\r\n \"web\": \"false\",\r\n \"search\": \"false\",\r\n \"catalogue\": \"false\",\r\n \"giftRegistry\": \"false\"\r\n },\r\n \"fulfilment\": {\r\n \"dropShip\": \"false\"\r\n },\r\n \"callout\": {\r\n \"exclusive\": \"false\",\r\n \"bestBuy\": \"false\",\r\n \"privateLabel\": \"false\",\r\n \"clearance\": \"false\"\r\n },\r\n \"productState\": {\r\n \"outOfStock\": \"false\",\r\n \"purchasable\": \"true\",\r\n \"stocked\": \"true\",\r\n \"sellableInStore\": \"true\",\r\n \"returnableInStore\": \"true\",\r\n \"archived\": \"false\",\r\n \"discontinued\": \"false\",\r\n \"enriched\": \"false\"\r\n }\r\n },\r\n \"productIdentification\": {\r\n \"primaryBarcode\": \"9351395000351\",\r\n \"productLookupCode\": \"1000000778144\"\r\n },\r\n \"dateDetails\": [\r\n {\r\n \"dateCode\": \"LaunchedDate\",\r\n \"dateValue\": \"2017-10-18T13:00:00\"\r\n },\r\n {\r\n \"dateCode\": \"LastUpdatedDate\",\r\n \"dateValue\": \"2019-05-24T00:23:43\"\r\n }\r\n ],\r\n \"packDetails\": {\r\n \"packageType\": null,\r\n \"packLabel\": \"EACH\",\r\n \"packQuantity\": \"1.000000\",\r\n \"dimensionDetails\": {\r\n \"unitLengthInCentimetre\": \"14\",\r\n \"unitWidthInCentimetre\": \"27\",\r\n \"unitHeightInCentimetre\": \"32\",\r\n \"unitWeightInKilogram\": \"0.34\",\r\n \"unitVolumeInCubicMetre\": \"0.012100\"\r\n }\r\n }\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products","description":"

This endpoint allows for creating and updating product information for a specific company via an HTTP PUT request.

with a payload containing a JSON array with the details of the products to be upserted.

The request payload should be a JSON array containing product objects to be upserted. Each object in the array should have:

uniqueId (string): A unique identifier for the product.
\n
meta (object): Contains all product-specific information, including but not limited to:
\n
- productName, productPageURL, priceDetails, brandDetails, supplierDetails
\n

\n
Note: If a product with the same uniqueId already exists, it will be overwritten with the new data provided in this request.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"776a79bb-34a5-4081-8bc1-e2cc75f07040","id":"776a79bb-34a5-4081-8bc1-e2cc75f07040","name":"PIM Sync","type":"folder"}},"urlObject":{"protocol":"https","path":["pim",":companyId","Pims",":pimId","Products"],"host":["api","intelligentreach","io"],"query":[],"variable":[{"type":"any","value":"","key":"companyId"},{"type":"any","value":"","key":"pimId"}]}},"response":[{"id":"d5ce4586-9133-44fc-b583-d16073fffc67","name":"200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"uniqueId\": \"108883\",\r\n \"meta\": {\r\n \"productCode\": \"108883\",\r\n \"parentProductCode\": \"108883\",\r\n \"productType\": \"Sales Inventory\",\r\n \"productStructure\": \"Product\",\r\n \"productName\": \"My Family Backpack Space Monkey\",\r\n \"productPageURL\": \"https://www.babybunting.com.au/product/108883\",\r\n \"priceDetails\": {\r\n \"retailPrice\": \"39.95\",\r\n \"taxable\": \"true\"\r\n },\r\n \"brandDetails\": {\r\n \"referenceId\": \"MY FAMILY\",\r\n \"brandName\": \"MY FAMILY\"\r\n },\r\n \"supplierDetails\": {\r\n \"referenceId\": \"605\",\r\n \"productCode\": \"amyfambpmonkey\"\r\n },\r\n \"promotionDetails\": [\r\n {\r\n \"referenceId\": \"8141\",\r\n \"promotionName\": \"Price Promotion\",\r\n \"promotionPrice\": \"29.860000\",\r\n \"promotionStartDate\": \"2019-06-28\",\r\n \"promotionEndDate\": \"2020-12-31\"\r\n }\r\n ],\r\n \"attributeFlags\": {\r\n \"availability\": {\r\n \"web\": \"true\",\r\n \"erp\": \"true\",\r\n \"app\": \"true\",\r\n \"pos\": \"true\",\r\n \"oms\": \"true\",\r\n \"digitalFeed\": \"true\"\r\n },\r\n \"visibility\": {\r\n \"web\": \"false\",\r\n \"search\": \"false\",\r\n \"catalogue\": \"false\",\r\n \"giftRegistry\": \"false\"\r\n },\r\n \"fulfilment\": {\r\n \"dropShip\": \"false\"\r\n },\r\n \"callout\": {\r\n \"exclusive\": \"false\",\r\n \"bestBuy\": \"false\",\r\n \"privateLabel\": \"false\",\r\n \"clearance\": \"false\"\r\n },\r\n \"productState\": {\r\n \"outOfStock\": \"false\",\r\n \"purchasable\": \"true\",\r\n \"stocked\": \"true\",\r\n \"sellableInStore\": \"true\",\r\n \"returnableInStore\": \"true\",\r\n \"archived\": \"false\",\r\n \"discontinued\": \"false\",\r\n \"enriched\": \"false\"\r\n }\r\n },\r\n \"productIdentification\": {\r\n \"primaryBarcode\": \"9351395000351\",\r\n \"productLookupCode\": \"1000000778144\"\r\n },\r\n \"dateDetails\": [\r\n {\r\n \"dateCode\": \"LaunchedDate\",\r\n \"dateValue\": \"2017-10-18T13:00:00\"\r\n },\r\n {\r\n \"dateCode\": \"LastUpdatedDate\",\r\n \"dateValue\": \"2019-05-24T00:23:43\"\r\n }\r\n ],\r\n \"packDetails\": {\r\n \"packageType\": null,\r\n \"packLabel\": \"EACH\",\r\n \"packQuantity\": \"1.000000\",\r\n \"dimensionDetails\": {\r\n \"unitLengthInCentimetre\": \"14\",\r\n \"unitWidthInCentimetre\": \"27\",\r\n \"unitHeightInCentimetre\": \"32\",\r\n \"unitWeightInKilogram\": \"0.34\",\r\n \"unitVolumeInCubicMetre\": \"0.012100\"\r\n }\r\n }\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products","protocol":"https","host":["api","intelligentreach","io"],"path":["pim",":companyId","Pims",":pimId","Products"],"variable":[{"key":"companyId","value":""},{"key":"pimId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Request-Context","value":"appId=cid-v1:a07e9694-d602-4c75-bd53-8981f8f5ffc4"},{"key":"RateLimit-Policy","value":"50;w=1, bandwidth=102400;w=300\""},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Limit","value":"50"},{"key":"Date","value":"Wed, 30 Oct 2024 16:50:50 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"2b0330ad-9ad8-4d61-b357-2c5bc60717e3","name":"400 - InvalidData","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products","protocol":"https","host":["api","intelligentreach","io"],"path":["pim",":companyId","Pims",":pimId","Products"],"variable":[{"key":"companyId","value":""},{"key":"pimId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"code\": \"InvalidData\",\r\n \"message\": \"Request data is not in the right format.\",\r\n \"reference\": \"\"\r\n}"},{"id":"3857118c-fe99-459c-8c66-c51d70935bd3","name":"400 - DuplicateData","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products","protocol":"https","host":["api","intelligentreach","io"],"path":["pim",":companyId","Pims",":pimId","Products"],"variable":[{"key":"companyId","value":""},{"key":"pimId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"code\": \"DuplicateData\",\r\n \"message\": \"\",\r\n \"reference\": \"\"\r\n}"},{"id":"446e03b8-21b3-48e0-aa40-6f52802b2659","name":"401","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"uniqueId\": \"108883\",\r\n \"meta\": {\r\n \"productCode\": \"108883\",\r\n \"parentProductCode\": \"108883\",\r\n \"productType\": \"Sales Inventory\",\r\n \"productStructure\": \"Product\",\r\n \"productName\": \"My Family Backpack Space Monkey\",\r\n \"productPageURL\": \"https://www.babybunting.com.au/product/108883\",\r\n \"priceDetails\": {\r\n \"retailPrice\": \"39.95\",\r\n \"taxable\": \"true\"\r\n },\r\n \"brandDetails\": {\r\n \"referenceId\": \"MY FAMILY\",\r\n \"brandName\": \"MY FAMILY\"\r\n },\r\n \"supplierDetails\": {\r\n \"referenceId\": \"605\",\r\n \"productCode\": \"amyfambpmonkey\"\r\n },\r\n \"promotionDetails\": [\r\n {\r\n \"referenceId\": \"8141\",\r\n \"promotionName\": \"Price Promotion\",\r\n \"promotionPrice\": \"29.860000\",\r\n \"promotionStartDate\": \"2019-06-28\",\r\n \"promotionEndDate\": \"2020-12-31\"\r\n }\r\n ],\r\n \"attributeFlags\": {\r\n \"availability\": {\r\n \"web\": \"true\",\r\n \"erp\": \"true\",\r\n \"app\": \"true\",\r\n \"pos\": \"true\",\r\n \"oms\": \"true\",\r\n \"digitalFeed\": \"true\"\r\n },\r\n \"visibility\": {\r\n \"web\": \"false\",\r\n \"search\": \"false\",\r\n \"catalogue\": \"false\",\r\n \"giftRegistry\": \"false\"\r\n },\r\n \"fulfilment\": {\r\n \"dropShip\": \"false\"\r\n },\r\n \"callout\": {\r\n \"exclusive\": \"false\",\r\n \"bestBuy\": \"false\",\r\n \"privateLabel\": \"false\",\r\n \"clearance\": \"false\"\r\n },\r\n \"productState\": {\r\n \"outOfStock\": \"false\",\r\n \"purchasable\": \"true\",\r\n \"stocked\": \"true\",\r\n \"sellableInStore\": \"true\",\r\n \"returnableInStore\": \"true\",\r\n \"archived\": \"false\",\r\n \"discontinued\": \"false\",\r\n \"enriched\": \"false\"\r\n }\r\n },\r\n \"productIdentification\": {\r\n \"primaryBarcode\": \"9351395000351\",\r\n \"productLookupCode\": \"1000000778144\"\r\n },\r\n \"dateDetails\": [\r\n {\r\n \"dateCode\": \"LaunchedDate\",\r\n \"dateValue\": \"2017-10-18T13:00:00\"\r\n },\r\n {\r\n \"dateCode\": \"LastUpdatedDate\",\r\n \"dateValue\": \"2019-05-24T00:23:43\"\r\n }\r\n ],\r\n \"packDetails\": {\r\n \"packageType\": null,\r\n \"packLabel\": \"EACH\",\r\n \"packQuantity\": \"1.000000\",\r\n \"dimensionDetails\": {\r\n \"unitLengthInCentimetre\": \"14\",\r\n \"unitWidthInCentimetre\": \"27\",\r\n \"unitHeightInCentimetre\": \"32\",\r\n \"unitWeightInKilogram\": \"0.34\",\r\n \"unitVolumeInCubicMetre\": \"0.012100\"\r\n }\r\n }\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products","protocol":"https","host":["api","intelligentreach","io"],"path":["pim",":companyId","Pims",":pimId","Products"],"variable":[{"key":"companyId","value":""},{"key":"pimId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"48"},{"key":"Content-Type","value":"application/json"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Limit","value":"50"},{"key":"Request-Context","value":"appId=cid-v1:a07e9694-d602-4c75-bd53-8981f8f5ffc4"},{"key":"Date","value":"Wed, 22 Jan 2025 09:26:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 401,\n \"message\": \"Invalid JWT.\"\n}"}],"_postman_id":"d144ad99-ad2f-4bab-a772-3cc9e1cc126f"},{"name":"List Products","id":"ae6fc8ae-faf0-4a3c-a3ab-184ff51a44d4","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products","description":"

This endpoint retrieves all product information for a specified company via an HTTP GET request.

Query Parameters

lastUpdatedDate (string): Filters products updated on or after the specified date.
\n
uniqueIds (array of strings): Filters results to include only products with specific unique IDs.
\n
fields (array of strings): Limits the response to only the specified product fields, reducing the payload size.
\n

This endpoint allows for the deletion of a specific product by unique ID via an HTTP DELETE request.

Issuing this request for a specified uniqueId will permanently delete all associated data for that product, including:

Product details
\n
Pricing information
\n
Store inventory data
\n
Online inventory data
\n

\n

Note: This operation is irreversible. Ensure you want to remove all data associated with the specified product before proceeding.

This endpoint retrieves details of a specific product by its uniqueId via an HTTP GET request.

Calling this endpoint with a specific uniqueId will return all available product level data.

\n
Note: This will not return additional details such as Store Inventory or Online Inventory
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"776a79bb-34a5-4081-8bc1-e2cc75f07040","id":"776a79bb-34a5-4081-8bc1-e2cc75f07040","name":"PIM Sync","type":"folder"}},"urlObject":{"protocol":"https","path":["pim",":companyId","Pims",":pimId","Products",":uniqueId"],"host":["api","intelligentreach","io"],"query":[],"variable":[{"type":"any","value":"","key":"companyId"},{"type":"any","value":"","key":"pimId"},{"type":"any","value":"","key":"uniqueId"}]}},"response":[{"id":"027cbc55-94db-43e8-9a3a-7f1ecb7121fb","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products/:uniqueId","protocol":"https","host":["api","intelligentreach","io"],"path":["pim",":companyId","Pims",":pimId","Products",":uniqueId"],"variable":[{"key":"companyId","value":""},{"key":"pimId","value":""},{"key":"uniqueId","value":"108883"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"br"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:a07e9694-d602-4c75-bd53-8981f8f5ffc4"},{"key":"RateLimit-Policy","value":"50;w=1, bandwidth=102400;w=300\""},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Limit","value":"50"},{"key":"Date","value":"Wed, 30 Oct 2024 16:51:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"uniqueId\": \"108883\",\n \"meta\": {\n \"productCode\": \"108883\",\n \"parentProductCode\": \"108883\",\n \"productType\": \"Sales Inventory\",\n \"productStructure\": \"Product\",\n \"productName\": \"My Family Backpack Space Monkey\",\n \"productPageURL\": \"https://www.babybunting.com.au/product/108883\",\n \"priceDetails\": {\n \"retailPrice\": \"39.95\",\n \"taxable\": \"true\"\n },\n \"brandDetails\": {\n \"referenceId\": \"MY FAMILY\",\n \"brandName\": \"MY FAMILY\"\n },\n \"supplierDetails\": {\n \"referenceId\": \"605\",\n \"productCode\": \"amyfambpmonkey\"\n },\n \"promotionDetails\": [\n {\n \"referenceId\": \"8141\",\n \"promotionName\": \"Price Promotion\",\n \"promotionPrice\": \"29.860000\",\n \"promotionStartDate\": \"2019-06-28\",\n \"promotionEndDate\": \"2020-12-31\"\n }\n ],\n \"attributeFlags\": {\n \"availability\": {\n \"web\": \"true\",\n \"erp\": \"true\",\n \"app\": \"true\",\n \"pos\": \"true\",\n \"oms\": \"true\",\n \"digitalFeed\": \"true\"\n },\n \"visibility\": {\n \"web\": \"false\",\n \"search\": \"false\",\n \"catalogue\": \"false\",\n \"giftRegistry\": \"false\"\n },\n \"fulfilment\": {\n \"dropShip\": \"false\"\n },\n \"callout\": {\n \"exclusive\": \"false\",\n \"bestBuy\": \"false\",\n \"privateLabel\": \"false\",\n \"clearance\": \"false\"\n },\n \"productState\": {\n \"outOfStock\": \"false\",\n \"purchasable\": \"true\",\n \"stocked\": \"true\",\n \"sellableInStore\": \"true\",\n \"returnableInStore\": \"true\",\n \"archived\": \"false\",\n \"discontinued\": \"false\",\n \"enriched\": \"false\"\n }\n },\n \"productIdentification\": {\n \"primaryBarcode\": \"9351395000351\",\n \"productLookupCode\": \"1000000778144\"\n },\n \"dateDetails\": [\n {\n \"dateCode\": \"LaunchedDate\",\n \"dateValue\": \"2017-10-18T13:00:00\"\n },\n {\n \"dateCode\": \"LastUpdatedDate\",\n \"dateValue\": \"2019-05-24T00:23:43\"\n }\n ],\n \"packDetails\": {\n \"packageType\": null,\n \"packLabel\": \"EACH\",\n \"packQuantity\": \"1.000000\",\n \"dimensionDetails\": {\n \"unitLengthInCentimetre\": \"14\",\n \"unitWidthInCentimetre\": \"27\",\n \"unitHeightInCentimetre\": \"32\",\n \"unitWeightInKilogram\": \"0.34\",\n \"unitVolumeInCubicMetre\": \"0.012100\"\n }\n }\n }\n}"},{"id":"962c0739-bacd-48fb-82e9-0a0e821a1739","name":"404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products/:uniqueId","protocol":"https","host":["api","intelligentreach","io"],"path":["pim",":companyId","Pims",":pimId","Products",":uniqueId"],"variable":[{"key":"companyId","value":""},{"key":"pimId","value":""},{"key":"uniqueId","value":"108883"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"br"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:a07e9694-d602-4c75-bd53-8981f8f5ffc4"},{"key":"RateLimit-Policy","value":"50;w=1, bandwidth=102400;w=300\""},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Limit","value":"50"},{"key":"Date","value":"Wed, 30 Oct 2024 16:52:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"NotFound\",\n \"message\": \"Product could not be found.\",\n \"reference\": \"0HN7K7AKB78IA:00000050\"\n}"},{"id":"6dcc979c-508e-4a66-b3a3-a2a03c375286","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products/:uniqueId","protocol":"https","host":["api","intelligentreach","io"],"path":["pim",":companyId","Pims",":pimId","Products",":uniqueId"],"variable":[{"key":"companyId","value":""},{"key":"pimId","value":""},{"key":"uniqueId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"48"},{"key":"Content-Type","value":"application/json"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Limit","value":"50"},{"key":"Request-Context","value":"appId=cid-v1:a07e9694-d602-4c75-bd53-8981f8f5ffc4"},{"key":"Date","value":"Wed, 22 Jan 2025 09:26:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 401,\n \"message\": \"Invalid JWT.\"\n}"}],"_postman_id":"ef491187-0ec3-4719-806d-70e1ddcc0cc6"},{"name":"Create OnlineInventories","id":"e41a6d3a-d405-449c-8546-43223e69228d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"uniqueId\": \"108883\",\r\n \"quantity\": 5,\r\n \"price\": 99.99\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://api.intelligentreach.io/pim/:companyId/Pims/:pimId/Products/OnlineInventories","description":"

This endpoint updates online inventory details for specific products via an HTTP PUT request.

The request body should be a JSON array where each object represents an individual product’s online inventory update. Each object should include:

uniqueId (string): The unique identifier of the product.
\n
quantity (integer): The updated quantity available online.
\n
price (decimal): The updated online price for the product.
\n

This endpoint retrieves online inventory information for products via an HTTP GET request.

Calling this endpoint will return a JSON array with online inventory details for all products. Each product object in the response may include fields such as uniqueId, quantity, and price.

This endpoint is used to update store-specific inventory details for products, grouped by uniqueId, via an HTTP PUT request.

The request body should be a JSON array where each object represents a product's store inventory details. Each object includes:

uniqueId (string): The unique identifier for the product.
\n
storeQuantities (object, optional): Maps store IDs to their respective inventory quantities.
\n
storePrices (object, optional): Maps store IDs to their respective prices.
\n
storeLeadTimes (object, optional): Maps store IDs to lead times.
\n

This endpoint is used to update store-specific inventory details for products, grouped by storeId, via an HTTP PUT request.

The request body should be a JSON array where each object represents a store's inventory details. Each object includes:

storeId (string): The unique identifier for the store.
\n
uniqueIdQuantities (object, optional): Maps product IDs to their respective inventory quantities.
\n
uniqueIdPrices (object, optional): Maps product IDs to their respective prices.
\n
uniqueIdLeadTimes (object, optional): Maps product IDs to lead times.
\n

This endpoint retrieves store-specific inventory details for products, grouped by uniqueId, via an HTTP GET request.

Query Parameters

uniqueIds (array of strings, optional): Filters the response to include only the specified product unique IDs.
\n
storeIds (array of strings, optional): Filters the response to include only the specified store IDs.
\n

This endpoint retrieves store-specific inventory details for products, grouped by storeId, via an HTTP GET request.

Query Parameters

uniqueIds (array of strings, optional): Filters the response to include only the specified product unique IDs.
\n
storeIds (array of strings, optional): Filters the response to include only the specified store IDs.
\n

This endpoint updates the pricing information for specific products via an HTTP PUT request.

The request body should be a JSON array where each object represents a product price update. Each object includes:

uniqueId (string): The unique identifier for the product.
\n
price (decimal): The price to be set for the product.
\n
startDate (string, optional): The date and time from which the new price becomes effective (ISO 8601 format).
\n
endDate (string, optional): The date and time when the price expires (ISO 8601 format).
\n

This endpoint retrieves pricing information for specific products via an HTTP GET request.

Query Parameters

uniqueIds (array of strings, optional): Filters the response to include only the specified product unique IDs.
\n
lastUpdatedDate (DateTimeOffset, optional): Filters the response to include only products with prices updated on or after the specified date and time (ISO 8601 format).
\n

Overview

The PIM Sync resource is used to create and store an online catalog of products and product information. The PIM Sync can be used once a merchant has and account and created API Credentials in the Developer API Admin page.

Merchants are required to abide by the rate limits defined.

Rate Limits

Requests

50 requests per second

Bandwidth Quota

100 MB per 300 seconds

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"50f290f2-f0d2-46de-82ee-000c558c94fb","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"239987aa-6148-4121-ba33-903ea4a5115c","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"776a79bb-34a5-4081-8bc1-e2cc75f07040"}],"event":[{"listen":"prerequest","script":{"id":"a767597f-9516-49a4-a28f-48ade9de99c1","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b60f6400-4cb4-4b5e-8566-38c731e2a623","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"clientId","value":"","type":"default"},{"key":"clientSecret","value":"","type":"default"},{"key":"companyId","value":"","type":"default"},{"key":"pimId","value":"","type":"default"},{"key":"uniqueId","value":"","type":"default"}]}