Use this endpoint to submit a single event for a specified customer asyncronously. The event is accepted immediately and processed in the background.This endpoint is compatible with the following event actions:
\n"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.{{environment}}.antavo.com/v1/async/events?correlation_id=549a7bf8-65e7-c184-54a8-3bf67ac2c080","description":"Use this endpoint to query the processing status of an event sent through the v1/async/events endpoint.
\nOnce the event has been processed, the response includes the customer information and the detailed event data.
\n","urlObject":{"protocol":"https","path":["v1","async","events"],"host":["api","{{environment}}","antavo","com"],"query":[{"key":"correlation_id","value":"549a7bf8-65e7-c184-54a8-3bf67ac2c080"}],"variable":[]}},"response":[{"id":"060ce93d-7be8-47e2-8d11-c80a0606284b","name":"Successful status query","originalRequest":{"method":"GET","header":[],"url":"https://api.{{environment}}.antavo.com/v1/async/events/549a7bf8-65e7-c184-54a8-3bf67ac2c080"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jan 2026 12:41:03 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"403"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Antavo-Bug-Report","value":"developer@antavo.com"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Correlation-Id","value":"11b46f52-38d4-3063-64d2-5d4a5ca901e8"},{"key":"X-Frame-Options","value":"deny"},{"key":"X-Powered-By","value":"Antavo Loyalty Engine"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=WK4JX5cdpBpj%2BAZqRvnMAb%2FlzKPD5Fz2BEfCc%2Frapb7BTMuYm%2FRAgxWgiFmM%2B53c2P%2FNdk6A7k9lE3fUl2uE7eNGZ79EB2JRpFmPw7LljsYmmMU%3D\"}]}"},{"key":"CF-RAY","value":"9c275cf3dea9d93d-BUD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": [],\n \"payload\": {\n \"status\": \"processed\",\n \"response\": {\n \"success\": {\n \"id\": \"testcustomer\",\n \"created_at\": 1657106644,\n \"email\": \"m\",\n \"first_name\": \"Klari\",\n \"last_name\": \"Nemeth\",\n \"handler\": \"\",\n \"status\": \"active\",\n \"score\": 34170,\n \"spent\": 12167,\n \"expired\": 0,\n \"level\": \"64b647cd257f93741550d3e4\",\n \"pending\": 34511,\n \"language\": \"\",\n \"currency\": \"JPY\",\n \"mobile_phone\": \"\",\n \"image_url\": null,\n \"spendable\": 21953,\n \"events\": [\n {\n \"id\": \"69736bd56967744fd607d512\",\n \"action\": \"point_add\",\n \"points\": 15,\n \"expdate\": \"2025-06-01\",\n \"account\": {\n \"id\": \"family_account\",\n \"name\": \"Family account\"\n }\n }\n ],\n \"cf_vmi\": \"\",\n \"stores\": [\n {\n \"id\": \"4\"\n }\n ]\n },\n \"error\": []\n }\n }\n}"},{"id":"f6e0ddb2-5e2f-4e7c-a73b-5b7b711d1dd1","name":"Account not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/async/events/:correlation_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","async","events",":correlation_id"],"variable":[{"key":"correlation_id","value":"44d6a314-5abc-b6e4-d0bd-f18e606ef7d1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jan 2026 12:50:36 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"142"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Antavo-Bug-Report","value":"developer@antavo.com"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Correlation-Id","value":"aab108e9-357f-7475-8b57-d590becd47bd"},{"key":"X-Frame-Options","value":"deny"},{"key":"X-Powered-By","value":"Antavo Loyalty Engine"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=uqraZgcSCPo%2By0rn4MK304hRW8QicIPzCLtquwh96BOrfd2ksoY2gNu9cx39ZLIOrgphDCgV5EgGu%2B7SP2zNecJ9ngTNmPFfkB89%2BFt9tsS%2BcYc%3D\"}]}"},{"key":"CF-RAY","value":"9c276af0fa4dd93d-BUD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": [],\n \"payload\": {\n \"status\": \"error\",\n \"response\": {\n \"success\": [],\n \"error\": {\n \"type\": \"RuntimeException\",\n \"code\": 221010,\n \"message\": \"Account not found\"\n }\n }\n }\n}"},{"id":"dd66691c-574d-4459-9268-d4505c5b09e7","name":"Required event parameter is missing","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/async/events/:correlation_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","async","events",":correlation_id"],"variable":[{"key":"correlation_id","value":"2b137c65-7556-5833-39ef-513428e1f43e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 23 Jan 2026 12:52:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Antavo-Bug-Report","value":"developer@antavo.com"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Correlation-Id","value":"71706e1d-fbb2-c354-0467-dcd89a6e66aa"},{"key":"X-Frame-Options","value":"deny"},{"key":"X-Powered-By","value":"Antavo Loyalty Engine"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=Jt1RgknXGefb9TMvhb6eBLqO5%2FiJ%2ByjtYkAdGOuQ8Ek3hrb6DTs3c6ufC6Fl4%2BV8trmSn8jJck%2B2tsxNp3pfWkEpLvnHUqSWXqVWfRD8nZmrOfE%3D\"}]}"},{"key":"CF-RAY","value":"9c276d873851d93d-BUD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": [],\n \"payload\": {\n \"status\": \"error\",\n \"response\": {\n \"success\": [],\n \"error\": {\n \"type\": \"RuntimeException\",\n \"code\": 160360,\n \"message\": \"Property 'points' cannot be empty\"\n }\n }\n }\n}"},{"id":"e0db4541-e0ba-4f5f-9223-dcb28bcd75dd","name":"Correlation ID not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/async/events/:correlation_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","async","events",":correlation_id"],"variable":[{"key":"correlation_id","value":"2b137c65-7556-5833-39ef-513428e1f43"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 23 Jan 2026 12:54:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"127"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Antavo-Bug-Report","value":"developer@antavo.com"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Correlation-Id","value":"d100c8a4-9ad7-c3f2-a27a-a983e28c67f3"},{"key":"X-Frame-Options","value":"deny"},{"key":"X-Powered-By","value":"Antavo Loyalty Engine"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=fDn4vuOOqUce9ws%2FxNLuDhTK4nCejh3A28S8lVTSmHsPEvOFyQnZ%2BY8P3E4AzdqSPKubH7027RAVHe0KIlLBoPml7nYRltF0I1LEtntdCr5ZtQs%3D\"}]}"},{"key":"CF-RAY","value":"9c27710c5f98684d-BUD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"type\": \"NotFoundException\",\n \"code\": 203405,\n \"message\": \"Correlation ID not found\"\n }\n}"},{"id":"ce09f5da-ea4c-4afb-a13e-ff9b05074344","name":"Successful status query with erroneous event processing","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/async/events?correlation_id=549a7bf8-65e7-c184-54a8-3bf67ac2c080","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","async","events"],"query":[{"key":"correlation_id","value":"549a7bf8-65e7-c184-54a8-3bf67ac2c080"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"status\": \"success\",\r\n\t\"metadata\": [],\r\n\t\"payload\": {\r\n\t\t\"status\": \"error\",\r\n\t\t\"response\": {\r\n\t\t\t\"success\": [],\r\n\t\t\t\"error\": {\r\n\t\t\t\t\"type\": \"RuntimeException\",\r\n\t\t\t\t\"code\": 112101,\r\n\t\t\t\t\"message\": \"Customer has already been opted-in.\"\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n}\r\n"},{"id":"336d25c4-c74b-4f15-a57f-1fa4a8a37e5e","name":"Successful status query with failed status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/async/events/:correlation_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","async","events",":correlation_id"],"variable":[{"key":"correlation_id","value":"2c00938f-74c1-b215-d520-cda495e0f831"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 24 Jan 2026 23:04:03 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"169"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Antavo-Bug-Report","value":"developer@antavo.com"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Correlation-Id","value":"6edcd7c6-a796-b800-96b6-94d6f32407c9"},{"key":"X-Frame-Options","value":"deny"},{"key":"X-Powered-By","value":"Antavo Loyalty Engine"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=PN3Pdk5YXm2STaRFiD5vB0j%2FqJ0A1bIR82IGV4VJ%2BtJNdAKoPATcrDzqAEZ%2FKK7uhTUmD8rj%2FownnZ1qn4CmF8733FuIDBPGWa6S4IHhZ8gSo5I%3D\"}]}"},{"key":"CF-RAY","value":"9c332ae51bcdc1a8-BUD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": [],\n \"payload\": {\n \"status\": \"failed\",\n \"response\": {\n \"success\": [],\n \"error\": {\n \"type\": \"RuntimeException\",\n \"code\": 210110,\n \"message\": \"This transaction is not yet accepted so it cannot be refunded\"\n }\n }\n }\n}"}],"_postman_id":"bed92e82-e930-4138-bcf1-d965e03b3445"}],"id":"fd1fe99d-50d3-4d0c-874e-30658666df89","description":"The Async Events API is used to record events in Antavo asynchronously, allowing events to be accepted quickly and processed in the background.
\nUnlike the synchronous Events API, this API is designed for high-throughput and peak-load scenarios , where immediate processing is not required, but reliable delivery and tracking are critical.
\nThe Async Events API is useful when:
\n\nA large number of events need to be sent in a short period of time (for example, during campaigns, promotions, or data imports)
\nThe client application must not wait for event processing to complete
\nTemporary traffic spikes should not impact system stability
\nEvent submission reliability is more important than immediate feedback
\n \nWhen an event is submitted, the API immediately acknowledges the submission and returns a correlation ID, which can later be used to track the processing result.
\nEvent compatibility \nThe Async Events API supports the following events:
\n\npoint_add
\ncheckout
\ncheckout_item
\ncheckout_update
\ncheckout_update_item
\ncheckout_accept
\ncheckout_accept_item
\ncheckout_reject
\npartial_refund
\nrefund_item
\nrefund
\n \nThe corresponding attributes of the events can be found on the Events page.
\nEndpoints \n\nSubmitting events asynchronously \nThe Async Events API supports single event submission.
\nPOST /v1/async/events: Submits a single event for asynchronous processing. Only one event can be submitted per request. Each request is processed independently and tracked using a correlation ID.
\nImportant
\nThe order in which events are submitted is important. The API expects events to be sent in the correct sequence , and the system guarantees that events are processed in the order they were received.
\nYou must wait for a successful acknowledgment from the API (HTTP 200 OK) before sending the next event in the sequence. For example:
\n\nAfter an opt_in event is accepted, only then should a checkout event be sent.
\nAfter a checkout event is processed, the corresponding checkout_accept can be submitted.
\n Ensuring proper ordering allows the Loyalty Engine to correctly apply loyalty program rules and maintain accurate customer state.
\nTracking event processing
\n \nSince events are processed asynchronously, the final processing result is not returned immediately.
\nGET /v1/async/events/{correlation_id}: Retrieves the processing status and result of a previously submitted event.
\nUsing the correlation ID, you can:
\n\nCheck whether the event has been processed
\nRetrieve the full customer information and detailed event data once processing is complete
\nInspect error details if processing failed
\n \nThis makes it possible to build reliable retry, monitoring, or audit mechanisms on the client side.
\nCallback mechanism \nThe Async Events API supports an optional callback mechanism that allows your system to receive the processing result of an asynchronous event without polling the correlation endpoint.
\nIf a callback_url is provided when submitting an event via the Async Events API, Antavo will send the processing result to the specified URL once the event has been handled. The callback request references the original submission using the correlation_id.
\nThe callback_url must be configured as a Trusted Site in the Management UI. The callback request has a timeout of 1 second. If you need a longer timeout, please contact the Antavo Service Desk.
\nSuccess payload
\n{\n \"status\": \"success\",\n \"payload\": {\n \"correlation_id\": \"62cc313988befe60e3413e75\",\n \"status\": \"success\",\n \"processed_at\": \"2025-10-16T15:29:41+02:00\"\n }\n}\n\nError payload
\n{\n \"status\": \"success\",\n \"payload\": {\n \"correlation_id\": \"62cc313988befe60e3413e75\",\n \"status\": \"error\",\n \"processed_at\": \"2025-10-16T15:29:41+02:00\",\n \"error\": {\n \"code\": 123456,\n \"message\": \"Transaction not found.\"\n }\n }\n}\n\nDead-Letter Queues (DLQs) \nThe Async Events API provides two separate Dead-Letter Queues: one for events and one for callbacks . These queues store messages that could not be processed or delivered successfully, allowing manual inspection, retry, or export via the Management UI.
\n\nThe Events DLQ stores events that were successfully enqueued but failed processing after 5 retry attempts.
\nThe Callback DLQ stores callback requests that could not be delivered to the callback_url within the configured timeout.
\n \nFor detailed instructions on managing both DLQs, see the Management UI user manual.
\nSubmission-based timestamping \nEach asynchronous event sent through the /v1/async/events endpoint is recorded using the time it is submitted to the system , regardless of when it is queued or processed. This ensures that the event is evaluated according to the loyalty program configuration active at the time of submission, not any subsequent changes. The date, timestamp, and effective_timestamp attributes on the event are all set to the submission time by default.
\nThe endpoint also supports backdating . Optionally, the event payload can include an effective_timestamp to register the event as occurring at a past time. If provided, the event is stored as if it happened at the specified timestamp. If no effective_timestamp is provided in the request, the submission time is automatically used.
\n","_postman_id":"fd1fe99d-50d3-4d0c-874e-30658666df89"},{"name":"Customer API","item":[{"name":"Search Antavo database using customer filters","event":[{"listen":"prerequest","script":{"id":"0b3fcd89-ff08-4032-a17b-a560e119029a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e8c57a95-038e-4e91-b1c6-50ec54e6fe22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/customers?search=&match=&fields=&limit=&offset=&Filtering=","description":"This endpoint allows you to search the Antavo database for customers based on specific criteria and returns the Antavo Customer ID. Note that the filtering is case-sensitive and does not support partial matches.searchable in the Antavo Management UI.
\n","urlObject":{"protocol":"https","path":["customers"],"host":["api","{{environment}}","antavo","com"],"query":[{"description":{"content":"Perform searches using key fields such as first_name, last_name, email, mobile_phone, or membership_id.
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"Enables querying specific customer data. Currently only works with the following attributes: _id, email, and membership_id. Example usage: &match=exact&membership_id=33492206-ba75-4487-8047-a9d78a135ce9
\n","type":"text/plain"},"key":"match","value":""},{"description":{"content":"Returns additional optional attributes from the customer object.
\nNote: Separating commas must be percentage encoded for API signing.
\n","type":"text/plain"},"key":"fields","value":""},{"description":{"content":"Limits the number of events to be returned in one response. Other values are accessible by pagination made accessible via the offset.
\nDefaults to 100
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"Offsets the starting number of items for pagination.
\nDefaults to 0
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"Customers can be filtered upon any configured customer field (marked as searchable). Results are case-sensitive and return exact matches.
\nIt's possible to query multiple customers based on the last update date. Customer IDs are returned if the updated_at customer attribute is greater than a specified datetime using the format updated_at.gt=.
\n","type":"text/plain"},"key":"Filtering","value":""}],"variable":[]}},"response":[{"id":"530e989e-27c4-4626-9075-c84efa6b1c0e","name":"Successful customer search","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/customers?search=first_name=John","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["customers"],"query":[{"key":"search","value":"first_name=John","description":"Perform searches using key fields such as first_name, last_name, email, mobile_phone, or membership_id."},{"key":"match","value":"","description":"Enables querying specific customer data. Currently only works with the following attributes: _id, email, and membership_id. Example usage: &match=exact&membership_id=33492206-ba75-4487-8047-a9d78a135ce9","disabled":true},{"key":"fields","value":"","description":"Returns additional optional attributes from the customer object.\n\nNote: Separating commas must be percentage encoded for API signing.\n","disabled":true},{"key":"limit","value":"","description":"Limits the number of events to be returned in one response. Other values are accessible by pagination made accessible via the offset.\n\nDefault value : 100\n","disabled":true},{"key":"offset","value":"","description":"Offsets the starting number of items for pagination.\n\nDefault value : 0\n","disabled":true},{"key":"Filtering","value":"","description":"Customers can be filtered upon any configured customer field (marked as searchable). Results are case-sensitive and return exact matches.\n","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"55e5d4dc2cf1901e688b45d3\"\n}"},{"id":"18aa2db1-1733-43df-937d-13e144d94548","name":"Returned error object","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/customers","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["customers"],"query":[{"key":"search","value":"","description":"Perform searches using key fields such as first_name, last_name, email, mobile_phone, or membership_id.","disabled":true},{"key":"match","value":"","description":"Enables querying specific customer data. Currently only works with the following attributes: _id, email, and membership_id. Example usage: &match=exact&membership_id=33492206-ba75-4487-8047-a9d78a135ce9","disabled":true},{"key":"fields","value":"","description":"Returns additional optional attributes from the customer object.\n\nNote: Separating commas must be percentage encoded for API signing.\n","disabled":true},{"key":"limit","value":"","description":"Limits the number of events to be returned in one response. Other values are accessible by pagination made accessible via the offset.\n\nDefault value : 100\n","disabled":true},{"key":"offset","value":"","description":"Offsets the starting number of items for pagination.\n\nDefault value : 0\n","disabled":true},{"key":"Filtering","value":"","description":"Customers can be filtered upon any configured customer field (marked as searchable). Results are case-sensitive and return exact matches.\n","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 160211,\n \"message\": \"Empty search criteria\",\n \"type\": \"BadRequestException\"\n }\n}"}],"_postman_id":"e8c57a95-038e-4e91-b1c6-50ec54e6fe22"},{"name":"Retrieve detailed customer data using the Antavo unique ID","event":[{"listen":"prerequest","script":{"id":"d1683dca-3197-464b-9590-84637b721a07","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b34cafa0-9c5f-4b62-88f2-36bb94727090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/customers/:customer_id?fields=","description":"This endpoint returns detailed information for a specific customer.
\n","urlObject":{"protocol":"https","path":["customers",":customer_id"],"host":["api","{{environment}}","antavo","com"],"query":[{"description":{"content":"Returns additional optional fields:
\n\ngroups: Returns associated groups (requires User groups module for selected customer in the form of an object with the following properties:
\n\nID - integer
\nName - string, optional (not returned for non-existing groups)
\nexternal_id - string, optional (not returned if empty)
\n \npurchases.ytd: A summary of purchase statistics.
\nexpiring_points: A summary of expiration statistics.
\nexpiring_points_history: An array of dates and number of points that have expired or will expire.
\n \n","type":"text/plain"},"key":"fields","value":""}],"variable":[{"description":{"content":"Unique customer ID. This can be
\nThe Antavo unique ID e.g., 280e674c-c4ea-4a30-987a-d9267d1a5018\nAn external ID (requires configuration): {external_field:external_id_value}
\n","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]}},"response":[{"id":"c476c60a-0fad-44d6-bd26-7ca36657878c","name":"Successful customer search","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/customers/:customer_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["customers",":customer_id"],"query":[{"key":"fields","value":"","disabled":true}],"variable":[{"key":"customer_id","value":"55e5d4dc2cf1901e688b45d3\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"55e5d4dc2cf1901e688b45d3\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"nickname\": \"Johnny\",\n \"email\": \"jsmith@example.com\",\n \"birth_date\": \"1969-12-25\",\n \"gender\": \"Male\",\n \"language\": \"en\",\n \"currency\": \"GBP\",\n \"status\": \"Active\",\n \"score\": 100,\n \"spent\": 20,\n \"reserved\": 0,\n \"expired\": 100,\n \"spendable\": 50,\n \"pending\": 20,\n \"image_url\": \"https://example.com/image.png\",\n \"optin_at\": 1577836800,\n \"last_login_at\": 1593561600,\n \"updated_at\": 1593561623,\n \"properties\": {\n \"city\": \"London\"\n },\n \"purchase_total\": 100,\n \"purchase_count\": 2,\n \"purchase_last_date\": \"2020-10-01\",\n \"mobile_phone\": \"123 456 789\",\n \"accounts\": {\n \"id\": \"main_account\",\n \"name\": \"Main account\",\n \"earned\": 1000,\n \"spent\": 500,\n \"pending\": 50,\n \"reserved\": 200,\n \"expired\": 50,\n \"spendable\": 800,\n \"burn_rates\": {\n \"amount\": 100,\n \"points\": 50,\n \"currency\": \"USD\",\n \"converted_amount\": 8,\n \"unconverted_points\": 40\n }\n },\n \"campaigns\": {\n \"id\": \"63772885e9af5b34933d4aa6\",\n \"occurrences\": {\n \"id\": \"662bac7c0e76787c9b75c80b\",\n \"pending_points\": 100,\n \"awarded_points\": 50,\n \"status\": \"active\",\n \"start_date\": \"2022-11-01T06:36:00.000Z\",\n \"end_date\": \"2022-12-01T06:36:00.000Z\",\n \"evaluation_date\": \"2022-12-01T06:36:00.000Z\"\n }\n },\n \"tiers\": {\n \"id\": \"tier1\",\n \"name\": \"Gold\",\n \"since\": \"2022-05-02T12:57:41+02:00\",\n \"threshold\": 1000,\n \"expdate\": \"2023-01-11T00:00:00+01:00\",\n \"points\": 1100,\n \"points_after_expiration\": 1000,\n \"structure\": {\n \"id\": \"standard_tiers\",\n \"name\": \"Standard tiers\"\n },\n \"next\": {\n \"id\": \"tier2\",\n \"name\": \"Platinum\",\n \"points\": 900\n }\n },\n \"groups\": [\n {\n \"id\": 330,\n \"name\": \"USA-Department\",\n \"external_id\": \"AG331\"\n }\n ]\n}"}],"_postman_id":"b34cafa0-9c5f-4b62-88f2-36bb94727090"},{"name":"Merge the current customer into the target customer","event":[{"listen":"prerequest","script":{"id":"39c23995-2b6b-4b3b-be3d-7a1f1cfd8571","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d9af67c0-6521-440b-90a8-44394933595e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"target\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/customers/:customer_id/merge","description":"This endpoint permanently merges the current customer into the target account.
\nBody param descriptions
\n\n*required
\n","urlObject":{"protocol":"https","path":["customers",":customer_id","merge"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"Unique customer ID. This can be
\nThe Antavo unique ID e.g., 280e674c-c4ea-4a30-987a-d9267d1a5018
\nAn external ID (requires configuration): {external_field:external_id_value}
\n","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]}},"response":[{"id":"458d173e-065a-420c-a9a8-2cb4685a8404","name":"Merges the current customer into the target customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"target\": \"a280e674c-de2a-4a30-987a-d9267d1a119bc123\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/customers/:customer_id/merge","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["customers",":customer_id","merge"],"variable":[{"key":"customer_id","value":"ca862cc9-de93-46bb-a903-118f585d1b84","description":"Unique customer ID. This can be\n\nThe Antavo unique ID e.g., 280e674c-c4ea-4a30-987a-d9267d1a5018\n\nAn external ID (requires configuration): {external_field:external_id_value}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"OK"},{"id":"831d9f06-5119-4c40-b729-a386702a99db","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"target\": \"a280e674c-de2a-4a30-987a-d9267d1a119bc123\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/customers/:customer_id/merge","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["customers",":customer_id","merge"],"variable":[{"key":"customer_id","value":"ca862cc9-de93-46bb-a903-118f585d1b84"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 160216,\n \"message\": \"Customer is not active\",\n \"type\": \"BadRequestException\"\n }\n}"}],"_postman_id":"d9af67c0-6521-440b-90a8-44394933595e"},{"name":"Retrieve the number of active customers","event":[{"listen":"prerequest","script":{"id":"24aa6f5c-6d10-48e8-bb08-03c8d62816cd","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c479b33a-02b0-460f-980b-8bc07caf8c6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/customers/-/count","description":"This endpoint returns the number of customers with active status within Antavo.
\n","urlObject":{"protocol":"https","path":["customers","-","count"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"aee11b20-0afe-4c71-a8fd-1324c3edbbe1","name":"Successful customer search","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/customers/-/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"active\": 1134\n}"}],"_postman_id":"c479b33a-02b0-460f-980b-8bc07caf8c6d"}],"id":"1cc55b94-717d-4a3e-9bba-e1a6b4224eed","description":"The Customer API allows for comprehensive management and querying of customer data within Antavo. With these APIs, you can search for customers using their information, retrieve detailed customer data by customer ID, merge customers, and count the number of active customers in the loyalty program.
\nBy default, these API endpoints focus on active customers, but inactive customers can be included by enabling the option in the Antavo Management UI. Navigate to the Customer settings under the Settings menu.
\nEndpoints using a customer_id can also be accessed using external IDs by replacing customer_id with the appropriate external_field:external_customer_id, provided the external field is tagged as external_id in the Antavo Management UI.
\nAll Customer API requests must be signed. To comply with GDPR standards, searches for opted-out customers will return empty search results as Antavo does not retain any customer identifiers upon unenrollment.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"5a214070-5abe-4f2f-b2ba-ad0da5087f3e"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"0d036cbd-19c2-4074-b27f-b22027880993"}}],"_postman_id":"1cc55b94-717d-4a3e-9bba-e1a6b4224eed"},{"name":"Coupons API","item":[{"name":"Query coupons independent of customer","event":[{"listen":"prerequest","script":{"id":"21f208ba-a270-4ac0-9eba-db39dd111c00","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"fe6668aa-4496-484a-b1e8-08041806ec00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/coupons?code=&status=&limit=&page=","description":"Use this endpoint to query coupons within Antavo independently of customer data.
\n","urlObject":{"protocol":"https","path":["coupons"],"host":["api","{{environment}}","antavo","com"],"query":[{"description":{"content":"The code used to search for a specific coupon.
\n","type":"text/plain"},"key":"code","value":""},{"description":{"content":"The status of the coupons to search for.\nOptions: claimed, redeemed, invalid, expired, unassigned, partially_redeemed.
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"Limits the number of results to be returned in one response.
\nDefaults to 100
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"This parameter gets a specific page of the coupon list if a limit has been set. This is used in pagination in conjunction with the limit query.
\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"248835fd-b262-43e9-a862-2eaf5382075b","name":"Successful coupon search","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/coupons?code=TC22341","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["coupons"],"query":[{"key":"code","value":"TC22341"},{"key":"status","value":"","disabled":true},{"key":"limit","value":"","disabled":true},{"key":"page","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"code\": \"TC22341\",\n \"name\": \"10% Discount Coupon\",\n \"status\": \"claimed\",\n \"created_at\": \"2024-01-01T00:00:00.000Z\",\n \"customer\": {\n \"id\": \"280e674c-c4ea-4a30-987a-d9267d1a5018\"\n },\n \"claimed_at\": \"2024-01-02T00:00:00.000Z\",\n \"expires_at\": \"2024-12-31T23:59:59.000Z\",\n \"currency\": \"USD\",\n \"type\": \"percentage\",\n \"value\": 100,\n \"balance\": 50,\n \"pool\": \"60b8bec0ce61d7c91b000014\",\n \"min_amount\": 5,\n \"min_redemption_value\": 20,\n \"purchase_threshold\": 100\n },\n {\n \"code\": \"TS34523\",\n \"name\": \"Free Shipping Coupon\",\n \"status\": \"claimed\",\n \"created_at\": \"2021-10-29T11:15:53.000Z\",\n \"customer\": {\n \"id\": \"280e674c-de2a-4a30-987a-d9267d1a119\"\n },\n \"claimed_at\": \"2021-10-29T11:15:53.000Z\",\n \"type\": \"free_shipping\"\n }\n ],\n \"next\": \"/coupons?page=2&limit=0\"\n}"},{"id":"f4528788-0559-4e1d-8c4d-ffac890d8e79","name":"Customer-independent coupon querying endpoint","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/coupons","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["coupons"],"query":[{"key":"code","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"limit","value":"","disabled":true},{"key":"page","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"BadRequestException\",\n \"code\": 160311,\n \"message\": \"Empty search criteria\"\n}"}],"_postman_id":"fe6668aa-4496-484a-b1e8-08041806ec00"}],"id":"8dca261c-dd15-4bba-acd3-fc225f4511a6","description":"The Coupons API facilitates the querying of coupons within Antavo, independent of customer context. This enables searching for coupons based on various criteria such as coupon code and status.
\nPagination is supported through limit and offset parameters.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"5c495fef-7c91-40e9-b286-65b870ea5d8a"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"3ff437e4-cc32-4372-9686-9d98e616db2d"}}],"_postman_id":"8dca261c-dd15-4bba-acd3-fc225f4511a6"},{"name":"Coupon Pools API","item":[{"name":"Create a new coupon pool","event":[{"listen":"prerequest","script":{"id":"03b4dbf7-0376-410c-81e6-d47a44ecb10b","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b36ef7c3-8a27-4b63-bc48-5e54bd082db2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"source\": \"\",\r\n \"type\": \"\",\r\n \"external_id\": \"\",\r\n \"remote_url\": \"\",\r\n \"value\": \"\",\r\n \"minimum_value\": \"\",\r\n \"minimum_redemption_value\": \"\",\r\n \"currency\": \"\",\r\n \"purchase_minimum\": \"\",\r\n \"expiration_time\": \"\",\r\n \"aggregated\": \"\",\r\n \"products\": [\r\n \"\",\r\n \"\"\r\n ],\r\n \"stores\": [\r\n \"\",\r\n \"\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools","description":"This endpoint can be used to create a new coupon pool with the attributes provided in the request body.
\nThe `name`, `source` and `type` attributes in the request body are required. The request body can also include custom attributes (if used).
\n","urlObject":{"protocol":"https","path":["v1","coupon-pools"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"193f1302-ce35-4c7b-bea7-16d8151bf3c7","name":"Coupon pool created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"metadata\": {},\r\n \"payload\": {\r\n \"id\": \"146cb226c3d47e4d6a28176b\",\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n }\r\n}"},{"id":"eb7d89b1-e4f5-4181-b8c1-df17e74d8221","name":"400 - Invalid ID attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"invalidID\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202004,\r\n\t\t\"message\": \"Given id parameter is invalid\"\r\n\t}\r\n}"},{"id":"1c953a77-6f4d-489f-ba48-57ff51fa97c8","name":"400 - Missing source attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202005,\r\n\t\t\"message\": \"The source is required\"\r\n\t}\r\n}"},{"id":"3e749b82-ccf5-464f-bf76-7adbce7ab971","name":"400 - Invalid source attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"test\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202006,\r\n\t\t\"message\": \"Given source parameter is invalid\"\r\n\t}\r\n}"},{"id":"7a2fb6e1-669e-4508-9283-1513a4e61363","name":"400 - Missing name attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202007,\r\n\t\t\"message\": \"The name is required\"\r\n\t}\r\n}"},{"id":"f2bda87b-8eb2-4568-84d2-083df1b45f63","name":"400 - The name attribute must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": 12345,\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202008,\r\n\t\t\"message\": \"The name must be a string\"\r\n\t}\r\n}"},{"id":"a54d3537-3e7c-4ec7-8c23-10ee4bc0f0d5","name":"400 - Missing type attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202009,\r\n\t\t\"message\": \"The type is required\"\r\n\t}\r\n}"},{"id":"6aaf2df3-3fe7-4d67-a30d-9a52a34732f6","name":"400 - The type attribute must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": 12345,\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202010,\r\n\t\t\"message\": \"The type must be a string\"\r\n\t}\r\n}"},{"id":"1b76e037-333c-40dd-91d6-17eb04e6bda4","name":"400 - Invalid type attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"test\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202011,\r\n\t\t\"message\": \"Given type parameter is invalid\"\r\n\t}\r\n}"},{"id":"8b6254ca-2e6b-441c-bd96-79a133631447","name":"400 - The value attribute must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": \"test\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202012,\r\n\t\t\"message\": \"The value must be a number\"\r\n\t}\r\n}"},{"id":"9fd00cd8-1079-4f1d-b6ee-427bccf287cc","name":"400 - The value attribute must be a value with up to 2 decimal places","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.15687,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202013,\r\n\t\t\"message\": \"The value must be a value with up to 2 decimal places\"\r\n\t}\r\n}"},{"id":"5b6babc9-8e41-4612-8265-c38f45a12217","name":"400 - The value attribute must be at least 0.01","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 0,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202014,\r\n\t\t\"message\": \"The value must be at least 0.01\"\r\n\t}\r\n}"},{"id":"ed839229-2f15-4ef5-aa3e-1423a08c2d66","name":"400 - The purchase_minimum must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": \"test\",\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202015,\r\n\t\t\"message\": \"The purchase_minimum must be a number\"\r\n\t}\r\n}"},{"id":"dbb5d69d-fbce-44da-ac3c-d216498fa4a8","name":"400 - The purchase_minimum value must be at least 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 0.5,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202016,\r\n\t\t\"message\": \"The value must be at least 1\"\r\n\t}\r\n}"},{"id":"79ec2f7d-6472-47b2-aa7b-0cd77ca2a2f3","name":"400 - The minimum_value must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": \"test\",\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202017,\r\n\t\t\"message\": \"The minimum_value must be a number\"\r\n\t}\r\n}"},{"id":"a845bb7e-13e8-40e4-b929-628a09f7a9ed","name":"400 - The minimum_value must be at least 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 0.5,\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202018,\r\n\t\t\"message\": \"The minimum_value must be at least 1\"\r\n\t}\r\n}"},{"id":"5eafd508-0056-4565-884d-e73bebcc9417","name":"400 - The minimum_redemption_value must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": \"test\",\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202019,\r\n\t\t\"message\": \"The minimum_redemption_value must be a number\"\r\n\t}\r\n}"},{"id":"fe64251a-10d5-4da0-a97e-b6716f030235","name":"400 - The minimum_redemption_value must be at least 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": 0.5,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202020,\r\n\t\t\"message\": \"The minimum_redemption_value must be at least 1\"\r\n\t}\r\n}"},{"id":"aee81164-628b-4998-a8f8-68b75210ce1e","name":"400 - The currency attribute must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": 12345,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202021,\r\n\t\t\"message\": \"The currency must be a string\"\r\n\t}\r\n}"},{"id":"1efa46e5-2b71-4548-a12b-3c1917dd34b5","name":"400 - The currency attribute must contain letters only","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": \"EUR12345\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202022,\r\n\t\t\"message\": \"The currency must be contain only letters\"\r\n\t}\r\n}"},{"id":"b68d34a8-ecdb-4137-9ace-21483f0d8222","name":"400 - The expiration_time must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": 12345,\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202023,\r\n\t\t\"message\": \"The expiration_time must be a string\"\r\n\t}\r\n}"},{"id":"1b85243a-f346-47d4-8876-ffe6de63396f","name":"400 - Invalid expiration_time attribute (1)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"test\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202024,\r\n\t\t\"message\": \"Given expiration_time parameter is invalid\"\r\n\t}\r\n}"},{"id":"fc44f339-5aff-4a13-943e-ce614649f511","name":"400 - Invalid expiration_time attribute (2)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": 12345,\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202025,\r\n\t\t\"message\": \"Given expiration_time parameter is invalid\"\r\n\t}\r\n}"},{"id":"104b79a0-a1f1-41d4-96eb-0767b72210b4","name":"400 - The aggregated attribute must be a boolean","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": 12345,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202026,\r\n\t\t\"message\": \"The aggregated must be a boolean\"\r\n\t}\r\n}"},{"id":"b10e524d-ec3e-4fb7-98ef-a0bec7000caa","name":"400 - The stores attribute must be an array","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": 12345\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202027,\r\n\t\t\"message\": \"The stores must be an array\"\r\n\t}\r\n}"},{"id":"d231683e-5bc5-4ac7-9909-6c37c9656ec4","name":"400 - The stores attribute must include a valid store ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"test\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202028,\r\n\t\t\"message\": \"The stores must be a valid store id\"\r\n\t}\r\n}"},{"id":"ff9cb582-467d-4e72-83d3-fe29302ae4ed","name":"400 - The products attribute must be an array","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": 12345,\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202029,\r\n\t\t\"message\": \"The products must be an array\"\r\n\t}\r\n}"},{"id":"9b6065f2-9381-4c0f-b47d-845317addf77","name":"400 - The external_id must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": 12345,\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202030,\r\n\t\t\"message\": \"The external_id must be a string\"\r\n\t}\r\n}"},{"id":"e11a6829-ff5f-4dc9-8fc8-97398ca0fac2","name":"400 - The external_id must be unique","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"duplicateExternalID\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202031,\r\n\t\t\"message\": \"The external_id must be unique\"\r\n\t}\r\n}"},{"id":"ccb71e7d-c6a6-4c94-aba2-2e9c4d6e0d2f","name":"400 - The external_id must be between 6 and 24 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"abcd\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202032,\r\n\t\t\"message\": \"The external_id must be between 6 and 24 characters\"\r\n\t}\r\n}"},{"id":"a76297a0-1855-46da-ade5-c5082af34c3a","name":"400 - The minimum_value is not allowed for this type of pool","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 2,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202039,\r\n \"message\": \"The minimum_value is not allowed for this type of pool\"\r\n }\r\n}"},{"id":"67a0a3cf-b10c-49eb-8b47-7ef1e96de6ca","name":"400 - The minimum_redemption_value is not allowed for this type of pool","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"minimum_redemption_value\": 2,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202040,\r\n \"message\": \"The minimum_redemption_value is not allowed for this type of pool\"\r\n }\r\n}"},{"id":"506c51e7-44d3-48c1-a77e-bad44b94fb98","name":"400 - The currency is not allowed for this type of pool","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202041,\r\n \"message\": \"The currency is not allowed for this type of pool\"\r\n }\r\n}"}],"_postman_id":"b36ef7c3-8a27-4b63-bc48-5e54bd082db2"},{"name":"Update a coupon pool","event":[{"listen":"prerequest","script":{"id":"13ebed53-c714-4af1-98d4-cc06e3a97702","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"33722933-f6d9-4b08-853a-3481b6444be3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"update_method\": \"\",\r\n \"external_id\": \"\",\r\n \"name\": \"\",\r\n \"source\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\",\r\n \"minimum_value\": \"\",\r\n \"minimum_redemption_value\": \"\",\r\n \"currency\": \"\",\r\n \"purchase_minimum\": \"\",\r\n \"expiration_time\": \"\",\r\n \"aggregated\": \"boolean\",\r\n \"products\": [\r\n \"\",\r\n \"\"\r\n ],\r\n \"stores\": [\r\n \"\",\r\n \"\"\r\n ],\r\n \"update_matching\": \"boolean\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","description":"This endpoint can be used to update a coupon pool with the attributes provided in the request body.
\nThe `update_method` parameter in the request body is required. The request body can also include custom attributes (if used).
\n","urlObject":{"protocol":"https","path":["v1","coupon-pools",":coupon_pool_id","update"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the coupon pool to update which can be:
\n\nthe ID of the coupon pool (pool_id) \na unique external attribute used to identify the coupon pool (external_id) \n \n","type":"text/plain"},"type":"any","value":"","key":"coupon_pool_id"}]}},"response":[{"id":"7aa5e0f0-6fa9-443b-9cf1-a01bf93b4d79","name":"Coupon pool updated successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"metadata\": {\r\n \"update_method\": \"update_none\",\r\n \"update_matching\": false\r\n },\r\n \"payload\": {\r\n \"id\": \"146cb226c3d47e4d6a28176b\",\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n }\r\n}"},{"id":"0b31b730-1772-42fc-a5ec-706f4d406648","name":"404 - Coupon pool not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"invalidCouponPoolId","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"NotFoundException\",\r\n \"code\": 202001,\r\n \"message\": \"Coupon Pool not found\"\r\n }\r\n}"},{"id":"24f7e63f-782a-4c48-8a3d-81b00f867253","name":"400 - Invalid source attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"test\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202006,\r\n\t\t\"message\": \"Given source parameter is invalid\"\r\n\t}\r\n}"},{"id":"02d64d21-dd5c-4ef4-9652-ec4e85869a47","name":"400 - The name attribute must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": 12345,\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202008,\r\n\t\t\"message\": \"The name must be a string\"\r\n\t}\r\n}"},{"id":"b01b2328-ca3b-4a0f-bd0f-6aca27cff97f","name":"400 - The type attribute must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": 12345,\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202010,\r\n\t\t\"message\": \"The type must be a string\"\r\n\t}\r\n}"},{"id":"6bfb35d7-40e9-478a-aae0-999c110dd018","name":"400 - Invalid type attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"test\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202011,\r\n\t\t\"message\": \"Given type parameter is invalid\"\r\n\t}\r\n}"},{"id":"5ccf807b-1bc4-49b6-84cd-aa25438b30b7","name":"400 - The value attribute must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": \"test\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202012,\r\n\t\t\"message\": \"The value must be a number\"\r\n\t}\r\n}"},{"id":"06adce44-cce3-4cb1-b350-bffff2fb4510","name":"400 - The value attribute must be a value with up to 2 decimal places","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.15687,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202013,\r\n\t\t\"message\": \"The value must be a value with up to 2 decimal places\"\r\n\t}\r\n}"},{"id":"aee63d11-c285-4a4a-b279-8d865c303520","name":"400 - The value attribute must be at least 0.01","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 0,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202014,\r\n\t\t\"message\": \"The value must be at least 0.01\"\r\n\t}\r\n}"},{"id":"cadd0427-8713-4f7c-aefd-8c3844cb4416","name":"400 - The purchase_minimum must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": \"test\",\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202015,\r\n\t\t\"message\": \"The purchase_minimum must be a number\"\r\n\t}\r\n}"},{"id":"50f6cc3d-cde2-43ad-b999-572e5ecc6893","name":"400 - The purchase_minimum value must be at least 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 0.5,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202016,\r\n\t\t\"message\": \"The value must be at least 1\"\r\n\t}\r\n}"},{"id":"d3ec65b9-c248-4fa1-8cf3-1bafb6f4212f","name":"400 - The minimum_value must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": \"test\",\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176c","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202017,\r\n\t\t\"message\": \"The minimum_value must be a number\"\r\n\t}\r\n}"},{"id":"1e383502-e4bc-4454-a933-4cd2682df0cf","name":"400 - The minimum_value must be at least 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 0.5,\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176c","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202018,\r\n\t\t\"message\": \"The minimum_value must be at least 1\"\r\n\t}\r\n}"},{"id":"4a48b771-6425-405c-a7f3-0da39a34e6d6","name":"400 - The minimum_redemption_value must be a number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": \"test\",\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176c","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202019,\r\n\t\t\"message\": \"The minimum_redemption_value must be a number\"\r\n\t}\r\n}"},{"id":"77a220ce-e141-42f5-9709-1260303c5b16","name":"400 - The minimum_redemption_value must be at least 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": 0.5,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176c","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202020,\r\n\t\t\"message\": \"The minimum_redemption_value must be at least 1\"\r\n\t}\r\n}"},{"id":"8f4d6a51-e307-4bfb-baf4-79656997d1cf","name":"400 - The currency attribute must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": 12345,\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176c","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202021,\r\n\t\t\"message\": \"The currency must be a string\"\r\n\t}\r\n}"},{"id":"1b31e53d-ab3c-4c9d-a07f-598aa819e1d4","name":"400 - The currency attribute must contain letters only","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New gift_card coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"gift_card\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 1,\r\n \"minimum_redemption_value\": 1,\r\n \"currency\": \"EUR12345\",\r\n \"purchase_minimum\": 2,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176c","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202022,\r\n\t\t\"message\": \"The currency must be contain only letters\"\r\n\t}\r\n}"},{"id":"d90ece34-cd49-4e03-98f7-e7f3c73c938d","name":"400 - The expiration_time must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": 12345,\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202023,\r\n\t\t\"message\": \"The expiration_time must be a string\"\r\n\t}\r\n}"},{"id":"6ecf33c8-d69c-454c-9667-67ef4739b45d","name":"400 - Invalid expiration_time attribute (1)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"test\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202024,\r\n\t\t\"message\": \"Given expiration_time parameter is invalid\"\r\n\t}\r\n}"},{"id":"8dda56ce-2056-43e5-b8d6-92ced38513d0","name":"400 - Invalid expiration_time attribute (2)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": 12345,\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202025,\r\n\t\t\"message\": \"Given expiration_time parameter is invalid\"\r\n\t}\r\n}"},{"id":"245d90d1-f7eb-43f4-824e-b1a3064d0306","name":"400 - The aggregated attribute must be a boolean","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": 12345,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202026,\r\n\t\t\"message\": \"The aggregated must be a boolean\"\r\n\t}\r\n}"},{"id":"536280a0-0b41-4a1a-947e-f0ffa0e27ac3","name":"400 - The stores attribute must be an array","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": 12345,\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202027,\r\n\t\t\"message\": \"The stores must be an array\"\r\n\t}\r\n}"},{"id":"da32f00b-3ffb-4922-8fb6-cecab3b0e922","name":"400 - The stores attribute must include a valid store ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"test\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202028,\r\n\t\t\"message\": \"The stores must be a valid store id\"\r\n\t}\r\n}"},{"id":"e99158d8-a47d-4506-aa16-c49e7e246c84","name":"400 - The products attribute must be an array","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": 12345,\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202029,\r\n\t\t\"message\": \"The products must be an array\"\r\n\t}\r\n}"},{"id":"b5039cbb-63ae-480f-930a-ab20b568053c","name":"400 - The external_id must be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": 12345,\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202030,\r\n\t\t\"message\": \"The external_id must be a string\"\r\n\t}\r\n}"},{"id":"e3ce759e-6e11-4c6b-9a3e-e0e4cba34e0a","name":"400 - The external_id must be unique","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"duplicateExternalID\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202031,\r\n\t\t\"message\": \"The external_id must be unique\"\r\n\t}\r\n}"},{"id":"816ca41a-c483-401e-9688-833d202c800c","name":"400 - The external_id must be between 6 and 24 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"abcd\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"status\": \"error\",\r\n\t\"error\": {\r\n\t\t\"type\": \"BadRequestException\",\r\n\t\t\"code\": 202032,\r\n\t\t\"message\": \"The external_id must be between 6 and 24 characters\"\r\n\t}\r\n}"},{"id":"3d29364b-f6ac-4544-8cbb-b0efc55047a0","name":"400 - Missing update_method","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202033,\r\n \"message\": \"The update_method is required\"\r\n }\r\n}"},{"id":"c68449ca-b6c3-46af-8013-eeb6a600cc75","name":"400 - The update_method bust be a string","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": 12345\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202034,\r\n \"message\": \"The update_method must be a string\"\r\n }\r\n}"},{"id":"324db9e0-488c-4b61-8cf6-2052d962c3ec","name":"400 - Invalid update_method attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202035,\r\n \"message\": \"Given update_method parameter is invalid\"\r\n }\r\n}"},{"id":"fe10165a-520b-499f-9098-7a9cff9dad12","name":"400 - The update_matching must be a boolean","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\",\r\n \"update_matching\": 12345\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202038,\r\n \"message\": \"The update_matching must be a boolean\"\r\n }\r\n}"},{"id":"78b82de3-ceb1-421f-a404-683a8f00c699","name":"400 - The minimum_value is not allowed for this type of pool","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"minimum_value\": 2,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202039,\r\n \"message\": \"The minimum_value is not allowed for this type of pool\"\r\n }\r\n}"},{"id":"1ea7c619-a8ca-4ba0-a835-334a46c820db","name":"400 - The minimum_redemption_value is not allowed for this type of pool","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"minimum_redemption_value\": 2,\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202040,\r\n \"message\": \"The minimum_redemption_value is not allowed for this type of pool\"\r\n }\r\n}"},{"id":"81bcd4d3-9e42-4ff5-ac99-ccdc7e171608","name":"400 - The currency is not allowed for this type of pool","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"uniqueExternalId\",\r\n \"name\": \"New coupon pool\",\r\n \"source\": \"uploaded\",\r\n \"type\": \"amount\",\r\n \"value\": 12.1,\r\n \"currency\": \"EUR\",\r\n \"purchase_minimum\": 1,\r\n \"expiration_time\": \"2 months\",\r\n \"aggregated\": false,\r\n \"products\": [\"product1\", \"product2\"],\r\n \"stores\": [\"store1\"],\r\n \"update_method\": \"update_none\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/coupon-pools/:coupon_pool_id/update","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","coupon-pools",":coupon_pool_id","update"],"variable":[{"key":"coupon_pool_id","value":"146cb226c3d47e4d6a28176b","description":"(Required) The ID of the coupon pool to update which can be:\n\n- the ID of the coupon pool (`pool_id`)\n- a unique external attribute used to identify the coupon pool (`external_id`)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"error\",\r\n \"error\": {\r\n \"type\": \"BadRequestException\",\r\n \"code\": 202041,\r\n \"message\": \"The currency is not allowed for this type of pool\"\r\n }\r\n}"}],"_postman_id":"33722933-f6d9-4b08-853a-3481b6444be3"}],"id":"83532170-a246-4bfc-be5b-42990916d0ef","description":"The Coupon Pool API allows users to create and manage coupon pools effectively. Coupon pools serve as containers that define the characteristics of individual coupons, including their value, code patterns, expiration dates, and other relevant attributes. This API is designed for developers who want to integrate coupon pool functionalities into their applications, facilitating the management of various promotional offers within a cohesive structure.
\nKey Features \n\nCreate a new Coupon Pool POST /v1/coupon-pools endpoint to implement this feature. A request body should be sent containing required attributes such as name, source, type, and optional attributes like products and stores.
\nUpdate an existing Coupon Pool POST /v1/coupon-pools/{coupon_pool_id}/update endpoint. The coupon_pool_id should be provided in the URL, along with a request body containing the updated attributes, including the required update_method.
\n \n","_postman_id":"83532170-a246-4bfc-be5b-42990916d0ef"},{"name":"Leaderboard API (deprecated)","item":[{"name":"List best-performing customers","event":[{"listen":"prerequest","script":{"id":"3ef256cd-d708-4ed3-a924-98d35a49a7cc","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"6df7ae8a-c6bf-4631-9dac-55d0b414f946","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/customers/leaderboard?limit=","description":"The Leaderboard API allows you to retrieve rankings and scores of customers based on various metrics within the Antavo Loyalty Cloud.
\n","urlObject":{"protocol":"https","path":["customers","leaderboard"],"host":["api","{{environment}}","antavo","com"],"query":[{"description":{"content":"The number of results to return. Values outside the acceptable range will be adjusted to the nearest boundary value.
\n1 to 100\nDefaults to 20
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"1c11c174-2ef4-46be-9297-365412937b3b","name":"Customer leaderboard data","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/customers/leaderboard?limit=2","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["customers","leaderboard"],"query":[{"key":"limit","value":"2","description":"The number of results to return. Values outside the acceptable range will be adjusted to the nearest boundary value.\n\n1 to 100\nDefaults to 20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"handler\": \"john_doe\",\n \"image_url\": \"https://example.com/avatar.jpg\",\n \"score\": 1500\n },\n {\n \"id\": \"ca862cc9-de93-46bb-a903-118f585d1b84\",\n \"handler\": \"sarah_doe\",\n \"image_url\": \"https://example.com/avatar.jpg\",\n \"score\": 1300\n }\n ]\n ]\n}"}],"_postman_id":"6df7ae8a-c6bf-4631-9dac-55d0b414f946"}],"id":"c9fbc5e5-0956-48ce-89a1-8108fe6dc454","description":"The Leaderboard API allows you to retrieve rankings and scores based on various metrics within the Antavo Loyalty Engine. This API provides a way to showcase top performers, track progress, and foster competition among participants in your loyalty program.
\nA valid request returns an array of customer representations without including any personally identifiable information (PII) of the customers.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"16436e0c-eacb-40f4-ace3-f97a8b221ac7"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2ad84aad-fb2b-4ebf-97e9-db34fb62def1"}}],"_postman_id":"c9fbc5e5-0956-48ce-89a1-8108fe6dc454"},{"name":"FAQ API","item":[{"name":"List FAQ entries","event":[{"listen":"prerequest","script":{"id":"c71b977f-8a73-4310-8042-1cabd692dfe2","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"30117149-6740-412f-9b82-26220daa05cd","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d4e37b5d-94c0-4c9f-a5ba-b48e9a26678b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/faq","description":"The FAQ API provides access to the questions and answers configured and managed in the Antavo FAQ module. A valid request returns an array of FAQ entries, ensuring no personally identifiable data of customers is included.
\n","urlObject":{"protocol":"https","path":["faq"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"b2715a64-8992-403a-aee2-2ed3f74fce48","name":"FAQ data","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/faq"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"title\": \"How to use points?\",\n \"description\": \"Points can be used to redeem rewards.\"\n },\n {\n \"title\": \"How to earn points?\",\n \"description\": \"Complete the challenges. Visit the Challenges tab to find out more.\"\n }\n ]\n}"},{"id":"5d6fffee-e83e-4f08-9605-e43a2397fc18","name":"FAQ module not activated","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/faq"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"NotFoundException\",\n \"code\": 0,\n \"message\": \"Not Found\"\n}"}],"_postman_id":"d4e37b5d-94c0-4c9f-a5ba-b48e9a26678b"}],"id":"d24f25bb-040a-4740-92a3-813a128c6c71","description":"The FAQ API provides access to the questions and answers configured and managed in the Antavo FAQ module . A valid request returns an array of FAQ entries, ensuring no personally identifiable data of customers is included.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"94460248-2c08-4833-a1a6-f1a3dc6b7634"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"0c7369cd-2891-4f24-bc2b-d4adced3636b"}}],"_postman_id":"d24f25bb-040a-4740-92a3-813a128c6c71"},{"name":"Points Preview API","item":[{"name":"Preview loyalty points based on submitted transaction data","event":[{"listen":"prerequest","script":{"id":"2bc895d1-4ec8-4d91-b1b1-10168788adfa","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4634a693-6c19-4a30-a2c7-b1d3e8dd585a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": \"\",\n \"action\": \"\",\n \"data\": {\n \"transaction_id\": \"\",\n \"total\": \"\",\n \"items\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"product_url\": \"\",\n \"price\": \"\",\n \"discount\": \"\",\n \"quantity\": \"\",\n \"subtotal\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"product_url\": \"\",\n \"price\": \"\",\n \"discount\": \"\",\n \"quantity\": \"\",\n \"subtotal\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/extensions/automation/campaign-bonus","description":"The Points Preview API enables querying before purchase to retrieve points awarded for purchases. The returned response includes the number of bonus points to be awarded by
\nCampaign bonus
\ncampaign workflow nodes.
\nThis endpoint works with standard and multi-account configurations.
\nBody param descriptions
\n\n*required
\n","urlObject":{"protocol":"https","path":["extensions","automation","campaign-bonus"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"75e47fc1-c297-44ca-935c-7c1b2af5cff9","name":"A successful points probe submission","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"items\": [\n {\n \"product_id\": \"prd_987654\",\n \"product_name\": \"Vintage Leather Jacket\",\n \"product_url\": \"https://example.com/products/vintage-leather-jacket\",\n \"price\": 12.23,\n \"discount\": 1.23,\n \"quantity\": 3,\n \"subtotal\": 33\n }\n ],\n \"total\": 23,\n \"transaction_id\": \"TR37882412\"\n },\n \"customer\": \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"action\": \"checkout\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/extensions/automation/campaign-bonus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"campaigns\": [\n {\n \"automation\": \"5b9bd24f90a963a4088b456c\",\n \"points\": 400,\n \"campaign\": {\n \"id\": \"63ac25de017f8306f5782e8c\",\n \"name\": \"Double points campaign\",\n \"issued_points\": 462320,\n \"customer_points\": 0\n }\n }\n ],\n \"purchase\": {\n \"base\": 724,\n \"bonus\": 400,\n \"points\": 1124\n }\n }\n}"},{"id":"49acf29c-92e6-4d97-a340-d34962e35ba0","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"items\": [\n {\n \"product_id\": \"prd_987654\",\n \"product_name\": \"Vintage Leather Jacket\",\n \"product_url\": \"https://example.com/products/vintage-leather-jacket\",\n \"price\": 12.23,\n \"discount\": 1.23,\n \"quantity\": 3,\n \"subtotal\": 33\n }\n ],\n \"total\": 23,\n \"transaction_id\": \"TR37882412\"\n },\n \"action\": \"checkout\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/extensions/automation/campaign-bonus"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"error\": \"Property customer cannot be empty\",\n \"type\": \"BadRequestException\"\n}"}],"_postman_id":"4634a693-6c19-4a30-a2c7-b1d3e8dd585a"}],"id":"f3ecd6a4-88cf-49af-afa2-9682fb165643","description":"The Points preview API enables pre-purchase queries to retrieve the points awarded for a purchase. This feature is ideal for providing customers with real-time information on potential point earnings. It calculates the total points for the entire cart, including points assigned by Campaign bonus workflow nodes.
\nThe API predicts loyalty points based on submitted transaction data. Unlike the Events API, which awards points to customers, the Points Preview API returns information about potential points earned for the purchase, including workflow bonus points.
\nNote that this API is only available if the Workflows module is enabled in your workspace.
\n","_postman_id":"f3ecd6a4-88cf-49af-afa2-9682fb165643"},{"name":"Offers API","item":[{"name":"List customer-specific offers","event":[{"listen":"prerequest","script":{"id":"969bac7d-4dbe-4dd4-b562-6399e015a27d","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7391802d-d6b6-48da-9303-073f5480dfef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"total\": \"\",\n \"items\": [\n {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discount\": \"\",\n \"subtotal\": \"\"\n },\n {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"discount\": \"\",\n \"subtotal\": \"\"\n }\n ],\n \"discount\": \"\",\n \"shipping\": \"\"\n },\n \"customer\": \"\",\n \"store\": \"\",\n \"eligible_only\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/offers/","description":"This API endpoint is used to submit the contents of a cart and receive any available offers on the products within.
\nBody param descriptions
\n\ncart*: The intended purchase items, recorded in the same format as an Antavo checkout event.
\n\ntotal*: The total value of the customer's cart including all items.
\nitems*: Array of product objects.
\n\nproduct_id*: Product ID or SKU.
\nquantity*: Number of items purchased.
\nprice: Unit price of the item.
\ndiscount: Product discount value for given quantity.
\nsubtotal: Product subtotal: price x quantity - discount
\n \ndiscount: Cart discount, aready subtracted from total.
\nshipping: Shipping fee, already subtracted from total.
\n \ncustomer*: The Antavo ID of the customer. This is used to determine customer eligibility. Providing a valid attribute will result in the return of possible loyalty and non-loyalty offers.
\nstore: The Antavo ID of the store. This may result in store-specific offers if configured.
\neligible_only: Restricts the returned offers to those available to the customer based on the current context (cart, customer, date, etc.). Default to true.
\n \n*required
\n","urlObject":{"protocol":"https","path":["offers",""],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"b6ee3a8c-a842-4a82-9f1a-57b5287709b3","name":"Successful cart submission","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"items\": [\n {\n \"product_id\": \"prd_987654\",\n \"quantity\": 2,\n \"price\": 10,\n \"discount\": 1,\n \"subtotal\": 18\n }\n ],\n \"total\": 22.22,\n \"discount\": 2.22,\n \"shipping\": 4.44\n },\n \"eligible_only\": true,\n \"customer\": \"9f3c82d6-288e-4361-aec0-039eb066a334\",\n \"store\": \"3044\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/offers/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"offer_12345\",\n \"name\": \"10% off\",\n \"type\": \"cart\",\n \"weight\": 1,\n \"min_total\": 20,\n \"max_total\": 100,\n \"required_match\": \"any\",\n \"required_items\": [\n {\n \"type\": \"product\",\n \"id\": \"prd_987654\",\n \"name\": \"Vintage Leather Jacket\",\n \"min_quantity\": \"1\"\n }\n ],\n \"eligible_match\": \"all\",\n \"eligible_items\": [\n {\n \"type\": \"product\",\n \"id\": \"prd_987654\",\n \"name\": \"Classic Denim Jeans\",\n \"min_quantity\": \"1\"\n }\n ],\n \"discount\": {\n \"type\": \"percent_discount\",\n \"value\": 10\n },\n \"is_exclusive\": true,\n \"is_eligible\": true,\n \"card_title\": \"10% Discount\",\n \"card_description\": \"Get 10% off on your purchase\"\n }\n ],\n \"eligible_only\": true,\n \"customer\": {\n \"id\": \"9f3c82d6-288e-4361-aec0-039eb066a334\"\n },\n \"cart\": {\n \"total\": 22.22,\n \"items\": [\n {\n \"product_id\": \"prd_987654\",\n \"quantity\": 2,\n \"price\": 10,\n \"discount\": 1,\n \"subtotal\": 18\n }\n ],\n \"discount\": 2.11,\n \"shipping\": 4.44\n }\n}"},{"id":"2c57457b-35fe-4bce-9e9e-11bf0a711a24","name":"Missing required parameter - customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"items\": [\n {\n \"product_id\": \"prd_987654\",\n \"quantity\": 2,\n \"price\": 10,\n \"discount\": 1,\n \"subtotal\": 18\n }\n ],\n \"total\": 22.22,\n \"discount\": 2.22,\n \"shipping\": 4.44\n },\n \"eligible_only\": true,\n \"store\": \"3044\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/offers/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"Missing required parameter ‘customer’\"\n}"}],"_postman_id":"7391802d-d6b6-48da-9303-073f5480dfef"}],"id":"22efdfbb-c0ef-46e6-b0fb-b11225099837","description":"The Offers API retrieves available offers configured in the Offers module on the Management UI within the Antavo Loyalty Engine.
\nThis API provides access to detailed information about various offers, designed to attract new customers, encourage upselling and cross-selling, and foster engagement with existing customers. Offers can be applied across in-store, online, and mobile channels and tailored to specific customer segments, time periods, and tiers.
\nIn contrast, rewards are post-purchase benefits provided after a purchase is made. Offers and rewards complement each other, providing incentives at various points of the transaction lifecycle.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"c8bf2590-f8bc-4620-9645-f81bed7afc31"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"6f2536a1-0862-45b5-9d1c-870d7257e803"}}],"_postman_id":"22efdfbb-c0ef-46e6-b0fb-b11225099837"},{"name":"Rewards API","item":[{"name":"List reward items","event":[{"listen":"prerequest","script":{"id":"c91e3cab-e923-48e1-a064-1d1dd9f653a8","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f025910e-019f-49bc-a0d2-f77a4abfc221","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/rewards?limit=&page=&min_price=&max_price=&customer=&external_id=","description":"This endpoint returns a list of available rewards based on various query parameters.
\n","urlObject":{"protocol":"https","path":["rewards"],"host":["api","{{environment}}","antavo","com"],"query":[{"description":{"content":"Limits the number of rewards returned per page.
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"This parameter gets a specific page of the reward list if a limit has been set.
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Lower point limit for returned eligible rewards.
\n","type":"text/plain"},"key":"min_price","value":""},{"description":{"content":"Upper point limit for returned eligible rewards.
\n","type":"text/plain"},"key":"max_price","value":""},{"description":{"content":"An Antavo-recognized unique customer identifier.
\n","type":"text/plain"},"key":"customer","value":""},{"description":{"content":"External ID (requires configuration)
\n","type":"text/plain"},"key":"external_id","value":""}],"variable":[]}},"response":[{"id":"a9d01dfd-5ecc-4427-bcff-6178deb8ce3a","name":"Available rewards","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/rewards?max_price=500","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["rewards"],"query":[{"key":"limit","value":"","disabled":true},{"key":"page","value":"","disabled":true},{"key":"min_price","value":"","disabled":true},{"key":"max_price","value":"500"},{"key":"customer","value":"","disabled":true},{"key":"external_id","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"63dcb7736123782ba6336425\",\n \"name\": \"10% Discount.\",\n \"category\": \"discounts\",\n \"price\": 500,\n \"description\": \"Enjoy 10% off on any item of the Winter Collection.\",\n \"image_url\": \"https://example.com/reward.jpg\"\n }\n ]\n}"},{"id":"25843ed1-4711-460b-9062-f8727c37104a","name":"Reward not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/rewards?external_id=22360112","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["rewards"],"query":[{"key":"limit","value":"","disabled":true},{"key":"page","value":"","disabled":true},{"key":"min_price","value":"","disabled":true},{"key":"max_price","value":"","disabled":true},{"key":"customer","value":"","disabled":true},{"key":"external_id","value":"22360112"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"type\": \"NotFoundException\",\n \"message\": \"Reward not found\"\n}"}],"_postman_id":"f025910e-019f-49bc-a0d2-f77a4abfc221"},{"name":"Retrieve reward-specific information","event":[{"listen":"prerequest","script":{"id":"4490a91a-1d43-42ee-8658-310d09331ecb","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"46961736-3578-471d-9c89-b4f77d45459c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/rewards/:reward_id","urlObject":{"protocol":"https","path":["rewards",":reward_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The unique ID of the reward.
\n","type":"text/plain"},"type":"any","value":"","key":"reward_id"}]}},"response":[{"id":"5dcb0755-9fa8-4e25-9a89-63d34fd5a4d5","name":"Reward data JSON object","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/rewards/:reward_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["rewards",":reward_id"],"variable":[{"key":"reward_id","value":"63dcb7736123782ba6336425"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"63dcb7736123782ba6336425\",\n \"name\": {\n \"en\": \"%15 off\"\n },\n \"description\": {\n \"en\": \"Enjoy 10% off on any item of the Winter Collection that you purchase at our store.\"\n },\n \"category\": \"\",\n \"price\": {\n \"EUR\": 100,\n \"USD\": 100,\n \"JPY\": 100,\n \"GBP\": 100\n },\n \"point_source\": \"customer\",\n \"image_url\": \"https://example.com/image_url.png\",\n}"},{"id":"7398a7aa-8274-4c3f-8e77-cad38353eaee","name":"Returned error object","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/rewards/:reward_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["rewards",":reward_id"],"variable":[{"key":"reward_id","value":"21f4adbd3750e2be288fbadc4"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"NotFoundException\",\n \"code\": 0,\n \"message\": \"Reward not found\"\n }\n}"}],"_postman_id":"46961736-3578-471d-9c89-b4f77d45459c"},{"name":"Claim a specific reward (deprecated)","event":[{"listen":"prerequest","script":{"id":"978bef5a-a95a-4cdd-a236-585c04f7115c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"66687c5e-f63f-42d8-a81c-dafacf16518d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": \"\",\n \"external_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/rewards/:reward_id/claim","description":"DEPRECATED endpoint
\nThis endpoint was used to register that a customer has claimed a specific reward.This endpoint is not supported anymore. Please use the reward endpoint of the Display API.
\nBody parameter desctiptions
\n\n_required
\n","urlObject":{"protocol":"https","path":["rewards",":reward_id","claim"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The unique ID of the reward.
\n","type":"text/plain"},"type":"any","value":"","key":"reward_id"}]}},"response":[{"id":"92976c86-d848-4166-b85b-afcff7fe926c","name":"Reward data JSON object","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"external_id\": \"CL003322913\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/rewards/:reward_id/claim","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["rewards",":reward_id","claim"],"variable":[{"key":"reward_id","value":"63dcb7736123782ba6336425"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"spent\": 100,\n \"coupon\": {\n \"code\": \"TC22341\",\n \"type\": \"percentage\"\n }\n}"},{"id":"53cb4659-b8c0-4c52-b7d8-6a2d7aae8c44","name":"Not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": \"9c4e6f0d-4a6b-4e91-8c1a-bb3de9f88e32\",\n \"external_id\": \"CL003322913\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/rewards/:reward_id/claim","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["rewards",":reward_id","claim"],"variable":[{"key":"reward_id","value":"63dcb7736123782ba6336425"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"type\": \"NotFoundException\",\n \"message\": \"Not found\"\n}"}],"_postman_id":"66687c5e-f63f-42d8-a81c-dafacf16518d"}],"id":"89576a0b-eb7b-45a4-86a6-4ee6a2f6ceec","description":"This API will be deprecated soon.
\nPlease use the reward section of the Display API .
\nThe Rewards API can be used to query information about various types of rewards, including coupons, gift cards, physical items, bidding rewards, and custom rewards available in the loyalty program. This API provides detailed data on each reward type, helping to manage and utilize rewards effectively within the Antavo Loyalty Engine.
\n","_postman_id":"89576a0b-eb7b-45a4-86a6-4ee6a2f6ceec"},{"name":"Entitites API","item":[{"name":"Generic","item":[{"name":"List all available entity of an entity module","event":[{"listen":"prerequest","script":{"id":"95bc16b3-97f0-45e7-956d-9124552e782c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"506f582a-526a-4aa9-a793-bfe0482f698f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/:module/:entity","description":"This endpoint lists all available entity items within the specified entity module. This interaction is customer-independent.
\n","urlObject":{"protocol":"https","path":["entities",":module",":entity"],"host":["api","{{environment}}","antavo","com"],"query":[{"disabled":true,"description":{"content":"Offsets the starting number of entity items to return. This is used in pagination in conjunction with the limit query.
\nMust be ≥ 0\nDefaults to 0
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Limits the number of entity items to be returned in one response. Other values are accessible by pagination made accessible via the offset.
\nMust be ≥ 0\nDefaults to 100
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Custom queries can be added here.
\n","type":"text/plain"},"key":"","value":""}],"variable":[{"description":{"content":"(Required) Name of the entity module e.g., rewards, accounts, custom (for custom entities).
\n","type":"text/plain"},"type":"any","value":"","key":"module"},{"description":{"content":"(Required) The entity's unique ID - typically the singular form of the entity module name.
\n","type":"text/plain"},"type":"any","value":"","key":"entity"}]}},"response":[{"id":"28eefb9b-35de-48ae-8394-da820a77678b","name":"Lists all entities - Example data is based on a profiling flow entity.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity"],"query":[{"key":"","value":"","description":"\nCustom queries can be added here.\n","disabled":true}],"variable":[{"key":"module","value":"profiling"},{"key":"entity","value":"flow"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"63d8d8cc17572c6ec15e688c\",\n \"name\": {\n \"en\": \"Product preferences\"\n },\n \"description\": {\n \"en\": \"Interactive flow capturing preferences through fun, interactive steps.\"\n },\n \"media\": {\n \"id\": \"63d8d8cc17572c6ec15e688a\",\n \"mime_type\": \"image/png\",\n \"url\": \"https://antavo.example.com\",\n \"image_urls\": {\n \"l\": \"https://antavo.example.com\",\n \"m\": \"https://antavo.example.com\",\n \"s\": \"https://antavo.example.com\",\n \"xs\": \"https://antavo.example.com\"\n }\n },\n \"status\": \"active\",\n \"stage\": {\n \"id\": \"\",\n \"question\": \"6644de7e0404c52b512f2be8\",\n \"outputs\": {\n \"_default\": {\n \"question\": \"6644df66e95cbe2c3e4bdc8a\",\n \"outputs\": []\n }\n }\n }\n },\n {\n \"id\": \"63d8df3a843936367a125eab\",\n \"name\": {\n \"en\": \"Tell a bit more about yourself!\"\n },\n \"description\": {\n \"en\": \"Let's get to know each other better.\"\n },\n \"media\": {\n \"id\": \"63d8df38843936367a125ea7\",\n \"mime_type\": \"image/png\",\n \"url\": \"https://antavo.example.com\",\n \"image_urls\": {\n \"l\": \"https://antavo.example.com\",\n \"m\": \"https://antavo.example.com\",\n \"s\": \"https://antavo.example.com\",\n \"xs\": \"https://antavo.example.com\"\n }\n },\n \"status\": \"inactive\"\n }\n ]\n}"},{"id":"f1e6ef6d-3ea2-4d78-9e40-112fe64aecb6","name":"Bad request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity?=","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity"],"query":[{"key":"","value":""}],"variable":[{"key":"module","value":"exams"},{"key":"entity","value":"test_level1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"BadRequestException\",\n \"message\": \"Entity type does not exist\",\n \"code\": 350300\n}"}],"_postman_id":"506f582a-526a-4aa9-a793-bfe0482f698f"},{"name":"Create a new entity","event":[{"listen":"prerequest","script":{"id":"de24720e-b79f-4352-8e5a-02b784d8ef9e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"01374aa6-2d6d-491a-a6c9-681226d63568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample Name\",\n \"active\": true,\n \"score\": 42.5,\n \"tags\": [\"tag1\", \"tag2\"],\n \"launchDate\": \"2025-07-09\",\n \"website\": \"https://example.com\",\n \"description\": {\n \"en\": \"English description\",\n \"fr\": \"Description en français\"\n },\n \"image_url\": \"https://antavo.com/test\",\n \"customAttribute1\": \"value1\",\n \"customAttribute2\": 123,\n \"customAttribute3\": [\"item1\", \"item2\"],\n \"...\": \"Any other entity attribute can be included. Available and required attributes depend on the configuration of the entity in the Management UI.\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/:module/:entity","description":"This endpoint created an entity in an entity module. Any parameter can be set as long as there is the corresponding attribute pre-configured in the Management UI.
\n","urlObject":{"protocol":"https","path":["entities",":module",":entity"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) Name of the entity module e.g., rewards, accounts, custom (for custom entities).
\n","type":"text/plain"},"type":"any","value":"","key":"module"},{"description":{"content":"(Required) The entity's unique ID - typically the singular form of the module.
\n","type":"text/plain"},"type":"any","value":"","key":"entity"}]}},"response":[{"id":"54989566-e34e-4817-9339-a037a0ea544d","name":"Successful entity creation - example data is based on a reward entity.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Elegant Evening Gown\",\n \"description\": \"Designed for elegance and comfort, perfect for formal occasions or red-carpet events.\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity"],"variable":[{"key":"module","value":"products"},{"key":"entity","value":"product"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"6757f9db3345ed03870e94a9\"\r\n}"},{"id":"8a4543ee-3740-461d-9b9f-9f2e725c1afd","name":"Bad request - a required attribute is not provided","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Chic Boutique\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity"],"variable":[{"key":"module","value":"stores"},{"key":"entity","value":"store"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"The ID is required and needs to be unique\"\n }\n}"}],"_postman_id":"01374aa6-2d6d-491a-a6c9-681226d63568"},{"name":"Retrieve all information regarding a specific entity","event":[{"listen":"prerequest","script":{"id":"e3980b4e-375d-471f-9119-9618f7339b7e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"806b0772-7d38-4f29-b86d-ad1611a9a464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","description":"This endpoint returns all information regarding a specific entity item.
\n","urlObject":{"protocol":"https","path":["entities",":module",":entity",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[{"disabled":true,"description":{"content":"Any query can be added here to filter results.
\n","type":"text/plain"},"key":"","value":""}],"variable":[{"description":{"content":"(Required) Name of the entity module e.g., rewards, accounts, custom (for custom entities).
\n","type":"text/plain"},"type":"any","value":"","key":"module"},{"description":{"content":"(Required) The entity's unique ID - typically the singular form of the entity module name.
\n","type":"text/plain"},"type":"any","value":"","key":"entity"},{"description":{"content":"(Required) The unique ID of a specific entity.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"fc9a9e7e-922a-485e-ae86-11a0230f67c4","name":"Entity information provided - example data is based on a store entity","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"query":[{"key":"","value":"","description":"Any query can be added here to filter results.","disabled":true}],"variable":[{"key":"module","value":"store"},{"key":"entity","value":"stores"},{"key":"entity_id","value":"FSH-2024-005"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"FSH-2024-005\",\n \"name\": \"004 Dublin\",\n \"currency\": \"EUR\",\n \"country\": \"Ireland\",\n \"county\": \"Dublin\",\n \"state\": \"Leinster\",\n \"zip\": \"0000\",\n \"city\": \"Dublin\",\n \"address\": \"Dublin 004\",\n \"group\": \"Europe stores\",\n \"status\": \"active\",\n \"lat\": 53.3498053,\n \"lng\": -6.2603097\n}"},{"id":"63bef4aa-e56d-4da4-9f4c-d4ec914757b0","name":"Entity not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"query":[{"key":"","value":"","disabled":true}],"variable":[{"key":"module","value":"store"},{"key":"entity","value":"stores"},{"key":"entity_id","value":"FSH-2024-009"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"Entity not found\"\n}"}],"_postman_id":"806b0772-7d38-4f29-b86d-ad1611a9a464"},{"name":"Update a specific entity","event":[{"listen":"prerequest","script":{"id":"c80ed694-f63d-4037-bc9a-a4a00a41cadb","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"75d5b778-ab09-462c-9322-17ed3b5afac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customAttribute1\": \"value1\",\n \"customAttribute2\": 123,\n \"customAttribute3\": [\n \"item1\",\n \"item2\"\n ],\n \"...\": \"Any other entity attribute can be included. Available and required attributes depend on the configuration of the entity in the Management UI.\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","description":"Any pre-configured attribute in an entity item can be modified using this API endpoint. Modification requires the use of attribute's unique ID, set in the Management UI.
\n","urlObject":{"protocol":"https","path":["entities",":module",":entity",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) Name of the entity module e.g., rewards, accounts, custom (for custom entities).
\n","type":"text/plain"},"type":"any","value":"","key":"module"},{"description":{"content":"(Required) The entity's unique ID - typically the singular form of the entity module.
\n","type":"text/plain"},"type":"any","value":"","key":"entity"},{"description":{"content":"(Required) The unique id for the specific entity item.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"978fe10b-112e-417d-a626-cbb86cecac0b","name":"Entity has been successfully updated - example data is based on a reward entity.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Dublin 004\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"variable":[{"key":"module","value":"store"},{"key":"entity","value":"stores"},{"key":"entity_id","value":"004"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"004\",\n \"name\": \"Dublin 004\",\n \"currency\": \"EUR\",\n \"country\": \"Ireland\",\n \"county\": \"Dublin\",\n \"state\": \"Leinster\",\n \"zip\": \"0000\",\n \"city\": \"Dublin\",\n \"address\": \"Dublin 004\",\n \"group\": \"Europe stores\",\n \"status\": \"active\",\n \"lat\": 53.3498053,\n \"lng\": -6.2603097\n}"},{"id":"dbd09b51-e334-481b-8138-e7bcd414a69c","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"live\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"variable":[{"key":"module","value":"store"},{"key":"entity","value":"stores"},{"key":"entity_id","value":"004"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"Status transition is not allowed from active to live\"\n }\n}"}],"_postman_id":"75d5b778-ab09-462c-9322-17ed3b5afac9"},{"name":"Create a new entity with a specific entity ID","event":[{"listen":"prerequest","script":{"id":"eeacb846-fff2-4e65-8ba1-3e56ccd74df0","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"dd872cbe-a699-4389-b762-39a143fee904","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample Name\",\n \"active\": true,\n \"score\": 42.5,\n \"tags\": [\"tag1\", \"tag2\"],\n \"launchDate\": \"2025-07-09\",\n \"website\": \"https://example.com\",\n \"description\": {\n \"en\": \"English description\",\n \"fr\": \"Description en français\"\n },\n \"customAttribute1\": \"value1\",\n \"customAttribute2\": 123,\n \"customAttribute3\": [\"item1\", \"item2\"],\n \"...\": \"Any other entity attribute can be included. Required attributes depend on the configuration of the entity in the Management UI.\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","description":"An entity item with a specified ID can be created in an entity module using this endpoint. Any parameter can be set as long as there is the corresponding attribute pre-configured in the Management UI.
\n","urlObject":{"protocol":"https","path":["entities",":module",":entity",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) Name of the entity module e.g., rewards, accounts, custom (for custom entities).
\n","type":"text/plain"},"type":"any","value":"","key":"module"},{"description":{"content":"(Required) The entity's unique ID - typically the singular form of the entity module.
\n","type":"text/plain"},"type":"any","value":"","key":"entity"},{"description":{"content":"(Required) The unique ID for the new entity.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"3a2e13f5-3365-405b-b47d-0ccf6a01acfd","name":"Successful entity creation - example data is based a product entity.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Elegant Evening Gown\",\n \"description\": \"Designed for elegance and comfort, perfect for formal occasions or red-carpet events.\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"variable":[{"key":"module","value":"products"},{"key":"entity","value":"product"},{"key":"entity_id","value":"FSH-2024-001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"FSH-2024-001\",\n \"name\": \"Elegant Evening Gown\",\n \"description\": \"Designed for elegance and comfort, perfect for formal occasions or red-carpet events.\"\n}"},{"id":"80c06420-4d58-48e8-861c-a26b5ebe43bf","name":"Bad request - Entity type doesn't exist","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Elegant Evening Gown\",\n \"description\": \"Designed for elegance and comfort, perfect for formal occasions or red-carpet events.\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"variable":[{"key":"module","value":"products"},{"key":"entity","value":"item"},{"key":"entity_id","value":"63eaabe8b0fe6815c91425b6"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 350300,\n \"message\": \"Entity type does not exist\"\n }\n}"}],"_postman_id":"dd872cbe-a699-4389-b762-39a143fee904"},{"name":"Archive an inactive entity","event":[{"listen":"prerequest","script":{"id":"2dfd4cd5-d6a2-4bce-9781-76d75b9190c5","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"37d88694-55d8-43d3-9ffd-af57bdacb24c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","description":"This endpoint archives a specific deactivated entity, effectively removing it from the system. The reward will be completely non-visible and inaccessible for member and Management UI users as well.
\n","urlObject":{"protocol":"https","path":["entities",":module",":entity",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) Name of the entity module e.g., rewards, accounts, custom (for custom entities).
\n","type":"text/plain"},"type":"any","value":"","key":"module"},{"description":{"content":"(Required) The entity's unique ID - typically the singular form of the entity module.
\n","type":"text/plain"},"type":"any","value":"","key":"entity"},{"description":{"content":"(Required) The unique ID of a specific entity.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"13071d1e-e88d-4352-8d3a-f22cbdd6bcdc","name":"Entity archived - The example is based on a prize wheel entity.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"variable":[{"key":"module","value":"prize-wheels"},{"key":"entity","value":"wheel"},{"key":"entity_id","value":"63fdccaca88ac11c347af899"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n \"ok\"\n]"},{"id":"d5e4c40d-f2cc-4ea6-844c-1d6f50d47199","name":"Entity not found - The example is based on a prize wheel entity.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/:module/:entity/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities",":module",":entity",":entity_id"],"variable":[{"key":"module","value":"prize-wheels"},{"key":"entity","value":"wheel"},{"key":"entity_id","value":"1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"Entity not found\"\n }\n}"}],"_postman_id":"37d88694-55d8-43d3-9ffd-af57bdacb24c"},{"name":"Submit entities in bulk","event":[{"listen":"prerequest","script":{"id":"5a6d07b7-6969-40eb-ae9a-be5f466d09a8","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3c810082-74e3-4ffb-8799-016e2f646ccf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"method\": \"\",\n \"type\": \"\",\n \"id\": \"\"\n },\n {\n \"method\": \"\",\n \"type\": \"\",\n \"id\": \"\"\n }\n ],\n \"error_handling\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities","description":"Multiple calls to various entity endpoints can be made by submitting a request with data in array format. The following options are available for error checking the submitted data:
\n\nskip: Erroneous data is not added, and the whole entry is skipped.
\npre-check: The submitted data is checked for validity but not entered into the Antavo system. Any error messages are returned.
\nfail: The submission is stopped when an error is encountered.
\n \nBody parameter descriptions
\n\nentities: Array of entity objects.
\n\nmethod: Type of the API call.
\ntype: Name of the entity module e.g., rewards, accounts, custom (for custom entities).
\nid: Entity ID.
\ndata: Array containing all data attributes to be processed by the request.
\n \nerror_handling: Error processing protocol for submitted functions: Options: skip, pre-check and fail.
\n \n","urlObject":{"protocol":"https","path":["entities"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"caa90df7-3b13-4c2b-9ea4-32f0acc892cd","name":"Successful pre-check response - The example is based on a store entity.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"method\": \"PUT\",\n \"type\": \"stores/store\",\n \"id\": \"63eaabe8b0fe2315c91425b6\"\n },\n {\n \"method\": \"PUT\",\n \"type\": \"stores/store\",\n \"id\": \"63eaabe8b0fe6826c91425b6\"\n }\n ],\n \"error_handling\": \"pre-check\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"method\": \"PUT\",\n \"type\": \"stores/store\",\n \"id\": \"63eaabe8b0fe2315c91425b6\"\n },\n {\n \"method\": \"PUT\",\n \"type\": \"stores/store\",\n \"id\": \"63eaabe8b0fe6826c91425b6\"\n }\n ],\n \"total\": 2,\n \"errors\": 0\n}"},{"id":"3c3aeacf-59a8-487f-83e4-d3e6c078c9e2","name":"Erroneous pre-check response - The example is based on a store entity.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"method\": \"PUT\",\n \"type\": \"custom/invalid_entity\",\n \"id\": \"63eaabe8b0fe6815c91425b6\"\n }\n ],\n \"error_handling\": \"pre-check\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"method\": \"PUT\",\n \"type\": \"custom/invalid_entity\",\n \"id\": \"63eaabe8b0fe6815c91425b6\",\n \"error\": {\n \"error\": {\n \"type\": \"RuntimeException\",\n \"code\": 300700,\n \"message\": \"Entity type does not exist\"\n }\n }\n }\n ],\n \"total\": 1,\n \"errors\": 1\n}"}],"_postman_id":"3c810082-74e3-4ffb-8799-016e2f646ccf"}],"id":"5c41f1b4-e293-4a11-b4cf-259e8e3cfa15","description":"Provides basic operations for creating, reading, updating, and deleting entities.
\n","_postman_id":"5c41f1b4-e293-4a11-b4cf-259e8e3cfa15"},{"name":"Rewards","item":[{"name":"List all available rewards","event":[{"listen":"prerequest","script":{"id":"1e6cb8a5-15e8-4ffa-917d-d791561d7344","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c8aeac35-3d07-4603-a71f-477a631a55ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/rewards/reward?stores=","description":"This endpoint lists all available rewards.
\n","urlObject":{"protocol":"https","path":["entities","rewards","reward"],"host":["api","{{environment}}","antavo","com"],"query":[{"description":{"content":"Filters the return rewards by stores, using a store ID.
\n","type":"text/plain"},"key":"stores","value":""}],"variable":[]}},"response":[{"id":"4f23e5cc-f12f-4cf8-bbb1-409a581746d9","name":"List of all rewards - this example includes translations.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/rewards/reward","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","rewards","reward"],"query":[{"key":"stores","value":"","description":"Filters the return rewards by stores, using a store ID.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5f05b989a44bc1c44008b4590\",\n \"name\": {\n \"en\": \"20% Off on Winter Collection\",\n \"de\": \"20% Rabatt auf die Winterkollektion\"\n },\n \"description\": {\n \"en\": \"Enjoy a 20% discount on our Winter Collection items.\",\n \"de\": \"Sichern Sie sich 20% Rabatt auf Artikel aus unserer Winterkollektion.\"\n },\n \"redeem_instructions\": {\n \"en\": \"Present this coupon at checkout to apply the discount. Valid on Winter Collection items only.\",\n \"de\": \"Zeigen Sie diesen Gutschein an der Kasse vor, um den Rabatt zu erhalten. Gültig nur für Artikel aus der Winterkollektion.\"\n },\n \"terms\": {\n \"en\": \"Cannot be combined with other offers.\",\n \"de\": \"Nicht mit anderen Angeboten kombinierbar.\"\n },\n \"account\": {\n \"id\": \"Main account\",\n \"name\": \"main_account\"\n },\n \"type\": \"coupon\",\n \"starts_at\": \"2020-07-21T12:00:00.000Z\",\n \"ends_at\": \"2020-12-21T12:00:00.000Z\",\n \"claim_button_label\": {\n \"en\": \"Get Discount\",\n \"de\": \"Rabatt Sichern\"\n },\n \"category\": {\n \"id\": \"5ef1ad79a44b5e15008b456e\"\n },\n \"segments\": [\n {\n \"id\": \"5ef1ad79a44b5e15008b456e\",\n \"name\": \"Returning Customers\",\n \"status\": \"active\"\n }\n ],\n \"cost\": \"150.5\",\n \"hide_restricted\": false,\n \"hidden\": false,\n \"restricted_message\": {\n \"en\": \"This offer is currently unavailable. Please visit us again later.\",\n \"de\": \"Dieses Angebot ist derzeit nicht verfügbar. Bitte besuchen Sie uns später erneut.\"\n },\n \"repeat_interval\": \"1 week\",\n \"stock\": 42,\n \"max_claims\": 90,\n \"notifications\": false,\n \"user_notifications\": false,\n \"status\": \"inactive\",\n \"price\": {\n \"EUR\": 500,\n \"USD\": 500\n },\n \"coupon_pool\": \"5b22a37f71f92e7f798q4186\"\n}"}],"_postman_id":"c8aeac35-3d07-4603-a71f-477a631a55ba"},{"name":"Create a new reward","event":[{"listen":"prerequest","script":{"id":"d068a50c-c645-4b5f-b7f2-78969fe6606c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"10907342-6e07-4808-acea-3154becb1cea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Name\",\r\n \"active\": true,\r\n \"score\": 42.5,\r\n \"tags\": [\"tag1\", \"tag2\"],\r\n \"launchDate\": \"2025-07-09\",\r\n \"website\": \"https://example.com\",\r\n \"description\": {\r\n \"en\": \"English description\",\r\n \"fr\": \"Description en français\"\r\n },\r\n \"customAttribute1\": \"value1\",\r\n \"customAttribute2\": 123,\r\n \"customAttribute3\": [\"item1\", \"item2\"],\r\n \"...\": \"Any other entity attribute can be included. Required attributes depend on the configuration of the entity in the Management UI.\"\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/rewards/reward","description":"This endpoint facilitates the creation of rewards.
\nBody parameters should include the attributes of the reward to be created. These must match attributes available in the Management UI.
\n","urlObject":{"protocol":"https","path":["entities","rewards","reward"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"29b95d2f-7127-42c3-9ac5-0e17b7856a2e","name":"Successful reward creation","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"20% Off on Winter Collection\",\r\n \"description\": \"Enjoy a 20% discount on our Winter Collection items.\",\r\n \"price\": 100,\r\n \"type\": \"coupon\"\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/rewards/reward"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"675614d7b0d0ca30a004e63d\",\n \"status\": \"inactive\",\n \"type\": \"coupon\",\n \"name\": \"20% Off on Winter Collection\",\n \"description\": \"Enjoy a 20% discount on our Winter Collection items.\",\n \"claim_button_label\": [],\n \"price\": 100,\n \"point_source\": \"customer\",\n \"hide_restricted\": false,\n \"notifications\": false,\n \"user_notification\": false,\n \"transferable\": false\n}"},{"id":"847e8c7c-042d-44d7-9514-d97fa7aaa969","name":"Bad request - a required attribute is not provided","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"20% Off on Winter Collection\",\r\n \"description\": \"Enjoy a 20% discount on our Winter Collection items.\",\r\n \"price\": 100\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/rewards/reward"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"'type' property is required\"\n }\n}"}],"_postman_id":"10907342-6e07-4808-acea-3154becb1cea"},{"name":"Retrieve all information regarding a specific reward","event":[{"listen":"prerequest","script":{"exec":["utils.signRequest(pm);"],"type":"text/javascript","packages":{},"id":"dc761137-e00f-4551-821a-66064ba995b4"}}],"id":"608d05a3-5cfd-45f5-89d0-3d7bba2dc55f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","description":"A detailed breakdown of all parameters for the specific reward is returned.
\n","urlObject":{"protocol":"https","path":["entities","rewards","reward",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The unique ID of the reward.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"ad330db5-3422-4f17-8df6-6f08231f17b6","name":"Reward information provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id?api_key=","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","rewards","reward",":entity_id"],"query":[{"key":"api_key","value":"","description":"Added as a part of security scheme: apikey"}],"variable":[{"key":"entity_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": {\n \"en\": \"\",\n \"de\": \"\"\n },\n \"description\": {\n \"en\": \"\",\n \"de\": \"\"\n },\n \"redeem_instructions\": {\n \"en\": \"\",\n \"de\": \"\"\n },\n \"terms\": {\n \"en\": \"\",\n \"de\": \"\"\n },\n \"account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\",\n \"starts_at\": \"\",\n \"ends_at\": \"\",\n \"claim_button_label\": {\n \"en\": \"\",\n \"de\": \"\"\n },\n \"category\": {\n \"id\": \"\"\n },\n \"segments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ],\n \"cost\": \"\",\n \"hide_restricted\": \"\",\n \"hidden\": \"\",\n \"restricted_message\": {\n \"en\": \"\",\n \"de\": \"\"\n },\n \"repeat_interval\": \"\",\n \"stock\": \"\",\n \"max_claims\": \"\",\n \"notifications\": \"\",\n \"user_notifications\": \"\",\n \"status\": \"\",\n \"price\": {\n \"EUR\": \"\",\n \"USD\": \"\"\n },\n \"coupon_pool\": \"\"\n}"},{"id":"61b943fe-c3a2-4f54-b1a5-a16af0495ae2","name":"Reward not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","rewards","reward",":entity_id"],"variable":[{"key":"entity_id","value":"01"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"Entity not found\"\n}"}],"_postman_id":"608d05a3-5cfd-45f5-89d0-3d7bba2dc55f"},{"name":"Update specific reward attributes","event":[{"listen":"prerequest","script":{"id":"7a46ab90-c2a8-4143-8d7b-0379a450ba39","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"53cc8d27-12e0-438b-b110-04ec14394cf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customAttribute1\": \"value1\",\n \"customAttribute2\": 123,\n \"customAttribute3\": [\n \"item1\",\n \"item2\"\n ],\n \"...\": \"Any other entity attribute can be included. Required attributes depend on the configuration of the entity in the Management UI.\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","description":"An attribute of a reward can be updated via this endpoint.
\nBody parameters should include the attributes of the reward to be updated. These must match attributes available in the Management UI.
\n","urlObject":{"protocol":"https","path":["entities","rewards","reward",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The unique identifier of the reward.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"d8e56bf3-53a8-4c13-96b1-d33e3f0f2a74","name":"Successful update - reward status update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","rewards","reward",":entity_id"],"variable":[{"key":"entity_id","value":"675614d7b0d0ca30a004e63d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"675614d7b0d0ca30a004e63d\",\n \"status\": \"active\",\n \"type\": \"coupon\",\n \"name\": \"20% Off on Winter Collection\",\n \"description\": \"Enjoy a 20% discount on our Winter Collection items.\",\n \"redeem_instructions\": [],\n \"terms\": [],\n \"claim_button_label\": [],\n \"price\": 100,\n \"point_source\": \"customer\",\n \"hide_restricted\": false,\n \"restricted_message\": [],\n \"notifications\": false,\n \"user_notification\": false,\n \"transferable\": false\n}"},{"id":"3e1d8e89-6b7b-40a6-bc70-483e68a5c4e3","name":"Bad request - Invalid status update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"live\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","rewards","reward",":entity_id"],"variable":[{"key":"entity_id","value":"675614d7b0d0ca30a004e63d"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"'Status' type is must be 'select'\"\n }\n}"}],"_postman_id":"53cc8d27-12e0-438b-b110-04ec14394cf7"},{"name":"Archive an inactive reward","event":[{"listen":"prerequest","script":{"id":"6a9a0ba8-b65a-49f0-8c57-09eefffec4cd","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"bdc9e8f2-caf5-44d2-baaa-d2107de9d69e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","description":"This endpoint archives a specific deactivated reward, effectively removing it from the system. The reward will be completely non-visible and inaccessible for members and Management UI users as well.
\n","urlObject":{"protocol":"https","path":["entities","rewards","reward",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The unique ID of the reward.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"20adae40-209d-457f-bf62-652fc6e8617b","name":"Reward archived","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","rewards","reward",":entity_id"],"variable":[{"key":"entity_id","value":"65b8f82a88b456710a44e84a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n \"ok\"\n]"},{"id":"4f8dbae5-f98d-46cb-a8b2-e1d624060a0a","name":"Reward not found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/rewards/reward/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","rewards","reward",":entity_id"],"variable":[{"key":"entity_id","value":"01"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"BadRequestException\",\n \"code\": 0,\n \"message\": \"Entity not found\"\n}"}],"_postman_id":"bdc9e8f2-caf5-44d2-baaa-d2107de9d69e"}],"id":"e8b0b92b-369f-47da-94ec-55320e9df209","description":"Manages reward entities, including creating, reading, updating, and deleting rewards.
\n","_postman_id":"e8b0b92b-369f-47da-94ec-55320e9df209"},{"name":"Customer lists","item":[{"name":"Create a new customer list","event":[{"listen":"prerequest","script":{"id":"824d967d-8091-4e2d-9897-6a5f58ece8e0","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"de02366d-d61a-43fa-956a-cdf7a2397f4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/core/customer-list","description":"This endpoint allows you to create a new customer list.
\nBody parameter descriptions
\n\nname: Name of the customer list to be created. \n \n","urlObject":{"protocol":"https","path":["entities","core","customer-list"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"bff9697e-4730-42de-a634-d2ad70a12e2d","name":"OK - List created","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"VIP members\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/core/customer-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"draft\",\n \"id\": \"63f2cc942d6ef241c0167e6c\"\n}"}],"_postman_id":"de02366d-d61a-43fa-956a-cdf7a2397f4b"},{"name":"List all available customer lists","event":[{"listen":"prerequest","script":{"id":"68f3494f-0fbe-432c-b127-7d7336287ca8","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a2adfb14-2af7-4d74-acee-691c760b73af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/core/customer-list","description":"This endpoint returns all available customer lists.
\n","urlObject":{"protocol":"https","path":["entities","core","customer-list"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[]}},"response":[{"id":"810d2615-549b-4dec-b206-ab2d4b42ce0e","name":"List of customer lists provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/core/customer-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"66810cfc5fd576165c69bb35\",\n \"status\": \"draft\"\n },\n {\n \"id\": \"66810d1883aeae307b712d42\",\n \"name\": \"VIP customers\",\n \"status\": \"active\"\n },\n {\n \"id\": \"66810d9683aeae307b712d43\",\n \"name\": \"Suspicious activity\",\n \"status\": \"active\"\n },\n {\n \"id\": \"66810dc25fd576165c69bb36\",\n \"status\": \"draft\"\n },\n {\n \"id\": \"66810dd083aeae307b712d44\",\n \"status\": \"draft\"\n },\n {\n \"id\": \"66810de4487ccf2b3b35c48b\",\n \"status\": \"draft\"\n },\n {\n \"id\": \"66810edd4920cd580571bdb4\",\n \"status\": \"draft\"\n }\n ]\n}"}],"_postman_id":"a2adfb14-2af7-4d74-acee-691c760b73af"},{"name":"Retrieve information of a specific customer list","event":[{"listen":"prerequest","script":{"id":"60283358-4643-4bbe-85d7-2ffbea387f2e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c1b1dd32-13f1-4680-8935-055ebc3e3576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","description":"This endpoint returns a specific customer list.
\n","urlObject":{"protocol":"https","path":["entities","core","customer-list",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the customer list.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"491ba638-b88e-4707-a5a3-9735b720d73d","name":"List information provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","core","customer-list",":entity_id"],"variable":[{"key":"entity_id","value":"66810d1883aeae307b712d42"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"66810d1883aeae307b712d42\",\n \"name\": \"VIP customers\",\n \"status\": \"active\"\n}"},{"id":"fd7945d4-f4e6-4e4e-aec7-b11c76a6a3c6","name":"Customer list not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","core","customer-list",":entity_id"],"variable":[{"key":"entity_id","value":"01"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 300400,\n \"message\": \"Customer List not found\"\n }\n}"}],"_postman_id":"c1b1dd32-13f1-4680-8935-055ebc3e3576"},{"name":"Update a customer list","event":[{"listen":"prerequest","script":{"id":"bc73a702-96a0-4e70-927f-221b9b141a46","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c0546c6b-e01f-4031-952c-38af365dbc68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"status\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","description":"This endpoint allows you to update a customer list.
\nBody parameter descriptions
\n\n","urlObject":{"protocol":"https","path":["entities","core","customer-list",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the customer list.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"a2b8822d-0fc2-42a7-956a-eda44fd5536e","name":"Customer list updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"inactive\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","core","customer-list",":entity_id"],"variable":[{"key":"entity_id","value":"66810d1883aeae307b712d42"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"66810d1883aeae307b712d42\",\n \"name\": \"VIP customers\",\n \"status\": \"inactive\"\n}"},{"id":"5aeea696-7620-4ef3-9428-f3ce0f77ed93","name":"Customer list not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"inactive\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","core","customer-list",":entity_id"],"variable":[{"key":"entity_id","value":"01"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 300400,\n \"message\": \"Customer List not found\"\n }\n}"}],"_postman_id":"c0546c6b-e01f-4031-952c-38af365dbc68"},{"name":"Archive a customer list","event":[{"listen":"prerequest","script":{"id":"8b980528-2cc6-42de-97db-55b8f0d0e36f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"93ba4484-4786-438d-b3d7-339f9ef5f180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","description":"This endpoint allows archiving a customer list and removing users from it. Only inactive lists can be archived. Once archived, lists cannot be restored.
\n","urlObject":{"protocol":"https","path":["entities","core","customer-list",":entity_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the customer list.
\n","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]}},"response":[{"id":"26ab4aea-e81e-4f55-a166-5456220574c5","name":"Customer list archived","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","core","customer-list",":entity_id"],"variable":[{"key":"entity_id","value":"66810d9683aeae307b712d43"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n \"ok\"\n]"},{"id":"34b67ca7-8fa1-4204-8df6-4ae5b0df8fe5","name":"Customer list not found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/entities/core/customer-list/:entity_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["entities","core","customer-list",":entity_id"],"variable":[{"key":"entity_id","value":"01"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"BadRequestException\",\n \"code\": 300400,\n \"message\": \"Customer List not found\"\n}"}],"_postman_id":"93ba4484-4786-438d-b3d7-339f9ef5f180"}],"id":"6a8551ca-d890-4a7e-8170-f23406ca1404","description":"Handles customer list entities, allowing for the creation, retrieval, updating, and deletion of customer lists.
\n","_postman_id":"6a8551ca-d890-4a7e-8170-f23406ca1404"}],"id":"e027f1a3-1da6-45ac-9b4f-82622257e417","description":"Entities APIs manage the creation, expansion, and customization of entities within Antavo. An entity is a generic model representing various types of data objects, such as customers, products, or rewards. The endpoints provided in this documentation demonstrate how entity API calls work.
\nCurrently, it is possible to expand entities, and other entities may become available upon module activation.
\nThe API endpoints require the Custom entities module to be enabled in the Management UI, and the corresponding custom entities must also be activated. Entity attributes must be tagged as searchable to be used as additional parameters. API requests can be submitted and processed with null attributes.
\nSupported Entities and Actions \nBelow is the current list of Antavo entities, their associated modules, and supported actions:
\n\n\n\nAssociated module/Core feature Entity module name {module} \nEntity name {entity} \nCreate \nRead \nUpdate \nDelete \n \n \n\n\nCustom entities \ncustom{unique id of the custom entity}✅ \n✅ \n✅ \n✅ \n \n\nChallenges \nchallengeschallenge✅ \n✅ \n✅ \n✅ \n \n\nContest lite \ncontestscontest❌ \n✅ \n❌ \n❌ \n \n\nCoupons \ncouponspool❌ \n✅ \n❌ \n❌ \n \n\nCore feature \ncoretransaction✅ \n✅ \n❌ \n❌ \n \n\nCore feature \ncorecustomer✅ \n✅ \n✅ \n✅ \n \n\nCustomer lists \ncorecustomer-list✅ \n✅ \n✅ \n✅ \n \n\nGamified profiling \nprofilingflow❌ \n✅ \n❌ \n❌ \n \n\nLoyalty cards \ncardscard✅ \n✅ \n✅ \n❌ \n \n\nOffers \noffersoffer❌ \n✅ \n❌ \n❌ \n \n\nPoints economy \naccountsaccount❌ \n✅ \n❌ \n❌ \n \n\nPrize wheels \nprize-wheelswheel❌ \n✅ \n❌ \n✅ \n \n\nProduct catalog \nproductsproduct✅ \n✅ \n✅ \n❌ \n \n\nRewards \nrewardsreward✅ \n✅ \n✅ \n✅ \n \n\nReward categories \nnot available \nnot available \n❌ \n❌ \n❌ \n❌ \n \n\nStores \nstoresstore✅ \n✅ \n✅ \n✅ \n \n\nTiers \ntierstier❌ \n✅ \n❌ \n❌ \n \n \n
\n
\",\n \"\"\n ],\n \"callback_url\": \"\",\n \"force_claim\": true,\n \"metadata\": {\n \"external_batch_id\": \"\",\n \"custom_attributes\": {\n \"id\": \"\",\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:reward_id","description":"Submit reward claim requests for a batch of customers. Each request can include a maximum of 100,000 customers.
\nBody parameter descriptions
\n\ncustomers*: Array of string values representing unique customer IDs. If any of the customer IDs don't exist in the database, the batch will still be processed and the unknown customer IDs will be provided in the payload of the /error endpoint.
\ncallback_url: Antavo will attempt to call this URL once the batch processing is finished. The webhook message sent to this URL provides the API URL to the /status endpoint to query the status of the batch claim process and any custom data that has been added to the bulk reward claim request. The schema://hostname of the callback URL must be configured in the Trusted sites module and able to handle REST API calls with JSON payload.
\nmetadata: Object of key-value pairs.
\n\nexternal_batch_id: The batch ID specified in the request.
\ncustom_attributes: Any context variable that is associated with this submitted batch. Custom attributes are recorded on the coupon entity assigned to the customer during the bulk reward claim procedure.
\n\n \nforce_claim: When set to true, the reward point price is treated as zero and the reward can be claimed without applying validation rules, except for stock restrictions.
\n \n","urlObject":{"protocol":"https","path":["v1","bulk-operation","reward","claim",":reward_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the reward to be claimed.
\n","type":"text/plain"},"type":"any","value":"","key":"reward_id"}]}},"response":[{"id":"ff54a994-f442-4cc2-9745-2edf582bfa3f","name":"The batch claim request has been submitted successfully.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"metadata\": {\n \"custom_attributes\": {\n \"id\": \"country\",\n \"value\": \"DE\"\n },\n \"external_batch_id\": \"batch001\"\n },\n \"customers\": [\n \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"afa53d5e-72e8-443b-8ac2-eab0cbaa181a\"\n ],\n \"callback_url\": \"https://webservices.yourapi.com/callback_url\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:reward_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","reward","claim",":reward_id"],"variable":[{"key":"reward_id","value":"63dcb7736123782ba6336425"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": {\n \"external_batch_id\": \"batch001\",\n \"custom_attributes\": {\n \"id\": \"country\",\n \"value\": \"DE\"\n }\n },\n \"payload\": {}\n}}"},{"id":"aba6cfdf-7133-4355-aa1f-a3a679d8f658","name":"Bad request - Batch ID already exists","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"metadata\": {\n \"custom_attributes\": {\n \"id\": \"country\",\n \"value\": \"DE\"\n },\n \"external_batch_id\": \"batch001\"\n },\n \"customers\": [\n \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"afa53d5e-72e8-443b-8ac2-eab0cbaa181a\"\n ],\n \"callback_url\": \"https://webservices.yourapi.com/callback_url\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:reward_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","reward","claim",":reward_id"],"variable":[{"key":"reward_id","value":"63dcb7736123782ba6336425"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 320503,\n \"message\": \"The unique batch id provided already exists\"\n }\n}"},{"id":"97940e76-bda7-4add-a4b4-6c6d92aebef8","name":"Reward not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"metadata\": {\n \"custom_attributes\": {\n \"id\": \"country\",\n \"value\": \"DE\"\n },\n \"external_batch_id\": \"batch001\"\n },\n \"customers\": [\n \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"afa53d5e-72e8-443b-8ac2-eab0cbaa181a\"\n ],\n \"callback_url\": \"https://webservices.yourapi.com/callback_url\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:reward_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","reward","claim",":reward_id"],"variable":[{"key":"reward_id","value":"01"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"type\": \"NotFoundException\",\n \"code\": 320501,\n \"message\": \"Reward not found\"\n }\n}"}],"_postman_id":"08795267-4c72-4eef-bbf6-9bd19e2246a0"},{"name":"Retrieve the status of the reward claim process","event":[{"listen":"prerequest","script":{"id":"038e21b3-e7eb-4703-ad7d-88c8d3cd6890","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"924ba541-46ea-464e-bc2c-63a4b690b15d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:batch_id/status","description":"This API endpoint allows you to query the status of a bulk reward claim process, providing details on the processing status, any errors encountered, and the overall completion status.
\n","urlObject":{"protocol":"https","path":["v1","bulk-operation","reward","claim",":batch_id","status"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the batch.
\n","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]}},"response":[{"id":"5a1411b8-a27b-4377-8dc0-cbb4f3b8112a","name":"Returned after the batch has been successfully added to the queue.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:batch_id/status","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","reward","claim",":batch_id","status"],"variable":[{"key":"batch_id","value":"batch001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": {\n \"bulk_operation_error\": {\n \"number_of_errors\": 0,\n \"url\": \"https://api.{environment}.antavo.com/v1/bulk-operation/reward/claim/batch001/status/error\"\n },\n \"pagination\": {\n \"total\": 0\n }\n },\n \"payload\": {\n \"batch_status\": \"queued\",\n \"customers\": []\n }\n}"},{"id":"c36ea139-6458-4393-9f95-340f12e547dc","name":"The batch ID provided as parameter does not exists.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:batch_id/status","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","reward","claim",":batch_id","status"],"variable":[{"key":"batch_id","value":"invalid_batch_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"type\": \"NotFoundException\",\n \"code\": 320510,\n \"message\": \"Batch ID is not found\"\n }\n}"}],"_postman_id":"924ba541-46ea-464e-bc2c-63a4b690b15d"},{"name":"Retrieve the failed reward claim attempts","event":[{"listen":"prerequest","script":{"id":"11b35194-0510-47ef-8082-3ec12190c24b","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3f051362-8f52-464d-b1c5-78839656248f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:batch_id/status/error","description":"This endpoint returns the error occured while processing the batch.
\n","urlObject":{"protocol":"https","path":["v1","bulk-operation","reward","claim",":batch_id","status","error"],"host":["api","{{environment}}","antavo","com"],"query":[{"disabled":true,"description":{"content":"Offsets the starting number of errors to return. This is used in pagination in conjunction with the limit query.
\nMust be ≥ 0\nDefaults to 0
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Limits the number of errors to be returned in one response. Other values are accessible by pagination made accessible via the offset.
\nMust be ≥ 0\nDefaults to 100
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[{"description":{"content":"(Required) The ID of the batch.
\n","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]}},"response":[{"id":"c3f1b529-f2c9-4c0d-8233-232e364529c9","name":"Returned after the batch claim request has been processed.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:batch_id/status/error?offset=20&limit=20","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","reward","claim",":batch_id","status","error"],"query":[{"key":"offset","value":"20","description":"Offsets the starting number of errors to return. This is used in pagination in conjunction with the limit query.\n\nMust be ≥ 0\nDefaults to 0"},{"key":"limit","value":"20","description":"Limits the number of errors to be returned in one response. Other values are accessible by pagination made accessible via the offset.\n\nMust be ≥ 0\nDefaults to 100"}],"variable":[{"key":"batch_id","value":"batch001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": {\n \"pagination\": {\n \"total\": 42,\n \"next\": \"https://api.{environment}.antavo.com/v1/bulk-operation/reward/claim/batch001/status/error?offset=40&limit=20\",\n \"previous\": \"https://api.{environment}.antavo.com/v1/bulk-operation/reward/claim/batch001/status/error?offset=0&limit=20\"\n }\n },\n \"payload\": {\n \"number_of_errors\": 42,\n \"customers\": {\n \"customer_01\": {\n \"reward\": \"6275010c75c54b7810090000\",\n \"error_message\": \"Sorry, you can't claim this reward, as it's currently out of stock\",\n \"error_code\": 156156\n }\n }\n }\n}"},{"id":"c12d0178-e296-4c21-ac85-29dc38e530d2","name":"The batch ID provided as parameter does not exists.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/reward/claim/:batch_id/status/error","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","reward","claim",":batch_id","status","error"],"variable":[{"key":"batch_id","value":"invalid_batch_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"type\": \"NotFoundException\",\n \"code\": 320510,\n \"message\": \"Batch ID is not found\"\n }\n}"}],"_postman_id":"3f051362-8f52-464d-b1c5-78839656248f"}],"id":"bc693d55-561e-4cc5-bfaa-8b3535cd0e83","_postman_id":"bc693d55-561e-4cc5-bfaa-8b3535cd0e83","description":""},{"name":"Customer lists","item":[{"name":"Add customers to a customer list","event":[{"listen":"prerequest","script":{"id":"94a572c8-189d-43bd-b762-494e32a06d17","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"72655139-2bc1-46e1-83da-b8a495b0af52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/bulk-operation/customer-list/add/:customer_list_id","description":"This API endpoint allows you to add a group of customers to a customer list all at once.
\nThis API endpoint operates asynchronously, so customer list updates are processed separately.
\n","urlObject":{"protocol":"https","path":["v1","bulk-operation","customer-list","add",":customer_list_id"],"host":["api","{{environment}}","antavo","com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the customer list to which customers will be added to.
\n","type":"text/plain"},"type":"any","value":"","key":"customer_list_id"}]}},"response":[{"id":"7ca30d33-14e6-4739-9012-0367d3fb7b78","name":"Success response with batch details.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customers\": [\n \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"afa53d5e-72e8-443b-8ac2-eab0cbaa181a\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/customer-list/add/:customer_list_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","customer-list","add",":customer_list_id"],"variable":[{"key":"customer_list_id","value":"63f2cc942d6ef241c0167e6c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"metadata\": {\n \"external_batch_id\": \"batch001\"\n },\n \"payload\": {}\n}"},{"id":"004c753f-0669-4b00-8a53-f73cff3052c9","name":"Bad request, indicates missing or empty payload or exceeding payload size limitations.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customers\": [\n \n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/customer-list/add/:customer_list_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","customer-list","add",":customer_list_id"],"variable":[{"key":"customer_list_id","value":"63f2cc942d6ef241c0167e6c"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"type\": \"BadRequestException\",\n \"code\": 330502,\n \"message\": \"The 'payload' field is not found or empty\"\n }\n}"},{"id":"466c45bb-224d-4f3a-a977-0cb220538379","name":"Thrown in case there is no Customer list registered in Antavo with the ID provided in the path as customerListId.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customers\": [\n \"280e674c-c4ea-4a30-987a-d9267d1a5018\",\n \"afa53d5e-72e8-443b-8ac2-eab0cbaa181a\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.{{environment}}.antavo.com/v1/bulk-operation/customer-list/add/:customer_list_id","protocol":"https","host":["api","{{environment}}","antavo","com"],"path":["v1","bulk-operation","customer-list","add",":customer_list_id"],"variable":[{"key":"customer_list_id","value":"invalid_list_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"type\": \"NotFoundException\",\n \"code\": 330501,\n \"message\": \"Customer List not found\"\n }\n}"}],"_postman_id":"72655139-2bc1-46e1-83da-b8a495b0af52"},{"name":"Remove customers from a customer list","event":[{"listen":"prerequest","script":{"id":"54094f3c-cb08-44ed-a443-8d3a6a77e090","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"57f410df-53a4-402a-a13e-5bc9da428fd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{signature}}","type":"text"},{"key":"Date","value":"{{date}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.{{environment}}.antavo.com/v1/bulk-operation/customer-list/remove/:customer_list_id","description":"This endpoint supports the removal of customers from a customer list in batches.