This document is a developer’s guide and provides the necessary information to integrate your websites and mobile apps with our Zubale API endpoints. In this document some of our API endpoints are discussed, giving their business context and some examples on how to use specific features provided by the endpoints.
\nBasic prior knowledge on JSON, HTTPS and an understanding of software programming is assumed.
\nIt's the process to unite with your service automatically in order to provide a connection between your services and Zubale's system to create tasks and update its statuses.
\nIt is important to note that this API is serving different customers, thus modifications to it are not feasible. If you have special requirements or needs, please talk to your Sales Account Manager to explore a custom integration.
\nCustomer: This is the company that integrates with us
\nClient: This is the person who make an order
\nZubalero: The person who runs Picking and deliveries
\nThe Zubale API uses HTTP status codes to indicate the status of the requests. This includes successful and error responses.
\nMETHOD: POST
\nThe Zubale API endpoints make use of ACCESS_TOKEN for secure authentication and authorization.
\nThe ACCESS_TOKEN is necessary to test and work in the Zubale production environment when dealing with secured endpoints allowing the secure exchange of JSON information pertaining to your account.
\nPayload request structure
\nNote: The ACCESS TOKEN must be provided in the Authorization header of the HTTP request using the ‘Bearer’ scheme.
\nResponse status code: 200 OK
\nSuccess response
\nPayload Structure
\nResponse status code: 400 Bad request
\nPayload Structure
\nThe Zubale API endpoints make use of JWT (JSON Web Tokens) for secure authentication and authorization.
\nThe JWT token is necessary to test and work in the Zubale production environment when dealing with secured endpoints allowing the secure exchange of JSON information pertaining to your account. The token must be provided in the Authorization header of the HTTP request using the ‘Bearer’ scheme.
\nNote: If you have a JWT for Picking and delivery or delivery it isn´t de same as the one for GPS TRACKER.
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"34ff21a8-2134-4f07-9f1c-4a64bc87350d","id":"34ff21a8-2134-4f07-9f1c-4a64bc87350d","name":"Authentication","type":"folder"}},"urlObject":{"path":["oauth2","token"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7b5e9a41-e1e3-4c26-8401-f1ebff6249b7","name":"Authentication OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"name":"Content-Type","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"curl --location -g --request POST '{{BASE_URL}}/oauth2/token' \\\r\n--header 'Content-Type: application/json' \\\r\n--data-raw '{\r\n \"client_id\": \"{{CLIENT_ID}}\",\r\n \"client_secret\": \"{{CLIENT_SECRET}}\",\r\n \"grant_type\": \"client_credentials\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"bearer\",\n \"access_token\": \"ia1XaSImbm8h4yLz5FiQOfYdygG0b6LKu\",\n \"expires_in\": 7200\n}"},{"id":"121e29cf-5da6-497a-9dae-306b285bd8db","name":"Authentication Error","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"name":"Content-Type","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"curl --location -g --request POST '{{BASE_URL}}/oauth2/token' \\\r\n--header 'Content-Type: application/json' \\\r\n--data-raw '{\r\n \"client_id\": \"{{CLIENT_ID}}\", \r\n \"client_secret\": \"{{CLIENT_SECRET}}\",\r\n \"grant_type\": \"client_credentials\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_description\": \"Invalid client authentication\",\n \"error\": \"invalid_client\"\n}"}],"_postman_id":"3ee0256c-7285-486d-a0d5-fd7f9d0ed98c"}],"id":"34ff21a8-2134-4f07-9f1c-4a64bc87350d","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"904eb133-28bd-476d-af81-3879c857f080"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c695ec3c-ab6a-43a7-8ffc-8699a5d273a6"}}],"_postman_id":"34ff21a8-2134-4f07-9f1c-4a64bc87350d","description":""},{"name":"Delivery API","item":[{"name":"Create Delivery Order","id":"f2eb19f5-1904-4d03-8261-717bca03d2b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{TOKEN}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"brandId\": \"{{CLIENT_PLATFORM}}\",\n \"comment\": \"C/5 #20, apartment 140. In front of the market A\",\n \"contactInfo\": {\n \"address\": \"Estr. Nuporanga a Batatais, Batatais - SP, 14300-000, Brazil\",\n \"comments\": \"No comments for now\",\n \"name\": \"Zubale Staging\",\n \"phone_number\": \"+50250192439\",\n \"zip_code\": \"00110\"\n },\n \"dropOffLocation\": {\n \"latitude\": -20.8199846,\n \"longitude\": -47.7547004\n },\n \"orderId\": \"{{customer_order_id}}\",\n \"requestId\": \"{{customer_order_id}}\",\n \"storeId\": \"{{CLIENT_STORE_ID}}\",\n \"orderInfo\": {\n \"totalLineItems\": 3,\n \"totalQuantity\": 2,\n \"totalVolume\": 1,\n \"totalWeight\": 8,\n \"total_amount\": 20\n },\n \"orderItems\": [\n {\n \"amount\": 10.1,\n \"imageUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"longName\": \"Jugetes para perros\",\n \"pesable\": false,\n \"quantity\": 1,\n \"shortName\": \"Jugetes para perros\",\n \"sku\": \"17501017043214\",\n \"thumbnailUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"unit\": \"PCE\",\n \"comments\": \"\",\n \"productId\": \"\"\n },\n {\n \"amount\": 10.1,\n \"imageUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"longName\": \"Jugetes para perros\",\n \"pesable\": false,\n \"quantity\": 1,\n \"shortName\": \"Jugetes para perros\",\n \"sku\": \"10694021118003\",\n \"thumbnailUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"unit\": \"PCE\",\n \"comments\": \"\",\n \"productId\": \"\"\n }\n ],\n \"paymentInfo\": {\n \"amount\": 20.2,\n \"mode\": \"PAY_ON_DELIVERY\",\n \"payOnDeliveryType\": \"type\",\n \"status\": \"pending\",\n \"type\": \"CARD\"\n },\n \"windowConfiguration\": {\n \"storeArrivalTime\": \"2023-04-26 00:30:00.000Z\",\n \"pickup\": {\n \"endTime\": \"2023-04-27 00:30:00.000Z\",\n \"startTime\": \"2023-04-26 00:30:00.000Z\"\n },\n \"delivery\": {\n \"endTime\": \"2023-04-27 00:30:00.000Z\",\n \"startTime\": \"2023-04-26 00:30:00.000Z\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BASE_URL}}/orders/api/pnp_delivery/jobs/sync","description":"At this endpoint the client will post the order with all the required information. Here you could find the attributes necessary, the structure and values to perform the process optimally. The format is JSON.
\nCase 1: Orderdetail has 3 item.
\nCase 2: Orderdetail has 4 item
\nCase 3: Orderdetail has 2 item.
\n","urlObject":{"path":["orders","api","pnp_delivery","jobs","sync"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2181fd22-3e6f-4f3a-9bf4-4d6234f66620","name":"201 Created (PAY_ONLINE)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"brandId\": \"{{CLIENT_PLATFORM}}\",\n \"comment\": \"C/5 #20, apartment 140. In front of the market A\",\n \"contactInfo\": {\n \"address\": \"Estr. Nuporanga a Batatais, Batatais - SP, 14300-000, Brazil\",\n \"comments\": \"No comments for now\",\n \"name\": \"Zubale Staging\",\n \"phone_number\": \"+50250192439\",\n \"zip_code\": \"00110\"\n },\n \"dropOffLocation\": {\n \"latitude\": -20.8199846,\n \"longitude\": -47.7547004\n },\n \"orderId\": \"{{customer_order_id}}\",\n \"orderInfo\": {\n \"totalLineItems\": 3,\n \"totalQuantity\": 2,\n \"totalVolume\": 1,\n \"totalWeight\": 8,\n \"total_amount\": 20\n },\n \"orderItems\": [\n {\n \"amount\": 10.1,\n \"imageUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"longName\": \"Jugetes para perros\",\n \"pesable\": false,\n \"quantity\": 1,\n \"shortName\": \"Jugetes para perros\",\n \"sku\": \"17501017043214\",\n \"thumbnailUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"unit\": \"PCE\",\n\t\t\t\"comments\": \"\",\n\t\t\t\"productId\": \"\"\n },\n {\n \"amount\": 10.1,\n \"imageUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"longName\": \"Jugetes para perros\",\n \"pesable\": false,\n \"quantity\": 1,\n \"shortName\": \"Jugetes para perros\",\n \"sku\": \"10694021118003\",\n \"thumbnailUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"unit\": \"PCE\",\n\t \"comments\": \"\",\n\t \"productId\": \"\"\n }\n ],\n \"paymentInfo\": {\n \"amount\": 20.2,\n \"comments\": \"Payment comments\",\n \"mode\": \"PAY_ONLINE\",\n \"payOnDeliveryType\": \"type\",\n \"status\": \"pending\",\n \"type\": \"CARD\"\n },\n \"requestId\": \"{{customer_order_id}}\",\n \"storeId\": \"{{customer_store_id}}\",\n \"windowConfiguration\": {\n \"delivery\": {\n \"endTime\": \"2023-04-27 00:30:00.000Z\",\n \"startTime\": \"2023-04-26 00:30:00.000Z\"\n },\n \"pickup\": {\n \"endTime\": \"2023-04-27 00:30:00.000Z\",\n \"startTime\": \"2023-04-26 00:30:00.000Z\"\n },\n \"storeArrivalTime\": \"2023-04-26 00:30:00.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}/orders/api/pnp_delivery/jobs/sync"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"OK\"\n}"},{"id":"e77254fb-5996-4be4-8ea4-ae699375c55a","name":"201 Created (PAY_ON_DELIVERY CARD)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"brandId\": \"{{CLIENT_PLATFORM}}\",\n \"comment\": \"C/5 #20, apartment 140. In front of the market A\",\n \"contactInfo\": {\n \"address\": \"Estr. Nuporanga a Batatais, Batatais - SP, 14300-000, Brazil\",\n \"comments\": \"No comments for now\",\n \"name\": \"Zubale Staging\",\n \"phone_number\": \"+50250192439\",\n \"zip_code\": \"00110\"\n },\n \"dropOffLocation\": {\n \"latitude\": -20.8199846,\n \"longitude\": -47.7547004\n },\n \"orderId\": \"{{customer_order_id}}\",\n \"orderInfo\": {\n \"totalLineItems\": 3,\n \"totalQuantity\": 2,\n \"totalVolume\": 1,\n \"totalWeight\": 8,\n \"total_amount\": 20\n },\n \"orderItems\": [\n {\n \"amount\": 10.1,\n \"imageUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"longName\": \"Jugetes para perros\",\n \"pesable\": false,\n \"quantity\": 1,\n \"shortName\": \"Jugetes para perros\",\n \"sku\": \"17501017043214\",\n \"thumbnailUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"unit\": \"PCE\",\n\t\t\t\"comments\": \"\",\n\t\t\t\"productId\": \"\"\n },\n {\n \"amount\": 10.1,\n \"imageUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"longName\": \"Jugetes para perros\",\n \"pesable\": false,\n \"quantity\": 1,\n \"shortName\": \"Jugetes para perros\",\n \"sku\": \"10694021118003\",\n \"thumbnailUrl\": \"https://jugetesImage/image/upload/7441001700064.jpg\",\n \"unit\": \"PCE\",\n\t \"comments\": \"\",\n\t \"productId\": \"\"\n }\n ],\n \"paymentInfo\": {\n \"amount\": 20.2,\n \"comments\": \"Payment comments\",\n \"mode\": \"PAY_ON_DELIVERY\",\n \"payOnDeliveryType\": \"type\",\n \"status\": \"pending\",\n \"type\": \"CARD\"\n },\n \"requestId\": \"{{customer_order_id}}\",\n \"storeId\": \"{{customer_store_id}}\",\n \"windowConfiguration\": {\n \"delivery\": {\n \"endTime\": \"2023-04-27 00:30:00.000Z\",\n \"startTime\": \"2023-04-26 00:30:00.000Z\"\n },\n \"pickup\": {\n \"endTime\": \"2023-04-27 00:30:00.000Z\",\n \"startTime\": \"2023-04-26 00:30:00.000Z\"\n },\n \"storeArrivalTime\": \"2023-04-26 00:30:00.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}/orders/api/pnp_delivery/jobs/sync"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"OK\"\n}"},{"id":"93c92708-74bb-427d-9ce6-021c2a109cae","name":"201 Created (PAY_ON_DELIVERY CARD)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe following is a list of the statuses that we can notify:
\nThe statuses sent will depend on the type of operation agreed with the client. In the following diagrams you can see different ways of operating.
\n\nPayload request new status \"TASK_ASSIGNED\"
\n","urlObject":{"path":["integration","notify-status"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3150b26b-3ca4-4dab-a53d-e464130f5302","name":"200 OK TASK_SCHEDULED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"TASK_SCHEDULED\",\n \"oldStatus\": \"\",\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{externalOrderId}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/?token={{zubale_tracking_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notifyStatusChange"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3e479163-9fbf-4951-9c1e-4cccbac00e16","name":"200 OK TASK_ASSIGNED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\":\"TASK_ASSIGNED\",\n \"oldStatus\":\"TASK_SCHEDULED\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\":\"{{customer_order_id}}\",\n \"shopperDetail\":\n {\n \"firstName\":\"Pedro Adrian\",\n \"id\":\"fdf97ceb-cebf-4bfd-8edb-e282d3d868c6\",\n \"lastName\":\"Perez Garcia\",\n \"phoneNumber\":\"+573142911027\",\n \"vehicle\":\n {\n \"licensePlateNumber\":\"STQ192\",\n \"model\":\"hyundai eon\",\n \"type\":\"car\",\n \"year\":\"2015\"}\n },\n \"trackingUrl\":\"https://tracking-stag.zubale.com/{{zubale_tracking_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notifyStatusChange"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3a1e516d-76d5-4c72-99e8-0aaf097ba532","name":"200 OK DRIVE_TO_STORE","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"DRIVE_TO_STORE\",\n \"oldStatus\": \"TASK_ASSIGNED\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/{{zubale_tracking_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notifyStatusChange"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d19e3ee1-dbeb-4f20-859f-35b8e2490e63","name":"200 OK AT_STORE","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"AT_STORE\",\n \"oldStatus\": \"DRIVE_TO_STORE\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/{{zubale_tracking_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notifyStatusChange"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"baf1829b-1174-4d3b-a3cb-92d486539ab2","name":"200 OK PICKED_OUT","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"PICKED_OUT\",\n \"oldStatus\": \"TASK_ASSIGNED\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/?token={{zubale_tacking_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify-status"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"9ffb8482-bd70-43be-b610-2c831686ae21","name":"200 OK ENROUTE_TO_DROPOOF","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\":\"ENROUTE_TO_DROPOFF\",\n \"oldStatus\":\"PICKED_OUT\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\":\"https://tracking.zubale.com/?token={{zubale_tacking_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify-status"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"87c7f447-cab3-4838-8f51-8f1a3978fdfa","name":"200 OK AT_DROPOFF","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"AT_DROPOFF\",\n \"oldStatus\": \"ENROUTE_TO_DROPOFF\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/?token={{zubale_tacking_token}}\"\n},","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify-status"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"30565dcc-c53b-4f6c-bf9f-66b62a892e9d","name":"200 OK DELIVERED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"DELIVERED\",\n \"oldStatus\": \"AT_DROPOFF\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/?token={{zubale_tacking_token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify-status"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b571a8c5-9118-497a-9ae1-2c17e16fcbb8","name":"200 OK TASK_SCHEDULED","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"TASK_CANCELLED\",\n \"oldStatus\": \"TASK_SCHEDULED\",\n \"lastLocation\": { \"latitude\": 19.3535238, \"longitude\": -99.1763607 },\n \"date\": \"2024-04-04T16:43:41.993349Z\",\n \"orderID\": \"{{externalOrderId}}\",\n \"last_location\": \"\",\n \"trackingUrl\": \"https://tracking.zubale.com/?token=\"{{zubale_tracking_token}}\"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BASE_URL}}/integration/notify-status"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8c1a3801-3bb8-403e-b4d0-b29b33571db0"}],"id":"ba42c6df-b7d0-42df-a3a0-59e84579eb27","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"72b2d5bd-ffed-43c3-9cad-72ac0dcff207"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d661e286-f3fd-4667-bb1d-16c2a25adb54"}}],"_postman_id":"ba42c6df-b7d0-42df-a3a0-59e84579eb27","description":""},{"name":"Picking & Delivery API","item":[{"name":"Create Picking & Delivery Order","event":[{"listen":"test","script":{"id":"e5d71c42-5064-4841-98de-f282dc189387","exec":["var jsonData = JSON.parse(responseBody);","","if (jsonData.success) {"," postman.setEnvironmentVariable(\"id\", jsonData.id);"," postman.setEnvironmentVariable(\"uploadFileURL\", jsonData.url)","} else {"," postman.clearEnvironmentVariable(\"id\");"," postman.clearEnvironmentVariable(\"uploadFileURL\");","}"],"type":"text/javascript","packages":{}}}],"id":"4ab0e51a-93a4-430b-9c3d-e6da50be1830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"At this endpoint the client will post the order with all the required information. Here you could find the attributes necessary, the structure and values to perform the process optimally. The format is JSON.
\nThe following is a list of the statuses that we could notify:
\nIn the status TASK_ASSIGNED we send the zubalero data
\nIn other case:
\n","urlObject":{"path":["integration","notify_status"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"06852386-8db4-445d-a6d6-bb7201170248","name":"200 OK TASK_ASSIGNED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"reserve\",\n \"oldStatus\": \"TASK_ASSIGNED\",\n \"orderID\": \"{{customer_order_id}}\",\n \"shopperDetail\": {\n \"id\": \"bdde06a8-85f3-40d8-8ca9-b61a895271f7\",\n \"firstName\": \"Gabriela\",\n \"lastName\": \"Recinos Arevalo\",\n \"phoneNumber\": \"+50250192435\",\n \"vehicle\": {\n \"licensePlateNumber\": \"QWERT\",\n \"model\": \"Default\",\n \"type\": \"auto\",\n \"year\": \"2020\"\n },\n \"trackingUrl\": \"https://tracking.zubale.com/?token={{zubale_tracking_token}}\"\n },\n \"date\": \"2024-04-11T20:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify_status"},"status":"OK (TASK_ASSIGNED)","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"917a3583-f969-4c9e-871a-953a99a64cdb","name":"200 OK PICKING_STARTED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"PICKING_STARTED\",\n \"oldStatus\": \"TASK_ASSIGNED\",\n \"lastLocation\": { \n \"latitude\": 19.3535238, \n \"longitude\": -99.1763607 \n },\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking-stag.zubale.com/?token={{zubale_tracking_token}}\",\n \"date\": \"2024-04-11T20:30:00.00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify_status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"a1bf53fa-86f7-4bd3-a2a0-894ef84cdbbd","name":"200 OK PRODUCT_ADDED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"PRODUCT_ADDED\",\n \"oldStatus\": \"PICKING_STARTED\",\n \"lastLocation\": { \n \"latitude\": 19.3535238, \n \"longitude\": -99.1763607 \n },\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking-stag.zubale.com/?token={{zubale_tracking_token}}\",\n \"date\": \"2024-04-11T20:30:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify_status"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"4053dee6-a519-40c4-b7c0-e48d05169eec","name":"200 OK PICKED_OUT","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"PICKED_OUT\",\n \"oldStatus\": \"PRODUCT_ADDED\",\n \"lastLocation\": { \n \"latitude\": 19.3535238, \n \"longitude\": -99.1763607 \n },\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking-stag.zubale.com/?token={{zubale_tracking_token}}\",\n \"date\": \"2024-04-11T20:30:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify_status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"12a44531-2765-40ec-a5fb-80c0c5f40625","name":"200 OK ENROUTE_TO_DROPOFF","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"AT_DROPOFF\",\n \"oldStatus\": \"ENROUTE_TO_DROPOFF\",\n \"lastLocation\": { \n \"latitude\": 19.3535238, \n \"longitude\": -99.1763607 \n },\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking-stag.zubale.com/?token={{zubale_tracking_token}}\",\n \"date\": \"2024-04-11T20:30:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify_status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"559b6d11-585d-4300-8e34-8dadf55b70f5","name":"200 OK PRODUCT_ADDED","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"TASK_CANCELLED\",\n \"oldStatus\": \"TASK_SCHEDULED\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/?token=\"{{zubale_tacking_token}}\"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BASE_URL}}/integration/notify_status"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"92828bcc-4238-4e75-b76d-f0aa8e62b8c2","name":"200 OK DELIVERED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"DELIVERED\",\n \"oldStatus\": \"AT_DROPOFF\",\n \"orderID\": \"{{customer_order_id}}\",\n \"lastLocation\": { \n \"latitude\": 19.3535238,\n \"longitude\": -99.1763607 \n },\n \"trackingUrl\": \"https://tracking-stag.zubale.com/?token={{zubale_tracking_token}}\",\n \"date\": \"2024-04-11T20:30:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{customer_url}}/integration/notify_status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"fca58849-f56d-4bb6-bda5-a110d590f8b7","name":"200 OK TASK_ASSIGNED","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"TASK_CANCELLED\",\n \"oldStatus\": \"TASK_SCHEDULED\",\n \"orderID\": \"{{customer_order_id}}\",\n \"trackingUrl\": \"https://tracking.zubale.com/?token=\"{{zubale_tacking_token}}\"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BASE_URL}}/integration/notify_status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f43ab406-1fba-45d4-82bf-090f22ce8637"},{"name":"Get Product (Customer Side)","id":"3717d915-43e0-4814-9253-8fe589f00db4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BASE_URL}}/integration/scanBarCode?upc={{sku}}&storeId={{customer_store_id}}","description":"This is an endpoint you provide as a customer, in order for Zubale to retrieve information about a given product.
\nThe most common use case happens when a consumer requests a product replacement (product out of stock, difference in units, etc.), in which case Zubale asks you to provide us with details of the new product.
\n200OK
\n","urlObject":{"path":["integration","scanBarCode"],"host":["{{BASE_URL}}"],"query":[{"description":{"content":"EAN - 13 OR SKU
\n","type":"text/plain"},"key":"upc","value":"{{sku}}"},{"description":{"content":"store_id
\n","type":"text/plain"},"key":"storeId","value":"{{customer_store_id}}"}],"variable":[]}},"response":[{"id":"4521f724-a168-43c0-99c4-b58c4fb2d073","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{BASE_URL}}/integration/scanBarCode?upc={{sku}}&storeId={{customer_store_id}}","host":["{{BASE_URL}}"],"path":["integration","scanBarCode"],"query":[{"description":"EAN - 13 OR SKU","key":"upc","value":"{{sku}}"},{"description":"store_id","key":"storeId","value":"{{customer_store_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"productId\": \"000000000003612548\",\n \"thumbnailUrl\": \"https://media.example.com/7502219450506-01.jpg\",\n \"imageUrl\": \"https://media.example.com/7502219450506-00\",\n \"unit\": \"PCE\",\n \"upc\": \"750251965070\",\n \"shortName\": \"Tequila Don Nacho Extra Premium Reposado 750ml\",\n \"longName\": \"Tequila Don Nacho Extra Premium Reposado 750ml\",\n \"price\": 549,\n \"pesable\": false,\n \"restricted\": true,\n \"aisle\": \"Licores\",\n \"alternateIds\": [\n \"750251965070\",\n \"7502519\",\n \"7502519650705\"\n ],\n \"stock\": 10\n}"},{"id":"cfbf951e-4e72-45de-b582-5dcc63951b3d","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{BASE_URL}}/integration/scanBarCode?upc={{sku}}&storeId={{customer_store_id}}","host":["{{BASE_URL}}"],"path":["integration","scanBarCode"],"query":[{"description":"EAN - 13 OR SKU","key":"upc","value":"{{sku}}"},{"description":"store_id","key":"storeId","value":"{{customer_store_id}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Bad Request\",\n \"message\": \"Missing required keys: [\\\"storeId\\\", \\\"upc\\\"]\",\n \"statusCode\": 400\n}"}],"_postman_id":"3717d915-43e0-4814-9253-8fe589f00db4"},{"name":"Confirm Order","id":"876532a4-d515-4339-836e-13df1f9a5626","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Once the order picking has been completed, we send you the final order, so you can perform any bookkeeping, calculation or any other processing on your end.
\nYou may receive the order unchanged from what the consumer originally ordered, or it may have changed (added/replaced/deleted items), based on product availability at the store
\nThe only relevant field for you, should be each item's quantity. Be aware of new/replaced/removed items (if any).
\nAll these changes in the order
\nPERSISTENT
\nDECREASE
\nNEW
\nINCREASE
\nREPLACE
\nDELETE
\n","urlObject":{"path":["integration","finalOrder"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"6dee4441-df71-4784-9929-b9a6b254b49e","name":"200 Ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis endpoit is used to cancel an order that was previously created. When cancelling an order the process of delivery or picking and deliver will finish
\nThis API is use to both service, delivery or picking and delivery
\nMETHOD: POST
\nThe Zubale API endpoints make use of ACCESS_TOKEN for secure authentication and authorization.
\nThe ACCESS_TOKEN is necessary to test and work in the Zubale production environment when dealing with secured endpoints allowing the secure exchange of JSON information pertaining to your account.
\nPayload request structure
\nNote: The ACCESS TOKEN must be provided in the Authorization header of the HTTP request using the ‘Bearer’ scheme.
\nResponse status code: 200 OK
\nSuccess response
\nPayload Structure
\nResponse status code: 400 Bad request
\nPayload Structure
\n","urlObject":{"path":["oauth2","token"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"464ecb88-8ea0-4897-b4cc-5aad3131f31b","name":"Authentication OK","originalRequest":{"method":"POST","header":[{"name":"Content-Type","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"curl --location -g --request POST '{{BASE_URL}}/oauth2/token' \\\r\n--header 'Content-Type: application/json' \\\r\n--data-raw '{\r\n \"client_id\": \"{{CLIENT_ID}}\",\r\n \"client_secret\": \"{{CLIENT_SECRET}}\",\r\n \"grant_type\": \"client_credentials\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"","value":""}],"cookie":[{"expires":"Thu Jan 01 1970 00:00:00 GMT+0000 (Coordinated Universal Time)","domain":"","path":""}],"responseTime":null,"body":"{\n \"token_type\": \"bearer\",\n \"access_token\": \"ia1XaSImbm8h4yLz5FiQOfYdygG0b6LKu\",\n \"expires_in\": 7200\n}"},{"id":"b92fd00b-cac8-4e01-bc92-a0b6b682b66e","name":"Authentication Error","originalRequest":{"method":"POST","header":[{"name":"Content-Type","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"curl --location -g --request POST '{{BASE_URL}}/oauth2/token' \\\r\n--header 'Content-Type: application/json' \\\r\n--data-raw '{\r\n \"client_id\": \"{{CLIENT_ID}}\", \r\n \"client_secret\": \"{{CLIENT_SECRET}}\",\r\n \"grant_type\": \"client_credentials\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"","value":""}],"cookie":[{"expires":"Thu Jan 01 1970 00:00:00 GMT+0000 (Coordinated Universal Time)","domain":"","path":""}],"responseTime":null,"body":"{\n \"error_description\": \"Invalid client authentication\",\n \"error\": \"invalid_client\"\n}"}],"_postman_id":"f37d4181-a590-4c53-955d-6c2b4cb3f3ac"}],"id":"7064e89d-1a66-468e-b853-8bbe53e97abc","description":"⚠️ Todo los tokens, keys son de referencia como ejemplo
\nCon los valores client y secret proporcionados por Zubale, la solicitud genera un token de autenticación que se utiliza para formar los parámetros para abrir la vista web del chat.
![https://galletasImage.com/7441001700065.jpg\"](\"https://galletasImage.com/7441001700065.jpg\"){kind=link}
curl --location '' \\\\\n --header 'Content-Type: application/json' \\\\\n --data '{\n \"client_id\": \"{{client}}\",\n \"client_secret\": \"{{secret}}\",\n \"grant_type\": \"client_credentials\"\n }'\n\nRespuesta | 200 OK
\nEn la respuesta, Zubale devuelve el token (access_token) que se encriptará más adelante.
{\n \"expires_in\": 7200,\n \"token_type\": \"bearer\",\n \"access_token\": \"04xuWYc5y71huX2qNDZsHT7ZsL2mZpKK\"\n }\n\naes256, utilizando una secret_key proporcionada por Zubale.{\n \"order_id\": \"1684417669-00\",\n \"token\": \"04xuWYc5y71huX2qNDZsHT7ZsL2mZpKK\"\n }\n\nEjemplo: Encriptar en JavaScript
\nconst crypto = require('crypto')\nconst algorithm = 'aes256';\n// secret key provided by Zubale\nconst secret_key = \"HqCwhM/RZ2u/kMZ6aFKlNVKobcdgBaC4pKylk0Cwy3brbYA49hEMxrx/10IObcKF\"\nfunction decryptString(key, encryptedString) {\n const decipher = crypto.createDecipher(algorithm, key);\n return decipher.update(encryptedString, 'hex', 'utf8') +\n decipher.final('utf8');\n}\nfunction encryptString(key, plaintext) {\n const encipher = crypto.createCipher(algorithm, key);\n const encrypted = Buffer.concat([encipher.update(plaintext), encipher.final()]);\n return encrypted.toString(\"hex\")\n}\n// Json Object\nconst jsonObject = {\n \"order_id\": \"1684417669-00\",\n // Value of the access_token that returns the request in the step 1\n \"token\": \"05vuWZc5y71huX2qNDZsHP8ZsL2mZpKJ\" \n};\n// Convert Json to String\nconst jsonString = JSON.stringify(jsonObject);\nvar encrypted = encryptString(secret_key, jsonString)\nconsole.log(\"Encrypted: \", encrypted)\nvar decrypted = decryptString(secret_key, encrypted)\nconsole.log(\"Decrypted: \", decrypted)\n**// OUTPUT:**\n// **Encrypted**: 4e948c1504cc00fe389b06e37796a3c10b77abc61938a9c897903b8072e2830751d83a69e632b687061b0334c3510dced97645e775ac933a89ebabfba5ccd2ece3f9da96717e28768a68a87bf2503464\n// **Decrypted**: {\"order_id\":\"1684417669-00\",\"token\":\"05vuWZc5y71huX2qNDZsHP8ZsL2mZpKJ\"}\n\nEjemplo de la url formada webview
\nCambien el valor de BASE_URL por la url proporcionada por Zubale.
{{BASE_URL}}?params=4e948c1504cc00fe389b06e37796a3c10b77abc61938a9c897903b8072e2830751d83a69e632b687061b0334c3510dced97645e775ac933a89ebabfba5ccd2ece3f9da96717e28768a68a87bf2503464\n\nBased on a JSON array of products, create products massively in our service.
\nbrand_id in the path params is an integer value provided by Zubale.
\nNote: each brand can only have 1 existing catalog, which means calling this endpoint again will overwrite your existing data, this includes all product records from all stores.
\nWarning: if you're integrating your stock service with us, make sure to set all products stock values to 0.
\n","urlObject":{"path":["product-catalog","api","v1","catalog",":brand_id"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{brand_id}}","key":"brand_id"}]}},"response":[{"id":"88063bd2-01fb-4281-89ab-fd28803bed3d","name":"Success creating","originalRequest":{"method":"POST","header":[{"description":"Required value.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"sale_price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"name\": \"Gansito unidad 50gr\",\n \"brand\": \"Marinela\",\n \"description\": \"Bizcocho relleno y con cobertura sabor chocolate\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 700.0,\n \"sale_price\": 700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Dulces y pasteles\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 119990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 89990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7800007771353\",\n \"name\": \"Ibuprofeno 600mg 20 comprimidos\",\n \"brand\": \"Laboratorio Chile\",\n \"description\": \"Venta bajo receta medica en establecimiento tipo A\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 2690.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Farmacia\",\n \"restricted\": true\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/catalog/{{brand_id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Operation completed successfully\"\n}"},{"id":"45b1548f-7e61-46eb-a960-c4b75d3c2ec9","name":"Success with failed products","originalRequest":{"method":"POST","header":[{"description":"Required value.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"sale_price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"name\": \"Gansito unidad 50gr\",\n \"brand\": \"Marinela\",\n \"description\": \"Bizcocho relleno y con cobertura sabor chocolate\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 700.0,\n \"sale_price\": 700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Dulces y pasteles\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 119990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 89990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7800007771353\",\n \"name\": \"Ibuprofeno 600mg 20 comprimidos\",\n \"brand\": \"Laboratorio Chile\",\n \"description\": \"Venta bajo receta medica en establecimiento tipo A\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 2690.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Farmacia\",\n \"restricted\": true\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/catalog/{{brand_id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"failed_products\": [\"70847009511\", \"7803473543189\"],\n \"message\": \"Operation completed successfully\"\n}"},{"id":"05b467b5-2502-4d75-bb98-9ce1bb420ac1","name":"Response on an unhandled error","originalRequest":{"method":"POST","header":[{"description":"Required value.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"sale_price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"name\": \"Gansito unidad 50gr\",\n \"brand\": \"Marinela\",\n \"description\": \"Bizcocho relleno y con cobertura sabor chocolate\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 700.0,\n \"sale_price\": 700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Dulces y pasteles\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 119990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 89990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7800007771353\",\n \"name\": \"Ibuprofeno 600mg 20 comprimidos\",\n \"brand\": \"Laboratorio Chile\",\n \"description\": \"Venta bajo receta medica en establecimiento tipo A\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 2690.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Farmacia\",\n \"restricted\": true\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/catalog/{{brand_id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Internal Server Error\"\n }\n}"},{"id":"df29b880-7594-44af-b327-7d344764a36f","name":"Success creating","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate a given list of products. This endpoint will not overwrite your existing data.
\nAttempting to update an unexisting record won't create it, meaning that if you send a product that isn't on our database will not attempt to insert it. To make sure it exists, please refer to the Get products(s) section
\nbrand_id in the path params is an integer value provided value.
\n\"brand_id\", \"store_id\" and \"product_code\" are mandatory fields. Any undeclared, empty strings, zero and null values won't be overwritten on the original record.
\n","urlObject":{"path":["product-catalog","api","v1","catalog",":brand_id"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{brand_id}}","key":"brand_id"}]}},"response":[{"id":"ad14b086-bfb8-4fc0-a0fd-578d1896d74d","name":"Success updating","originalRequest":{"method":"PUT","header":[{"description":"Required field.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": true\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"price\": 700.0,\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": null,\n \"brand\": null,\n \"description\": null, \n \"available\": false, // the only effective change for this product for the given store\n \"condition\": null,\n \"price\": 0.0,\n \"link\": null,\n \"image_link\": null,\n \"department\": null\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/catalog/{{brand_id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Operation completed successfully\"\n}"},{"id":"a6551faa-89b7-45d4-b7cb-76fc111402a0","name":"Response on an unhandled error","originalRequest":{"method":"PUT","header":[{"description":"Required field.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": true\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"price\": 700.0,\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": null,\n \"brand\": null,\n \"description\": null, \n \"available\": false, // the only effective change for this product for the given store\n \"condition\": null,\n \"price\": 0.0,\n \"link\": null,\n \"image_link\": null,\n \"department\": null\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/catalog/{{brand_id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Internal Server Error\"\n }\n}"},{"id":"d69e444d-385c-4085-8ad2-7c4515b99ae4","name":"Success updating","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCreates an array of multiple products at once. This endpoint will not overwrite existing records, but will return products that failed to insert whenever they don't match the expected values.
\nWarning: if you're integrating your stock service with us, make sure to set all products stock values to 0.
\n","urlObject":{"path":["product-catalog","api","v1","brands","1093","products"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"c5baad0e-49f1-4e7e-a6bd-22f6a549ed12","name":"Success creating","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"sale_price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"name\": \"Gansito unidad 50gr\",\n \"brand\": \"Marinela\",\n \"description\": \"Bizcocho relleno y con cobertura sabor chocolate\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 700.0,\n \"sale_price\": 700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Dulces y pasteles\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 119990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 89990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7800007771353\",\n \"name\": \"Ibuprofeno 600mg 20 comprimidos\",\n \"brand\": \"Laboratorio Chile\",\n \"description\": \"Venta bajo receta medica en establecimiento tipo A\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 2690.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Farmacia\",\n \"restricted\": true\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/brand/1093/products"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Operation completed successfully\"\n}"},{"id":"6b61b369-b3cd-4667-b74d-99a67891102e","name":"Success with failed products","originalRequest":{"method":"POST","header":[{"description":"Required value.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"sale_price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"name\": \"Gansito unidad 50gr\",\n \"brand\": \"Marinela\",\n \"description\": \"Bizcocho relleno y con cobertura sabor chocolate\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 700.0,\n \"sale_price\": 700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Dulces y pasteles\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 119990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 89990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7800007771353\",\n \"name\": \"Ibuprofeno 600mg 20 comprimidos\",\n \"brand\": \"Laboratorio Chile\",\n \"description\": \"Venta bajo receta medica en establecimiento tipo A\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 2690.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Farmacia\",\n \"restricted\": true\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/catalog/{{brand_id}}/create"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"failed_products\": [\"70847009511\", \"7803473543189\"],\n \"message\": \"Operation completed successfully\"\n}"},{"id":"1e0a294a-102c-4b3f-b3bb-1a1dfb2ef103","name":"Response on an unhandled error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"sale_price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7803473543189\",\n \"name\": \"Gansito unidad 50gr\",\n \"brand\": \"Marinela\",\n \"description\": \"Bizcocho relleno y con cobertura sabor chocolate\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 700.0,\n \"sale_price\": 700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Dulces y pasteles\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 119990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"4710273775609\",\n \"name\": \"Audifonos gaming XPG headset precog analog\",\n \"brand\": \"Adata\",\n \"description\": \"\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 119990.0,\n \"sale_price\": 89990.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Audifonos\",\n \"restricted\": false\n },\n {\n \"store_id\": \"store12\",\n \"product_code\": \"7800007771353\",\n \"name\": \"Ibuprofeno 600mg 20 comprimidos\",\n \"brand\": \"Laboratorio Chile\",\n \"description\": \"Venta bajo receta medica en establecimiento tipo A\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 2690.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_link\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Farmacia\",\n \"restricted\": true\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/product/create"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Internal Server Error\"\n }\n}"},{"id":"583b2392-6009-4b76-9e5a-697a3a2f7e10","name":"Success creating","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdates a single product.
\n\"brandId\", \"storeId\", and \"productCode\" are mandatory fields. Any undeclared, empty strings, zero and null values won't be overwritten on the original record.
\n","urlObject":{"path":["product-catalog","api","v1","products"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"df06bcec-4541-44f4-a9c4-8e24790fb7d1","name":"Success updating","originalRequest":{"method":"PUT","header":[{"description":"Required field.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"brand_id\": \"1093\",\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"stock\": 4,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_iink\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/products"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Operation completed successfully\"\n}"},{"id":"f7868603-c3c8-4b3b-8f10-7d287e803057","name":"Response on an unhandled error","originalRequest":{"method":"PUT","header":[{"description":"Required field.","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"brand_id\": 1093,\n \"store_id\": \"store10\",\n \"product_code\": \"70847009511\",\n \"name\": \"Bebida Monster clasica 473ml\",\n \"brand\": \"Monster Energy\",\n \"description\": \"Atrevete a probar una de las bebidas mas extremas del planeta, Monster Energy\", \n \"available\": true,\n \"condition\": \"new\",\n \"price\": 1700.0,\n \"link\": \"https://your.domain.com/path/to/product\",\n \"image_iink\": \"https://your.domain.com/path/to/product-image\",\n \"department\": \"Bebidas energeticas\",\n \"restricted\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zubale.com/product-catalog/api/v1/products"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Internal Server Error\"\n }\n}"},{"id":"5cba52c9-a1f6-4cff-8543-0c015b3323d7","name":"Success updating","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGet a product based on certain query parameters.
\n","urlObject":{"path":["product-catalog","api","v1","brands",":brand_id","products"],"host":["{{BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"Product GTIN, comma sepparated, no whitespaces
\n","type":"text/plain"},"key":"product_code","value":"70847009511,4710273775609"},{"disabled":true,"description":{"content":"Your store identifier.
\n","type":"text/plain"},"key":"store_id","value":"store12"},{"disabled":true,"description":{"content":"Product categorization.
\n","type":"text/plain"},"key":"department","value":"Alimentos"}],"variable":[{"type":"any","value":"{{brand_id}}","key":"brand_id"}]}},"response":[{"id":"735cb63f-3279-4a42-8914-ccd66259ae3b","name":"Response on an unhandled error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zubale.com/product-catalog/api/v1/brands/{{brand_id}}/products","protocol":"https","host":["api","zubale","com"],"path":["product-catalog","api","v1","brands","{{brand_id}}","products"],"query":[{"description":"Product GTIN, comma sepparated, no whitespaces","key":"product_code","value":"70847009511,4710273775609","disabled":true},{"description":"Your store identifier.","key":"store_id","value":"store12","disabled":true},{"description":"Product categorization.","key":"department","value":"Alimentos","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Internal Server Error\"\n }\n}"},{"id":"207ea3f0-ab9d-464c-8f39-6ad3c9cd6875","name":"Response on an unhandled error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/product-catalog/api/v1/brands/:brand_id/products","host":["{{BASE_URL}}"],"path":["product-catalog","api","v1","brands",":brand_id","products"],"query":[{"description":"Product GTIN, comma sepparated, no whitespaces","key":"product_code","value":"70847009511,4710273775609","disabled":true},{"description":"Your store identifier.","key":"store_id","value":"store12","disabled":true},{"description":"Product categorization.","key":"department","value":"Alimentos","disabled":true}],"variable":[{"key":"brand_id","value":"{{brand_id}}"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"failure to get a peer from the ring-balancer\"\n}"}],"_postman_id":"0c5e7e2f-9630-462c-8381-c4c677d2935b"}],"id":"984a14a7-88e2-4ede-99ad-9bac5852ae3f","_postman_id":"984a14a7-88e2-4ede-99ad-9bac5852ae3f","description":""},{"name":"External outbound","item":[{"name":"Basic template","id":"f7bda79f-c816-49b0-b753-a50b0e9e1864","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWT_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"target\": \"+57301000000\",\n \"templateName\": \"example_basic_template\",\n \"languageCode\": \"es\",\n \"flow\": \"promotions_purchase\",\n \"payload\": {},\n \"metadata\": {\n \"node\": \"start-single-product\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BASE_URL}}/hermes/integrations/:iINTEGRATION_NAME/conversations/messages","description":"Send a basic WhatsApp template message without variable parameters.
\nRequired headers:
\nContent-Type: application/json
\nAuthorization: Bearer {{JWT_TOKEN}}
\nUse for simple notifications or confirmations where no template variables are needed.
\nJSON structure:
\ntarget (string, required): Recipient phone number in E.164 format, including country code.
templateName (string, required): Name of the WhatsApp template configured for this basic message.
languageCode (string, required): Language/locale code for the template (for example, es, en_US).
flow (string, required): Static flow identifier provided by Zubale.
payload (object, optional): Reserved for additional content or metadata if needed for the template; typically empty for a basic template.
metadata (object, required): Additional routing information.
node (string, required): Static node identifier provided by Zubale.Send a WhatsApp template message with variables
\nRequired headers:
\nContent-Type: application/json
\nAuthorization: Bearer {{jwtToken}}
\nUse when you need to send a template with dynamic variables.
\nJSON structure:
\ntarget (string, required): Recipient phone number, including country code.
templateName (string, required): Name of the WhatsApp template configured with variables.
languageCode (string, required): Language/locale code for the template (for example, es, en_US).
flow (string, required): Static flow identifier provided by Zubale.
payload (object, required): Contains the variable values to be injected into the template.
body (array, required): List of template components.type (for example, header, body) and parameters.For header with images: parameters[].image.link is the URL of the image to show.
For body with text variables: parameters[].text contains the value for each template placeholder in order.
metadata (object, required): Additional routing information.
node (string, required): Static node identifier provided by Zubale.Send a single product campaign catalog message.
\nRequired headers:
\nContent-Type: application/json
\nAuthorization: Bearer {{jwtToken}}
\nUse to promote one specific product with rich media.
\nJSON structure:
\ntarget (string, required): Recipient phone number, including country code.
templateName (string, required): Name of the WhatsApp campaign/template for a single product.
languageCode (string, required): Language/locale code for the template (for example, es, en_US).
flow (string, required): Static flow identifier provided by Zubale.
payload (object, required): Template variables for the message.
body (array, required): Template components.header component: parameters[].image.link is the image URL for the product or brand.
body component: parameters[].text are text variables such as product name, price, or description.
metadata (object, required): Campaign and routing metadata.
node (string, required): Static node identifier provided by Zubale.
promotionCode (string, optional): Code associated with the promotion/campaign.
productName (string, optional): Human-readable product name.
productCode (string, optional): Internal or retailer product identifier used by your catalog.
Send multiple product items as a WhatsApp catalog campaign message.
\nRequired headers:
\nContent-Type: application/json
\nAuthorization: Bearer {{jwtToken}}
\nUse to showcase multiple products in a single outbound campaign.
\nJSON structure:
\ntarget (string, required): Recipient phone number, including country code.
templateName (string, required): Name of the WhatsApp campaign/template for multiple products.
languageCode (string, required): Language/locale code for the template (for example, es, en_US).
flow (string, required): Static flow identifier provided by Zubale.
payload (object, required): Template variables and catalog configuration.
body (array, required): Template components for the message body and CTA button.Discount text component: parameters[].text contains values such as discount percentage.
Catalog button component (type: button, sub_type: mpm):
parameters[].action.sections[].title is the section title shown in the catalog.
product_items[] is an array of catalog product entries.
product_retailer_id (string, required): Identifier of the product in your catalog.metadata (object, required): Campaign and routing metadata.
node (string, required): Static node identifier provided by Zubale.
promotionCode (string, optional): Code associated with the promotion/campaign.
Required
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/webhook","description":"Configuration for setting up the webhook. The client should point their webhook to the provided URL with the appropriate method and headers.
\n","urlObject":{"path":["webhook"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5014ad9c-6135-4c15-a49d-8135e576d74e"},{"name":"Example Payload","id":"82aa0175-da6a-4e3c-aae7-a2617cf2508d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"c5c35334-b909-4ddd-a7a9-1245cf0947e7\",\n \"status\": \"pending\",\n \"items\": [\n {\n \"currency\": \"USD\",\n \"item_category\": null,\n \"item_id\": \"sku_replace_1\",\n \"item_name\": null,\n \"item_price\": 30.02,\n \"quantity\": 1000\n },\n {\n \"currency\": \"USD\",\n \"item_category\": null,\n \"item_id\": \"sku_change_1\",\n \"item_name\": null,\n \"item_price\": 1000.61,\n \"quantity\": 9\n }\n ],\n \"purchase_amount\": \"39025.49\",\n \"delivery_date\": \"2024-07-31T00:00:00\",\n \"created_at\": \"2024-07-30T23:46:17\",\n \"status_detail\": null,\n \"total_products\": 1009,\n \"total_purchase_amount\": \"43024.49\",\n \"payment_method\": null,\n \"delivery_fee\": \"3999.00\",\n \"discount\": null,\n \"drop_off_location\": {\n \"complement\": \"3rd floor, door 3A\",\n \"formatted_address\": \"Av. Corrientes 1234, CABA, Argentina\",\n \"latitude\": 0.0,\n \"longitude\": 0.0\n },\n \"origin_location\": {\n \"name\": \"...\",\n \"region\": \"...\",\n \"type\": \":coverate_typ\"\n },\n \"customer\": {\n \"name\": null,\n \"email\": null,\n \"contact_info\": \"Ana lucia otoya, al.otoya@gmail.com , 3176368548, 1143858897\",\n \"last_name\": null,\n \"phone_number\": \"+50230905700\"\n }\n}"},"url":"{{BASE_URL}}/","description":"This is an example of the payload that will be received by the webhook.
\n","urlObject":{"path":[""],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"82aa0175-da6a-4e3c-aae7-a2617cf2508d"}],"id":"51cda0e2-ceee-4696-bf04-d55be4e76b4a","_postman_id":"51cda0e2-ceee-4696-bf04-d55be4e76b4a","description":""},{"name":"Consumer Connect","item":[{"name":"API Documentation for External Notification Handler","item":[{"name":"Send Event","id":"aab4122c-a501-4698-93bf-2db35b5d804e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer\": \"development\",\n \"supplier\": {\n \"identifier\": \"22\",\n \"name\": \"supply\"\n },\n \"event\": \"order_created\",\n \"target\": \"+50241512151\",\n \"orderReference\": \"v10000-23\",\n \"countryCode\": \"MX\",\n \"brandIdentifier\": \"123\",\n \"storeIdentifier\": \"456\",\n \"data\": {\n \"customerName\": \"Wesley López\",\n \"deliveryDate\": \"2025-02-15\",\n \"slotStart\": \"13:00\",\n \"slotEnd\": \"15:00\",\n \"brandName\": \"Zubale\",\n \"plateNumber\": \"P123ABC\",\n \"shopperName\": \"Juan Perez\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BASE_URL}}/external-notification-handler/api/v1/events","description":"This endpoint allows clients to notify their consumers via WhatsApp about order status updates.
\nThe following values are allowed for the event field:
order_created
picking_started
picked_out
enroute_to_dropoff
at_dropoff
delivered
If you require additional custom events, please contact us to discuss adding them to the system.
\nNote: The required parameters may vary depending on the event type. Each event corresponds to specific message templates and required parameters. Ensure that the request includes the necessary fields for the intended notification.
\nevent: Type of event (e.g., order_created).
retailer: Retailer identifier.
target: Target contact (e.g., phone number).
orderReference: Unique order reference.
data: Additional order details.