ProductRecords

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Inventory/ProductRecords

Represents a product record.

GUID

3e3bfb7c-bb0c-495b-b88d-e1efa1f50368

Required permission

Show serial number

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the product record.
ProductRecordType Int32 The type of the product record.

  • ProductRecord: 0
  • Batch: 1
SerialNumberWithPartNumber String The batch or serial number along with the part number of the product record.
CommentId Int64? The business key identifier of the product record's comment.

References Comments
Comment Comments The product record comment.

  • Expandable
CertificateId Int64? The business key identifier of the product record's certificate.

References Comments
 Introduced in version 2.24
Certificate Comments The certificate of the product record.

  • Expandable
 Introduced in version 2.24
WarrantyCommitmentId Int64? The business key identifier of the product record's warranty commitment.

References Comments
 Introduced in version 2.24
WarrantyCommitment Comments The warranty commitment of the product record.

  • Expandable
 Introduced in version 2.24
InstallationCommentId Int64? The business key identifier of the product record's installation comment.

References Comments
 Introduced in version 2.24
InstallationComment Comments The installation comment of the product record.

  • Expandable
 Introduced in version 2.24
SerialNumber String The batch or serial number of the product record.
ChargeNumber String The charge number of the product record.
PartId Int64 The business key identifier of the part that the product record belongs to.

References Parts
Part Parts The part that the product record belongs to.

  • Expandable
ManufacturingOrderId Int64? The business key identifier of the manufacturing order that the product record is linked to.

References ManufacturingOrders
ManufacturingOrder ManufacturingOrders The manufacturing order that the product record is linked to.

  • Expandable
ExtraFields ExtraFields[] A collection of extra field values for the product record.

  • Expandable
HasWarranty Boolean Specifies if the product is covered by warranty.
 Introduced in version 2.36
WarrantyStartDate DateTimeOffset? The date when the warranty started.
 Introduced in version 2.36
WarrantyEndDate DateTimeOffset? The date when the warranty expires.
 Introduced in version 2.36
WarrantyMonths Int32 The length of the warranty period in months.
 Introduced in version 2.36
OwnerId Int64? The business key identifier of the product record owner.

References Customers
 Introduced in version 2.40
CustomerOrderId Int64? The business key identifier of the customer order of the product record.

References
Introduced in version 2.40
CustomerOrder CustomerOrders The customer order of the product record.

  • Expandable
 Introduced in version 2.40
CustomerOrderDeliveryRowId Int64? The business key identifier of the customer order delivery row of the product record.

References CustomerOrderDeliveryRows
 Introduced in version 2.40
CustomerOrderDeliveryRow CustomerOrderDeliveryRows The customer order of the product record.

  • Expandable
 Introduced in version 2.40
DeliveryAddressId Int64? The business key identifier of the delivery address of the product record.

References DeliveryAddresses
 Introduced in version 2.40
DeliveryAddress Addresses The delivery address of the product record.

  • Expandable
 Introduced in version 2.40
BlockMessageId Int64? The business key identifier of the message for the life cycle state of the product record.

References Comments
 Introduced in version 2.45
BlockMessage Comments The message for the life cycle state of the product record.

  • Expandable
 Introduced in version 2.45
BlockedById Int64? The identifier of the application user that has set the product record to blocked or message.

References ApplicationUsers
 Introduced in version 2.45
LifeCycleState Int32 The life cycle state of the product record.

  • ApprovalForUse: 0
  • NonApproval: 1
  • ServicePastDue: 2
  • UnderServiceOrCalibration: 3
  • Rejected: 4
  • ServiceOrCalibrationBeforeUse: 5
  • Missing: 6
  • Scrapped: 7
 Introduced in version 2.45
BlockContext Int32 The block context which the product records life cycle state is used for.

  • None: 0
  • ManufacturingOrderWithdrawal: 1
  • ManufacturingOrderClearance: 2
  • CustomerOrderDelivery: 4
  • CustomerOrderClearance: 8
  • RequirementCalculation: 16

  • Bitmask
 Introduced in version 2.45
BlockedFromDate DateTimeOffset? The date from which the product record has been blocked.
 Introduced in version 2.45
BlockedToDate DateTimeOffset? The date from which the product record has been unblocked.
 Introduced in version 2.45
MeasurementSetting Decimal? The measurement setting for a product record.
 Introduced in version 2.49
OperationTime TimeSpan? The operation time for a product record.
 Introduced in version 2.49
NumberOfCycles Decimal? The number of cycles for a product record.
 Introduced in version 2.49
OperationReportings ProductRecordOperationReportings[] The list of product record operation reporting logs.

  • Expandable
 Introduced in version 2.49
CustomerOrderOurReferenceId Int64? The business key identifier of the customer order our reference person of the product record.

 Introduced in version 2.51
