curl --location --request GET 'https://api.stateset.com/v1/vendor' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "vendor_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "new_vendor": true,
  "vendor": {
    "team_id": 3,
    "token": "<vendor_api_token>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

GET

vendor

list

curl --location --request GET 'https://api.stateset.com/v1/vendor' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "vendor_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "new_vendor": true,
  "vendor": {
    "team_id": 3,
    "token": "<vendor_api_token>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

Body

string

required

This is the limit of the vendors.

string

required

This is the offset of the vendors.

string

required

This is the order direction of the vendors.

Response

number

This is the id of the vendor.

string

This is the name of the vendor.

string

This is the notes of the vendor.

string

This is the subtype of the vendor.

string

This is the type of the vendor.

string

This is the owner of the vendor.

string

This is the source of the vendor.

string

This is the annual revenue of the vendor.

string

This is the avatar of the vendor.

string

This is the billing city of the vendor.

string

This is the billing country of the vendor.

string

This is the billing latitude of the vendor.

string

This is the billing longitude of the vendor.

string

This is the billing state of the vendor.

string

This is the billing street of the vendor.

string

This is the created at of the vendor.

string

This is the description of the vendor.

string

This is the employees of the vendor.

string

This is the fax of the vendor.

string

This is the industry of the vendor.

string

This is the is active of the vendor.

string

This is the is public of the vendor.

string

This is the last modified by of the vendor.

curl --location --request GET 'https://api.stateset.com/v1/vendor' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "vendor_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "new_vendor": true,
  "vendor": {
    "team_id": 3,
    "token": "<vendor_api_token>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

Vendors

Vendors describes the general data about the vendor in Stateset.

The vendor object

Attributes

Name	Type	Description
id	Text	Unique identifier for the vendor
vendorName	Text	Name of the vendor
vendorNotes	Text	Notes or additional information about the vendor
vendorSubtype	Text	Subtype or specific category of the vendor
vendorType	Text	Type or general category of the vendor
vendor_owner	Text	Owner or responsible person for the vendor
vendor_source	Text	Source or origin of the vendor
annualRevenue	Text	Annual revenue associated with the vendor
avatar	Text	URL or path to the vendor’s avatar image
billingCity	Text	City of the billing address
billingCountry	Text	Country of the billing address
billingLatitude	Text	Latitude coordinate of the billing address
billingLongitude	Text	Longitude coordinate of the billing address
billingState	Text	State or province of the billing address
billingStreet	Text	Street address of the billing address
created_at	Date/Time	Date and time when the vendor was created
description	Text	Description or additional details about the vendor
employees	Text	Number or range of employees associated with the vendor
fax	Text	Fax number of the vendor
industry	Text	Industry or sector of the vendor
is_active	Boolean	Indicates whether the vendor is currently active
is_public	Boolean	Indicates whether the vendor is public or private
last_modified_by	Text	Last person who modified the vendor
numberOfEmployees	Text	Number of employees associated with the vendor
ownership	Text	Ownership type or structure of the vendor
parentVendor	Text	Parent vendor associated with the vendor
phone	Text	Phone number of the vendor
rating	Text	Rating or evaluation of the vendor
shippingCity	Text	City of the shipping address
shippingCountry	Text	Country of the shipping address
shippingLatitude	Text	Latitude coordinate of the shipping address
shippingLongitude	Text	Longitude coordinate of the shipping address
shippingState	Text	State or province of the shipping address
shippingStreet	Text	Street address of the shipping address
stockTicker	Text	Stock ticker symbol associated with the vendor
website	Text	Website URL of the vendor
yearStarted	Text	Year the vendor started or established

Delete Contact Get Vendor

StateSet One API

StateSet API v1

Customer Management

Order Management

Checkouts

Returns Management

Warranty Management

Wholesale Management

Inventory Management

ASN Management

Purchase Orders

Manufacturing

Warehouse Operations

CRM

Suppliers

E-commerce

Financial

Fulfillment

Communication

System

StateSet Response API

StateSet Cloud API

StateSet Commerce API

List Vendor

Body

Response

Vendors

The vendor object

Attributes

​Body

​Response

​Vendors

​The vendor object

​Attributes

Body

Response

Vendors

The vendor object

Attributes