vendor createdBeta

EVENT

vendor.created

Published when a Vendor is created.

Permissions:VENDOR_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of a seller associated with this event.

Link to section

location_id

string

The ID of a location associated with the event, if the event is associated with the location of the seller.

Link to section

type

string

The type of this event. The value is "vendor.created".

Link to section

event_id

string

A unique ID for this event.

Link to section

created_at

string

Read only The RFC 3339-formatted time when the underlying event data object is created.

Link to section

data

The data associated with this event.

Link to section

Examples

All versions ->

Response JSON

{
  "merchant_id": "ETCE****QDYP",
  "type": "vendor.created",
  "event_id": "4edd919d-ed19-492d-bcb0-1a1ef65dda1a",
  "created_at": "2022-03-16T01:04:37.308555597Z",
  "data": {
    "type": "vendor",
    "id": "5b041563-c3fa-4989-baaf-dec90e81de0b",
    "object": {
      "operation": "CREATED",
      "vendor": {
        "address": {
          "administrative_district_level_1": "NY",
          "country": "US",
          "locality": "New York",
          "postal_code": "10003"
        },
        "contacts": [
          {
            "email_address": "[email protected]",
            "id": "W43ANBJLR5UAV7WT",
            "name": "Joe Burrow",
            "ordinal": 0,
            "phone_number": "1-212-555-4250"
          }
        ],
        "created_at": "2022-03-16T01:04:12.581Z",
        "id": "BXIDSDOUIU34VY2V",
        "name": "A vendor",
        "status": "ACTIVE",
        "updated_at": "2022-03-16T01:04:12.581Z",
        "version": 1
      }
    }
  }
}