v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Vendors

BulkRetrieveVendors

Retrieves one or more vendors of specified Vendor IDs.

post/v2/vendors/bulk-retrieve

Request body

vendor_idsstring[] nullable

IDs of the Vendor objects to retrieve.

Example request

{
  "vendor_ids": [
    "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4"
  ]
}

Response

Success

responsesobject

The set of RetrieveVendorResponse objects encapsulating successfully retrieved Vendor objects or error responses for failed attempts. The set is represented by a collection of Vendor-ID/Vendor-object or Vendor-ID/error-object pairs.

Example response

{
  "responses": {
    "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {
      "vendor": {
        "account_number": "4025391",
        "address": {
          "address_line_1": "505 Electric Ave",
          "address_line_2": "Suite 600",
          "administrative_district_level_1": "NY",
          "country": "US",
          "locality": "New York",
          "postal_code": "10003"
        },
        "contacts": [
          {
            "email_address": "joe@joesfreshseafood.com",
            "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A",
            "name": "Joe Burrow",
            "phone_number": "1-212-555-4250"
          }
        ],
        "created_at": "2022-03-16T10:21:54.859Z",
        "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4",
        "name": "Joe's Fresh Seafood",
        "note": "a vendor",
        "status": "ACTIVE",
        "updated_at": "2022-03-16T10:21:54.859Z",
        "version": 1
      }
    }
  }
}