Vendor Items

Prev Next
Get
/public/v1/inventory/vendor-items

Retrieves a list of vendor items

Security

The requesting user must have the following permission to retrieve vendor items:

  • Food → Vendor Items → View Vendor Items
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
modifiedOnStart
string (date-time)

Starting datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the upper bound.

modifiedOnEnd
string (date-time)

Ending datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the lower bound.

pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
continuationToken
string
Responses
200

list of vendor item entities

Expand All
object

A response containing vendor items.

items
Array of object | 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 (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 whether the vendor item is the primary item.

item
object (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 (InventoryUnitOfMeasureReference)

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 (InventoryUnitOfMeasureReference)

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 (GlAccountUserReference)

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 (GlAccountUserReference)

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 | 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 (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 whether the vendor item is the primary item.

item
object (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 (InventoryUnitOfMeasureReference)

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 (InventoryUnitOfMeasureReference)

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 (GlAccountUserReference)

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 (GlAccountUserReference)

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 | 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 (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 whether the vendor item is the primary item.

item
object (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 (InventoryUnitOfMeasureReference)

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 (InventoryUnitOfMeasureReference)

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 (GlAccountUserReference)

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 (GlAccountUserReference)

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.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.