v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Vendors

BulkCreateVendors

Creates one or more Vendor objects to represent suppliers to a seller.

post/v2/vendors/bulk-create

Request body

vendorsobject required

Specifies a set of new Vendor objects as represented by a collection of idempotency-key/Vendor-object pairs.

Example request

{
  "47bb76a8-c9fb-4f33-9df8-25ce02ca4505": {
    "contacts": [
      {
        "email_address": "annie@annieshotsauce.com",
        "name": "Annie Thomas",
        "phone_number": "1-212-555-4250"
      }
    ],
    "name": "Annie’s Hot Sauce"
  },
  "vendors": {
    "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": {
      "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",
          "name": "Joe Burrow",
          "phone_number": "1-212-555-4250"
        }
      ],
      "name": "Joe's Fresh Seafood",
      "note": "a vendor"
    }
  }
}

Response

Success

responsesobject

A set of CreateVendorResponse objects encapsulating successfully created Vendor objects or error responses for failed attempts. The set is represented by a collection of idempotency-key/Vendor-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified in the input.

Example response

{
  "47bb76a8-c9fb-4f33-9df8-25ce02ca4505": {
    "vendor": {
      "contacts": [
        {
          "email_address": "annie@annieshotsauce.com",
          "id": "INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4",
          "name": "Annie Thomas",
          "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-16T10:21:54.859Z",
      "version": 1
    }
  },
  "responses": {
    "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": {
      "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": 0
      }
    }
  }
}