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/vendor-items

Prev Next
Get
/public/v1/vendor-items

Retrieves vendor items according to the specified filters

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
modifiedOnStart
string($date-time)

Starting datetime of 'modifiedOn' range; must be accompanied by 'modifiedOnEnd'

modifiedOnEnd
string($date-time)

Ending datetime of 'modifiedOn' range; must be accompanied by 'modifiedOnStart'

pageSize
integer($int32)

Maximum number of top level objects in the response, max value 250; if there are more objects matching the criteria, a link with a continuation token will be included in the response

continuationToken
string
Responses
200

list of vendor item entities

Expand All
object

A response containing vendor items.

items
Array of object (R365.Inventory.Public.Contracts.VendorItems.Models.VendorItemPublicDto) | null

Collection of public vendor items records returned in this page.

object

A vendor item.

id
string (uuid)

The unique identifier of the vendor item.

name
string | null

The name of the vendor item.

vendor
object (R365.Inventory.Shared.Contracts.Vendors.VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

number
string | null

The user-defined number of the vendor item.

brandItemNumber
string | null

The brand item number of the vendor item.

isPrimary
boolean

Indicates if the vendor item is the primary item.

item
object (R365.Inventory.Public.Contracts.InventoryCounts.Models.PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
purchaseUnitOfMeasure
object (R365.Inventory.Shared.Contracts.UnitsOfMeasure.UnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (R365.Inventory.Shared.Contracts.UnitsOfMeasure.UnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

vendorPackSizeDescription
string | null

The vendor's pack size description.

price
number (double) | null

The price of the vendor item.

splitPrice
number (double) | null

The split price of the vendor item.

createdOn
string (date-time) | null

The date and time the vendor item was created.

createdBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the vendor item was last modified.

modifiedBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object

A response containing vendor items.

items
Array of object (R365.Inventory.Public.Contracts.VendorItems.Models.VendorItemPublicDto) | null

Collection of public vendor items records returned in this page.

object

A vendor item.

id
string (uuid)

The unique identifier of the vendor item.

name
string | null

The name of the vendor item.

vendor
object (R365.Inventory.Shared.Contracts.Vendors.VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

number
string | null

The user-defined number of the vendor item.

brandItemNumber
string | null

The brand item number of the vendor item.

isPrimary
boolean

Indicates if the vendor item is the primary item.

item
object (R365.Inventory.Public.Contracts.InventoryCounts.Models.PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
purchaseUnitOfMeasure
object (R365.Inventory.Shared.Contracts.UnitsOfMeasure.UnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (R365.Inventory.Shared.Contracts.UnitsOfMeasure.UnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

vendorPackSizeDescription
string | null

The vendor's pack size description.

price
number (double) | null

The price of the vendor item.

splitPrice
number (double) | null

The split price of the vendor item.

createdOn
string (date-time) | null

The date and time the vendor item was created.

createdBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the vendor item was last modified.

modifiedBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object

A response containing vendor items.

items
Array of object (R365.Inventory.Public.Contracts.VendorItems.Models.VendorItemPublicDto) | null

Collection of public vendor items records returned in this page.

object

A vendor item.

id
string (uuid)

The unique identifier of the vendor item.

name
string | null

The name of the vendor item.

vendor
object (R365.Inventory.Shared.Contracts.Vendors.VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

number
string | null

The user-defined number of the vendor item.

brandItemNumber
string | null

The brand item number of the vendor item.

isPrimary
boolean

Indicates if the vendor item is the primary item.

item
object (R365.Inventory.Public.Contracts.InventoryCounts.Models.PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
purchaseUnitOfMeasure
object (R365.Inventory.Shared.Contracts.UnitsOfMeasure.UnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (R365.Inventory.Shared.Contracts.UnitsOfMeasure.UnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

vendorPackSizeDescription
string | null

The vendor's pack size description.

price
number (double) | null

The price of the vendor item.

splitPrice
number (double) | null

The split price of the vendor item.

createdOn
string (date-time) | null

The date and time the vendor item was created.

createdBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the vendor item was last modified.

modifiedBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

403

Forbidden

object
type
string | null
title
string | null
status
integer (int32) | null

Current status of the problem details.

detail
string | null
instance
string | null
422

Unprocessable Content

Expand All
object
errorCode
string | null
innerError
object (R365.Inventory.Public.Models.R365Error)
errorCode
string | null
innerError
object (R365.Inventory.Public.Models.R365Error) Recursive