Serial Numbers Queries

Query serial numbers, their status, and linked documents.

SerialNumberLineItem — Returns a single serial number line item by ID

Example Query:

query GetSerialNumberLineItem($line_item_id: ID, $serial_number_id: ID) {
  SerialNumberLineItem(line_item_id: $line_item_id, serial_number_id: $serial_number_id) {
    serial_number_id
    line_item_id
    serial_number {
      id
      label
      status
    }
    line_item {
      id
      label
    }
  }
}

SerialNumberLineItems — Returns a list of serial number line items with filters

Example Query:

query SerialNumberLineItems(
  $where: QuerySerialNumberLineItemsWhereWhereConditions,
  $orderBy: [QuerySerialNumberLineItemsOrderByOrderByClause!]
) {
  SerialNumberLineItems(
    where: $where
    orderBy: $orderBy
  ) {
    serial_number_id
    line_item_id
    serial_number {
      id
      label
      status
    }
    line_item {
      id
      label
    }
  }
}

Example Variables:

{
  "where": {
    "AND": [
      { "column": "LINE_ITEM_ID", "operator": "EQ", "value": 100001 }
    ]
  },
  "orderBy": [
    { "column": "SERIAL_NUMBER_ID", "order": "ASC" }
  ]
}

Available fields

FieldTypeDescription
serial_number_idIntID of the linked serial number.
line_item_idIntID of the linked line item.
serial_numberSerialNumberAssociated serial number data.
line_itemLineItemAssociated line item data.

Filters

FieldExample
serial_number_id{ "column": "SERIAL_NUMBER_ID", "operator": "EQ", "value": 50001 }
line_item_id{ "column": "LINE_ITEM_ID", "operator": "EQ", "value": 100001 }
serial_number_label{ "column": "SERIAL_NUMBER_LABEL", "operator": "LIKE", "value": "%SN-%" }

Sorting

You can sort data based on following fields: serial_number_id, line_item_id

query SortSerialNumberLineItems {
  SerialNumberLineItems(
    orderBy: [{ column: SERIAL_NUMBER_ID, order: ASC }]
  ) {
    serial_number_id
    line_item_id
  }
}

SerialNumberInventoryLog — Returns a single serial number inventory log by ID

Example Query:

query GetSerialNumberInventoryLog($inventory_log_id: ID, $serial_number_id: ID) {
  SerialNumberInventoryLog(inventory_log_id: $inventory_log_id, serial_number_id: $serial_number_id) {
    inventory_log_id
    serial_number_id
    status
    location_id
    batch_number_id
    serial_number {
      id
      label
      status
    }
    inventory_log {
      id
    }
    location {
      id
      label
    }
    batch_number {
      id
      label
    }
  }
}

SerialNumberInventoryLogs — Returns a list of serial number inventory logs with filters

Example Query:

query SerialNumberInventoryLogs(
  $where: QuerySerialNumberInventoryLogsWhereWhereConditions,
  $orderBy: [QuerySerialNumberInventoryLogsOrderByOrderByClause!]
) {
  SerialNumberInventoryLogs(
    where: $where
    orderBy: $orderBy
  ) {
    inventory_log_id
    serial_number_id
    status
    location_id
    batch_number_id
    serial_number {
      id
      label
    }
  }
}

Example Variables:

{
  "where": {
    "AND": [
      { "column": "SERIAL_NUMBER_ID", "operator": "EQ", "value": 50001 }
    ]
  },
  "orderBy": [
    { "column": "INVENTORY_LOG_ID", "order": "DESC" }
  ]
}

Available fields

FieldTypeDescription
inventory_log_idIntID of the linked inventory log.
serial_number_idIntID of the linked serial number.
statusStringStatus of the serial number in this log.
location_idIntID of the linked location.
batch_number_idIntID of the linked batch number.
serial_numberSerialNumberAssociated serial number data.
inventory_logInventoryLogAssociated inventory log data.
locationLocationAssociated location data.
batch_numberBatchNumberAssociated batch number data.

Filters

FieldExample
inventory_log_id{ "column": "INVENTORY_LOG_ID", "operator": "EQ", "value": 100001 }
serial_number_id{ "column": "SERIAL_NUMBER_ID", "operator": "EQ", "value": 50001 }
status{ "column": "STATUS", "operator": "EQ", "value": "active" }
location_id{ "column": "LOCATION_ID", "operator": "EQ", "value": 100245 }
batch_number_id{ "column": "BATCH_NUMBER_ID", "operator": "EQ", "value": 100010 }
serial_number_label{ "column": "SERIAL_NUMBER_LABEL", "operator": "LIKE", "value": "%SN-%" }

Sorting

You can sort data based on following fields: inventory_log_id, serial_number_id, status, location_id, batch_number_id

query SortSerialNumberInventoryLogs {
  SerialNumberInventoryLogs(
    orderBy: [{ column: SERIAL_NUMBER_ID, order: ASC }]
  ) {
    inventory_log_id
    serial_number_id
    status
  }
}

Data Types

SerialNumber

FieldTypeDescription
idIntUnique identifier.
labelStringSerial number label.
statusStringCurrent status (e.g., active, sold, defective).
variant_idIntID of the linked product variant.
location_idIntID of the linked location.
batch_number_idIntID of the linked batch number.
variantVariantAssociated product variant data.
locationLocationAssociated location data.
batch_numberBatchNumberAssociated batch number data.