BusinessContactReferenceId Int64? The business key identifier of the customer's reference of the product record.

 Introduced in version 2.51
CustomerOrderPartRevisionId Int64? The business key identifier of the revision for the part of the product record.
Has been replaced by the more general PartRevisionId

  • References Revisions
  • Obsolete since version 24.1 (Replaced by PartRevisionId)
 Introduced in version 2.51
PartRevisionId Int64? The business key identifier of the revision for the part of the product record.

 Introduced in version 24.1
PlannedDeliveryDate DateTimeOffset? The planned delivery date for the customer order of the product record.
 Introduced in version 2.51
ActualDeliveryDate DateTimeOffset? The actual delivery date for the customer order of the product record.
 Introduced in version 2.51
MeasurementSettingWarranty Decimal? The meter reading for warranty of the product record.
 Introduced in version 2.51
OperationTimeWarranty TimeSpan? The operation time for warranty of the product record.
 Introduced in version 2.51
NumberOfCyclesWarranty Decimal? The number of cycles for warranty of the product record.
 Introduced in version 2.51
PurchaseOrderId Int64? The business key identifier of the purchase order of the product record.

 Introduced in version 2.51
ActualArrivalDate DateTimeOffset? The actual delivery date for the purchase order of the product record.
 Introduced in version 2.51
ManufactureDate DateTimeOffset? The finish date for the manufacturing order of the product record.
 Introduced in version 2.51
InstallationOrderId Int64? The business key identifier of the customer order which the installation is linked to.

 Introduced in version 2.51
InstalledBy Int64? The business key identifier of the person that is linked to the installation of the product record.

 Introduced in version 2.51
InstallationDate DateTimeOffset? The date when the installation of the product record will take place.
 Introduced in version 2.51
InstallationCode String The code that is applying to the installation of the product record.
 Introduced in version 2.51
WarrantyCode String The code that is applying to the installation of the product record.
 Introduced in version 2.51
RegistrationNo String The registration number for the manufacturing order of the product record.
 Introduced in version 2.51
TypeDescription String The type description for the customer order of the product record.
 Introduced in version 2.51
Status Int32 The status of the product record.

  • NotInitialized: 0
  • Registrered: 1
  • Manufacturing: 2
  • ManufacturingPending: 3
  • Inventory: 4
  • Blocked: 5
  • Packed: 6
  • PackedAndMarked: 7
  • Historical: 9
 Introduced in version 22.6
BestBeforeDate DateTimeOffset? The best before date of the product record.
 Introduced in version 22.7
ProductRecordBatchId Int64? The business key identifier of the batch number.
 Introduced in version 23.3

Example

{
  "Id": 0,
  "ProductRecordType": 0,
  "SerialNumberWithPartNumber": null,
  "CommentId": null,
  "Comment": null,
  "CertificateId": null,
  "Certificate": null,
  "WarrantyCommitmentId": null,
  "WarrantyCommitment": null,
  "InstallationCommentId": null,
  "InstallationComment": null,
  "SerialNumber": null,
  "ChargeNumber": null,
  "PartId": 0,
  "Part": null,
  "ManufacturingOrderId": null,
  "ManufacturingOrder": null,
  "ExtraFields": null,
  "HasWarranty": false,
  "WarrantyStartDate": null,
  "WarrantyEndDate": null,
  "WarrantyMonths": 0,
  "OwnerId": null,
  "CustomerOrderId": null,
  "CustomerOrder": null,
  "CustomerOrderDeliveryRowId": null,
  "CustomerOrderDeliveryRow": null,
  "DeliveryAddressId": null,
  "DeliveryAddress": null,
  "BlockMessageId": null,
  "BlockMessage": null,
  "BlockedById": null,
  "LifeCycleState": 0,
  "BlockContext": 0,
  "BlockedFromDate": null,
  "BlockedToDate": null,
  "MeasurementSetting": null,
  "OperationTime": null,
  "NumberOfCycles": null,
  "OperationReportings": null,
  "CustomerOrderOurReferenceId": null,
  "BusinessContactReferenceId": null,
  "CustomerOrderPartRevisionId": null,
  "PartRevisionId": null,
  "PlannedDeliveryDate": null,
  "ActualDeliveryDate": null,
  "MeasurementSettingWarranty": null,
  "OperationTimeWarranty": null,
  "NumberOfCyclesWarranty": null,
  "PurchaseOrderId": null,
  "ActualArrivalDate": null,
  "ManufactureDate": null,
  "InstallationOrderId": null,
  "InstalledBy": null,
  "InstallationDate": null,
  "InstallationCode": null,
  "WarrantyCode": null,
  "RegistrationNo": null,
  "TypeDescription": null,
  "Status": 0,
  "BestBeforeDate": null,
  "ProductRecordBatchId": null
}