Assets

To create or manage serial number sequences for assets, see Sequences.

Create & Update Asset

# Create Asset

The only properties you need to create an asset is the item_id, location_id, and layout_id, which identify the item being converted to the asset and the location and layout where it will be placed. However, we recommend adding some more properties to the asset.

| sequence_id string
This field is required if the asset serial number is to be assigned from an predefined sequence. Either ther serial_number or sequence_id should be passed | | currency string
The currency in which the value is defined, for example 'USD' | | barcode string
The barcode of the asset | | category string
Category of the asset, for example, Electronics | | sub_category string
The subcategory within the asset's category, for example, Smart Phone | | warranty_expires_at integer
Time in epoch seconds at which the warranty expires | | is_warranty_valid boolean
A flag indicating whether the warranty is valid or not | | maintenance_schedule string
How often must the maintenance be performed on the asset. Can be daily, weekly, monthly, quarterly, or yearly | | options object
Options for asset, currently supports is_prefix flag, which determines whether the provided serial number is used as is, or if it is treated as a prefix for serial numbers. If set to true, sequence_id must not be null. Defaults to false | | next_maintenance_at integer
Time in epoch seconds for the next scheduled maintenance of the asset | | disposed_at integer
Time in epoch seconds when the asset was disposed | | disposal_reason_code string
Reason code for asset disposal | | disposal_comment string
Additional comments for disposal | | purchased_at integer
Time in epoch seconds at which the asset was purchased | | initial_value number
The initial value of the asset before any appreciation or depreciation is applied | | maintenance_status string
The current maintenance status of the asset. Can be good, upcoming, required, ongoing | | manifest_id string
An optional manifest ID to associate with the asset | | manufacturer_number string
The manufacturer's part or model number | | contact_id string
The ID of a contact to assign to the asset (alias for assignee) | | vendor string
The vendor or supplier of the asset | | origin_country string
The country of origin of the asset | | images object
An object with add and/or remove arrays of image URL strings for managing asset images | | linked_documents object
An object with add and/or remove arrays for managing associated documents (types: warranty_card, user_manual, invoice, transfer_order, POD, asset_request, other) |

        const data = {
  item_id: "item_5TngYZKdRFTSkcVCvNa885",
  layout_id: "lay_vgM65sMYtakxwfXkTCC8FB",
  location_id: "loc_8axWLqDo9kprqgNmFpCqxo",
  maintenance_schedule: "daily",
  maintenance_status: "good",
};

const res = await fetch(`https://api.packagex.io/v1/assets`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());

const asset = res.data; //Refer to the asset model

      

To create an asset with a user defined serial number, pass the serial_number in the request body. However, if the serial number already exists in the database, the API will throw an error.

        const data = {
  item_id: "item_5TngYZKdRFTSkcVCvNa885",
  layout_id: "lay_vgM65sMYtakxwfXkTCC8FB",
  location_id: "loc_8axWLqDo9kprqgNmFpCqxo",
  serial_number: "PX-AST-1001"
  maintenance_schedule: "daily",
  maintenance_status: "good",
};

const res = await fetch(`https://api.packagex.io/v1/assets`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());

const asset = res.data;

      

To use a predefined sequence for generating the asset serial number, pass the sequence_id instead

        const data = {
  item_id: "item_5TngYZKdRFTSkcVCvNa885",
  layout_id: "lay_vgM65sMYtakxwfXkTCC8FB",
  location_id: "loc_8axWLqDo9kprqgNmFpCqxo",
  sequence_id: "seq_dxEBJ9bS6gyZhxsmrrUMrM"
  maintenance_schedule: "daily",
  maintenance_status: "good",
};

const res = await fetch(`https://api.packagex.io/v1/assets`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());

const asset = res.data; //Refer to the asset model

      

As sequences are finite length they may get exhausted. For example, if the user defines the sequence as 1 for a prefix PX-AST, the user will be able to create 9 assets before the sequence is exhausted. Likewise, if the user defines a sequence as 01, and another one as 10, the user will be able to create 10 assets for the first serial number before collisions start to occur.

# Update Asset

Most of the asset properties can be updated, including

        metadata;
serial_number;
status;
maintenance_schedule;
maintenance_status;
value;
disposed_at;
disposal_reason_code;
disposal_comment;
purchased_at;
initial_value;
item_id;
location_id;
layout_id;

      

Note: updated_at and updated_by are system-managed fields and cannot be set directly.

Likewise, linked documents can be added or removed as follows

        {
  linked_documents: {
    add: [
      {
        document_type: "warranty_card",
        image: "...", // base64 encoded image
      },
      {
        id: "ast_vgM65sMYtakxwfXkTCC8FB",
        document_type: "user_manual",
      },
    ];
    remove: [`doc_vgM65sMYtakxwfXkTCC8FB`];
  }
}

      

The objects containing id in add will be updated and the ones without the id will be created. The document ids pased in remove will be deleted. Overall, an update request may look as follows

        //Update lead time mins for a delivery and org's DBA name
const data = {
  maintenance_status: "upcoming",
  status: "in_use",
  linked_documents: {
    add: [
      {
        document_type: "warranty_card",
        image: "...", // base64 encoded image
      },
    ],
  },
};

const res = await fetch(`https://api.packagex.io/v1/assets/ast_1tH2ofoBcDbPnyZCYmrSX3`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());

      

Bulk Serialize Asset Items

Assets can be bulk created and serialized against items that are marked as assets. For instance, if you have 10 asset items at a location A on a layout B, and you want to generate serial numbers for two of them and move them to layout C, the request will look like this

        //Update lead time mins for a delivery and org's DBA name
const data = {
  item_id: "item_5TngYZKdRFTSkcVCvNa885",
  source_layout_id: "lay_vgM65sMYtakxwfXkTCC8FB",
  location_id: "loc_8axWLqDo9kprqgNmFpCqxo",
  destination_layout_id: "lay_bnFvu9BvzfvZxvtuJk6vtQ",
  sequence_id: "seq_nieoNmFpCqadsdRF",
  qty: 2,
};

const res = await fetch(`https://api.packagex.io/v1/assets/serialize`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());

      

sequence_id is required for bulk serialization. If the source and destination layouts are same, destination layout can be omitted from the body.

        //Update lead time mins for a delivery and org's DBA name
const data = {
  item_id: "item_5TngYZKdRFTSkcVCvNa885",
  source_layout_id: "lay_vgM65sMYtakxwfXkTCC8FB",
  location_id: "loc_8axWLqDo9kprqgNmFpCqxo",
  sequence_id: "seq_nieoNmFpCqadsdRF",
  qty: 2,
};

const res = await fetch(`https://api.packagex.io/v1/assets/serialize`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());

      

If the assets are being procured from external sources, and any existing item quantities are not to be turned into assets, source layout ID can be omitted. In this case, the user must pass an options object containing check_inventory set to false. Destination layout, however, is required in this case.

        //Update lead time mins for a delivery and org's DBA name
const data = {
    item_id: "item_5TngYZKdRFTSkcVCvNa885",
    destination_layout_id: "lay_bnFvu9BvzfvZxvtuJk6vtQ"
    location_id: "loc_8axWLqDo9kprqgNmFpCqxo",
    sequence_id: "seq_nieoNmFpCqadsdRF",
    qty: 2,
    options: {
      check_inventory: false
    }
  };

const res = await fetch(`https://api.packagex.io/v1/assets/serialize`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());