POST v1/shipment/{shipmentID}/lineItem/save

Add or update information about a Shipment Line Item

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shipmentID

integer

Required

Body Parameters

ShipmentItemModel
NameDescriptionTypeAdditional information
ShipmentItemID

Unique identifier of a Shipment Line Item

integer

None.

SalesOrderNumber

string

None.

SKU

The SKU on the Purchase Order

SKUModel

None.

Quantity

The quantity of the SKU ordered

decimal number

None.

ShippedQuantity

The quantity of the SKU shipped

decimal number

None.

UnassignedToPalletQuantity

decimal number

None.

PalletPositions

integer

None.

Stacked

integer

None.

TareWeight

decimal number

None.

AllowManualLoad

boolean

None.

Class

string

None.

Request Formats

application/json, text/json

Sample:
{
  "shipmentItemID": 1,
  "salesOrderNumber": "sample string 2",
  "sku": {
    "skuId": 1,
    "isActive": true,
    "partNumber": "sample string 3",
    "partDescription": "sample string 4",
    "skuCategory": {
      "skuCategoryID": 1,
      "isSystem": true,
      "isIntegrationControlled": true,
      "isActive": true,
      "skuCategory": "sample string 5"
    },
    "skuSubCategory": {
      "skuSubCategoryId": 1,
      "skuCategoryId": 2,
      "skuSubCategory": "sample string 3"
    },
    "imageURL": "sample string 5",
    "fileCount": 6,
    "isNonSerialized": true,
    "isLotTraceable": true,
    "receiveNonSerialized": true,
    "receivePreLabeled": true,
    "nonSerializedSKUID": 11,
    "numberPerPallet": 12,
    "purchaseUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "stockUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "conversionRatio": 13.0,
    "standardCost": 14.0,
    "vat": 15.0,
    "truckloadQuantity": 16,
    "mask": "sample string 17",
    "skuType": {
      "skuTypeID": 1,
      "skuType": "sample string 2"
    },
    "isIntegrationControlled": true,
    "weight": 19.0,
    "height": 20.0,
    "length": 21.0,
    "width": 22.0,
    "dimensionUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "weightUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "isCertified": true,
    "certificationDate": "2025-11-08T08:24:35.5419374+00:00"
  },
  "quantity": 3.0,
  "shippedQuantity": 4.0,
  "unassignedToPalletQuantity": 5.0,
  "palletPositions": 6,
  "stacked": 7,
  "tareWeight": 8.0,
  "allowManualLoad": true,
  "class": "sample string 10"
}

Response Information

Resource Description

ShipmentItemModel
NameDescriptionTypeAdditional information
ShipmentItemID

Unique identifier of a Shipment Line Item

integer

None.

SalesOrderNumber

string

None.

SKU

The SKU on the Purchase Order

SKUModel

None.

Quantity

The quantity of the SKU ordered

decimal number

None.

ShippedQuantity

The quantity of the SKU shipped

decimal number

None.

UnassignedToPalletQuantity

decimal number

None.

PalletPositions

integer

None.

Stacked

integer

None.

TareWeight

decimal number

None.

AllowManualLoad

boolean

None.

Class

string

None.

Response Formats

application/json, text/json

Sample:
{
  "shipmentItemID": 1,
  "salesOrderNumber": "sample string 2",
  "sku": {
    "skuId": 1,
    "isActive": true,
    "partNumber": "sample string 3",
    "partDescription": "sample string 4",
    "skuCategory": {
      "skuCategoryID": 1,
      "isSystem": true,
      "isIntegrationControlled": true,
      "isActive": true,
      "skuCategory": "sample string 5"
    },
    "skuSubCategory": {
      "skuSubCategoryId": 1,
      "skuCategoryId": 2,
      "skuSubCategory": "sample string 3"
    },
    "imageURL": "sample string 5",
    "fileCount": 6,
    "isNonSerialized": true,
    "isLotTraceable": true,
    "receiveNonSerialized": true,
    "receivePreLabeled": true,
    "nonSerializedSKUID": 11,
    "numberPerPallet": 12,
    "purchaseUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "stockUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "conversionRatio": 13.0,
    "standardCost": 14.0,
    "vat": 15.0,
    "truckloadQuantity": 16,
    "mask": "sample string 17",
    "skuType": {
      "skuTypeID": 1,
      "skuType": "sample string 2"
    },
    "isIntegrationControlled": true,
    "weight": 19.0,
    "height": 20.0,
    "length": 21.0,
    "width": 22.0,
    "dimensionUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "weightUOM": {
      "unitOfMeasureID": 1,
      "unitOfMeasure": "sample string 2",
      "unitCode": "sample string 3"
    },
    "isCertified": true,
    "certificationDate": "2025-11-08T08:24:35.5419374+00:00"
  },
  "quantity": 3.0,
  "shippedQuantity": 4.0,
  "unassignedToPalletQuantity": 5.0,
  "palletPositions": 6,
  "stacked": 7,
  "tareWeight": 8.0,
  "allowManualLoad": true,
  "class": "sample string 10"
}