Recieve into Products's Inventory

post https://api-sandbox-revel.revelup.com/inventoryx/api/inventory/Product/{ProductId}/receive/

Performs recieve operation into Products's Inventory. Returns updated inventory.

Path Params

ProductId

int64

required

≥ 1

ID of the Product API object

Query Params

establishment

int64

required

≥ 1

ID of Estabishment object related to the Inventory object

user

int64

required

≥ 1

ID of User object that is performing receive operation

Form Data

qty

string

required

length ≤ 16

The quantity of inventory unit (if specified) to be recieved.
Values limited to 4 decimal places.

unit

int64

≥ 1

The ID of recieved InventoryUnit object belonging to the Product.

cost

string

length ≤ 16

The price of a single Unit of recieved qty.
If not specified or 0 value is provided then operation will use Inventory's cost.
Values limited to 4 decimal places.

serials

string

List Product serial numbers associated with the operation, separated by a new line symbol.
Number of serials must match qty and qty must be integer.
Use "curl" or other external tool to try with more than one serial.

remarks

string

Optional commentary for logging.

Responses

Response body

object

int64

ID of the Product object. Duplicates product_id field, this may change in the future.

product_id

int64

ID of the Product object.

bin_value

string

BIN value by which product can be searched in inventory.

product_class_id

int64

ID of a ProductClass API object. Represents which product class this product falls under.

source_establishment_id

int64

ID of a Establishment API object. Represents which Establishment this Inventory belongs to.

source_establishment_name

string

The name field from a Establishment API object. Represents which Establishment this Inventory belongs to. Can be null.

product_class

string

The name field from a ProductClass API object. Represents which product class this product falls under.

print_tags

boolean

Flag value specifying whether this product allowed for printing tags or not, 'true' if allowed

product_category

string

The name field of ProductCategory API object c

product_subcategory

string

The name field of ProductCategory API object representing main sub category of the product

barcode

string

Barcode of the product (must be unique in a given Establishment)

ingredient_id

int64

Unused, always null

quantity_for_sale

float

The quantity of the product available for sale (quantity on hand), less quantity on layaway

active

boolean

Status of whether the Product is active

name

string

Name of the Product.

sku

string

Stock Keeping Unit (SKU) of the product

has_recipes

string

Empty string. Unused

legacy_category_code

string

Internal field.

recipes

array of strings

Empty array. Unused

recipes

primary_stock_unit

object

Basic information about Product's Primary Stock Unit

qty_in_units

float

Absolute quantity based on the key of the unit. Value is up to 4 decimal places greater than 0.

conversion

float

This field provides a relative value in conjunction with the conversion unit. It is suggested to use “qty_in_units” which provides the absolute value.

int64

ID of the Inventory Unit

name

string

Name of the Inventory Unit.

primary_vendor

object

Basic information about Product's Primary Vendor

vendor_item_id

string

User defined vendor item ID.

name

string

Name of the Vendor.

int64

ID of the Vendor API resource

other_units

array of objects

List of Inventory Units defined for the product.

other_units

object

active

boolean

Defaults to true

Status of whether the Inventory Unit resource is active

barcode

string

length ≤ 200

Alphanumeric barcode. Must be unique in a given Establishment and can not exceed 200 characters.

qty_in_units

float

Absolute quantity based on the key of the unit. Value is up to 4 decimal places greater than 0.

conversion

float

This field provides a relative value in conjunction with the conversion unit. It is suggested to use “qty_in_units” which provides the absolute value.

int64

ID of the Inventory Unit

key

string

length ≤ 64

Key for the Unit. Also related with the name.

name

string

length ≤ 64

Name of the Unit.

primary_unit

boolean

Defaults to false

Primary key of unit used.

uom

string

Unit of measurement of the product used by tracking in inventory

inventory

object

int64

ID of the Inventory object

cost

float

Price of a single Inventory object.

total_value

float

Total inventory value.

threshold

float

The product/ingredient's reorder/par threshold.

version

number

Internal field.

costing_method

string

Internal field. Represents which costing method is currently used this inventory. Can be avg, lifo, fifo.

establishment

int64

ID of a Establishment API object. Represents which Establishment this Inventory belongs to.

require_serial_number

boolean

Flag value specifying whether the product required serial number for input and tracking or not, 'true' if required

quantity_in_hand

float

The total quantity in hand for the product/ingredient.

quantity_in_layaway

float

The quantity of the product/ingredient in layaway on invoices.

quantity_for_sale

float

The quantity of the product/ingredient available for sale (quantity on hand), less quantity on layaway

updated_date

date-time

Date and time timestamp when Inventory object was updated

created_date

date-time

Date and time timestamp when Inventory object was created

active

boolean

Status of whether the Inventory object is active

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


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox-revel.revelup.com/inventoryx/api/inventory/Product/ProductId/receive/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded'

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

application/json

200Inventory succesfully updated.