{"info":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","description":"

Overview

This API is for use with a SiteWatch system configured with Website Connect. It provides access to do the following items:

Create/Update/Lookup customer records
Create/Update/Tender sales for preconfigured items
Through items 1 and 2 you can:\n
1. Create customers and activate Pass Plans
2. Lookup existing SiteWatch customers and their plan info
3. Allow customers to manage, change, discontinue their recharge Pass Plans
4. Show customers their Club Plan status with details like Wash Credits or Points Earned
5. Sell SiteWatch Independent Prepaid Codes
\n

\n\n

API can be called from Postman for testing, via SDK or manually.

\n\n

Authentication

API requires a valid API key and AWS IAM credentials.

\n\n

Error Codes

\n\n

Error Format

\n{\n \"name\":\"string\",\n \"message\":\"string\"\n}\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"}],"owner":"16063422","collectionId":"bb51a275-571d-44e0-ad5c-15a3e7655824","publishedId":"TzY3AvWB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-02T14:49:39.000Z"},"item":[{"name":"/Prepaid","item":[{"name":"/info/{ppdcode}","id":"f586843a-50d4-45d5-ade2-6a086a41d62d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/prepaid/info/{{ppdcode}}","description":"

Returns SiteWatch Prepaid Info object containing balance and sale history of a prepaid code.

Response JSON Schema:\n{\n \"Prepaid\": {\n \"type\": \"object\",\n \"properties\": {\n \"Code\": {\n \"type\": \"string\"\n },\n \"Info\": {\n \"type\": \"object\",\n \"properties\": {\n \"PlanName\": {\n \"type\": \"string\"\n },\n \"PlanTypeName\": {\n \"type\": \"string\"\n },\n \"CurrentBalance\": {\n \"type\": \"number\"\n },\n \"ExpirationDate\": {\n \"type\": \"string\"\n },\n \"Uses\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"Date\": {\n \"type\": \"string\"\n },\n \"Site\": {\n \"type\": \"string\"\n },\n \"Amount\": {\n \"type\": \"number\"\n }\n }\n }\n }\n }\n }\n },\n \"required\": [\n \"Code\",\n \"Info\"\n ]\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","prepaid","info","{{ppdcode}}"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"b67b30f4-2c94-4613-9226-e40fa7fd45e4","name":"GET Prepaid Info Example","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/prepaid/info/{{ppdcode}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"339","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 12:18:45 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 2ff66c3e8250d693b62131b62b019fc5.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"WgX7oIwABy5HrdH8MuyQR-hJJwnLX90V462PtboRknNv5jjr2ZU5Tg==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e89824-113069091570786f72063a1b","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"a6e115aa-b4c7-11e7-afb1-51b151051af3","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Prepaid\":{\"Code\":\"KXMQBX6\",\"PlanName\":\"Gift Card\",\"PlanTypeName\":\"Ind. Prepaid Dollars\",\"CurrentBalance\":156.3,\"ExpirationDate\":\"2018-09-27T00:00:00.000-05:00\",\"Uses\":[{\"Date\":\"2017-09-26T16:11:48.000-04:00\",\"Site\":\"Previous Balance\",\"Amount\":155.25},{\"Date\":\"2017-09-26T16:11:48.000-04:00\",\"Site\":\"Northcoast Car Wash\",\"Amount\":1.05}]}}"}],"_postman_id":"f586843a-50d4-45d5-ade2-6a086a41d62d"},{"name":"/balance/{ppdcode}","id":"205ceaa3-766e-443f-a90e-440daee86314","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/prepaid/balance/{{ppdcode}}","description":"

Returns the balance and type of a SiteWatch prepaid code.

Return JSON Schema:\n{\n \"Prepaid\": {\n \"type\": \"object\",\n \"properties\": {\n \"Code\": {\n \"type\": \"string\"\n },\n \"Balance\": {\n \"type\": \"number\"\n },\n \"BalanceType\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Balance\",\n \"BalanceType\",\n \"Code\"\n ]\n }\n}

Prepaid route calls

\n","_postman_id":"3b471b2b-c686-4e30-8811-6cad9d10969e","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}}},{"name":"/Items","item":[{"name":"/items","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"01816f95-1bba-46d8-a91a-25f9a41ef3dd"}}],"id":"45deefe8-3fb9-4326-93b4-401cd0d5b96a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"content-type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/items","description":"

Returns the configured SiteWatch items available for use in sales via the API.

Response JSON Schema:\n\"Items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"SlotNumber\": {\n \"type\": \"integer\"\n },\n \"ItemName\": {\n \"type\": \"string\"\n },\n \"Amount\": {\n \"type\": \"number\",\n \"minimum\": 0\n },\n \"Type\": {\n \"type\": \"string\"\n }\n }\n }\n}

\n","urlObject":{"protocol":"https","path":["v1","items"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"c7f43281-dc8a-44b7-a859-214bef1f39b0","name":"GET Items Example","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"content-type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"1631","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 12:20:48 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 2ff66c3e8250d693b62131b62b019fc5.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"wzsMhHVHBfIZUWE-u-pMLEEUglqPzKhTOIOYWimGCN7yV--7TUUDpQ==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8989f-008d4d3ea62e2f5845104e11","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"effc4b5b-b4c7-11e7-be73-0500cd65b625","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Items\":[{\"SlotNumber\":1,\"ItemName\":\"Terminate ARM Plan\",\"Amount\":0,\"ItemType\":\"PassTerminate\"},{\"SlotNumber\":2,\"ItemName\":\"Discontinue ARM Plan\",\"Amount\":0,\"ItemType\":\"PassDiscontinue\"},{\"SlotNumber\":3,\"ItemName\":\"Switch ARM Plan\",\"Amount\":0,\"ItemType\":\"PassSwitch\"},{\"SlotNumber\":1000,\"ItemName\":\"Gift Card\",\"Amount\":0,\"ItemType\":\"Prepaid\"},{\"SlotNumber\":1001,\"ItemName\":\"Wash Card-5 Good\",\"Amount\":20,\"ItemType\":\"Prepaid\"},{\"SlotNumber\":2000,\"ItemName\":\"ARM 10 Good\",\"Amount\":28,\"ItemType\":\"PassPlan\"},{\"SlotNumber\":2001,\"ItemName\":\"ARM Better 2/day\",\"Amount\":29,\"ItemType\":\"PassPlan\"},{\"SlotNumber\":2002,\"ItemName\":\"ARM Best 2/day\",\"Amount\":39.99,\"ItemType\":\"PassPlan\"},{\"SlotNumber\":3000,\"ItemName\":\"Annual Pass Club\",\"Amount\":275,\"ItemType\":\"ClubPlan\"},{\"SlotNumber\":3001,\"ItemName\":\"VIP Club\",\"Amount\":0,\"ItemType\":\"ClubPlan\"},{\"SlotNumber\":4000,\"ItemName\":\"$10.00 Off 1st Mo.\",\"Amount\":10,\"ItemType\":\"Discount\"},{\"SlotNumber\":5000,\"ItemName\":\"3 Min Vac - 1pk\",\"Amount\":1,\"ItemType\":\"Misc\"},{\"SlotNumber\":5001,\"ItemName\":\"3 Min Vac - 3pk\",\"Amount\":2,\"ItemType\":\"Misc\"},{\"SlotNumber\":5002,\"ItemName\":\"3 Min Vac - 5pk\",\"Amount\":3,\"ItemType\":\"Misc\"},{\"SlotNumber\":5003,\"ItemName\":\"5 Min Vac - 1pk\",\"Amount\":1.5,\"ItemType\":\"Misc\"},{\"SlotNumber\":5004,\"ItemName\":\"5 Min Vac - 3pk\",\"Amount\":2.5,\"ItemType\":\"Misc\"},{\"SlotNumber\":5005,\"ItemName\":\"5 Min Vac - 5pk\",\"Amount\":4,\"ItemType\":\"Misc\"},{\"SlotNumber\":5006,\"ItemName\":\"10 Min Vac - 1pk\",\"Amount\":2,\"ItemType\":\"Misc\"},{\"SlotNumber\":5007,\"ItemName\":\"10 Min Vac - 3pk\",\"Amount\":5,\"ItemType\":\"Misc\"},{\"SlotNumber\":5008,\"ItemName\":\"10 Min Vac - 5pk\",\"Amount\":7,\"ItemType\":\"Misc\"}]}"}],"_postman_id":"45deefe8-3fb9-4326-93b4-401cd0d5b96a"}],"id":"df3a61c3-c519-4132-8ee7-e259e6215ff2","description":"

