Returns the list of VendorOrderableItem objects

get https://qa2.revelup.com/resources/VendorOrderableItem/

Returns a list of products and ingredients attached to vendors.

Query Params

active

boolean

Flag. If set to True, the request will only return currently active vendor items.

product

integer

Expects a product ID. Will only return vendor items with the specified product.

vendor

integer

Expects a vendor ID. Will only return vendor items carried by the specified vendor.

primary_vendor

integer

Expects a vendor ID. Will only return vendor items where the specified vendor is the primary source.

ingredient

integer

Expects an ingredient ID. Will only return vendor items with the specified ingredient.

order_by

string

fields

array of strings

Comma separated list of fields to display. Only the specified fields will be returned in the response body, along with fields related to those specified.

fields

limit

integer

Defaults to 20

Amount of objects to return per query. This amount must be lower than 100 to avoid high server load.

offset

integer

Defaults to 0

Offset value for returned resources. Used in conjunction with the limit parameter to return resources in "pages".

Responses

Response body

array of objects

object

active

boolean

Defaults to true

Flag. If set to True, the item can be ordered from the associated vendor.

conversion_factor

string

Conversion factor of the default unit of measure. Received stock is multiplied by this number to get the total received inventory quantity.

default_price

string

length ≤ 12

Default item reorder price per unit.

default_quantity

string

length ≤ 12

Default item reorder quantity.

gst_id

string

length ≤ 15

Product GST ID for tax reporting in certain countries.

number

ID of this VendorOrderableItem object.

ingredient

uri

URI of an Ingredient API object, which represents the ingredient carried by the associated vendor. This value can be null if the product URI is provided instead.

primary_stock_unit

boolean

Defaults to true

Flag. If set to True, the reorder unit is the primary item stock unit.

primary_vendor

boolean

Defaults to true

Flag. If set to True, the vendor associated with this item is the primary source of the item.

product

uri

URI of a ViewPurchaseOrderProductResource API object, which represents the product carried by the associated vendor. This value can be null if the ingredient URI is provided instead.

reorder_tax_rate

string

length ≤ 20

Default tax rate to be applied on future reorders of this item from this vendor.

reorder_to_par

boolean

Defaults to false

Flag. If set to True, calculates default quantity dynamically. Quantity is returned in reorder_unit_type UOM.

reorder_unit

string

Reorder unit name. Field only populated when primary_stock_unit is set to false.

reorder_unit_type

uri

URI of a InventoryUnit API object. Provides exact reference to the inventory unit used for reorder.

resource_uri

uri

URI of this VendorOrderableItem object.

taxed_on_reorder

boolean

Defaults to true

Flag. If set to True, the reorder_tax_rate will be applied on future reorders of this item from this vendor.

vendor

uri

URI of a Vendor API object. Specifies the vendor that carries the product/ingredient.

vendor_item_id

string

length ≤ 255

User defined vendor item ID. Included in purchase orders.

301

Invalid request URL - make sure that the URL ends with a trailing slash.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://qa2.revelup.com/resources/VendorOrderableItem/?limit=20&offset=0' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Resource successfully retrieved.