Add a new VendorOrderableItem

Add a new VendorOrderableItem

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

VendorOrderableItem object that needs to be added.

boolean
Defaults to true

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

string

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

string
length ≤ 12

Default item reorder price per unit.

string
length ≤ 12

Default item reorder quantity.

string
length ≤ 15

Product GST ID for tax reporting in certain countries.

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.

boolean
Defaults to true

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

boolean
Defaults to true

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

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.

string
length ≤ 20

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

boolean
Defaults to false

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

string

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

uri

URI of a InventoryUnit API object. Provides exact reference to the inventory unit used for 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.

uri

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

string
length ≤ 255

User defined vendor item ID. Included in purchase orders.

Responses

400

Bad request. Usually caused by invalid request body.

401

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

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json