• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Vendor BETA

Represents a supplier to a seller.

Properties

Name Description
id
string

A unique Square-generated ID for the Vendor. This field is required when attempting to update a Vendor.

Max Length 100
created_at
string

Read only An RFC 3339-formatted timestamp that indicates when the Vendor was created.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Max Length 34
updated_at
string

Read only An RFC 3339-formatted timestamp that indicates when the Vendor was last updated.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Max Length 34
name
string

The name of the Vendor. This field is required when attempting to create or update a Vendor.

Max Length 100
address
Address

The address of the Vendor.

contacts
VendorContact [ ]

The contacts of the Vendor.

account_number
string

The account number of the Vendor.

Max Length 100
note
string

A note detailing information about the Vendor.

Max Length 4096
version
integer (32-bit)

The version of the Vendor.

status
string

The status of the Vendor.