{"_id":"5adf4c260d03070003a2f5a6","category":{"_id":"5adf4c260d03070003a2f59b","version":"5adf4c260d03070003a2f591","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":"5adf4c260d03070003a2f591","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5adf4c260d03070003a2f592","5adf4c260d03070003a2f593","5adf4c260d03070003a2f594","5adf4c260d03070003a2f595","5adf4c260d03070003a2f596","5adf4c260d03070003a2f597","5adf4c260d03070003a2f598","5adf4c260d03070003a2f599","5adf4c260d03070003a2f59a","5adf4c260d03070003a2f59b","5adf4c260d03070003a2f59c","5adf4c260d03070003a2f59d","5adf4c260d03070003a2f59e","5adf4c260d03070003a2f59f","5adf4c260d03070003a2f5a0","5adf4c260d03070003a2f5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25.1 Release","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":""},"isReference":false,"order":36,"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\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\": \"<vendors xmlns=\\\"http://ws.plimus.com\\\">\\n  <total-results>148</total-results>\\n  <last-page>false</last-page>\\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.\n\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"}

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.

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='

Back to Top


Response Example

<vendors xmlns="http://ws.plimus.com">
  <total-results>148</total-results>
  <last-page>false</last-page>
  <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.



Back to Top