UN Numbers
Bases: BaseResource
A United Nations hazardous-materials shipping identifier.
A UN Number identifies a hazardous material for transport and carries the
associated shipping description and storage-class metadata used when
classifying substances and inventory items. UN Numbers are highly controlled
within Albert and cannot be created through the SDK; retrieve them with
UnNumberCollection.
Show JSON schema:
{
"$defs": {
"AuditFields": {
"description": "The audit fields for a resource",
"properties": {
"by": {
"default": null,
"title": "By",
"type": "string"
},
"byName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Byname"
},
"at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "At"
}
},
"title": "AuditFields",
"type": "object"
},
"Status": {
"description": "The status of a resource.\n\nAttributes\n----------\nACTIVE : str\n The resource is fully operational and visible in normal operations.\nINACTIVE : str\n The resource is hidden from normal operations and disabled from use.",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
}
},
"description": "A United Nations hazardous-materials shipping identifier.\n\nA UN Number identifies a hazardous material for transport and carries the\nassociated shipping description and storage-class metadata used when\nclassifying substances and inventory items. UN Numbers are highly controlled\nwithin Albert and cannot be created through the SDK; retrieve them with\n[`UnNumberCollection`][albert.collections.un_numbers.UnNumberCollection].",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null,
"description": "The status of the resource, optional."
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null,
"description": "Audit fields for the creation of the resource, optional."
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null,
"description": "Audit fields for the update of the resource, optional."
},
"unNumber": {
"description": "The UN Number itself (e.g. ``\"UN1090\"``).",
"title": "Unnumber",
"type": "string"
},
"albertId": {
"description": "The Albert ID of the UN Number. Set when the UN Number is retrieved from Albert.",
"title": "Albertid",
"type": "string"
},
"storageClassName": {
"description": "The name of the associated storage class.",
"title": "Storageclassname",
"type": "string"
},
"shippingDescription": {
"description": "The proper shipping description for the material.",
"title": "Shippingdescription",
"type": "string"
},
"storageClassNumber": {
"description": "The number of the associated storage class.",
"title": "Storageclassnumber",
"type": "string"
},
"unClassification": {
"description": "The UN hazard classification.",
"title": "Unclassification",
"type": "string"
}
},
"required": [
"unNumber",
"albertId",
"storageClassName",
"shippingDescription",
"storageClassNumber",
"unClassification"
],
"title": "UnNumber",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
un_number(str) -
id(str) -
storage_class_name(str) -
shipping_description(str) -
storage_class_number(str) -
un_classification(str)