Items route calls

\n","_postman_id":"df3a61c3-c519-4132-8ee7-e259e6215ff2","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}}},{"name":"/Customer","item":[{"name":"/{customer-code}","id":"dcacba49-7cc5-4e5e-9617-a1371b8b960a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/customer/{{arm-customer-code}}","description":"

Call used to lookup a customer record based on their customer code. Typically use case would be an existing carwash customer downloading the app and looking up their record for the first time, ideally by scanning a barcoded tag on their vehicle or entering their License Plate #.

Response JSON Schema:\n{\n \"Customer\": {\n \"type\":\"object\",\n \"properties\":{\n \"Id\":{\"type\":\"integer\"},\n \"Code\":{\"type\":\"string\"},\n \"SearchName\":{\"type\":\"string\"},\n \"FirstName\":{\"type\":\"string\"},\n \"LastName\":{\"type\":\"string\"},\n \"MI\":{\"type\":[\"string\",\"null\"]},\n \"Salutation\":{\"type\":[\"string\",\"null\"]},\n \"Suffix\":{\"type\":[\"string\",\"null\"]},\n \"Company\":{\"type\":[\"string\",\"null\"]},\n \"Address1\":{\"type\":[\"string\",\"null\"]},\n \"Address2\":{\"type\":[\"string\",\"null\"]},\n \"City\":{\"type\":[\"string\",\"null\"]},\n \"State\":{\"type\":[\"string\",\"null\"]},\n \"ZipCode\":{\"type\":[\"integer\",\"null\"]},\n \"ZipExt\":{\"type\":[\"integer\",\"null\"]},\n \"PrimaryPhone\":{\"type\":[\"string\",\"null\"]},\n \"AltPhone\":{\"type\":[\"string\",\"null\"]},\n \"PhoneComment\":{\"type\":[\"string\",\"null\"]},\n \"Email\":{\"type\":[\"string\",\"null\"]},\n \"DoNotMail\":{\"type\":\"boolean\"},\n \"VehicleColor\":{\"type\":[\"string\",\"null\"]},\n \"VehicleYear\":{\"type\":[\"string\",\"null\"]},\n \"VehicleModel\":{\"type\":[\"string\",\"null\"]},\n \"VehicleMake\":{\"type\":[\"string\",\"null\"]},\n \"TaxExempt\":{\"type\":[\"string\",\"null\"]},\n \"Note\":{\"type\":[\"string\",\"null\"]},\n \"Comment\":{\"type\":[\"string\",\"null\"]},\n \"Birthdate\":{\"type\":[\"string\",\"null\"]},\n \"AdditionalCustomerCodes\" : {\n \"type\" : \"array\",\n \"items\":{\"type\":\"string\"}\n },\n \"Updated\":{\"type\":\"boolean\"},\n \"CreationType\":{\"type\":\"string\"}\n }\n }\n}

Response JSON Schema:\n{\n \"Customer\": {\n \"type\":\"object\",\n \"properties\":{\n \"Id\":{\"type\":\"integer\"},\n \"Code\":{\"type\":\"string\"},\n \"SearchName\":{\"type\":\"string\"},\n \"FirstName\":{\"type\":\"string\"},\n \"LastName\":{\"type\":\"string\"},\n \"MI\":{\"type\":[\"string\",\"null\"]},\n \"Salutation\":{\"type\":[\"string\",\"null\"]},\n \"Suffix\":{\"type\":[\"string\",\"null\"]},\n \"Company\":{\"type\":[\"string\",\"null\"]},\n \"Address1\":{\"type\":[\"string\",\"null\"]},\n \"Address2\":{\"type\":[\"string\",\"null\"]},\n \"City\":{\"type\":[\"string\",\"null\"]},\n \"State\":{\"type\":[\"string\",\"null\"]},\n \"ZipCode\":{\"type\":[\"integer\",\"null\"]},\n \"ZipExt\":{\"type\":[\"integer\",\"null\"]},\n \"PrimaryPhone\":{\"type\":[\"string\",\"null\"]},\n \"AltPhone\":{\"type\":[\"string\",\"null\"]},\n \"PhoneComment\":{\"type\":[\"string\",\"null\"]},\n \"Email\":{\"type\":[\"string\",\"null\"]},\n \"DoNotMail\":{\"type\":\"boolean\"},\n \"VehicleColor\":{\"type\":[\"string\",\"null\"]},\n \"VehicleYear\":{\"type\":[\"integer\",\"null\"]},\n \"VehicleModel\":{\"type\":[\"string\",\"null\"]},\n \"VehicleMake\":{\"type\":[\"string\",\"null\"]},\n \"TaxExempt\":{\"type\":[\"string\",\"null\"]},\n \"Note\":{\"type\":[\"string\",\"null\"]},\n \"Comment\":{\"type\":[\"string\",\"null\"]},\n \"Birthdate\":{\"type\":[\"string\",\"null\"]},\n \"AdditionalCustomerCodes\" : {\n \"type\" : \"array\",\n \"items\":{\"type\":\"string\"}\n },\n \"Updated\":{\"type\":\"boolean\"},\n \"CreationType\":{\"type\":\"string\"}\n }\n }\n}

Customer route calls

These calls deal with creating, updating and retrieving customer records.

\n","_postman_id":"b09f65d2-0a66-4753-8474-161574a4c401","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}}},{"name":"/Command","item":[{"name":"/new-passplan-lookup/{customer-code}/{cc-last-four}","id":"ca2d0032-5efe-45fe-b1cf-1c09125efefd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/command/new-passplan-lookup/{{arm-customer-code}}/{{cc-last-four}}","description":"

Returns the Customer and PassPlan information for a SiteWatch pass plan customer. Recommended for looking up an active pass plan customer, this call uses the last four digits of the pass plan credit card as a second factor of authentication for security purposes when identifying the customer.

Input Requirements: \nCustomer Code (FastPass, License Plate, Generic Customer Code)\nCredit Card Last 4 (must be associated with the active pass plan)

Response JSON Schema:\n{\n \"Customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\"\n },\n \"Code\": {\n \"type\": \"string\"\n },\n \"SearchName\": {\n \"type\": \"string\"\n },\n \"FirstName\": {\n \"type\": \"string\"\n },\n \"LastName\": {\n \"type\": \"string\"\n },\n \"DoNotMail\": {\n \"type\": \"boolean\"\n },\n \"CustomerCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"Updated\": {\n \"type\": \"boolean\"\n },\n \"CreationType\": {\n \"type\": \"string\"\n }\n }\n },\n \"PassPlan\": {\n \"type\": \"object\",\n \"properties\": {\n \"PlanName\": {\n \"type\": \"string\"\n },\n \"PlanTypeName\": {\n \"type\": \"string\"\n },\n \"PlanStatus\": {\n \"type\": \"string\"\n },\n \"NextRechargeDt\": {\n \"type\": \"string\"\n },\n \"CreditCardAccount\": {\n \"type\": \"string\"\n },\n \"CreditBalance\": {\n \"type\": \"integer\"\n },\n \"Uses\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"Date\": {\n \"type\": \"string\"\n },\n \"Site\": {\n \"type\": \"string\"\n },\n \"Activity\": {\n \"type\": \"string\"\n },\n \"Credits\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","command","new-passplan-lookup","{{arm-customer-code}}","{{cc-last-four}}"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"88f81028-8a78-4f56-9ad1-386031c32f83","name":"GET New Pass Plan Customer Lookup","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/command/new-passplan-lookup/{{arm-customer-code}}/{{cc-last-four}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"504","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 12:37:51 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 8ba96c59749184e8382a71ee7ae85cad.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"R8hZjcFl8GQH_A6b7hKibpJMFiP-24PrunN3kJwRBZ6jZWrXVgeAEw==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e89c9e-2aa781285eb0b96bfab4bdc8","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"518e8f5c-b4ca-11e7-a984-41a707665b76","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Customer\":{\"Code\":\"20033+554432\",\"Id\":2100100331,\"SearchName\":\"KERR,LONEGAN\",\"FirstName\":\"Lonegan\",\"LastName\":\"Kerr\",\"State\":\"AL\",\"Zip\":null,\"DoNotMail\":\"false\",\"AdditionalCustomerCodes\":[]},\"PassPlan\":{\"PlanName\":\"ARM Limited Wash\",\"PlanTypeName\":\"ARM Monthly Pass\",\"PlanStatus\":\"Current\",\"NextRechargeDate\":\"2017-11-01T00:00:00.000-04:00\",\"CreditCardAccount\":\"MC x6781\",\"CreditBalance\":10,\"Uses\":[{\"Date\":\"2017-10-01T00:00:00.000-04:00\",\"Site\":\"Northcoast Car Wash\",\"Activity\":\"Sold\",\"Credits\":10}]}}"}],"_postman_id":"ca2d0032-5efe-45fe-b1cf-1c09125efefd"},{"name":"/new-cust-plan-sale-autotender","id":"a376cc76-be0e-44b4-9ce2-24704b66bdd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"FirstName\" : \"Daffy\",\n \"LastName\" : \"Duck\"\n },\n \"SaleRequest\": {\n \"Items\": [\n {\n \"SlotNumber\": 3000,\n \"Quantity\": 1\n }\n ],\n \"TenderData\": {\n \"TenderType\": \"Credit\",\n \"AcctNum\": 5499990123456781,\n \"Exp\": 1220,\n \"Cvv\": 123,\n \"Zip\": 44720\n }\n }\n}"},"url":"https://api.sitewatch.cloud/v1/command/new-cust-plan-sale-autotender","description":"

Utility call that allows you to create a new customer record and sell them into a recharge pass plan all in one call. For use with a new app customer that does not have an existing plan or customer record.

Input JSON Schema:\n{\n \"Customer\":{\n \"type\": \"object\",\n \"properties\": {\n \"Code\": {\n \"type\": \"string\"\n },\n \"FirstName\": {\n \"type\": \"string\"\n },\n \"LastName\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"FirstName\",\n \"LastName\"\n ],\n },\n \"SaleRequest\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n \"Code\": { \"type\": \"string\" },\n \"Items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"SlotNumber\": { \"type\": \"integer\" },\n \"Quantity\": { \"type\": \"integer\" },\n \"Amount\": { \"type\": \"number\" },\n \"PrepaidCode\": { \"type\": \"string\" }\n },\n \"required\": [\"SlotNumber\",\"Quantity\"]\n }\n },\n \"TenderData\": {\n \"type\": \"object\",\n \"properties\": {\n \"AcctNum\": {\n \"type\": \"integer\"\n },\n \"Exp\": {\n \"type\": \"integer\"\n },\n \"Cvv\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"AcctNum\",\n \"Cvv\",\n \"Exp\"\n ]\n }\n }\n }\n}

Response JSON Schema:\n{\n \"Customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\"\n },\n \"Code\": {\n \"type\": \"string\"\n },\n \"CreationType\": {\n \"type\": \"string\"\n },\n },\n \"Sale\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n \"Total\": { \"type\": \"number\" },\n \"SaleItems\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"ItemName\": { \"type\": \"string\" },\n \"ItemType\": { \"type\": \"string\" },\n \"Quantity\": { \"type\": \"integer\" },\n \"ItemAmount\": { \"type\": \"number\" },\n \"PackageAmount\": { \"type\": \"number\" },\n \"IndentationLevel\": { \"type\": \"integer\" },\n \"Visible\": { \"type\": \"boolean\" }\n }\n }\n },\n \"SalePrepaids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"Code\": { \"type\": \"string\" },\n \"PlanName\": { \"type\": \"string\" },\n \"PlanTypeName\": { \"type\": \"string\" },\n \"PreviousBalance\": { \"type\": \"number\" },\n \"AmountChanged\": { \"type\": \"number\" },\n \"CurrentBalance\": { \"type\": \"number\" },\n \"BalanceType\": { \"type\": \"string\" }\n }\n }\n },\n \"Messages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","command","new-cust-plan-sale-autotender"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"6c0f36b5-51f2-43f7-8044-8a4ec3f67562","name":"POST Command/New-Cust-Plan-Sale-AutoTender Example","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"FirstName\" : \"Daffy\",\n \"LastName\" : \"Duck\"\n },\n \"SaleRequest\": {\n \"Items\": [\n {\n \"SlotNumber\": 3000,\n \"Quantity\": 1\n }\n ],\n \"TenderData\": {\n \"TenderType\": \"Credit\",\n \"AcctNum\": 5499990123456781,\n \"Exp\": 1220,\n \"Cvv\": 123,\n \"Zip\": 44720\n }\n }\n}"},"url":"https://api.sitewatch.cloud/v1/command/new-cust-plan-sale-autotender"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"500","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 14:21:11 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 22b93618451324c719001c4ae66237ae.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"E5PeEJnXVyk4duxdLCL80K14TMlvn0VzoMsz9fmnSdCUv6SmhG5bEg==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8b4d1-ffc5432dda2f3e965bba4f37","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"be7a212a-b4d8-11e7-83db-e141dcab0af7","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Customer\":{\"Id\":\"459413556\",\"Updated\":true,\"Code\":\"W-8T0QYRD\"},\"Sale\":{\"Id\":\"30000680731\",\"Total\":\"0\",\"SaleItems\":[{\"ItemName\":\"ARM 10 Good\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"0\",\"PackageAmount\":\"0\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"Cash\",\"ItemType\":\"Tender\",\"Quantity\":\"1\",\"ItemAmount\":\"0\",\"PackageAmount\":\"0\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"}],\"SalePrepaids\":[],\"Messages\":[\"Automatic recharge plan updated with new information for credit card x6781.\"]}}"}],"_postman_id":"a376cc76-be0e-44b4-9ce2-24704b66bdd6"},{"name":"/new-clubplan-lookup/{customer-code}/{cc-last-four}","id":"9cad4c23-ac52-4a19-ac8c-1544bd7d84b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/command/new-clubplan-lookup/{{temp-cust-code}}/{{temp-last-name}}","description":"

Utility call used for looking up a club plan customer on the app once they have signed up at the site. Requires the customer's code and their last name as a secondary verification piece for security purposes.

Response JSON Schema:\n{\n \"Customer\" : {\n \"type\":\"object\",\n \"properties\":{\n \"Id\":{\"type\":\"integer\"},\n \"Code\":{\"type\":\"string\"},\n \"SearchName\":{\"type\":\"string\"},\n \"FirstName\":{\"type\":\"string\"},\n \"LastName\":{\"type\":\"string\"},\n \"MI\":{\"type\":[\"string\",\"null\"]},\n \"Salutation\":{\"type\":[\"string\",\"null\"]},\n \"Suffix\":{\"type\":[\"string\",\"null\"]},\n \"Company\":{\"type\":[\"string\",\"null\"]},\n \"Address1\":{\"type\":[\"string\",\"null\"]},\n \"Address2\":{\"type\":[\"string\",\"null\"]},\n \"City\":{\"type\":[\"string\",\"null\"]},\n \"State\":{\"type\":[\"string\",\"null\"]},\n \"ZipCode\":{\"type\":[\"integer\",\"null\"]},\n \"ZipExt\":{\"type\":[\"integer\",\"null\"]},\n \"PrimaryPhone\":{\"type\":[\"string\",\"null\"]},\n \"AltPhone\":{\"type\":[\"string\",\"null\"]},\n \"PhoneComment\":{\"type\":[\"string\",\"null\"]},\n \"VehicleColor\":{\"type\":[\"string\",\"null\"]},\n \"VehicleMake\":{\"type\":[\"string\",\"null\"]},\n \"VehicleModel\":{\"type\":[\"string\",\"null\"]},\n \"VehicleYear\":{\"type\":[\"string\",\"null\"]},\n \"Email\":{\"type\":[\"string\",\"null\"]},\n \"DoNotMail\":{\"type\":\"boolean\"},\n \"TaxExempt\":{\"type\":[\"string\",\"null\"]},\n \"Note\":{\"type\":[\"string\",\"null\"]},\n \"Comment\":{\"type\":[\"string\",\"null\"]},\n \"Birthdate\":{\"type\":[\"string\",\"null\"]},\n \"AdditionalCustomerCodes\" : {\n \"type\" : \"array\",\n \"items\":{\"type\":\"string\"}\n },\n \"Updated\":{\"type\":\"boolean\"},\n \"CreationType\":{\"type\":\"string\"}\n }\n },\n \"ClubPlan\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"PlanName\": { \"type\": \"string\" },\n \"PlanExp\": { \"type\": \"string\" },\n \"WashCredits\": { \"type\": \"integer\" }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","command","new-clubplan-lookup","{{temp-cust-code}}","{{temp-last-name}}"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"e22f8203-4e7d-4737-810e-868f25a30664","name":"GET Command/New-Clubplan-Lookup Example","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/command/new-clubplan-lookup/{{temp-cust-code}}/{{temp-last-name}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"254","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 14:36:44 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 f7d8a115683fdcb08e026f9afb821e4c.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"tTDnme7dXhvZ2rVN2q8P0_xToRuQ9Ec-86tZ9Px-k1aQwaFriDgS0A==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8b87a-c256df2597006d7a35a0d236","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"ecd67ffc-b4da-11e7-ab6c-f928a394aae3","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Customer\":{\"Code\":\"W-FL69LF2\",\"Id\":459413558,\"SearchName\":\"DUCK,DAFFY\",\"FirstName\":\"Daffy\",\"LastName\":\"Duck\",\"Zip\":null,\"DoNotMail\":\"false\",\"AdditionalCustomerCodes\":[]},\"ClubPlan\":{\"WashCredits\":0,\"PlanName\":\"Annual Pass Club\",\"PlanExp\":\"10/20/2018\"}}"}],"_postman_id":"9cad4c23-ac52-4a19-ac8c-1544bd7d84b7"},{"name":"/new-cust-plan-sale","id":"c7307d66-9da6-4889-8f06-726f0ae5828d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"FirstName\" : \"Daffy\",\n \"LastName\" : \"Duck\"\n },\n \"SaleRequest\": {\n \"Items\": [\n {\n \"SlotNumber\": 3000,\n \"Quantity\": 1\n }\n ]\n }\n}"},"url":"https://api.sitewatch.cloud/v1/command/new-cust-plan-sale","description":"

