Sign in

v1

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

CreateVendor

Creates a single Vendor object to represent a supplier to a seller.

post/v2/vendors/create

Request body

idempotency_keystring required

A client-supplied, universally unique identifier (UUID) to make this CreateVendor call idempotent.

See Idempotency in the API Development 101 section for more information.

Example request

{
  "idempotency_key": "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",
        "name": "Joe Burrow",
        "phone_number": "1-212-555-4250"
      }
    ],
    "name": "Joe's Fresh Seafood",
    "note": "a vendor"
  }
}

Response

Success

Example response

{
  "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
  }
}