POST v1/shipmentItem/{shipmentItemID}/{locationZoneID}/checkInventory

Add or update information about a Shipment

Request Information

URI Parameters

Name	Description	Type	Additional information
shipmentItemID		integer	Required
locationZoneID		integer	Required

Body Parameters

ShipmentItemModel

Name	Description	Type	Additional 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:30.078671+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

ShipmentModel

Name	Description	Type	Additional information
ShipmentID	Unique identifier of the shipment	integer	None.
ShipmentNumber	Formatted shipment number	string	None.
ShipStatus	Ship Status	ShipStatusModel	None.
ShipFromLocation	Ship From Location	LocationModel	None.
ShipToLocation	Ship To Location	LocationModel	None.
Carrier	Carrier	LocationModel	None.
ShipDate	Ship Date	date	None.
Trailer	Trailer number	string	None.
TrailerConfirmation	Trailer confirmation number	string	None.
Driver	Driver	string	None.
DriverURL		string	None.
SAPServiceOrder	SAP Service Order	string	None.
Rental	Rental	RentalModel	None.
SalesOrderID		integer	None.
PalletsExpected		integer	None.
SalesOrder		SalesOrderModel	None.
PalletsLoaded		integer	None.
BOLPrinted		boolean	None.
RentalID		integer	None.
PUNumber		string	None.
Items		Collection of ShipmentItemModel	None.
QuantityOnShipment		decimal number	None.
FileCount		integer	None.
CanCompleteShipment		boolean	None.
ShipmentTrailer		ShipmentTrailerModel	None.
ShipTime		date	None.
SendEmailConfirmation		boolean	None.
CreatedBy		string	None.
CreationDate		date	None.
ActualShipDate	Ship Date	date	None.
IsInternal		boolean	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.