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 Examples

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

Response Examples

{
  "totalResults": 746,
  "lastPage": false,
  "vendor": [
    {
      "vendorId": 10415692,
      "email": "vendor@bluesnap.com",
      "name": "Important Vendor",
      "vendorUrl": "http://mycompany.com",
      "firstName": "Joe",
      "lastName": "Smith",
      "address": "123 Main Street",
      "city": "testing city",
      "zip": "02453",
      "country": "us",
      "phone": "1-054-976-6778",
      "state": "MA",
      "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Juneau",
        "zip": "02453",
        "country": "US",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
        "driverLicenseNumber": "561196411",
        "email": "principal.name@vendor.com"
      },
      "payoutConfiguration": {
        "payoutFrequency": "MONTHLY",
        "reviewDelay": 14,
        "defaultLegalEntity": "US",
        "regions": [
          {
            "region": "US",
            "defaultCurrency": "USD",
            "currencyByRegion": [
              {
                "currencyCode": "USD",
                "status": "Active",
                "payoutPaymentType": "WIRE",
                "minimumPaymentAmount": 65,
                "reserve": {
                  "merchantReserve": {
                    "keepOnMerchantReserve": 110
                  }
                },
                "bankDetails": [
                  {
                    "country": "US",
                    "state": "MA",
                    "city": "Portland",
                    "address1": "1 bank address",
                    "zipCode": "12345",
                    "paymentReference": "payment",
                    "bic": "EXBN01",
                    "bankName": "Leumi",
                    "iban": "ABC123456789DEF",
                    "nameOnAccount": "Vendor",
                    "status": "Pending"
                  }
                ]
              }
            ]
          }
        ]
      },
      "vendorAgreement": {
        "commissionPercent": 20,
        "accountStatus": "ACTIVE",
        "recurringCommission": "Y"
      },
      "verification": {
        "payoutStatus": "Approved",
        "processingStatus": "Active"
      }
    },
    {
      "vendorId": 10409208,
      "email": "vendor@bluesnap.com",
      "name": "Important Vendor",
      "firstName": "Joe",
      "lastName": "Smith",
      "address": "123 Main Street",
      "city": "Juneau",
      "zip": "02453",
      "country": "us",
      "phone": "0549766778",
      "state": "MA",
      "taxId": "123456789",
      "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Juneau",
        "zip": "02453",
        "country": "US",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
        "driverLicenseNumber": "561196411",
        "email": "principal.name@vendor.com"
      },
      "payoutConfiguration": {
        "payoutFrequency": "MONTHLY",
        "reviewDelay": 14,
        "defaultLegalEntity": "US",
        "regions": [
          {
            "region": "US",
            "defaultCurrency": "USD",
            "currencyByRegion": [
              {
                "currencyCode": "USD",
                "status": "Active",
                "payoutPaymentType": "ACH",
                "minimumPaymentAmount": 65,
                "reserve": {
                  "merchantReserve": {
                    "keepOnMerchantReserve": 110
                  }
                },
                "bankDetails": [
                  {
                    "country": "US",
                    "state": "MA",
                    "city": "Juneau",
                    "address1": "1 bank address",
                    "zipCode": "12345",
                    "paymentReference": "payment",
                    "bic": "EXBN01",
                    "bankName": "Leumi",
                    "iban": "ABC123456789DEF",
                    "nameOnAccount": "Vendor",
                    "status": "Pending"
                  }
                ]
              }
            ]
          }
        ]
      },
      "vendorAgreement": {
        "commissionPercent": 30,
        "accountStatus": "ACTIVE",
        "recurringCommission": "Y"
      },
      "verification": {
        "payoutStatus": "Approved",
        "processingStatus": "Active"
      }
    }
  ]
}

API Explorer

To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.