Utility call that allows you to create a new customer record and create a sale for a recharge pass or club plan all in one call. For use with a new app customer that does not have an existing plan or customer record. Response SaleId will then need tendered with a POST call to /sale.

Response JSON Schema:\n{\n \"Customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\"\n },\n \"Code\": {\n \"type\": \"string\"\n },\n \"CreationType\": {\n \"type\": \"string\"\n },\n },\n \"Sale\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n \"Total\": { \"type\": \"number\" },\n \"SaleItems\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"ItemName\": { \"type\": \"string\" },\n \"ItemType\": { \"type\": \"string\" },\n \"Quantity\": { \"type\": \"integer\" },\n \"ItemAmount\": { \"type\": \"number\" },\n \"PackageAmount\": { \"type\": \"number\" },\n \"IndentationLevel\": { \"type\": \"integer\" },\n \"Visible\": { \"type\": \"boolean\" }\n }\n }\n },\n \"SalePrepaids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"Code\": { \"type\": \"string\" },\n \"PlanName\": { \"type\": \"string\" },\n \"PlanTypeName\": { \"type\": \"string\" },\n \"PreviousBalance\": { \"type\": \"number\" },\n \"AmountChanged\": { \"type\": \"number\" },\n \"CurrentBalance\": { \"type\": \"number\" },\n \"BalanceType\": { \"type\": \"string\" }\n }\n }\n },\n \"Messages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}

Generates a sale based form from an active SaleId.

Response JSON Schema:\n{\n \"Form\" : {\n \"type\" : \"object\",\n \"properties\": {\n \"Name\": { \"type\":\"string\" },\n \"Rows\": {\n \"type\": \"array\",\n \"items\": {\n \"type\":\"string\"\n }\n }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","command","generate-sale-form","{{active-sale-id}}","ibCustomerReceipt"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"9b73de4b-182d-4dc3-891d-a4f3fccaad2f","name":"GET Generate Sale Form/Sale-Id/Form-Name","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/command/generate-sale-form/{{active-sale-id}}/ibCustomerReceipt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"884","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 16:00:32 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 8df59d1006e83e9f3f0a9060d27eb23d.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"onGO-PljXXq1Kly4tZZWdu58MiN6OmEXhX3Olw27OxOMPMMB8DlZWA==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8cc1f-e3d139b2cbfdf51417f1328d","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"a23eed65-b4e6-11e7-80c2-870ddd0d1c3a","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Form\":{\"Name\":\"ibCustomerReceipt\",\"Rows\":[\"Receipt - for your car wash visit\",\" North Coast Car Care Centers\",\" 3245 Pickle Road\",\" 800-336-6338\",\" Car# \",\" PC# W-BWZMQ1Y\",\"Website, 10/19/17, 11:53 AM\",\"Shift 1, Empl -100, Sale # 10001467163\",\" * DUPLICATE RECEIPT *\",\" 1 ARM 10 Good 0.00 \",\" (ARM Limited Wash)\",\" Total 0.00 \",\" Cash 0.00 \",\" North Coast Car Care Centers\",\" Check us out on the web!\",\" www.DRBSystems.com\",\"Consider becoming a member of the Social\",\"Circle! As a member, you will receive \",\" special promotions and discounts, and \",\"your friends can too! Ask the attendant\",\" for details, or sign up at \",\"www.DRBSystems.com using the following \",\" code: BWZMQ1YP\"]}}"}],"_postman_id":"02ec6ff7-76a2-42a1-be80-b69b3c512871"},{"name":"/generate-cust-form/{cust-id}/{customer-form-name}","id":"1f0e5987-5aa8-4c3f-8cf3-3982942611e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/command/generate-cust-form/{{club-customer-id}}/ibClubPlanInfo","description":"

Generates the customer based form specified by name based on the provided CustomerId.

Command route calls

A collection of utility calls that fall outside of a normal REST design. These calls combine multiple calls for specific use case scenarios.

\n","_postman_id":"63fd1daf-252d-45bf-a481-2c29312a4a9a","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}}},{"name":"/PassPlan","item":[{"name":"/{customer-id}","id":"4cd119d1-448e-4eff-ad71-9924731432a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/passplan/{{customer-id}}","description":"

Retrieves a recharge pass plan customer's pass plan info based on their CustomerId.

Response JSON Schema:\n{\n \"PassPlan\": {\n \"type\": \"object\",\n \"properties\": {\n \"PlanName\": {\n \"type\": \"string\"\n },\n \"PlanTypeName\": {\n \"type\": \"string\"\n },\n \"PlanStatus\": {\n \"type\": \"string\"\n },\n \"NextRechargeDt\": {\n \"type\": \"string\"\n },\n \"CreditCardAccount\": {\n \"type\": \"string\"\n },\n \"CreditBalance\": {\n \"type\": \"integer\"\n },\n \"Uses\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"Date\": {\n \"type\": \"string\"\n },\n \"Site\": {\n \"type\": \"string\"\n },\n \"Activity\": {\n \"type\": \"string\"\n },\n \"Credits\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","passplan","{{customer-id}}"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"41e2cf8f-99ab-49a1-bbb4-89a560e32a07","name":"GET Pass Plan Example","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/passplan/{{customer-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"312","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 13:50:54 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 a2d78576769a85effceb78fed91f14af.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"dxQuHAdx1J_Ha1eEkY0QEgPlk6rdb0OaHs3p2cz7L9hck4DZ0J3uvg==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=0;root=1-59e8adbd-e4cdeddb4754ccdafcc5afe8","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"8608ced8-b4d4-11e7-aa8f-8949ccd56e6d","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"PassPlan\":{\"PlanName\":\"ARM Limited Wash\",\"PlanTypeName\":\"ARM Monthly Pass\",\"PlanStatus\":\"Current\",\"NextRechargeDate\":\"2017-11-01T00:00:00.000-04:00\",\"CreditCardAccount\":\"MC x6781\",\"CreditBalance\":10,\"Uses\":[{\"Date\":\"2017-10-01T00:00:00.000-04:00\",\"Site\":\"Northcoast Car Wash\",\"Activity\":\"Sold\",\"Credits\":10}]}}"}],"_postman_id":"4cd119d1-448e-4eff-ad71-9924731432a7"},{"name":"/creditcard","id":"894bcd7a-5fdb-48e4-a2c6-196606ccb98b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"Id\": 2100100094\n },\n \"TenderData\": {\n \"AcctNum\": 5499990123456781,\n \"Exp\": 1220,\n \"Cvv\": 123\n }\n}"},"url":"https://api.sitewatch.cloud/v1/passplan/creditcard","description":"

Patch call that allows a customer to update their recharge plan's credit card.

Input JSON Schema:\n{\n \"TenderData\": {\n \"type\": \"object\",\n \"properties\": {\n \"AcctNum\": {\n \"type\": \"integer\"\n },\n \"Exp\": {\n \"type\": \"integer\"\n },\n \"Cvv\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"AcctNum\",\n \"Cvv\",\n \"Exp\"\n ]\n },\n \"Customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"Id\"\n ]\n }\n}

Response JSON Schema:\n{\n \"Customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"Id\"\n ]\n },\n \"Message\": {\n \"type\": \"string\"\n }\n}

PassPlan route calls

These calls relate to retrieving, switching and discontinuing a customer recharge pass plan, as well as updating the recharge credit card on file.

\n","_postman_id":"e8fe7b1e-62d1-4548-920c-b763bd02eb72","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}}},{"name":"/Sale","item":[{"name":"/{sale-id}","id":"03d2ce9d-a7dc-48d9-be4d-5cc083fe0281","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/sale/{{active-sale-id}}","description":"

Generates a specific receipt form from an active SaleId.

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","sale","{{active-sale-id}}"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"1aebae32-a4a1-4992-b351-b9c2e5072b86","name":"GET Sale Receipt","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/sale/{{active-sale-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"851","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 15:54:07 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 679a4de27906d10e22d8f04cf2f6ad76.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"FwAY_9IhfAGbRLiQmtF0albwz-XpVDhtwsFRJKEOqmf5c5ulsgX-8g==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8ca9b-218b8d1863bd2b47da0ecbe5","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"bb2601c8-b4e5-11e7-a4e9-0b4a46dbe5ba","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Form\":{\"Name\":\"ibCustomerReceipt\",\"Rows\":[\"Receipt - for your car wash visit\",\" North Coast Car Care Centers\",\" 3245 Pickle Road\",\" 800-336-6338\",\" Car# \",\" PC# W-BWZMQ1Y\",\"Website, 10/19/17, 11:53 AM\",\"Shift 1, Empl -100, Sale # 10001467163\",\" 1 ARM 10 Good 0.00 \",\" (ARM Limited Wash)\",\" Total 0.00 \",\" Cash 0.00 \",\" North Coast Car Care Centers\",\" Check us out on the web!\",\" www.DRBSystems.com\",\"Consider becoming a member of the Social\",\"Circle! As a member, you will receive \",\" special promotions and discounts, and \",\"your friends can too! Ask the attendant\",\" for details, or sign up at \",\"www.DRBSystems.com using the following \",\" code: BWZMQ1YP\"]}}"}],"_postman_id":"03d2ce9d-a7dc-48d9-be4d-5cc083fe0281"}],"id":"55e53ac3-bdb7-4054-be4b-60fb36d1868e","description":"

Route Sale calls

All calls require an active, still in-memory SaleID. TTL on Sales is system configuration dependent and can vary from system to system.

\n","_postman_id":"55e53ac3-bdb7-4054-be4b-60fb36d1868e","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}}},{"name":"/ClubPlan","item":[{"name":"/{customer-id}","id":"de816a33-f055-4503-b6c0-8b36c018ac9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.sitewatch.cloud/v1/clubplan/{{club-customer-id}}","description":"

Request for customer club plan data based on required CustomerId.

Response JSON Schema:\n{\n \"ClubPlan\": {\n \"type\":\"object\",\n \"properties\":{\n \"PlanName\":{ \"type\": \"string\" },\n \"PlanExp\":{ \"type\": \"string\" },\n \"WashCredits\":{ \"type\": \"integer\" }\n }\n }\n}

Route ClubPlan related calls

Allows retrieval of club plan info based on supplied CustomerId.

\n","_postman_id":"36035882-8aaa-4e49-ae5d-a401cefe1fb1","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}}},{"name":"/customer","id":"2586e184-d1bb-4b5d-8c45-85818cf84a25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"Id\": 2100100077,\n \"FirstName\": \"Joe\",\n \"LastName\": \"Momma\",\n \"Address1\": \"1234 E Main St\",\n \"City\": \"Yuma\",\n \"State\": \"AZ\",\n \"PrimaryPhone\": \"123-456-7890\",\n \"AltPhone\": \"234-567-9999\",\n \"PhoneComment\":\"testing comment\",\n \"DoNotMail\":true,\n \"TaxExempt\":\"asdf\",\n \"Note\":\"Testing Note\",\n \"BirthDate\":\"1/1/11\",\n \"Suffix\":\"Sr.\",\n \"Company\":\"DRB\",\n \"Email\": \"testguy@testing.com\",\n \"AdditionalCustomerCode\":\"123ABC\"\n }\n}"},"url":"https://api.sitewatch.cloud/v1/customer","description":"

Used for updating a customer record within the SiteWatch system. It will update all fields posted.

Input JSON Schema:\n{\n \"Customer\": {\n \"type\": \"object\",\n \"properties\" : {\n \"Id\":{\"type\":\"integer\"},\n \"SearchName\":{\"type\":\"string\"},\n \"FirstName\":{\"type\":\"string\"},\n \"LastName\":{\"type\":\"string\"},\n \"MI\":{\"type\":[\"string\",\"null\"]},\n \"Suffix\":{\"type\":[\"string\",\"null\"]},\n \"Company\":{\"type\":[\"string\",\"null\"]},\n \"Address1\":{\"type\":[\"string\",\"null\"]},\n \"Address2\":{\"type\":[\"string\",\"null\"]},\n \"City\":{\"type\":[\"string\",\"null\"]},\n \"State\":{\"type\":[\"string\",\"null\"]},\n \"Zip\":{\"type\":[\"integer\",\"null\"]},\n \"ZipExt\":{\"type\":[\"integer\",\"null\"]},\n \"PrimaryPhone\":{\"type\":[\"string\",\"null\"]},\n \"AltPhone\":{\"type\":[\"string\",\"null\"]},\n \"PhoneComment\":{\"type\":[\"string\",\"null\"]},\n \"Email\":{\"type\":[\"string\",\"null\"]},\n \"DoNotMail\":{\"type\":\"boolean\"},\n \"TaxExempt\":{\"type\":[\"string\",\"null\"]},\n \"Note\":{\"type\":[\"string\",\"null\"]},\n \"Comment\":{\"type\":[\"string\",\"null\"]},\n \"Birthdate\":{\"type\":[\"string\",\"null\"]},\n \"AdditionalCustomerCode\":{\"type\":\"string\"}\n },\n \"required\":[\"Id\"]\n }\n }\n}

Response JSON Schema:\n{\n \"Customer\": {\n \"type\": \"object\",\n \"properties\" : {\n \"Id\":{\"type\":\"integer\"},\n \"Updated\":{\"type\":\"boolean\"}\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customer"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"c1870b49-9795-4958-bfc6-c14cc866e00c","name":"POST Customer","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"Id\": 2100100077,\n \"FirstName\": \"Jordan\",\n \"LastName\": \"Sinek\",\n \"Address1\": \"1234 E Main St\",\n \"City\": \"Tempe\",\n \"State\": \"AZ\",\n \"PrimaryPhone\": \"123-456-7890\",\n \"Email\": \"jordan.sinek@vuria.com\",\n \"AdditionalCustomerCode\": \"AB423-OH\"\n }\n}"},"url":"https://api.sitewatch.cloud/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"45","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 12:51:53 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 5dafcfe18ffd6eccdc6e9c39ca1b55d4.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"rmgPftXR4g7PK4u7hzBE845RFM1CQDYPqwjbi6YUyrnYNcPKhymJBw==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e89fe8-47d688b51e22d3b892d7dfc2","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"47a541dd-b4cc-11e7-af35-498c6350d23d","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Customer\":{\"Id\":2100100077,\"Updated\":true}}"}],"_postman_id":"2586e184-d1bb-4b5d-8c45-85818cf84a25"},{"name":"/customer","id":"0a861fd8-83af-4817-aab2-d21a17f25d2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"FirstName\": \"DRB\",\n \"LastName\": \"TestGuy\",\n \"MI\":\"B\",\n \"Code\":\"Testing\",\n \"AdditionalCustomerCode\":\"MoreTesting\"\n }\n}"},"url":"https://api.sitewatch.cloud/v1/customer","description":"

