RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

vendor

A supplier / vendor record.

Linked to products and purchase orders for receiving stock.

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The vendor object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

10 fields on vendor. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Vendor id.

Type
id: string

name

string

Vendor display name.

Type
name: string

code

string

Shop-scoped vendor code.

Type
code: string

email

string | null

Contact email.

Type
email: string | null

phone

string | null

Contact phone.

Type
phone: string | null

website

string | null

Website URL.

Type
website: string | null

address

string | null

Address blob.

Type
address: string | null

isActive

boolean

Whether the vendor is active.

Type
isActive: boolean

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related