Retrieve All Vendors

The Retrieve All Vendors request retrieves all your vendors and their saved details.


📘

Tip

You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

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.

Back to Top


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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vendors xmlns="http://ws.plimus.com">
  <total-results>751</total-results>
  <last-page>false</last-page>
  <vendor>
    <vendor-id>10410768</vendor-id>
    <email>vendor&#x40;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&#x40;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&#x40;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&#x40;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>

Back to Top


API Explorer

Click "Try It" to test out the request with default values, or add your own query parameters below and they will automatically be added to the request URL.

Language
Authentication
Header
Click Try It! to start a request and see the response here!