Initial call used to create a new customer and assign them a temporary system generated customer code starting with a W-.

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customer"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"f18403a7-c4d1-45cf-91d9-72a2f03f2aa6","name":"PUT Customer Example","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"FirstName\": \"DRB\",\n \"LastName\": \"TestGuy\",\n \"MI\":\"B\"\n }\n}"},"url":"https://api.sitewatch.cloud/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"81","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 13:29:50 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 c06db994a84d4430a1efdbc454251046.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"jsmRXOjLjPASwITJlD1PwWMHKGM4UvBmi6gtgA-_Ddfhy-hGOC9heg==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8a8cd-baa76f2083be5eae47a3fab7","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"94a2057f-b4d1-11e7-859a-f14d2ca1826a","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Customer\":{\"Id\":\"459413555\",\"Code\":\"W-3FK89YP\",\"CreationType\":\"TemporaryCode\"}}"}],"_postman_id":"0a861fd8-83af-4817-aab2-d21a17f25d2a"},{"name":"/passplan","id":"670506e7-5e7f-49eb-a2c5-4304f6255f9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"Id\": 2100100094\n },\n \"SaleRequest\": {\n \"Items\": [\n {\n \"SlotNumber\": 2001,\n \"Quantity\": 1\n } \n ],\n \"TenderData\": {\n \"AcctNum\": 5499990123456781,\n \"TenderType\": \"Credit\",\n \"Exp\": 1220,\n \"Cvv\": 123,\n \"Zip\": 44720\n }\n }\n}"},"url":"https://api.sitewatch.cloud/v1/passplan","description":"

