Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

/public/v1/inventory/vendors/{id}

Prev Next
Get
/public/v1/inventory/vendors/{id}

Retrieves a specified vendor

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Path parameters
id
stringRequired

The identifier of the vendor

Responses
200

The vendor entity

Expand All
object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddressPublicDto)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
Expand All
object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddressPublicDto)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
Expand All
object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddressPublicDto)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null