For companies who need to integrate with external data sources or automate tasks (and/or do not want to use the Excel spreadsheet method of data-sourcing), we offer a Web API to enable data transfer to/from your GoPlanogram site.
\nThe API supports automatic Catalog uploads, and limited modification of Planograms, as well as automated reporting in JSON, CSV, XLSX, and PDF format.
\nReach out to support@goplanogram.com to get your GoPlanogram account authorized for API access. You will receive an API password that will be used to authenticate requests, along with your GoPlanogram account username.
\nOpen an authenticated session to the GoPlanogram API. For this you need an API password, which is not the same as your account's regular password. Contact support@goplanogram.com enable API access for your account, which will enable you to generate an API password.
\n","urlObject":{"protocol":"https","path":["api","pub","auth"],"host":["stage","goplanogram","com"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"3aaffa39-7153-4222-b14d-43a199e69986","name":"Auth","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"Generate a report in raw JSON format, on the specified Planogram file.
\nThis endpoint is asynchronous, and will return a ULID representing a job. You can view the status of this job via the Job Progress endpoint.
\nInput Fields
\n","urlObject":{"protocol":"https","path":["api","pub","report",":fileId","raw",""],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"3696dd10-1e4a-4a28-8815-11e08c8bc41f","name":"Raw Report","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reportInput\": {\r\n \"name\": \"Test Report\",\r\n \"properties\": [\r\n {\r\n \"name\": \"Item Name\",\r\n \"expression\": \"name\"\r\n },\r\n {\r\n \"name\": \"Item SubCategory\",\r\n \"expression\": \"sub_category\"\r\n }\r\n ],\r\n \"aggregates\": [{\r\n \"name\": \"Total Cost\",\r\n \"expression\": \"Format(Sum(Cost), C)\"\r\n }],\r\n \"breakdowns\": []\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/report/:fileId/raw/","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","report",":fileId","raw",""],"variable":[{"key":"fileId","value":"01KGTFCG4QZHEF8059CPY3TN81"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 21:59:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"998"},{"key":"x-ratelimit-reset","value":"1773007156"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"01KGTFEVJ80GDCCJ7HM1TGM3F3\"\n}"}],"_postman_id":"5201c855-0386-49ec-b5f7-f40b1bb85a6a"},{"name":"File Report","id":"c9f9616b-ab25-4791-a09d-eacf705f7abe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reportFiles\": [{{plans}}],\r\n \"reportInput\": {\r\n \"name\": \"Test Report\",\r\n \"properties\": [\r\n {\r\n \"name\": \"Item Name\",\r\n \"expression\": \"name\"\r\n },\r\n {\r\n \"name\": \"Item SubCategory\",\r\n \"expression\": \"sub_category\"\r\n }\r\n ],\r\n \"aggregates\": [{\r\n \"name\": \"Total Cost\",\r\n \"expression\": \"Format(Sum(Cost), C)\"\r\n }],\r\n \"breakdowns\": []\r\n },\r\n \"options\": {\r\n \"format\": \"pdf\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/report/:fileId","description":"Generate a report in the specified file format, on the Planogram specified.
\nThis endpoint is asynchronous, and will return a ULID representing a job. You can view the status of this job via the Job Progress endpoint. Upon completion, the job will contain a signed R2 link to your completed report which will expire in one hour by default.
\nInput Fields
\nReport Options
\n","urlObject":{"protocol":"https","path":["api","pub","report",":fileId"],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"9871865c-945f-4db8-a38c-f8bd4a9ee6e2","name":"File Report","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reportFiles\": [{{plans}}],\r\n \"reportInput\": {\r\n \"name\": \"Test Report\",\r\n \"properties\": [\r\n {\r\n \"name\": \"Item Name\",\r\n \"expression\": \"name\"\r\n },\r\n {\r\n \"name\": \"Item SubCategory\",\r\n \"expression\": \"sub_category\"\r\n }\r\n ],\r\n \"aggregates\": [{\r\n \"name\": \"Total Cost\",\r\n \"expression\": \"Format(Sum(Cost), C)\"\r\n }],\r\n \"breakdowns\": []\r\n },\r\n \"options\": {\r\n \"format\": \"pdf\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/report/:fileId","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","report",":fileId"],"variable":[{"key":"fileId","value":"01KGTFCG4QZHEF8059CPY3TN81"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:01:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"997"},{"key":"x-ratelimit-reset","value":"1773007318"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"01KGTFKS9JKFG1KT2WW4DSFH11\"\n}"}],"_postman_id":"c9f9616b-ab25-4791-a09d-eacf705f7abe"}],"id":"47247fdb-5582-4204-919a-3f46440f8879","description":"Endpoints for generating reports. You can generate reports in PDF, XLSX, or CSV format, or in raw JSON. Reports can be generated based on one of the Report Property Sets on your site, or a custom Report Property Set specified by the types below.
\nReportPropertySet
\nReport Property
\nReport Aggregate
\nReport Breakdown
\n","_postman_id":"47247fdb-5582-4204-919a-3f46440f8879"},{"name":"Filesystem","item":[{"name":"Search","event":[{"listen":"test","script":{"id":"75b4fd3f-aa89-41b7-a740-095b55600f9f","exec":["const response = pm.response.json();\r","pm.environment.set('plans', response.map(x => `\"${x.id}\"`));\r","pm.environment.set('plan', pm.environment.get('plans')[0])"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f53acf3f-ae25-4587-98f6-30d126d77087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"filters\": [\r\n { \r\n \"names\": [\"aisle 1\"],\r\n \"minBaysLength\": 24\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/files/search","description":"Search plans on your site based on one or more FilesystemFilter objects.
\nReturns an array of FileEntities. The id field of these entities is used to specify a file as an input to other API endpoints.
\nFilesystemFilter
\nAll fields are optional. The filter's output will include files that match on all of the specified fields.
\nFileEntity
\nZero or more of these will make up the output of a file search.
\n","urlObject":{"protocol":"https","path":["api","pub","files","search"],"host":["stage","goplanogram","com"],"query":[],"variable":[]}},"response":[{"id":"ef355331-8d86-49de-a9b7-824d1d602ef9","name":"Search","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"filters\": [\r\n { \r\n \"names\": [\"aisle\"],\r\n \"minBaysLength\": 24\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/search"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 21 Nov 2025 19:39:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"339"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"01KAKYJ56VWH65YH6VDJ87S1JC\",\n \"name\": \"aisle 1\",\n \"description\": \"\",\n \"type\": \"Plan\",\n \"creationDate\": \"2025-11-21T19:34:31.894Z\",\n \"lastSavedDate\": \"2025-11-21T19:34:31.894Z\"\n },\n {\n \"id\": \"01KAKYK0AFZ9PXXBV8PFHJ9T0T\",\n \"name\": \"aisle 2\",\n \"description\": \"\",\n \"type\": \"Plan\",\n \"creationDate\": \"2025-11-21T19:34:53.230Z\",\n \"lastSavedDate\": \"2025-11-21T19:34:53.230Z\"\n }\n]"}],"_postman_id":"f53acf3f-ae25-4587-98f6-30d126d77087"},{"name":"Move File","event":[{"listen":"test","script":{"id":"75b4fd3f-aa89-41b7-a740-095b55600f9f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f04f4cda-e16e-4e48-89b7-6456369cab34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"destinationId\": \"01KC5RJHHC4JTDN2HZ7454P1JQ\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/files/:fileId/move","description":"Move a File (Plan or Store Plan) to another folder location on your GoPlanogram site.
\n","urlObject":{"protocol":"https","path":["api","pub","files",":fileId","move"],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"01KGTFCG4QZHEF8059CPY3TN81","key":"fileId"}]}},"response":[{"id":"8c9cffbe-3306-4507-a450-e36c4ea9eda3","name":"Move File","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"destinationId\": \"01KC5RJHHC4JTDN2HZ7454P1JQ\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/files/:fileId/move","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","files",":fileId","move"],"variable":[{"key":"fileId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:10:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"995"},{"key":"x-ratelimit-reset","value":"1773007828"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"\"Successfully moved file My Planogram to folder A Different Folder\""}],"_postman_id":"f04f4cda-e16e-4e48-89b7-6456369cab34"},{"name":"Copy File","event":[{"listen":"test","script":{"id":"75b4fd3f-aa89-41b7-a740-095b55600f9f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7d80949d-1bf0-4960-857b-4722b4cf32a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"destinationId\": \"01KC5RJHHC4JTDN2HZ7454P1JQ\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/files/:fileId/copy","description":"Copy a File (Plan or Store Plan) to another location on your GoPlanogram site.
\n","urlObject":{"protocol":"https","path":["api","pub","files",":fileId","copy"],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"01KGTFCG4QZHEF8059CPY3TN81","key":"fileId"}]}},"response":[{"id":"918a7928-65f4-4d5a-8be5-23c84dc1cbc4","name":"Copy File","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"destinationId\": \"01KC5RJHHC4JTDN2HZ7454P1JQ\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/files/:fileId/copy","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","files",":fileId","copy"],"variable":[{"key":"fileId","value":"01KGTFCG4QZHEF8059CPY3TN81"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:14:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"68"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"994"},{"key":"x-ratelimit-reset","value":"1773008085"}],"cookie":[],"responseTime":null,"body":"\"Successfully copied file My Planogram to folder A Different Folder\""}],"_postman_id":"7d80949d-1bf0-4960-857b-4722b4cf32a9"}],"id":"8bf33e94-9657-42a7-bac5-51f9845aa643","_postman_id":"8bf33e94-9657-42a7-bac5-51f9845aa643","description":""},{"name":"Planograms","item":[{"name":"Replace SKUs","id":"6c8fba90-d33e-4f08-aa87-6fdd9a1583ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"replacements\": [\r\n {\r\n \"from\": {\r\n \"item_id\": \"027500095145\"\r\n },\r\n \"to\": {\r\n \"item_id\": \"688267124181\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/plans/:fileId/replace/","description":"Replaces one or more SKUs with another in the specified Planogram.
\nPlanogram IDs used to reference files can be found in the File > Open modal in-app, or can be obtained from the output of the Search endpoint.
\nReplacements specify a from SKU and a to SKU. Each of these must specify an item_id, and optionally, a merch_style.
\nReplacements will be performed in the order they are passed to the endpoint.
\nThis endpoint is asynchronous, and will return a ULID representing a job. You can view the status of this job via the Job Progress endpoint.
\n","urlObject":{"protocol":"https","path":["api","pub","plans",":fileId","replace",""],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"9688973a-a8c9-48a3-aeb9-30ffa224d14e","name":"Replace SKUs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"replacements\": [\r\n {\r\n \"from\": {\r\n \"item_id\": \"027500095145\"\r\n },\r\n \"to\": {\r\n \"item_id\": \"688267124181\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/plans/:fileId/replace/","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","plans",":fileId","replace",""],"variable":[{"key":"fileId","value":"01KGTFCG4QZHEF8059CPY3TN81"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:17:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"993"},{"key":"x-ratelimit-reset","value":"1773008255"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"01KGTGGCDCYZNNYFJR04TZVE6X\"\n}"}],"_postman_id":"6c8fba90-d33e-4f08-aa87-6fdd9a1583ac"},{"name":"Apply Template","id":"20525395-6dee-42e2-a0de-b1fbccc7ece5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"replacements\": [\r\n {\r\n \"from\": {\r\n \"item_id\": \"027500095145\"\r\n },\r\n \"to\": {\r\n \"item_id\": \"688267124181\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/plans/:fileId/applyTemplate/","description":"If the specified Planogram has a Template associated with it, this endpoint will apply the template, repopulating all Regions associated with the planogram.
\nTemplates and Regions must be created in the app.
\n","urlObject":{"protocol":"https","path":["api","pub","plans",":fileId","applyTemplate",""],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"15e3edf1-ab26-4f4e-ad1e-05ac0437ae97","name":"Apply Template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"replacements\": [\r\n {\r\n \"from\": {\r\n \"item_id\": \"027500095145\"\r\n },\r\n \"to\": {\r\n \"item_id\": \"688267124181\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/plans/:fileId/applyTemplate/","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","plans",":fileId","applyTemplate",""],"variable":[{"key":"fileId","value":"01KGTFCG4QZHEF8059CPY3TN81"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:20:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"992"},{"key":"x-ratelimit-reset","value":"1773008438"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"01KGTGNZDAB6SA7N581HP3B0FN\"\n}"}],"_postman_id":"20525395-6dee-42e2-a0de-b1fbccc7ece5"}],"id":"4537d65c-bbd6-4a18-be50-a61fcf28d40f","description":"Endpoints relating to finding and modifying Planograms or other file types on your GoPlanogram site.
\n","_postman_id":"4537d65c-bbd6-4a18-be50-a61fcf28d40f"},{"name":"Catalogs","item":[{"name":"Items","item":[{"name":"Get Items","id":"efbed78e-9257-4a6b-9618-3afb2807e403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/items/?includeCustomData&item_ids","description":"Get information on the specified catalog item IDs, or the entire specified catalog.
\nYou can find the ID of a catalog you have access to at the Catalog Admin page.
\n","urlObject":{"protocol":"https","path":["api","pub","catalogs",":catalogId","items",""],"host":["stage","goplanogram","com"],"query":[{"description":{"content":"Determines whether to include Custom Data fields in the catalog item results.
\n","type":"text/plain"},"key":"includeCustomData","value":null},{"description":{"content":"Optional. If specified, only the catalog items with these IDs (as specified in the catalog) will be fetched. If not specified, this endpoint will attempt to fetch the entire catalog, which may be quite large.
\n","type":"text/plain"},"key":"item_ids","value":null}],"variable":[{"type":"any","value":"","key":"catalogId"}]}},"response":[{"id":"c56db4f3-c7b4-4b5e-a0f4-abd33f4bb987","name":"Get Items","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/items/?includeCustomData=1&item_ids=00010331000242,00011111261327,00011111261334","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","catalogs",":catalogId","items",""],"query":[{"key":"includeCustomData","value":"1","description":"Whether to include custom data fields in the catalog results."},{"key":"item_ids","value":"00010331000242,00011111261327,00011111261334","description":"Optional. A list of IDs (as specified in the uploaded catalog) to return. If not specified this endpoint will return the entire catalog, which may be quite large."}],"variable":[{"key":"catalogId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 21 Nov 2025 21:56:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2348"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"01KAKY86VKZ0YZG7VSJRF9Z448\",\n \"catalog_id\": \"01KAC9ZWMB943C23Y9NHREHCMR\",\n \"item_id\": \"00010331000242\",\n \"merch_style\": \"\",\n \"height\": 3.805,\n \"width\": 4.375,\n \"depth\": 1.786,\n \"name\": \"Dickinson's Original Witch Hazel Daily Cleansing Cloths - 25 CT\",\n \"type\": \"S\",\n \"upc\": \"00010331000242\",\n \"description\": null,\n \"image_uri\": \"00010331000242_1.png\",\n \"best_selling\": 195,\n \"price\": 24,\n \"cost\": 15,\n \"color\": null,\n \"category\": \"Cosmetics\",\n \"sub_category\": \"Dickinson's\",\n \"sub_sub_category\": \"\",\n \"hook_sku\": null,\n \"peg1_x\": null,\n \"peg1_y\": null,\n \"peg2_x\": null,\n \"peg2_y\": null,\n \"nest_y\": 0,\n \"hidden\": false,\n \"customer_id\": \"staticid-goplanogram5dev\",\n \"CustomData\": [\n {\n \"catalog_item_id\": \"01KAKY86VKZ0YZG7VSJRF9Z448\",\n \"catalog_id\": \"01KAC9ZWMB943C23Y9NHREHCMR\",\n \"item_id\": \"00010331000242\",\n \"property\": \"#type\",\n \"value\": \"Pharmacy\",\n \"customer_id\": \"staticid-goplanogram5dev\"\n }\n ]\n },\n {\n \"id\": \"01KAKY86VKGCQ87PXP3Q7EJP4C\",\n \"catalog_id\": \"01KAC9ZWMB943C23Y9NHREHCMR\",\n \"item_id\": \"00011111261327\",\n \"merch_style\": \"\",\n \"height\": 6.155,\n \"width\": 2.957,\n \"depth\": 1.861,\n \"name\": \"Dove Men + Care Face Wash Hydrate +\",\n \"type\": \"S\",\n \"upc\": \"00011111261327\",\n \"description\": null,\n \"image_uri\": \"00011111261327_1.png\",\n \"best_selling\": 36,\n \"price\": 17,\n \"cost\": 9,\n \"color\": null,\n \"category\": \"Cosmetics\",\n \"sub_category\": \"Dove\",\n \"sub_sub_category\": \"\",\n \"hook_sku\": null,\n \"peg1_x\": null,\n \"peg1_y\": null,\n \"peg2_x\": null,\n \"peg2_y\": null,\n \"nest_y\": 0,\n \"hidden\": false,\n \"customer_id\": \"staticid-goplanogram5dev\",\n \"CustomData\": [\n {\n \"catalog_item_id\": \"01KAKY86VKGCQ87PXP3Q7EJP4C\",\n \"catalog_id\": \"01KAC9ZWMB943C23Y9NHREHCMR\",\n \"item_id\": \"00011111261327\",\n \"property\": \"#type\",\n \"value\": \"Pharmacy\",\n \"customer_id\": \"staticid-goplanogram5dev\"\n }\n ]\n },\n {\n \"id\": \"01KAKY86VK3KT9VCV37799JDS8\",\n \"catalog_id\": \"01KAC9ZWMB943C23Y9NHREHCMR\",\n \"item_id\": \"00011111261334\",\n \"merch_style\": \"\",\n \"height\": 6.144,\n \"width\": 2.983,\n \"depth\": 1.876,\n \"name\": \"Dove Men+Care Face Wash Sensitive\",\n \"type\": \"S\",\n \"upc\": \"00011111261334\",\n \"description\": null,\n \"image_uri\": \"00011111261334_1.png\",\n \"best_selling\": 83,\n \"price\": 19,\n \"cost\": 12,\n \"color\": null,\n \"category\": \"Cosmetics\",\n \"sub_category\": \"Dove\",\n \"sub_sub_category\": \"\",\n \"hook_sku\": null,\n \"peg1_x\": null,\n \"peg1_y\": null,\n \"peg2_x\": null,\n \"peg2_y\": null,\n \"nest_y\": 0,\n \"hidden\": false,\n \"customer_id\": \"staticid-goplanogram5dev\",\n \"CustomData\": [\n {\n \"catalog_item_id\": \"01KAKY86VK3KT9VCV37799JDS8\",\n \"catalog_id\": \"01KAC9ZWMB943C23Y9NHREHCMR\",\n \"item_id\": \"00011111261334\",\n \"property\": \"#type\",\n \"value\": \"Pharmacy\",\n \"customer_id\": \"staticid-goplanogram5dev\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"efbed78e-9257-4a6b-9618-3afb2807e403"},{"name":"Count Items","id":"6fe6309f-525c-4136-9af6-01b6523ab3b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/items/count","description":"Get the number of items in the specified catalog on your site.
\nYou can find the ID of a catalog you have access to at the Catalog Admin page.
\n","urlObject":{"protocol":"https","path":["api","pub","catalogs",":catalogId","items","count"],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"catalogId"}]}},"response":[{"id":"41df7717-8338-449c-8d09-d216828fda0f","name":"Count Items","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/items/count","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","catalogs",":catalogId","items","count"],"variable":[{"key":"catalogId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 21 Nov 2025 21:58:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"19"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"itemsCount\": 1706\n}"}],"_postman_id":"6fe6309f-525c-4136-9af6-01b6523ab3b7"},{"name":"Upload Items","id":"17a6b272-012f-4beb-9f84-297e4a9c6ab1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"catalogItems\": [\r\n {\r\n \"item_id\": \"00010331000242\",\r\n \"merch_style\": \"\",\r\n \"height\": 3,\r\n \"width\": 5,\r\n \"depth\": 2,\r\n \"name\": \"Dickinson's Original Witch Hazel Daily Cleansing Cloths - 25 CT\",\r\n \"type\": \"S\",\r\n \"upc\": \"00010331000242\",\r\n \"description\": null,\r\n \"image_uri\": \"00010331000242_1.png\",\r\n \"best_selling\": 195,\r\n \"price\": 24,\r\n \"cost\": 15,\r\n \"color\": null,\r\n \"category\": \"Cosmetics\",\r\n \"sub_category\": \"Dickinson's\",\r\n \"sub_sub_category\": \"\",\r\n \"hook_sku\": null,\r\n \"peg1_x\": null,\r\n \"peg1_y\": null,\r\n \"peg2_x\": null,\r\n \"peg2_y\": null,\r\n \"nest_y\": 0,\r\n \"hidden\": false,\r\n \"CustomData\": [\r\n {\r\n \"property\": \"#type\",\r\n \"value\": \"Pharmacy\"\r\n }\r\n ] \r\n }\r\n ],\r\n \"uploadDuplicatesBehavior\": \"overwrite\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/items/","description":"Upload one or more CatalogItems in JSON format to the specified catalog.
\nYou can find the ID of a catalog you have access to at the Catalog Admin page.
\n","urlObject":{"protocol":"https","path":["api","pub","catalogs",":catalogId","items",""],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"catalogId"}]}},"response":[{"id":"28c88ff9-0ed0-43f0-8040-120097a1cd55","name":"Upload Items","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"catalogItems\": [\r\n {\r\n \"item_id\": \"00010331000242\",\r\n \"merch_style\": \"\",\r\n \"height\": 3,\r\n \"width\": 5,\r\n \"depth\": 2,\r\n \"name\": \"Dickinson's Original Witch Hazel Daily Cleansing Cloths - 25 CT\",\r\n \"type\": \"S\",\r\n \"upc\": \"00010331000242\",\r\n \"description\": null,\r\n \"image_uri\": \"00010331000242_1.png\",\r\n \"best_selling\": 195,\r\n \"price\": 24,\r\n \"cost\": 15,\r\n \"color\": null,\r\n \"category\": \"Cosmetics\",\r\n \"sub_category\": \"Dickinson's\",\r\n \"sub_sub_category\": \"\",\r\n \"hook_sku\": null,\r\n \"peg1_x\": null,\r\n \"peg1_y\": null,\r\n \"peg2_x\": null,\r\n \"peg2_y\": null,\r\n \"nest_y\": 0,\r\n \"hidden\": false,\r\n \"CustomData\": [\r\n {\r\n \"property\": \"#type\",\r\n \"value\": \"Pharmacy\"\r\n }\r\n ] \r\n }\r\n ],\r\n \"uploadDuplicatesBehavior\": \"overwrite\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/items/","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","catalogs",":catalogId","items",""],"variable":[{"key":"catalogId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Mon, 24 Nov 2025 17:07:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"39"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"\"Succesfully uploaded 1 catalog items.\""}],"_postman_id":"17a6b272-012f-4beb-9f84-297e4a9c6ab1"}],"id":"92616f31-edb5-44f3-9f64-59429530fbd4","_postman_id":"92616f31-edb5-44f3-9f64-59429530fbd4","description":""},{"name":"Images","item":[{"name":"Upload Images","id":"6b0d89ec-eed7-451d-9703-3b0e17006c05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"images\": [\r\n {\r\n \"url\": \"https://www.wikipedia.org/portal/wikipedia.org/assets/img/Wikipedia-logo-v2@1.5x.png\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/images/","description":"Upload a set of external images from URIs or base64 data. If the resulting images match existing image_uri fields in the specified catalog, they will update automatically in the app.
\nIf 20 images or fewer are uploaded in a single batch, this endpoint will run immediately. If more than 20 images at once are upload, the endpoint will queue the uploads as a job, whose progress can be monitored with the Job Progress endpoint.
\n","urlObject":{"protocol":"https","path":["api","pub","catalogs",":catalogId","images",""],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"catalogId"}]}},"response":[{"id":"517930e7-06a8-4012-94bb-23f078f76cd3","name":"Small Batch","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"images\": [\r\n {\r\n \"url\": \"https://www.wikipedia.org/portal/wikipedia.org/assets/img/Wikipedia-logo-v2@1.5x.png\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/catalogs/:catalogId/images/","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","catalogs",":catalogId","images",""],"variable":[{"key":"catalogId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 19 Dec 2025 22:38:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"208"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"complete\",\n \"uploaded\": 1,\n \"failed\": 0,\n \"results\": [\n {\n \"success\": true,\n \"filename\": \"Wikipedia-logo-v2@1.5x.png\",\n \"key\": \"imagesCatalogItems/01KAC9ZWMB943C23Y9NHREHCMR/Wikipedia-logo-v2_1.5x.png\",\n \"size\": 27282\n }\n ]\n}"}],"_postman_id":"6b0d89ec-eed7-451d-9703-3b0e17006c05"}],"id":"8fca0b3a-3741-463c-992d-ca0228b2841d","_postman_id":"8fca0b3a-3741-463c-992d-ca0228b2841d","description":""},{"name":"List Catalogs","id":"9d9de022-99f7-4857-8cad-49cb80bb4a4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://stage.goplanogram.com/api/pub/catalogs/","description":"Return a list of all of your site's catalogs, including names, descriptions, and units.
\nTo list the specific items in a given catalog, pass the returned id field as the catalogId in the Get Items endpoint.
\n","urlObject":{"protocol":"https","path":["api","pub","catalogs",""],"host":["stage","goplanogram","com"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"a32bda34-8af3-4d16-afb0-880ff241eda3","name":"List Catalogs","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage.goplanogram.com/api/pub/catalogs/","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","catalogs",""],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Mon, 24 Nov 2025 17:32:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"144"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"catalogs\": [\n {\n \"id\": \"01KAC9ZWMB943C23Y9NHREHCMR\",\n \"name\": \"test catalog\",\n \"description\": \"\",\n \"last_updated\": \"2025-11-24T17:07:12.440Z\",\n \"units\": \"in\"\n }\n ]\n}"}],"_postman_id":"9d9de022-99f7-4857-8cad-49cb80bb4a4f"}],"id":"65267734-1d43-450f-ab5b-eacfd809928e","description":"Endpoints relating to viewing and editing your site's catalog(s).
\n","_postman_id":"65267734-1d43-450f-ab5b-eacfd809928e"},{"name":"Store Data","item":[{"name":"Upload Store Data","id":"eda31616-003a-467e-b7d5-32220839072e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"fileName\": \"Sample Store Data\",\r\n \"folderId\": \"\",\r\n \"storeData\": {\r\n \"027500095169\": {\r\n \"!WeeklySales\": \"50\",\r\n \"!MonthlySales\": \"200\"\r\n },\r\n \"027500095183\": {\r\n \"!WeeklySales\": \"30\",\r\n \"!MonthlySales\": \"150\"\r\n },\r\n \"027500095145\": {\r\n \"!WeeklySales\": \"40\",\r\n \"!MonthlySales\": \"180\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/storedata/","description":"Upload a Store Data file in JSON format to your site.
\n","urlObject":{"protocol":"https","path":["api","pub","storedata",""],"host":["stage","goplanogram","com"],"query":[],"variable":[]}},"response":[{"id":"f8e1de90-4ec9-4d00-a66c-e4228e41c0c0","name":"Upload Store Data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"fileName\": \"Sample Store Data\",\r\n \"folderId\": \"\",\r\n \"storeData\": {\r\n \"027500095169\": {\r\n \"!WeeklySales\": \"50\",\r\n \"!MonthlySales\": \"200\"\r\n },\r\n \"027500095183\": {\r\n \"!WeeklySales\": \"30\",\r\n \"!MonthlySales\": \"150\"\r\n },\r\n \"027500095145\": {\r\n \"!WeeklySales\": \"40\",\r\n \"!MonthlySales\": \"180\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/storedata/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:22:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"39"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"991"},{"key":"x-ratelimit-reset","value":"1773008560"}],"cookie":[],"responseTime":null,"body":"{\n \"fileId\": \"01KGTGSPQ1S93RZEHZ4BX7CFNK\"\n}"}],"_postman_id":"eda31616-003a-467e-b7d5-32220839072e"},{"name":"Get Store Data","id":"02e5e7ff-373f-4737-a4e5-3c009bb92590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://stage.goplanogram.com/api/pub/storedata/:fileId","description":"Get the contents of a specified StoreData file, in JSON format.
\nYou can find the ID of a StoreData file you have access to in the File > Open view, or as the output of the Upload Store Data endpoint.
\n","urlObject":{"protocol":"https","path":["api","pub","storedata",":fileId"],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"f0c151fe-6319-4856-a9e0-4eb447548246","name":"Get Store Data","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage.goplanogram.com/api/pub/storedata/:fileId","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","storedata",":fileId"],"variable":[{"key":"fileId","value":"01KGTGSPQ1S93RZEHZ4BX7CFNK"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:23:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"214"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"990"},{"key":"x-ratelimit-reset","value":"1773008586"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Sample Store Data\",\n \"data\": {\n \"027500095169\": {\n \"!WeeklySales\": \"50\",\n \"!MonthlySales\": \"200\"\n },\n \"027500095183\": {\n \"!WeeklySales\": \"30\",\n \"!MonthlySales\": \"150\"\n },\n \"027500095145\": {\n \"!WeeklySales\": \"40\",\n \"!MonthlySales\": \"180\"\n }\n }\n}"}],"_postman_id":"02e5e7ff-373f-4737-a4e5-3c009bb92590"},{"name":"Attach Store Data","id":"863d04e9-c9e6-43a4-9d5f-60703b7f9943","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"planFileId\": \"01KGTFCG4QZHEF8059CPY3TN81\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://stage.goplanogram.com/api/pub/storedata/:fileId/attach/","description":"Link the specified StoreData file to the specified Plan file.
\nThis is equivalent to selecting a StoreData file via Choose Store Data File in the app. If a different StoreData file is currently attached to the specified Plan, it will be replaced.
\n","urlObject":{"protocol":"https","path":["api","pub","storedata",":fileId","attach",""],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"30d95d26-7989-42e7-965c-2e7cc00bedb9","name":"Attach Store Data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"planFileId\": \"01KGTFCG4QZHEF8059CPY3TN81\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage.goplanogram.com/api/pub/storedata/:fileId/attach/","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","storedata",":fileId","attach",""],"variable":[{"key":"fileId","value":"01KGTGSPQ1S93RZEHZ4BX7CFNK"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 22:24:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"989"},{"key":"x-ratelimit-reset","value":"1773008668"}],"cookie":[],"responseTime":null,"body":"\"Successfully attached store data 01KGTGSPQ1S93RZEHZ4BX7CFNK to 01KGTFCG4QZHEF8059CPY3TN81\""}],"_postman_id":"863d04e9-c9e6-43a4-9d5f-60703b7f9943"}],"id":"9577f92a-c834-455c-a522-6208706d2f9f","description":"Endpoints for creating, viewing, and modifying Store Data files on your site, and attaching them to existing Planogram(s).
\n","_postman_id":"9577f92a-c834-455c-a522-6208706d2f9f"},{"name":"Jobs","item":[{"name":"Job Progress","id":"a8e35bf9-790d-4df0-a873-8e3c7ad2a6b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{gop5ApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://stage.goplanogram.com/api/pub/jobs/:jobId","description":"View the current status of a job, created by the Raw Report, File Report, Replace SKUs, or Catalog Images endpoints.
\nThis will return four fields:
\n","urlObject":{"protocol":"https","path":["api","pub","jobs",":jobId"],"host":["stage","goplanogram","com"],"query":[],"variable":[{"type":"any","value":"","key":"jobId"}]}},"response":[{"id":"9874ec0c-257b-460d-aefa-98d0fca8c3a0","name":"Raw Report","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage.goplanogram.com/api/pub/jobs/:jobId","protocol":"https","host":["stage","goplanogram","com"],"path":["api","pub","jobs",":jobId"],"variable":[{"key":"jobId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 19 Dec 2025 22:30:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"214"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {\n \"Items\": {},\n \"Aggregates\": {\n \"Total Cost\": {\n \"\": \"$0.00\"\n }\n },\n \"Breakdowns\": {},\n \"ReportName\": \"Test Report\"\n },\n \"created_date\": \"2025-12-19T22:29:53.708Z\",\n \"completed_date\": \"2025-12-19T22:29:55.868Z\"\n}"},{"id":"6abdcf8d-ef5d-4e6d-9a4f-aae546e80d26","name":"File Report","originalRequest":{"method":"GET","header":[],"url":"https://stage.goplanogram.com/api/pub/jobs/01KCWBT7RKV7D82HN6QNE54264"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 19 Dec 2025 22:31:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"596"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": \"https://cust-staticid-goplanogram5dev.1934ce322ac49b405ec9ceed5c743ca8.r2.cloudflarestorage.com/19/k7o5izc8dcl/report.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=0e55bbd16c5ca416e8cfee2f3d50cc2d%2F20251219%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20251219T223121Z&X-Amz-Expires=3600&X-Amz-Signature=4c208f9fcebc3a6054cbf53f03ce11a6bfe27656aa3eb4fb2cb2c85dd50d0514&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject\",\n \"created_date\": \"2025-12-19T22:31:17.015Z\",\n \"completed_date\": \"2025-12-19T22:31:21.814Z\"\n}"},{"id":"d8867708-57d0-4138-b361-d9ee073babf3","name":"Replace SKUs","originalRequest":{"method":"GET","header":[],"url":"https://stage.goplanogram.com/api/pub/jobs/01KCWBXM5RQAJ1DQ2N77MBXR6K"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.26.3 (Ubuntu)"},{"key":"Date","value":"Fri, 19 Dec 2025 22:33:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"182"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": \"Successfully replaced SKUs in 0 out of 1 plans and storeplans.\",\n \"created_date\": \"2025-12-19T22:33:08.029Z\",\n \"completed_date\": \"2025-12-19T22:33:09.594Z\"\n}"}],"_postman_id":"a8e35bf9-790d-4df0-a873-8e3c7ad2a6b8"}],"id":"80410a96-6ea1-4b1f-9527-cfc756e9d299","_postman_id":"80410a96-6ea1-4b1f-9527-cfc756e9d299","description":""}]}