{"_id":"5c6c23e4735b81006177d089","category":{"_id":"5c6c23e4735b81006177d00e","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-23T19:23:42.327Z","from_sync":false,"order":8,"slug":"marketplace","title":"Marketplace"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T19:25:37.026Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"auth":"optional","params":[],"url":""},"isReference":false,"order":4,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/vendors?{parameters}</span>\n\n##Documentation\nThe Retrieve All Vendors request retrieves all your vendors and their saved details.\n\n\n###Request Content\nEnter any of the query parameters below into the request URL. For example:\n`services/2/vendors?pagesize=20&after=34567&gettotal=true`\n\n**Query Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"`after`\",\n    \"0-1\": \"Vendor ID. The response will get the page of results after the specified ID (exclusive).\",\n    \"0-2\": \"`after=34567`\",\n    \"1-0\": \"`before`\",\n    \"1-1\": \"Vendor ID. The response will get the page of results before the specified ID (exclusive).\",\n    \"1-2\": \"`before=12345`\",\n    \"2-0\": \"`gettotal`\",\n    \"2-1\": \"**true** = Include the number of total results in the response\",\n    \"2-2\": \"`gettotal=true`\",\n    \"3-0\": \"`pagesize`\",\n    \"3-1\": \"Positive integer. Sets the maximum number of results to return (i.e. page size).\\nDefault is **10** if not set.\",\n    \"3-2\": \"`pagesize=20`\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the [vendors](doc:vendors) object.\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors?gettotal=true\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve All Vendors Request\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"totalResults\\\": 47, \\n    \\\"lastPage\\\": false,\\n    \\\"vendor\\\": [\\n        {\\n            \\\"vendorId\\\": 514151,\\n            \\\"email\\\": \\\"vendor&#x40;bluesnap.com\\\",\\n            \\\"name\\\": \\\"Important Vendor\\\",\\n            \\\"firstName\\\": \\\"Joe\\\",\\n            \\\"lastName\\\": \\\"Smith\\\",\\n            \\\"address\\\": \\\"123 Main Street\\\",\\n            \\\"city\\\": \\\"Juneau\\\",\\n            \\\"zip\\\": \\\"4640802\\\",\\n            \\\"country\\\": \\\"us\\\",\\n            \\\"phone\\\": \\\"0549766778\\\",\\n            \\\"state\\\": \\\"MA\\\",\\n            \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n            \\\"frequency\\\": \\\"DAILY\\\",\\n            \\\"delay\\\": 3,\\n            \\\"vendorPrincipal\\\": {\\n                \\\"firstName\\\": \\\"Joe\\\",\\n                \\\"lastName\\\": \\\"Smith\\\",\\n                \\\"address\\\": \\\"123 Main Street\\\",\\n                \\\"city\\\": \\\"Juneau\\\",\\n                \\\"zip\\\": \\\"12345\\\",\\n                \\\"country\\\": \\\"US\\\",\\n                \\\"dob\\\": \\\"28-09-9999\\\",\\n                \\\"personalIdentificationNumber\\\": 1234,\\n              \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n                \\\"email\\\": \\\"principal.name&#x40;vendor.com\\\"\\n            },\\n            \\\"payoutInfo\\\": [\\n                {\\n                    \\\"payoutType\\\": \\\"ACH\\\",\\n                    \\\"baseCurrency\\\": \\\"USD\\\",\\n                    \\\"nameOnAccount\\\": \\\"vendor\\\",\\n                    \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n                    \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n                    \\\"bankName\\\": \\\"Leumi\\\",\\n                    \\\"bankId\\\": \\\"12445\\\",\\n                    \\\"country\\\": \\\"us\\\",\\n                    \\\"city\\\": \\\"Juneau\\\",\\n                    \\\"address\\\": \\\"1 bank address\\\",\\n                    \\\"state\\\": \\\"MA\\\",\\n                    \\\"zip\\\": \\\"12345\\\",\\n                    \\\"bankAccountId\\\": \\\"36628822\\\",\\n                    \\\"intermediaryBankInfo\\\": {}\\n                }\\n            ],\\n            \\\"vendorAgreement\\\": {\\n                \\\"commissionPercent\\\": 30,\\n                \\\"accountStatus\\\": \\\"ACTIVE\\\",\\n                \\\"recurringCommission\\\": \\\"Y\\\"\\n            }, \\n          \\\"verification\\\": {\\n            \\\"payoutStatus\\\": \\\"Approved\\\",\\n            \\\"processingStatus\\\": \\\"Active\\\",\\n          }\\n        },\\n        {\\n            \\\"vendorId\\\": 514147,\\n            \\\"email\\\": \\\"vendor&#x40;bluesnap.com\\\",\\n            \\\"name\\\": \\\"Important Vendor\\\",\\n            \\\"firstName\\\": \\\"Joe\\\",\\n            \\\"lastName\\\": \\\"Smith\\\",\\n            \\\"address\\\": \\\"123 Main Street\\\",\\n            \\\"city\\\": \\\"Juneau\\\",\\n            \\\"zip\\\": \\\"4640802\\\",\\n            \\\"country\\\": \\\"us\\\",\\n            \\\"phone\\\": \\\"0549766778\\\",\\n            \\\"state\\\": \\\"MA\\\",\\n            \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n            \\\"frequency\\\": \\\"DAILY\\\",\\n            \\\"delay\\\": 3,\\n            \\\"vendorPrincipal\\\": {\\n                \\\"firstName\\\": \\\"Joe\\\",\\n                \\\"lastName\\\": \\\"Smith\\\",\\n                \\\"address\\\": \\\"123 Main Street\\\",\\n                \\\"city\\\": \\\"Juneau\\\",\\n                \\\"zip\\\": \\\"12345\\\",\\n                \\\"country\\\": \\\"US\\\",\\n                \\\"dob\\\": \\\"28-09-9999\\\",\\n                \\\"personalIdentificationNumber\\\": 1234,\\n              \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n                \\\"email\\\": \\\"principal.name&#x40;vendor.com\\\"\\n            },\\n            \\\"payoutInfo\\\": [\\n                {\\n                    \\\"payoutType\\\": \\\"ACH\\\",\\n                    \\\"baseCurrency\\\": \\\"USD\\\",\\n                    \\\"nameOnAccount\\\": \\\"vendor\\\",\\n                    \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n                    \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n                    \\\"bankName\\\": \\\"Leumi\\\",\\n                    \\\"bankId\\\": \\\"12445\\\",\\n                    \\\"country\\\": \\\"us\\\",\\n                    \\\"city\\\": \\\"Juneau\\\",\\n                    \\\"address\\\": \\\"1 bank address\\\",\\n                    \\\"state\\\": \\\"MA\\\",\\n                    \\\"zip\\\": \\\"12345\\\",\\n                    \\\"bankAccountId\\\": \\\"36628822\\\",\\n                    \\\"intermediaryBankInfo\\\": {}\\n                }\\n            ],\\n            \\\"vendorAgreement\\\": {\\n                \\\"commissionPercent\\\": 30,\\n                \\\"accountStatus\\\": \\\"ACTIVE\\\",\\n                \\\"recurringCommission\\\": \\\"Y\\\"\\n            }, \\n           \\\"verification\\\": {\\n              \\\"payoutStatus\\\": \\\"Approved\\\",\\n              \\\"processingStatus\\\": \\\"Active\\\",\\n          }          \\n        }\\n      ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Retrieve All Vendors Response\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"retrieve-all-vendors","type":"endpoint","title":"Retrieve All Vendors"}