Patch call that allows a customer to change their recharge plan to a different plan type.

Input JSON Schema:\n{\n \"Customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"Id\"\n ]\n },\n \"SaleRequest\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n \"Code\": { \"type\": \"string\" },\n \"Items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"SlotNumber\": { \"type\": \"integer\" },\n \"Quantity\": { \"type\": \"integer\" },\n \"Amount\": { \"type\": \"number\" },\n \"PrepaidCode\": { \"type\": \"string\" }\n },\n \"required\": [\"SlotNumber\",\"Quantity\"]\n }\n },\n \"TenderData\": {\n \"type\": \"object\",\n \"properties\": {\n \"AcctNum\": {\n \"type\": \"integer\"\n },\n \"Exp\": {\n \"type\": \"integer\"\n },\n \"Cvv\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"AcctNum\",\n \"Cvv\",\n \"Exp\"\n ]\n }\n }\n }\n}

Response JSON Schema:\n{\n \"Sale\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n \"Total\": { \"type\": \"number\" },\n \"AbandonSuccess\": { \"type\": \"boolean\" },\n \"SaleItems\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"ItemName\": { \"type\": \"string\" },\n \"ItemType\": { \"type\": \"string\" },\n \"Quantity\": { \"type\": \"integer\" },\n \"ItemAmount\": { \"type\": \"number\" },\n \"PackageAmount\": { \"type\": \"number\" },\n \"IndentationLevel\": { \"type\": \"integer\" },\n \"Visible\": { \"type\": \"boolean\" }\n }\n }\n },\n \"SalePrepaids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"Code\": { \"type\": \"string\" },\n \"PlanName\": { \"type\": \"string\" },\n \"PlanTypeName\": { \"type\": \"string\" },\n \"PreviousBalance\": { \"type\": \"number\" },\n \"AmountChanged\": { \"type\": \"number\" },\n \"CurrentBalance\": { \"type\": \"number\" },\n \"BalanceType\": { \"type\": \"string\" }\n }\n }\n },\n \"Messages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","passplan"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"cba74c83-4437-4ae4-b332-c4bcd25c06d5","name":"PATCH PassPlan Example","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"Id\": 2100100094\n },\n \"SaleRequest\": {\n \"Items\": [\n {\n \"SlotNumber\": 2001,\n \"Quantity\": 1\n } \n ],\n \"TenderData\": {\n \"AcctNum\": 5499990123456781,\n \"TenderType\": \"Credit\",\n \"Exp\": 1220,\n \"Cvv\": 123,\n \"Zip\": 44720\n }\n }\n}"},"url":"https://api.sitewatch.cloud/v1/passplan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"717","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 14:15:11 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 69e1081599be6de60111b059bb0068c3.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"McvEDn3VwqMvvozSQoMpGAQmE-5QBzqyanch8TrA_VPVSag_FLUwxw==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8b36d-88b7f7f1e235320959a6d18c","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"ea30e324-b4d7-11e7-a5e8-8fda1c8faa5b","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Sale\":{\"Id\":\"90000353051\",\"Total\":\"-11\",\"SaleItems\":[{\"ItemName\":\"Switch ARM Plan\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"0\",\"PackageAmount\":\"0\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"ARM Better Rfnd\",\"ItemType\":\"Paidout\",\"Quantity\":\"1\",\"ItemAmount\":\"-11\",\"PackageAmount\":\"-11\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"ARM Better 2/day\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"0\",\"PackageAmount\":\"0\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"MasterCard x6781\",\"ItemType\":\"Tender\",\"Quantity\":\"1\",\"ItemAmount\":\"-11\",\"PackageAmount\":\"-11\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"}],\"SalePrepaids\":[],\"Messages\":[\"Ret Appr # TEST: MasterCard x6781 -$11.00\"]}}"}],"_postman_id":"670506e7-5e7f-49eb-a2c5-4304f6255f9f"},{"name":"/passplan","id":"79e2b6c9-f788-4507-b874-bd3d2d79367f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"Id\": 2100100094\n }\n}"},"url":"https://api.sitewatch.cloud/v1/passplan","description":"

