{"__v":0,"_id":"575676128749830e00681e8c","category":{"version":"575676128749830e00681e82","project":"55a4d5531a5f991700a9409e","_id":"575676128749830e00681e89","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T09:25:52.836Z","from_sync":false,"order":4,"slug":"errors","title":"Errors"},"parentDoc":null,"project":"55a4d5531a5f991700a9409e","user":"560266564f15002100ee444b","version":{"__v":2,"_id":"575676128749830e00681e82","project":"55a4d5531a5f991700a9409e","createdAt":"2016-06-07T07:21:54.005Z","releaseDate":"2016-06-07T07:21:54.005Z","categories":["575676128749830e00681e83","575676128749830e00681e84","575676128749830e00681e85","575676128749830e00681e86","575676128749830e00681e87","575676128749830e00681e88","575676128749830e00681e89","575676128749830e00681e8a","575676128749830e00681e8b","580c5ff36c35230f003d3b49"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-15T09:26:10.646Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"## Properties ##\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"status\",\n    \"1-0\": \"code\",\n    \"2-0\": \"message\",\n    \"3-0\": \"developer_message\",\n    \"4-0\": \"more_info\",\n    \"0-1\": \"int\",\n    \"1-1\": \"string, [Error Codes](doc:error-codes)\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string\",\n    \"0-2\": \"The status property is the same HTTP **status **code as in the response header. By including the status code in the body, any REST client that processes the error has only one place to look for all information about the error.\",\n    \"1-2\": \"The **code **property is an error code specific to this REST API. It is used to extend the HTTP status codes, that are more general purposed, with codes that will describe the error in more detail. If no specific code exist for the exception the HTTP status code will be returned.\",\n    \"2-2\": \"The **message **property is a human readable error message that can potentially be shown directly to an application end user.\",\n    \"3-2\": \"The **developer_message** property contains technical information that a developer calling your REST API might find useful. This might include exception messages, stack traces etc.\",\n    \"4-2\": \"The **more_info** property specifies a URL to a resource where more information.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n## Example ##\n\nThe structure of an error response can be found below.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": 401,\\n  \\\"code\\\": \\\"RET-001\\\",\\n  \\\"message\\\": \\\"Invalid authorization method.\\\",\\n  \\\"developer_message\\\": \\\"The Retailer is unauthorized to make the request.\\\",\\n  \\\"more_info\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"error-responses","type":"basic","title":"Error Responses"}

Error Responses


## Properties ## [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "status", "1-0": "code", "2-0": "message", "3-0": "developer_message", "4-0": "more_info", "0-1": "int", "1-1": "string, [Error Codes](doc:error-codes)", "2-1": "string", "3-1": "string", "4-1": "string", "0-2": "The status property is the same HTTP **status **code as in the response header. By including the status code in the body, any REST client that processes the error has only one place to look for all information about the error.", "1-2": "The **code **property is an error code specific to this REST API. It is used to extend the HTTP status codes, that are more general purposed, with codes that will describe the error in more detail. If no specific code exist for the exception the HTTP status code will be returned.", "2-2": "The **message **property is a human readable error message that can potentially be shown directly to an application end user.", "3-2": "The **developer_message** property contains technical information that a developer calling your REST API might find useful. This might include exception messages, stack traces etc.", "4-2": "The **more_info** property specifies a URL to a resource where more information." }, "cols": 3, "rows": 5 } [/block] ## Example ## The structure of an error response can be found below. [block:code] { "codes": [ { "code": "{\n \"status\": 401,\n \"code\": \"RET-001\",\n \"message\": \"Invalid authorization method.\",\n \"developer_message\": \"The Retailer is unauthorized to make the request.\",\n \"more_info\": null\n}", "language": "json" } ] } [/block]