The Notus API is REST based. Our API returns JSON-encoded responses and uses standard HTTP response codes. All API calls must be authenticated and accessed over SSL (HTTPS) and all data is transported using JSON.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8054331","collectionId":"63350e37-1278-4086-bf8b-7653e849d00f","publishedId":"TVmPAGfy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-12-12T18:48:05.000Z"},"item":[{"name":"Authentication","item":[{"name":"Token","id":"9a10f47b-3031-4101-b513-69573535af51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"user_name\": \"notus_user@domain.com\",\n \"password\": \"sns97dfbw\"\n}\n"},"url":"https://api.notuscontact.com/v1/token","description":"Generate a token using user credentials.
\n","urlObject":{"path":["token"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"bec13327-2ae1-49d0-a24f-eee64e0a1570","name":"Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\"user_name\": \"notus_user@domain.com\",\n \"password\": \"sns97dfbw\"\n}\n"},"url":"https://api.notuscontact.com/v1/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"268"},{"key":"Date","value":"Fri, 11 Dec 2020 17:09:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9a10f47b-3031-4101-b513-69573535af51"}],"id":"be663c31-ea76-48d7-88fc-09d914f86cf8","_postman_id":"be663c31-ea76-48d7-88fc-09d914f86cf8","description":""},{"name":"Customers","item":[{"name":"Create a Customer","id":"ef0aa55a-b193-476b-912f-90cefb2e5b5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"customer_id\": \"c6284549\",\r\n \"email_address\": [\"123@gmail.com\", \"345@yahoo.com\"],\r\n \"phone_number\": [\"123-456-7891\", \"321-654-1987\"],\r\n\t\"address\":{\r\n\t \"street_address\": \"7884 East Quaker\",\r\n\t \"street_address2\": \"Apt #4\",\r\n\t \"city\": \"Buffalo\",\r\n \"postal_code\": \"14127\",\r\n\t \"state_province\": \"New York\",\r\n\t \"country\": \"US\",\r\n\t \"location\": { \r\n \"lat\": 41.12,\r\n \"lon\": -71.34\r\n }\r\n\t },\r\n\t\"tags\": [\r\n \"Gold\",\r\n \"Enthusiast\"\r\n ],\r\n \"attributes\": {\r\n \"key\":\"value\",\r\n \"key2\":\"value2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/customers","description":"Customer ID must be unique. This endpoint will replace all information for any customer ID previously sent. If fields are omitted, they will overwrite previously sent values in those fields with nulls. Additional descriptors can be including in the \"attributes\" field which can contain any key value pair. Values in “attributes” can be strings, numbers, or dicts themselves.
\n","urlObject":{"path":["customers"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"6d3f23ba-7a93-42d0-a285-070d22b52cb2","name":"Create a Customer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"customer_id\": \"c6284549\",\r\n \"email_address\": [\"123@gmail.com\", \"345@yahoo.com\"],\r\n \"phone_number\": [\"123-456-7891\", \"321-654-1987\"],\r\n\t\"address\":{\r\n\t \"street_address\": \"7884 East Quaker\",\r\n\t \"street_address2\": \"Apt #4\",\r\n\t \"city\": \"Buffalo\",\r\n \"postal_code\": \"14127\",\r\n\t \"state_province\": \"New York\",\r\n\t \"country\": \"US\",\r\n\t \"location\": { \r\n \"lat\": 41.12,\r\n \"lon\": -71.34\r\n }\r\n\t },\r\n\t\"tags\": [\r\n \"Gold\",\r\n \"Enthusiast\"\r\n ],\r\n \"attributes\": {\r\n \"key\":\"value\",\r\n \"key2\":\"value2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 10 Dec 2020 00:42:40 GMT"},{"key":"x-amzn-RequestId","value":"aa86faf3-2017-4397-a4c3-c0a8b7794853"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"x-amz-apigw-id","value":"XT5IEHVhIAMFeRA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5fd16f00-19cc7d9f7280b13047fded8b;Sampled=0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 98e601970ea59f4d5f56a752787ff9fc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HIO50-C1"},{"key":"X-Amz-Cf-Id","value":"gJedc0PWW0EQVAvmCeBWOodYTQkLCJwaC0gUZ-WmxK1v2pd4ga-rKQ=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ef0aa55a-b193-476b-912f-90cefb2e5b5f"},{"name":"Update a Customer","id":"2eb6c3bd-017b-4eb6-b75a-2154cd6961ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"street_address\": \"21 Bridge Street\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/customers/234234","description":"Will replace any provided values for given customer_id. If base fields are omitted (not tags or attributes), they will not overwrite previously sent values in those fields with nulls. If attribute keys or tags are omitted, they will overwrite previously sent values in those fields with nulls.
\n","urlObject":{"path":["customers","234234"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"8234128a-02fa-4c2f-aac6-7cd55e2ac2e5","name":"Update a Customer","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"street_address\": \"21 Bridge Street\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/customers/234234"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"29"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 10 Dec 2020 00:58:01 GMT"},{"key":"x-amzn-RequestId","value":"c309defd-48a8-4fdf-bfa1-8b703b5b6bb1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"x-amz-apigw-id","value":"XT7XwHHxIAMFyXg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5fd17297-30bab7064c0459fe3385f978;Sampled=0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 446313511980eb02f28ff5a9a4147c0a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HIO50-C1"},{"key":"X-Amz-Cf-Id","value":"qTfd-7eSrCv7vftgUkrvKRmngsSFIqWoeD3r0fGXWUXStoKCSMzdCA=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2eb6c3bd-017b-4eb6-b75a-2154cd6961ba"},{"name":"Get a Customer","id":"5acca00b-9626-4d6a-a644-ced2b93135ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.notuscontact.com/v1/customers/c6284549","description":"Order ID must be unique. This endpoint will replace all information for any order ID previously sent. If fields are omitted, they will overwrite previously sent values in those fields with nulls. Additional descriptors can be including in the \"attributes\" field which can contain any key value pair. Values in “attributes” can be strings, numbers, or dicts themselves.
\nWill replace any provided values for given order_id. If base fields are omitted (not tags or attributes), they will not overwrite previously sent values in those fields with nulls. If attribute keys or tags are omitted, they will overwrite previously sent values in those fields with nulls.
\nProduct ID must be unique. This endpoint will replace all information for any Store ID previously sent. If fields are omitted, they will overwrite previously sent values in those fields with nulls. Additional descriptors can be including in the \"attributes\" field which can contain any key value pair. Values in “attributes” can be strings, numbers, or dicts themselves.
\n","urlObject":{"path":["products"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"1b6f9809-1862-41aa-bbb7-31856132fa2f","name":"Create a Product","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"product_id\": \"35g327\",\r\n \"ticket_price\": 19.95,\r\n \"tags\": [\r\n \"Down\",\r\n \"Winter\"\r\n ],\r\n \"attributes\": {\r\n \"key\":\"value\",\r\n \"key2\":\"value2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/products"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"49"},{"key":"Date","value":"Fri, 11 Dec 2020 17:31:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"39ac1d50-cd5c-45dd-a599-797ca17a1ff1"},{"name":"Update a Product","id":"e51e4150-c2ae-4ee3-8ec0-b8d4d47c39be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"product_id\": \"35g327\",\r\n \"ticket_price\": 29.95\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/products/35g327","description":"Will replace any provided values for given product_id. If base fields are omitted (not tags or attributes), they will not overwrite previously sent values in those fields with nulls. If attribute keys or tags are omitted, they will overwrite previously sent values in those fields with nulls.
\n","urlObject":{"path":["products","35g327"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"dc2f2a1e-6cbf-418a-92cf-75fe8c484532","name":"Update a Product","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"product_id\": \"35g327\",\r\n \"ticket_price\": 29.95\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/products/35g327"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"29"},{"key":"Date","value":"Fri, 11 Dec 2020 17:32:41 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e51e4150-c2ae-4ee3-8ec0-b8d4d47c39be"},{"name":"Get a Product","id":"15c366c4-e6bf-4d7b-bd67-17237536a4eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.notuscontact.com/v1/products/35g327","description":"Store ID must be unique. This endpoint will replace all information for any Store ID previously sent. If fields are omitted, they will overwrite previously sent values in those fields with nulls. Additional descriptors can be including in the \"attributes\" field which can contain any key value pair. Values in “attributes” can be strings, numbers, or dicts themselves.
\n","urlObject":{"path":["stores"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"ba98b8ea-2804-4c90-a0b4-a994ea6b0fac","name":"Create a Store","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"store_id\": \"9\",\r\n \"address\":{\r\n\t \"street_address\": \"7884 East Quaker\",\r\n\t \"street_address2\": \"Apt #4\",\r\n\t \"city\": \"Buffalo\",\r\n \"postal_code\": \"14127\",\r\n\t \"state_province\": \"New York\",\r\n\t \"country\": \"US\",\r\n\t \"location\": { \r\n \"lat\": 41.12,\r\n \"lon\": -71.34\r\n }\r\n\t },\r\n \"tags\": [\r\n \"Gold\",\r\n \"Enthusiast\"\r\n ],\r\n \"attributes\": {\r\n \"key\":\"value\",\r\n \"key2\":\"value2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/stores"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"42"},{"key":"Date","value":"Fri, 11 Dec 2020 17:33:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9f7c138a-4b86-4177-82e0-e9ec8e644715"},{"name":"Update a Store","id":"c7512c69-684c-4559-aaf7-bdc1c81f36fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"tags\": [\r\n \"Farm\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/stores/9","description":"Will replace any provided values for given store_id. If base fields are omitted (not tags or attributes), they will not overwrite previously sent values in those fields with nulls. If attribute keys or tags are omitted, they will overwrite previously sent values in those fields with nulls.
\n","urlObject":{"path":["stores","9"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"8becb385-fd08-4b9d-9210-889dfbf58f93","name":"Update a Store","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"tags\": [\r\n \"Farm\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/stores/9"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"24"},{"key":"Date","value":"Fri, 11 Dec 2020 17:33:52 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c7512c69-684c-4559-aaf7-bdc1c81f36fc"},{"name":"Get a Store","id":"508a134e-4fd6-43e5-96d6-97163baceef4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.notuscontact.com/v1/stores/9","description":"Files must be in jsonL format. A JsonL file must conform to the following:
\nUTF-8 Encoding JSON allows encoding Unicode strings with only ASCII escape sequences, however those escapes will be hard to read when viewed in a text editor. The author of the JSON Lines file may choose to escape characters to work with plain ASCII files. Encodings other than UTF-8 are very unlikely to be valid when decoded as UTF-8 so the chance of accidentally misinterpreting characters in JSON Lines files is low.
\nEach Line is a Valid JSON Value The most common values will be objects or arrays, but any JSON value is permitted.
\nLine Separator is '\\n'
\nInformation in the file must conform to the \"Create\" requirements of one of the following categories:
\nEach line in the jsonL will create a record in the same manner a request to the Create endpoint would for the associated category. Returns Job ID, Job progress can be pulled from Jobs endpoint.
\n","urlObject":{"path":["file_import"],"host":["https://api.notuscontact.com/v1"],"query":[],"variable":[]}},"response":[{"id":"bfbe7a34-6704-4812-b733-0ef73ad81d67","name":"File Import","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"category\": \"order\",\n\"method\": \"s3\",\n\"server\": \"sftp.yoursftp.com\",\n\"user_name\": \"notus_test\",\n\"password\": \"2nbde02ns\",\n\"key_pair\": false,\n\"port\": 22,\n\"aws_access_key_id\": \"**Your s3 Key*\",\n\"aws_secret_access_key\": \"**Your s3 Secret*\",\n\"aws_bucket\": \"your_bucket\",\n\"aws_region\": \"us-east-1\",\n\"path\": \"/orders_5777_3.json\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notuscontact.com/v1/file_import"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 13 Dec 2020 18:18:43 GMT"},{"key":"x-amzn-RequestId","value":"07475392-6606-4ee8-9316-3648b8ed6b04"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"XgMofHZeIAMFXOA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 cb2af39fbf29fa8b3d7f263c2b822093.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HIO50-C1"},{"key":"X-Amz-Cf-Id","value":"CZkB9RtWboreWW7e4VbiA7A5pkhFoI3AiaBvFP6t_FSSnCMbFnw79w=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"240a37e3-3893-41e0-a007-5edf5594b83f"}],"id":"551e8991-1fec-4842-853b-7af12a9ba3da","_postman_id":"551e8991-1fec-4842-853b-7af12a9ba3da","description":""},{"name":"Jobs","item":[{"name":"Get a Job","id":"8faa38fa-4659-4cf7-82ff-d2fcf3a51072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"**Token from Auth endpoint**"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.notuscontact.com/v1/job/cb0ef02f8539421b9f38","description":"