Base Api Flow :
\nCreate a session from an API key.
\nTo obtain an API key for your instance, please follow these steps:
\nFor further assistance, contact support@pawa.zone.
\n","urlObject":{"path":["api","security","api-session"],"host":["https://yourinstance.pawa.zone"],"query":[],"variable":[]}},"response":[{"id":"a7a4fe90-20b4-4d1d-8902-b15e44de1763","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Close session token.
\n","urlObject":{"path":["api","security","log-out"],"host":["https://yourinstance.pawa.zone"],"query":[],"variable":[]}},"response":[{"id":"b6478993-4a49-4723-b214-4c3c6cbfe050","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"List of routes for authentication
\n","_postman_id":"382d947a-cad6-4629-a07d-a2f3be695eee"},{"name":"CustomerItems","item":[{"name":"CustomerItems","id":"27806322-4375-4e36-9665-6f144070d80a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://yourinstance.pawa.zone/api/planning/v2/customer-items?include_attributes=Get the list of customer items. Use the query parameter ?include_attributes=true to also return items with their attribute values
\n","urlObject":{"path":["api","planning","v2","customer-items"],"host":["https://yourinstance.pawa.zone"],"query":[{"key":"include_attributes","value":"Create or update a list of customer items.
\nOptionally, you can also specify attribute values when creating or updating customers. To include additional attributes, simply add extra fields to the input data, following the naming conventions:
\nTextual Attributes: Use the naming convention attribute_*, where * is the attribute's code. The field's value will be treated as a textual attribute.
\nNumeric Attributes: Use the naming convention #_*, where * is the attribute's code. The field's value will be treated as a numeric attribute.
\nImportant: Attribute codes in the customer items must have been previously set up in the system.
\nExample:
\nTo add a textual attribute \"Status\" with the attribute code \"status\", include the field \"attribute_status\" in the customer item.\nFor a numeric attribute \"Status ID\" with the attribute code \"statusId\", include \"#_statusId\".
\nA customer item with both of these attributes would have the form :
\n{\n \"CustomerCode\": \"CustomerCode\",\n \"ItemCode\": \"ItemCode\",\n \"attribute_status\": \"Open\",\n \"#_statusId\": 10\n}\nList of routes for creating and updating customer items and their attributes
\n","_postman_id":"b6b7ad33-8059-4d23-a71c-323256b6a09c"},{"name":"Customers","item":[{"name":"Customers","id":"d597f956-81f8-4d3f-9af6-e3ae8a3137d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://yourinstance.pawa.zone/api/planning/v2/customers?include_attributes=Get the list of customers. Use the query parameter ?include_attributes=true to also return items with their attribute values
\n","urlObject":{"path":["api","planning","v2","customers"],"host":["https://yourinstance.pawa.zone"],"query":[{"key":"include_attributes","value":"Create or update a list of customers.
\nOptionally, you can also specify attribute values when creating or updating customers. To include additional attributes, simply add extra fields to the input data, following the naming conventions:
\nTextual Attributes: Use the naming convention attribute_*, where * is the attribute's code. The field's value will be treated as a textual attribute.
\nNumeric Attributes: Use the naming convention #_*, where * is the attribute's code. The field's value will be treated as a numeric attribute.
\nImportant: Attribute codes in the customers must have been previously set up in the system.
\nExample:
\nTo add a textual attribute \"Preferred Language\" with the attribute code \"language\", include the field \"attribute_language\" in the customer.\nFor a numeric attribute \"Customer ID Number\" with the attribute code \"idnumber\", include \"#_idnumber\".
\nA customer with both of these attributes would have the form :
\n{\n \"Code\": \"CustomerCode\",\n \"Name\": \"CustomerName\",\n \"attribute_language\": \"English\",\n \"#_idnumber\": 10\n}\nCreate or update a list of customer attributes to improve the structure of customer information. Attributes can be added individually or in groups as needed. If the API is called multiple times, attributes are updated or added only when necessary, using the 'code' field as a reference key.
\n","urlObject":{"path":["api","planning","v2","customers","attributes"],"host":["https://yourinstance.pawa.zone"],"query":[],"variable":[]}},"response":[{"id":"e66762f3-7140-49e1-9fce-7f9b063fe4a3","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Add or update values on customers for attributes.
\n","urlObject":{"path":["api","planning","v2","customers","attributes","values"],"host":["https://yourinstance.pawa.zone"],"query":[],"variable":[]}},"response":[{"id":"58dcb570-7382-465b-8668-916dac5c648c","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Add or update permissions for customers.
\nOptionally, you can specify replace_permissions to be true to delete the permissions of the imported customers before the import, replacing the permissions.
\nAccess Type can be either \"User\" or \"Group\", Access Name will then be the name of that user or group.
\nForecast Permission can be \"None\", \"Read\" or \"Write\".
\n","urlObject":{"path":["api","planning","v2","customers","permissions"],"host":["https://yourinstance.pawa.zone"],"query":[{"key":"replace_permissions","value":"Delete all permissions for customers.
\n","urlObject":{"path":["api","planning","v2","customers","permissions","delete"],"host":["https://yourinstance.pawa.zone"],"query":[],"variable":[]}},"response":[{"id":"01811a46-2654-47f3-99be-3ba4f67f9242","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"List of routes for creating and updating customers and their attributes
\n","_postman_id":"e64078b6-04d7-41ce-8e17-23045accbcd5"},{"name":"CustomMetrics","item":[{"name":"Custom Metric Types","id":"b827d1ce-257a-48b5-841f-e5204f20a77c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Code\": \"Create or update a list of custom metric types.
\nTimeframeType must be one of the following: Date, PeriodOfYear or Year.
\n","urlObject":{"path":["api","planning","v2","custom-metric-types"],"host":["https://yourinstance.pawa.zone"],"query":[],"variable":[]}},"response":[{"id":"ae7cf058-7e04-4390-ad84-e62b22b5b4be","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Create or update a list of custom metrics. \nIt is required that at least one of ItemCode, CustomerCode or KeyCode must be provided. \nAt least one of Units, Dollars or Percent must be provided as well.
\nOptionally, you can also specify attribute values when creating or updating custom metrics. To include additional attributes, simply add extra fields to the input data, following the naming conventions:
\nTextual Attributes: Use the naming convention attribute_{item/customer}_*, where \"item\" or \"customer\" is the attribute type and * is the attribute's code. The field's value will be treated as a textual attribute.
\nNumeric Attributes: Use the naming convention #_{item/customer}_*, where \"item\" or \"customer\" is the attribute type and * is the attribute's code. The field's value will be treated as a numeric attribute.
\nImportant: Attribute codes in the custom metrics must have been previously set up for customers and items in the system.
\nExample:
\nTo add a textual value for an item attribute \"Country of Origin\" with the attribute code \"origin\", include the field \"attribute_item_origin\" in the custom metric.\nFor a numeric value for an item attribute \"Inner Pack Count\" with the attribute code \"inner\", include \"#_item_inner\".\nFor a textual value for a customer attribute \"Preferred Language\" with the attribute code \"language\", include \"attribute_customer_language\".\nFor a numeric value for a customer attribute \"Customer ID Number\" with the attribute code \"idnumber\", include \"#_customer_idnumber\".
\nAn item with all of these attributes would have the form :
\n{\n \"ItemCode\": \"ItemCode\",\n \"CustomerCode\": \"CustomerCode\",\n \"attribute_item_origin\": \"Canada\",\n \"#_item_inner\": 6,\n \"attribute_customer_language\": \"English\",\n \"#_customer_idnumber\": 10,\n \"Date\": \"2000-01-01\",\n \"Units\": 1,\n \"Source\": \"File\"\n}\n(Required)
\n","type":"text/plain"},"type":"any","value":"