Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Vendors

BulkUpdateVendors

Updates one or more of existing Vendor objects as suppliers to a seller.

put/v2/vendors/bulk-update

Request body

vendorsobject required

A set of UpdateVendorRequest objects encapsulating to-be-updated Vendor objects. The set is represented by a collection of Vendor-ID/UpdateVendorRequest-object pairs.

Example request

{
  "vendors": {
    "FMCYHBWT1TPL8MFH52PBMEN92A": {
      "address": {
        "address_line_1": "202 Mill St",
        "administrative_district_level_1": "NJ",
        "country": "US",
        "locality": "Moorestown",
        "postal_code": "08057"
      },
      "status": "ACTIVE",
      "version": 10
    },
    "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {
      "note": "favorite vendor",
      "status": "ACTIVE",
      "version": 30
    }
  }
}

Response

Success

responsesobject

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

Example response

{
  "responses": {
    "INV_V_FMCYHBWT1TPL8MFH52PBMEN92A": {
      "vendor": {
        "address": {
          "address_line_1": "202 Mill St",
          "administrative_district_level_1": "NJ",
          "country": "US",
          "locality": "Moorestown",
          "postal_code": "08057"
        },
        "contacts": [
          {
            "email_address": "annie@annieshotsauce.com",
            "id": "INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4",
            "name": "Annie Thomas",
            "ordinal": 0,
            "phone_number": "1-212-555-4250"
          }
        ],
        "created_at": "2022-03-16T10:21:54.859Z",
        "id": "INV_V_FMCYHBWT1TPL8MFH52PBMEN92A",
        "name": "Annie’s Hot Sauce",
        "status": "ACTIVE",
        "updated_at": "2022-03-16T20:21:54.859Z",
        "version": 11
      }
    },
    "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",
            "ordinal": 0,
            "phone_number": "1-212-555-4250"
          }
        ],
        "created_at": "2022-03-16T10:10:54.859Z",
        "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4",
        "name": "Joe's Fresh Seafood",
        "note": "favorite vendor",
        "status": "ACTIVE",
        "updated_at": "2022-03-16T20:21:54.859Z",
        "version": 31
      }
    }
  }
}