Replaces a PurchaseOrderItem object

put

https://qa2.revelup.com/resources/PurchaseOrderItem/{PurchaseOrderItemId}/

Replaces a PurchaseOrderItem object specified by ID

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

PurchaseOrderItemId

int64

required

ID of PurchaseOrderItem to replace

Body Params

PurchaseOrderItem object that needs to be updated

_forecasted_amount

float

Field used only for temporarily storing forecasted amount to use for sorting of sent PO items.

closed

boolean

Defaults to false

Flag. If set to True, the item quantity and cost is considered finalized.

conversion_factor

float

Stock unit multiplier used when the item is received in bulk quantities. Item quantity is multiplied by this factor to get the final increase amount.

ingredient

object

inventory_unit

string

length ≤ 255

Unit of measurement to receive the item in.

is_created_through_api

boolean

Defaults to false

Flag. If set to True, flags this item as one created via API. API created items can have their price locked with certain settings.

paid_by_ebt

boolean

Defaults to false

deprecated

Leftover from old order model. Does nothing.

price

float

Price of a single unit.

price_sent_through_api

float

Single unit price, as sent by API. With the appropriate settings enabled, the price will be locked to this value.

product

object

purchase_order

uri

required

URI of the PurchaseOrder API resource representing the purchase order that this item is part of.

quantity

float

required

Total ordered quantity of the specified measurement unit.

reorder_unit_type

uri

URI of the UnitType API resource that represents the reorder unit.

tax_rate

float

deprecated

Unused field included as part of a scrapped project.

taxed

boolean

Defaults to false

Flag. If set to True, the total price of this order item will be used as part of the purchase order tax calculation. Calculation always uses the prevailing tax rate.

total_price

float

required

Total order item price, calculated by multiplying the price and quantity fields.

vendor_item_id

string

length ≤ 255

Text field for entering the vendor item ID to help identify the order item.

Responses

301

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

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.

404

PurchaseOrderItem with the provided ID not found.

201Resource successfully replaced