Skip to main content

Create a stock item​

Creates a new stock item entity (required scope stock:write)

Header Parameters
    Customer-Id int64 required

    The customer identifier

Request Body
    stockDetailsId int64 required

    The unique identifier of the stock details related to this stock item

    quantity double nullable

    The quantity of the stock items. Must be omitted or null if the stock item is not consumable

    locationContactId int64 nullable

    The ID of the contact associated with the stock item, must be omitted or null if the stock item is located at a vehicle or another stock item

    locationVehicleId int64 nullable

    The ID of the vehicle associated with the stock item, must be omitted or null if the stock item is located at a contact or another stock item

    locationStockItemId int64 nullable

    The ID of the stock item this stock item is allocated to, must be omitted or null if the stock item is located at a contact or a vehicle

    soldAt date-time nullable

    The date when the stock item was sold

    notes string nullable

    Notes on the stock item, must be null or omitted if the stock item is not consumable

    serialNumber string nullable

    The unique number or barcode assigned to each individual stock item for identification and tracking. Required if the stock item is non consumable, otherwise must be null or omitted. Cannot contain preceding or trailing whitespace

    altSerialNumber string nullable

    The alternative serial number of the stock item. Must be omitted or null if the stock item is consumable

    supplierSerialNumber string nullable

    The unique number used by the supplier for the stock item, must be null or omitted if the stock item is not consumable

    customerSerialNumber string nullable

    The number assigned by the customer for the stock item

    isEquipment boolean

    Indicates whether the stock item is equipment or not, defaults to false

    condition StockItemCondition

    Possible values: [new, refurbished, used]

    Represents the condition of a stock item

    Possible values:

    • new: New stock item
    • refurbished: Refurbished stock item
    • used: Used stock item

    usage double nullable

    The usage of the stock item, must be null or omitted when stock item is consumable

    customFields object[] nullable

    The custom fields associated with the stock item

  • Array [
    • definitionId int64 required

    The unique identifier of the associated custom field definition

    value string nullable

    The value of this custom field. If set to null, any existing value will be unset

  • ]
Responses

Created

Schema
    id int64

    Identifier of the newly created record

Loading...