/lots/{lotId}

This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

GET /lots/{lotId}

Get lot

Description

Returns lot

Parameters (path)

Name	Required	Description	Values
lotId	required	Target lot.

Parameters (query)

Name	Required	Description	Values
include	optional	The resources that can be included in this request, delimited by a comma: sku, attributes, attribute_values, attribute_values, dates, inbound_order, inbound_order_lot, lot_predecessor, partner, partner_location, traces, traces_brought_forward, inbound_parcels_count, outbound_parcels_count, inputs, inputs_specified

Responses

200

successful operation

Response content JSON schema

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "availability_date": {
        "description": "The date when the lot is available for dispositions",
        "type": "string",
        "format": "date",
        "readOnly": true,
        "example": "2019-01-01"
      },
      "batch_number": {
        "description": "Batch number from batch number trace",
        "type": "string",
        "format": "string",
        "readOnly": true,
        "example": "ABC123"
      },
      "eol_date": {
        "description": "The date when the final stock movement was made on the lot (End Of Life).",
        "type": "string",
        "format": "date",
        "readOnly": true,
        "example": "2019-01-01"
      },
      "expiry_date": {
        "description": "Expiry date of the lot taken from lot dates",
        "type": "string",
        "format": "date",
        "readOnly": true,
        "example": "2019-01-01"
      },
      "inventory_value_actual": {
        "description": "The actual inventory value per UoM",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "inventory_value_budget": {
        "description": "The expected inventory value per UoM",
        "type": "number",
        "format": "double",
        "readOnly": true,
        "example": 1234.123
      },
      "inventory_value_overhead": {
        "description": "The overhead part of the inventory values per UoM",
        "type": "number",
        "format": "double",
        "readOnly": true,
        "example": 1234.123
      },
      "locked": {
        "description": "If the lot is locked and therefore cannot be deleted",
        "type": "boolean",
        "format": "boolean",
        "readOnly": true,
        "example": true
      },
      "lot_number": {
        "description": "The sequential lot_number of the lot",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "lot_number_complete": {
        "description": "The complete lot number, including SKU-code and lot version",
        "type": "string",
        "format": "string",
        "readOnly": true,
        "example": "A string"
      },
      "lot_predecessor_id": {
        "description": "Id of the lot predecessor. Used for return orders and warehouse orders.",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "lot_sequence": {
        "description": "The version of the lot",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "lot_sequence_source": {
        "description": "The version of source lot (deprecated)",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "order_lines_count": {
        "description": "Count of the orders that uses the lot",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "origin_country": {
        "description": "The origin country",
        "type": "string",
        "format": "string",
        "readOnly": true,
        "example": "A string"
      },
      "origin_spec_system": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "readOnly": true,
        "example": "A string"
      },
      "origin_spec_value": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "readOnly": true,
        "example": "A string"
      },
      "partner_location_id": {
        "description": "Reference to the partner location where the lot is located",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "quantity_adjusted": {
        "description": "The quantity that have been taken out by adjustments",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "quantity_available": {
        "description": "The quantity that is available for dispositions",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "quantity_disposed": {
        "description": "The quantity thats has already been disposed",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "quantity_on_hand": {
        "description": "The quantity physically on hand",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "sku_id": {
        "description": "Id of the sku",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "status": {
        "description": "Status of the lot",
        "type": "string",
        "format": "string",
        "enum": [
          "draft",
          "expected",
          "confirmed",
          "in_transit",
          "partly_on_location",
          "on_location",
          "lost"
        ],
        "readOnly": true,
        "example": "A string"
      },
      "unit": {
        "description": "The unit of the quantities",
        "type": "string",
        "format": "string",
        "readOnly": true,
        "example": "A string"
      },
      "uom_conversion": {
        "description": "The conversion factor between the unit of the quantities and the unit of measure on the SKU.",
        "type": "number",
        "format": "double",
        "readOnly": true,
        "example": 1234.123
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "readOnly": true,
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "readOnly": true,
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

500

internal server error

PUT /lots/{lotId}

Update information on lot