Delete call that allows for the discontinuation of a recharge pass plan.

Input JSON Schema:\n{\n \"Customer\":{\n \"type\":\"object\",\n \"properties\":{\n \"Id\":{\"type\":\"integer\"},\n },\n \"required\": [\"Id\"]\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","passplan"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"579d6279-8fce-40be-8a6a-1d85ec797f75","name":"DEL PassPlan Example","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Customer\": {\n \"Id\": 2100100094\n }\n}"},"url":"https://api.sitewatch.cloud/v1/passplan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"375","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 14:21:51 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 22b93618451324c719001c4ae66237ae.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"O-Wwsc9AiOfuhqDgIrh_wpL_1TFBPiUwWBGqknzyufKfIwQM8zP6Cw==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8b4fd-fde1dab5b393a047b6c06989","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"d868c5bb-b4d8-11e7-b64e-3375f722bf65","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Sale\":{\"Id\":\"40000746267\",\"Total\":\"0\",\"SaleItems\":[{\"ItemName\":\"Discontinue ARM Plan\",\"ItemType\":\"Note\",\"Quantity\":\"1\",\"ItemAmount\":\"0\",\"PackageAmount\":\"0\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"WebSite Tender\",\"ItemType\":\"Tender\",\"Quantity\":\"1\",\"ItemAmount\":\"0\",\"PackageAmount\":\"0\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"}],\"SalePrepaids\":[],\"Messages\":[]}}"}],"_postman_id":"79e2b6c9-f788-4507-b874-bd3d2d79367f"},{"name":"/sale","id":"b4be7406-2260-4765-b759-b9a0389c3afe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Id\": 81464164891,\n \"TenderData\": {\n \"TenderType\":\"IBTender\"\n }\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale","description":"

Operation for tendering a previously created sale by providing the SaleId and a TenderData object. Sale must still be active in the SiteWatch system, TTL for the sale is dependent on individual SiteWatch system configuration.

Input JSON Schema:\n{\n \"SaleRequest\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n \"Code\": { \"type\": \"string\" },\n \"Items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"SlotNumber\": { \"type\": \"integer\" },\n \"Quantity\": { \"type\": \"integer\" },\n \"Amount\": { \"type\": \"number\" },\n \"PrepaidCode\": { \"type\": \"string\" }\n },\n \"required\": [\"SlotNumber\",\"Quantity\"]\n }\n },\n \"TenderData\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"DataString\": { \"type\": \"string\" },\n \"TenderType\": { \"type\": \"string\" },\n \"AcctNum\": { \"type\": \"integer\" },\n \"Exp\": { \"type\": \"integer\" },\n \"Zip\": { \"type\": \"integer\" },\n \"Cvv\": { \"type\": \"integer\" }\n },\n \"required\":[\"TenderType\"]\n }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","sale"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"853c4311-acc2-41fd-a28f-3333d931b64d","name":"POST Sale Example","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Id\": 81464164891,\n \"TenderData\": {\n \"TenderType\":\"IBTender\"\n }\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"384","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 14:35:48 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 f7d8a115683fdcb08e026f9afb821e4c.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"y9342dCUwLuVGLHQ0DcPlIpt8mmI-oWAlTAWzWJGoVlBouceNUkWZg==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8b837-7314b491ca87ac3f1721d56b","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"c4b9f244-b4da-11e7-ad8d-8731a3685ef2","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Sale\":{\"Id\":\"40001008411\",\"Total\":\"275\",\"SaleItems\":[{\"ItemName\":\"Annual Pass Club\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"275\",\"PackageAmount\":\"275\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"WebSite Tender\",\"ItemType\":\"Tender\",\"Quantity\":\"1\",\"ItemAmount\":\"275\",\"PackageAmount\":\"275\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"}],\"SalePrepaids\":[],\"Messages\":[]}}"}],"_postman_id":"b4be7406-2260-4765-b759-b9a0389c3afe"},{"name":"/sale","id":"09fcd945-7192-4a2c-81e0-ede59a98832f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Items\": [\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 10\n },\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 15,\n \"PrepaidCode\": \"\"\n }\n ]\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale","description":"

For basic sale creation, ideally used for selling prepaids for the wallet functionality but also useful for any other sale functionality needed. Requires a SaleRequest object and returns a Sale object. Reponse SaleID will need to be submitted with TenderData in a POST call to /sale to complete the sale.

For selling prepaids, if a PrepaidCode is provided that code will be used. \nIf one is not provided, the API will pull a prepaid code from it's cloud database of available prepaid codes for the organization.

If the app user decides not to complete the sale, a DELETE call to /sale with the SaleID will instruct SiteWatch to abandon the sale and remove it.

Input JSON Schema:\n{\n \"SaleRequest\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Code\": { \"type\": \"string\" },\n \"Items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"SlotNumber\": { \"type\": \"integer\" },\n \"Quantity\": { \"type\": \"integer\" },\n \"Amount\": { \"type\": \"number\" },\n \"PrepaidCode\": { \"type\": \"string\" }\n },\n \"required\": [\"SlotNumber\",\"Quantity\"]\n }\n }\n },\n \"required\":[\"Items\"]\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","sale"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"d6b58412-dd80-4205-9bf0-9e5f6f5142b4","name":"PUT Sale Example","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Items\": [\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 10\n },\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 15,\n \"PrepaidCode\": \"\"\n }\n ]\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"713","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 16:17:25 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 8df59d1006e83e9f3f0a9060d27eb23d.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"Zgux6jn8fjHGCaiD1y4N_q30rBYL-F1XlKFinarPCZLUYtzIo-Ko7Q==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8d014-cb10fa269af13a58876f9ece","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"fdbdb4a9-b4e8-11e7-8a73-9133e36dcdfb","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Sale\":{\"Id\":\"10001991451\",\"Total\":\"25\",\"SaleItems\":[{\"ItemName\":\"Gift Card\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"10\",\"PackageAmount\":\"10\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"Gift Card\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"15\",\"PackageAmount\":\"15\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"}],\"SalePrepaids\":[{\"Code\":\"02GKMS7\",\"PlanName\":\"Gift Card\",\"PlanTypeName\":\"Ind. Prepaid Dollars\",\"PreviousBalance\":\"0\",\"AmountChanged\":\"10.5\",\"CurrentBalance\":\"10.5\",\"BalanceType\":\"Dollar\"},{\"Code\":\"02GRMRG\",\"PlanName\":\"Gift Card\",\"PlanTypeName\":\"Ind. Prepaid Dollars\",\"PreviousBalance\":\"0\",\"AmountChanged\":\"15.75\",\"CurrentBalance\":\"15.75\",\"BalanceType\":\"Dollar\"}],\"Messages\":[]}}"}],"_postman_id":"09fcd945-7192-4a2c-81e0-ede59a98832f"},{"name":"/sale","id":"6e3b7d40-989d-4ba5-aa2f-8fa509da2cc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Id\": 90039857533,\n \"Items\": [\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 20\n },\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 35,\n \"PrepaidCode\": \"\"\n }\n ]\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale","description":"

For use updating a previously created sale prior to tendering, if a customer wants to change sale amount. Requires a SaleRequest object with the previously created SaleID and returns an updated Sale object. Response SaleID will need to be submitted with TenderData in a POST call to /sale to complete the sale.

If the app user decides not to complete the sale, a DELETE call to /sale with the SaleID will instruct SiteWatch to abandon the sale and remove it.

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","sale"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"71d62c2f-3c05-48d7-a03b-f644b130daf7","name":"PATCH Sale Example","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Id\": 90039857533,\n \"Items\": [\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 20\n },\n {\n \"SlotNumber\": 1000,\n \"Quantity\": 1,\n \"Amount\": 35,\n \"PrepaidCode\": \"\"\n }\n ]\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"754","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 16:19:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 f67b851ee5081b3091a26e4dc87cc6c4.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"MmcX6sRy57ZeWanUqClJlXweP1PeI04qS0MiZ-4NQFApOM8GGsOM-w==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8d08f-6266ac9165aa65f5b17beb3e","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"472388c6-b4e9-11e7-bcc3-61e8c7c3d332","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Sale\":{\"Id\":\"10001991451\",\"Total\":\"55\",\"SaleItems\":[{\"ItemName\":\"Gift Card\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"20\",\"PackageAmount\":\"20\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"},{\"ItemName\":\"Gift Card\",\"ItemType\":\"Prepaid\",\"Quantity\":\"1\",\"ItemAmount\":\"35\",\"PackageAmount\":\"35\",\"IndentationLevel\":\"0\",\"Visible\":\"true\"}],\"SalePrepaids\":[{\"Code\":\"02S809K\",\"PlanName\":\"Gift Card\",\"PlanTypeName\":\"Ind. Prepaid Dollars\",\"PreviousBalance\":\"0\",\"AmountChanged\":\"21\",\"CurrentBalance\":\"21\",\"BalanceType\":\"Dollar\"},{\"Code\":\"02SXZHT\",\"PlanName\":\"Gift Card\",\"PlanTypeName\":\"Ind. Prepaid Dollars\",\"PreviousBalance\":\"0\",\"AmountChanged\":\"36.75\",\"CurrentBalance\":\"36.75\",\"BalanceType\":\"Dollar\"}],\"Messages\":[\"Card Balance: $10.50\",\"Card Balance: $15.75\"]}}"}],"_postman_id":"6e3b7d40-989d-4ba5-aa2f-8fa509da2cc8"},{"name":"/sale","id":"cd1a2b1e-f6b6-4f1b-8262-85770eaf2d8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Id\": 50012397949\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale","description":"

For use abandoning previously created sale prior to tendering when the customer decides to cancel their sale. Requires a SaleRequest object with the previously created SaleID and returns an updated Sale object.

Input JSON Schema:\n{\n \"SaleRequest\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n },\n \"required\":[\"Id\"]\n }\n}

Response JSON Schema:\n{\n \"Sale\": {\n \"type\" : \"object\",\n \"properties\" : {\n \"Id\": { \"type\": \"integer\" },\n \"AbandonSuccess\": { \"type\": \"boolean\" },\n \"Messages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}

\n","auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]},"isInherited":true,"source":{"_postman_id":"bb51a275-571d-44e0-ad5c-15a3e7655824","id":"bb51a275-571d-44e0-ad5c-15a3e7655824","name":"SiteWatch API - v1 Stage (Outdated)","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","sale"],"host":["api","sitewatch","cloud"],"query":[],"variable":[]}},"response":[{"id":"c54f149b-b957-4469-aa50-24c17d698323","name":"DEL Sale Example","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"SaleRequest\": {\n \"Id\": 50012397949\n }\n}"},"url":"https://api.sitewatch.cloud/v1/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"108","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Oct 2017 18:36:05 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Via","value":"1.1 62bfddf007f62547e3e721f2f9789b1c.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"prLMRndjoWxECGNQMEIqBl2j298pTVCaG6yh5bYJw4EECnlf-56aZQ==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Amzn-Trace-Id","value":"sampled=1;root=1-59e8f095-ef2b78f5f598d1a3f5b515cf","name":"X-Amzn-Trace-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"},{"key":"x-amzn-RequestId","value":"5d7079e2-b4fc-11e7-810d-3b13a5b51ffa","name":"x-amzn-RequestId","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"Sale\":{\"Id\":40002056987,\"AbandonSuccess\":true,\"Messages\":[\"Card Balance: $10.50\",\"Card Balance: $15.75\"]}}"}],"_postman_id":"cd1a2b1e-f6b6-4f1b-8262-85770eaf2d8b"}],"auth":{"type":"awsv4","awsv4":{"basicConfig":[{"key":"accessKey","value":"{{aws-access-key-id}}"},{"key":"secretKey","value":"{{aws-secret-access-key}}"}],"advancedConfig":[{"key":"region","value":""},{"key":"service","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b517609f-0ef6-4e9e-b296-1ff278149f3b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b9e879c5-e6b2-4fee-9794-f425c62a9180"}}]}