{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"optional","method":"get","results":{"codes":[]},"settings":"","examples":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Retrieve All Vendors","type":"endpoint","slug":"retrieve-all-vendors","excerpt":"","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.\\nMaximum is **500**.\",\n \"3-2\": \"`pagesize=20`\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]\n\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 Example\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/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n \"language\": \"curl\",\n \"name\": \"Retrieve All Vendors Request\"\n }\n ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n### Response Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<vendors xmlns=\\\"http://ws.plimus.com\\\">\\n <total-results>751</total-results>\\n <last-page>false</last-page>\\n <vendor>\\n <vendor-id>10410768</vendor-id>\\n <email>vendor@bluesnap.com</email>\\n <name>Important Vendor</name>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <address>123 Main Street</address>\\n <city>Juneau</city>\\n <zip>4640802</zip>\\n <country>us</country>\\n <phone>0549766778</phone>\\n <state>MA</state>\\n <tax-id>123456789</tax-id>\\n <default-payout-currency>USD</default-payout-currency>\\n <frequency>MONTHLY</frequency>\\n <delay>14</delay>\\n <vendor-principal>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <address>123 Main Street</address>\\n <city>Juneau</city>\\n <zip>12345</zip>\\n <country>US</country>\\n <dob>28-09-9999</dob>\\n <personal-identification-number>1234</personal-identification-number>\\n <driver-license-number>561196411</driver-license-number>\\n <email>principal.name@vendor.com</email>\\n </vendor-principal>\\n <payout-info>\\n <payout-type>ACH</payout-type>\\n <base-currency>USD</base-currency>\\n <minimal-payout-amount>50</minimal-payout-amount>\\n <name-on-account>vendor</name-on-account>\\n <bank-account-class>PERSONAL</bank-account-class>\\n <bank-account-type>CHECKING</bank-account-type>\\n <bank-name>Leumi</bank-name>\\n <bank-id>124456789</bank-id>\\n <country>us</country>\\n <city>Juneau</city>\\n <address>1 bank address</address>\\n <state>MA</state>\\n <zip>12345</zip>\\n <bank-account-id>36628822</bank-account-id>\\n <intermediary-bank-info />\\n </payout-info>\\n <vendor-agreement>\\n <commission-percent>30</commission-percent>\\n <account-status>ACTIVE</account-status>\\n <recurring-commission>Y</recurring-commission>\\n </vendor-agreement>\\n <verification>\\n <payout-status>Approved</payout-status>\\n <processing-status>Active</processing-status>\\n </verification>\\n </vendor>\\n <vendor>\\n <vendor-id>10409208</vendor-id>\\n <email>vendor@bluesnap.com</email>\\n <name>Important Vendor</name>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <address>123 Main Street</address>\\n <city>Juneau</city>\\n <zip>4640802</zip>\\n <country>us</country>\\n <phone>0549766778</phone>\\n <state>MA</state>\\n <tax-id>123456789</tax-id>\\n <default-payout-currency>USD</default-payout-currency>\\n <frequency>MONTHLY</frequency>\\n <delay>14</delay>\\n <vendor-principal>\\n <first-name>Joe</first-name>\\n <last-name>Smith</last-name>\\n <address>123 Main Street</address>\\n <city>Juneau</city>\\n <zip>12345</zip>\\n <country>US</country>\\n <dob>28-09-9999</dob>\\n <personal-identification-number>1234</personal-identification-number>\\n <driver-license-number>561196411</driver-license-number>\\n <email>principal.name@vendor.com</email>\\n </vendor-principal>\\n <payout-info>\\n <payout-type>ACH</payout-type>\\n <base-currency>USD</base-currency>\\n <minimal-payout-amount>50</minimal-payout-amount>\\n <name-on-account>vendor</name-on-account>\\n <bank-account-class>PERSONAL</bank-account-class>\\n <bank-account-type>CHECKING</bank-account-type>\\n <bank-name>Leumi</bank-name>\\n <bank-id>124456789</bank-id>\\n <country>us</country>\\n <city>Juneau</city>\\n <address>1 bank address</address>\\n <state>MA</state>\\n <zip>12345</zip>\\n <bank-account-id>366288322</bank-account-id>\\n <intermediary-bank-info />\\n </payout-info>\\n <vendor-agreement>\\n <commission-percent>30</commission-percent>\\n <account-status>ACTIVE</account-status>\\n <recurring-commission>Y</recurring-commission>\\n </vendor-agreement>\\n <verification>\\n <payout-status>Approved</payout-status>\\n <processing-status>Active</processing-status>\\n </verification>\\n </vendor>\\n</vendors>\",\n \"language\": \"xml\",\n \"name\": \"Retrieve All Vendors Response\"\n }\n ]\n}\n[/block]\n##Example Descriptions\n\n###Retrieve Vendors\nThe example above shows how to retrieve all vendors in your account.\n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603d5be8af8f1a0061138113","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Marketplace","slug":"marketplace","order":13,"from_sync":false,"reference":false,"_id":"603d5be8af8f1a0061138104","version":"603d5be8af8f1a00611381ba","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-11-23T18:27:07.992Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603d5be8af8f1a00611380fb","603d5be8af8f1a00611380fc","603d5be8af8f1a00611380fd","603d5be8af8f1a00611380fe","603d5be8af8f1a00611380ff","603d5be8af8f1a0061138100","603d5be8af8f1a0061138101","603d5be8af8f1a0061138102","603d5be8af8f1a0061138103","603d5be8af8f1a0061138104","603d5be8af8f1a0061138105","603d5be8af8f1a0061138106","603d5be8af8f1a0061138107","603d5be8af8f1a0061138108","603d5be8af8f1a0061138109","603d5be8af8f1a006113810a","603d5be8af8f1a006113810b","603d5be8af8f1a006113810c","603d5be8af8f1a006113810d","603d5be8af8f1a006113810e"],"_id":"603d5be8af8f1a00611381ba","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5ff4b747849e1b03c50684c7","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-11-23T18:31:09.832Z","githubsync":"","__v":0}getRetrieve All Vendors
Definition
https://sandbox.bluesnap.com/services/2/vendors?{parameters}
Documentation
The Retrieve All Vendors request retrieves all your vendors and their saved details.
Request Content
Enter any of the query parameters below into the request URL. For example:services/2/vendors?pagesize=20&after=34567&gettotal=true
Query Parameters
Parameter Name
Description
Example
after
Vendor ID. The response will get the page of results after the specified ID (exclusive).
after=34567
before
Vendor ID. The response will get the page of results before the specified ID (exclusive).
before=12345
gettotal
true = Include the number of total results in the response
gettotal=true
pagesize
Positive integer. Sets the maximum number of results to return (i.e. page size).
Default is 10 if not set.
Maximum is 500.
pagesize=20
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the vendors object.
Examples
Request Example
curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors?gettotal=true
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
<vendors xmlns="http://ws.plimus.com">
<total-results>751</total-results>
<last-page>false</last-page>
<vendor>
<vendor-id>10410768</vendor-id>
<email>vendor@bluesnap.com</email>
<name>Important Vendor</name>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<address>123 Main Street</address>
<city>Juneau</city>
<zip>4640802</zip>
<country>us</country>
<phone>0549766778</phone>
<state>MA</state>
<tax-id>123456789</tax-id>
<default-payout-currency>USD</default-payout-currency>
<frequency>MONTHLY</frequency>
<delay>14</delay>
<vendor-principal>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<address>123 Main Street</address>
<city>Juneau</city>
<zip>12345</zip>
<country>US</country>
<dob>28-09-9999</dob>
<personal-identification-number>1234</personal-identification-number>
<driver-license-number>561196411</driver-license-number>
<email>principal.name@vendor.com</email>
</vendor-principal>
<payout-info>
<payout-type>ACH</payout-type>
<base-currency>USD</base-currency>
<minimal-payout-amount>50</minimal-payout-amount>
<name-on-account>vendor</name-on-account>
<bank-account-class>PERSONAL</bank-account-class>
<bank-account-type>CHECKING</bank-account-type>
<bank-name>Leumi</bank-name>
<bank-id>124456789</bank-id>
<country>us</country>
<city>Juneau</city>
<address>1 bank address</address>
<state>MA</state>
<zip>12345</zip>
<bank-account-id>36628822</bank-account-id>
<intermediary-bank-info />
</payout-info>
<vendor-agreement>
<commission-percent>30</commission-percent>
<account-status>ACTIVE</account-status>
<recurring-commission>Y</recurring-commission>
</vendor-agreement>
<verification>
<payout-status>Approved</payout-status>
<processing-status>Active</processing-status>
</verification>
</vendor>
<vendor>
<vendor-id>10409208</vendor-id>
<email>vendor@bluesnap.com</email>
<name>Important Vendor</name>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<address>123 Main Street</address>
<city>Juneau</city>
<zip>4640802</zip>
<country>us</country>
<phone>0549766778</phone>
<state>MA</state>
<tax-id>123456789</tax-id>
<default-payout-currency>USD</default-payout-currency>
<frequency>MONTHLY</frequency>
<delay>14</delay>
<vendor-principal>
<first-name>Joe</first-name>
<last-name>Smith</last-name>
<address>123 Main Street</address>
<city>Juneau</city>
<zip>12345</zip>
<country>US</country>
<dob>28-09-9999</dob>
<personal-identification-number>1234</personal-identification-number>
<driver-license-number>561196411</driver-license-number>
<email>principal.name@vendor.com</email>
</vendor-principal>
<payout-info>
<payout-type>ACH</payout-type>
<base-currency>USD</base-currency>
<minimal-payout-amount>50</minimal-payout-amount>
<name-on-account>vendor</name-on-account>
<bank-account-class>PERSONAL</bank-account-class>
<bank-account-type>CHECKING</bank-account-type>
<bank-name>Leumi</bank-name>
<bank-id>124456789</bank-id>
<country>us</country>
<city>Juneau</city>
<address>1 bank address</address>
<state>MA</state>
<zip>12345</zip>
<bank-account-id>366288322</bank-account-id>
<intermediary-bank-info />
</payout-info>
<vendor-agreement>
<commission-percent>30</commission-percent>
<account-status>ACTIVE</account-status>
<recurring-commission>Y</recurring-commission>
</vendor-agreement>
<verification>
<payout-status>Approved</payout-status>
<processing-status>Active</processing-status>
</verification>
</vendor>
</vendors>
