{"_id":"59a45d477ee621000fc9d442","category":{"_id":"59a45d447ee621000fc9d3c1","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-23T18:27:07.992Z","from_sync":false,"order":9,"slug":"marketplace","title":"Marketplace"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T18:31:09.832Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"optional","params":[],"url":"/vendors/"},"isReference":false,"order":34,"body":"[block:html]\n{\n  \"html\": \"<script>\\n  // hide body textbox of API Explorer\\n $(document).ready(function() {\\n  $(\\\"textarea[placeholder='Body Content']\\\").hide();  \\n }); \\n</script>\"\n}\n[/block]\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/\\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\": \"<vendors xmlns=\\\"http://ws.plimus.com\\\">\\n  <vendor>\\n    <vendor-id>10396912</vendor-id>\\n    <email>name:::at:::yahoo.com</email>\\n    <name>MarketVendor</name>\\n    <first-name>Vita</first-name>\\n    <last-name>Test</last-name>\\n    <address>Medinat</address>\\n    <city>Tel Aviv</city>\\n    <zip>123456</zip>\\n    <country>il</country>\\n    <phone>1800808080</phone>\\n    <default-payout-currency>USD</default-payout-currency>\\n    <frequency>DAILY</frequency>\\n    <delay>3</delay>\\n    <vendor-principal>\\n      <first-name>Brad</first-name>\\n      <last-name>Pitt</last-name>\\n      <address>Hollywood</address>\\n      <city>LA</city>\\n      <zip>4234234</zip>\\n      <country>US</country>\\n      <dob>04-10-1983</dob>\\n      <personal-identification-number>1234</personal-identification-number>\\n      <driver-license-number>561196411</driver-license-number>\\n      <email>test@test.com</email>\\n    </vendor-principal>\\n    <payout-info>\\n      <payout-type>ACH</payout-type>\\n      <base-currency>USD</base-currency>\\n      <name-on-account>Kuki</name-on-account>\\n      <bank-account-class>CORPORATE</bank-account-class>\\n      <bank-account-type>CHECKING</bank-account-type>\\n      <bank-name>Leumi</bank-name>\\n      <bank-id>12445</bank-id>\\n      <country>ir</country>\\n      <city>Teheran</city>\\n      <address>Tahrir</address>\\n      <zip>665433</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>513275</vendor-id>\\n    <email>joe@yahoo.com</email>\\n    <name>MarketVendor</name>\\n    <first-name>Vita</first-name>\\n    <last-name>Test</last-name>\\n    <address>Medinat</address>\\n    <city>Tel Aviv</city>\\n    <zip>123456</zip>\\n    <country>il</country>\\n    <phone>1800808080</phone>\\n    <default-payout-currency>USD</default-payout-currency>\\n    <frequency>DAILY</frequency>\\n    <delay>3</delay>\\n    <vendor-principal>\\n      <first-name>Tom</first-name>\\n      <last-name>Jones</last-name>\\n      <address>Hollywood</address>\\n      <city>LA</city>\\n      <zip>4234234</zip>\\n      <country>US</country>\\n      <dob>04-10-1983</dob>\\n      <personal-identification-number>1234</personal-identification-number>\\n      <driver-license-number>561196411</driver-license-number>\\n      <email>test@test.com</email>\\n    </vendor-principal>\\n    <payout-info>\\n      <payout-type>ACH</payout-type>\\n      <base-currency>USD</base-currency>\\n      <name-on-account>Kuki</name-on-account>\\n      <bank-account-class>INTERNATIONAL</bank-account-class>\\n      <bank-account-type>CHECKING</bank-account-type>\\n      <bank-name>Leumi</bank-name>\\n      <bank-id>12445</bank-id>\\n      <country>ir</country>\\n      <city>Teheran</city>\\n      <address>Tahrir</address>\\n      <zip>665433</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</vendors>\\n\",\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.","excerpt":"","slug":"retrieve-all-vendors","type":"get","title":"Retrieve All Vendors"}

getRetrieve All Vendors


Definition

{{ api_url }}{{ page_api_url }}

Documentation


Examples

Request Example

curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors/
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Back to Top


Response Example

<vendors xmlns="http://ws.plimus.com">
  <vendor>
    <vendor-id>10396912</vendor-id>
    <email>name@yahoo.com</email>
    <name>MarketVendor</name>
    <first-name>Vita</first-name>
    <last-name>Test</last-name>
    <address>Medinat</address>
    <city>Tel Aviv</city>
    <zip>123456</zip>
    <country>il</country>
    <phone>1800808080</phone>
    <default-payout-currency>USD</default-payout-currency>
    <frequency>DAILY</frequency>
    <delay>3</delay>
    <vendor-principal>
      <first-name>Brad</first-name>
      <last-name>Pitt</last-name>
      <address>Hollywood</address>
      <city>LA</city>
      <zip>4234234</zip>
      <country>US</country>
      <dob>04-10-1983</dob>
      <personal-identification-number>1234</personal-identification-number>
      <driver-license-number>561196411</driver-license-number>
      <email>test@test.com</email>
    </vendor-principal>
    <payout-info>
      <payout-type>ACH</payout-type>
      <base-currency>USD</base-currency>
      <name-on-account>Kuki</name-on-account>
      <bank-account-class>CORPORATE</bank-account-class>
      <bank-account-type>CHECKING</bank-account-type>
      <bank-name>Leumi</bank-name>
      <bank-id>12445</bank-id>
      <country>ir</country>
      <city>Teheran</city>
      <address>Tahrir</address>
      <zip>665433</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>513275</vendor-id>
    <email>joe@yahoo.com</email>
    <name>MarketVendor</name>
    <first-name>Vita</first-name>
    <last-name>Test</last-name>
    <address>Medinat</address>
    <city>Tel Aviv</city>
    <zip>123456</zip>
    <country>il</country>
    <phone>1800808080</phone>
    <default-payout-currency>USD</default-payout-currency>
    <frequency>DAILY</frequency>
    <delay>3</delay>
    <vendor-principal>
      <first-name>Tom</first-name>
      <last-name>Jones</last-name>
      <address>Hollywood</address>
      <city>LA</city>
      <zip>4234234</zip>
      <country>US</country>
      <dob>04-10-1983</dob>
      <personal-identification-number>1234</personal-identification-number>
      <driver-license-number>561196411</driver-license-number>
      <email>test@test.com</email>
    </vendor-principal>
    <payout-info>
      <payout-type>ACH</payout-type>
      <base-currency>USD</base-currency>
      <name-on-account>Kuki</name-on-account>
      <bank-account-class>INTERNATIONAL</bank-account-class>
      <bank-account-type>CHECKING</bank-account-type>
      <bank-name>Leumi</bank-name>
      <bank-id>12445</bank-id>
      <country>ir</country>
      <city>Teheran</city>
      <address>Tahrir</address>
      <zip>665433</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>
</vendors>

Example Descriptions

Retrieve Vendors

The example above shows how to retrieve all vendors in your account.


User Information

Try It Out


get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}