PUT api/ordPiece/{id}

Update an existing record from the Pieces table.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

ordPieceDb
NameDescriptionTypeAdditional information
PieceID

integer

None.

OrderID

integer

Required

DataVersion

string

Required

WarehouseAlertID

integer

None.

FreightLegID

integer

None.

PalletNumber

integer

None.

BoxNumber

integer

None.

PieceTypeID

byte

None.

PieceDescription

string

Max length: 60

PieceLength

decimal number

None.

PieceWidth

decimal number

None.

PieceHeight

decimal number

None.

PieceWeight

decimal number

None.

Quantity

integer

None.

ManualTotalWeight

decimal number

None.

DimWeight

decimal number

None.

ItemCount

integer

None.

PackedByUserID

integer

None.

PackTimeStart

date

None.

PackTimeFinish

date

None.

WarehouseCheck

boolean

None.

CreatedBy

integer

None.

CreatedDate

date

None.

UpdatedBy

integer

None.

UpdatedDate

date

None.

results

Collection of ValidationResult

None.

Request Formats

application/json, text/json

Sample:
{
  "results": null,
  "PieceID": 1,
  "OrderID": 2,
  "DataVersion": "sample string 3",
  "WarehouseAlertID": 1,
  "FreightLegID": 1,
  "PalletNumber": 1,
  "BoxNumber": 1,
  "PieceTypeID": 64,
  "PieceDescription": "sample string 4",
  "PieceLength": 1.0,
  "PieceWidth": 1.0,
  "PieceHeight": 1.0,
  "PieceWeight": 1.0,
  "Quantity": 5,
  "ManualTotalWeight": 1.0,
  "DimWeight": 1.0,
  "ItemCount": 1,
  "PackedByUserID": 1,
  "PackTimeStart": "2025-12-06T23:42:08.7751204+00:00",
  "PackTimeFinish": "2025-12-06T23:42:08.7751204+00:00",
  "WarehouseCheck": true,
  "CreatedBy": 7,
  "CreatedDate": "2025-12-06T23:42:08.7751204+00:00",
  "UpdatedBy": 9,
  "UpdatedDate": "2025-12-06T23:42:08.7751204+00:00"
}

application/xml, text/xml

Sample:
<ordPieceDb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <BoxNumber>1</BoxNumber>
  <CreatedBy>7</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:42:08.7751204Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <DataVersion>sample string 3</DataVersion>
  <DimWeight>1</DimWeight>
  <FreightLegID>1</FreightLegID>
  <ItemCount>1</ItemCount>
  <ManualTotalWeight>1</ManualTotalWeight>
  <OrderID>2</OrderID>
  <PackTimeFinish xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:42:08.7751204Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </PackTimeFinish>
  <PackTimeStart xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:42:08.7751204Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </PackTimeStart>
  <PackedByUserID>1</PackedByUserID>
  <PalletNumber>1</PalletNumber>
  <PieceDescription>sample string 4</PieceDescription>
  <PieceHeight>1</PieceHeight>
  <PieceID>1</PieceID>
  <PieceLength>1</PieceLength>
  <PieceTypeID>64</PieceTypeID>
  <PieceWeight>1</PieceWeight>
  <PieceWidth>1</PieceWidth>
  <Quantity>5</Quantity>
  <UpdatedBy>9</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:42:08.7751204Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
  <WarehouseAlertID>1</WarehouseAlertID>
  <WarehouseCheck>true</WarehouseCheck>
</ordPieceDb>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ordPieceDb'.

Response Information

Resource Description

UpsertRetOfordPieceDb
NameDescriptionTypeAdditional information
returnID

integer

None.

results

Collection of ValidationResult

None.

returnItem

ordPieceDb

None.

displayMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "PieceID": 1,
    "OrderID": 2,
    "DataVersion": "sample string 3",
    "WarehouseAlertID": 1,
    "FreightLegID": 1,
    "PalletNumber": 1,
    "BoxNumber": 1,
    "PieceTypeID": 64,
    "PieceDescription": "sample string 4",
    "PieceLength": 1.0,
    "PieceWidth": 1.0,
    "PieceHeight": 1.0,
    "PieceWeight": 1.0,
    "Quantity": 5,
    "ManualTotalWeight": 1.0,
    "DimWeight": 1.0,
    "ItemCount": 1,
    "PackedByUserID": 1,
    "PackTimeStart": "2025-12-06T23:42:08.7833585+00:00",
    "PackTimeFinish": "2025-12-06T23:42:08.7833585+00:00",
    "WarehouseCheck": true,
    "CreatedBy": 7,
    "CreatedDate": "2025-12-06T23:42:08.7833585+00:00",
    "UpdatedBy": 9,
    "UpdatedDate": "2025-12-06T23:42:08.7833585+00:00"
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<UpsertRetOfordPieceDb66KPc_SrH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
  <displayMessage>sample string 1</displayMessage>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
  <returnID>1</returnID>
  <returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
    <d2p1:BoxNumber>1</d2p1:BoxNumber>
    <d2p1:CreatedBy>7</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:42:08.7833585Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:DataVersion>sample string 3</d2p1:DataVersion>
    <d2p1:DimWeight>1</d2p1:DimWeight>
    <d2p1:FreightLegID>1</d2p1:FreightLegID>
    <d2p1:ItemCount>1</d2p1:ItemCount>
    <d2p1:ManualTotalWeight>1</d2p1:ManualTotalWeight>
    <d2p1:OrderID>2</d2p1:OrderID>
    <d2p1:PackTimeFinish xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:42:08.7833585Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:PackTimeFinish>
    <d2p1:PackTimeStart xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:42:08.7833585Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:PackTimeStart>
    <d2p1:PackedByUserID>1</d2p1:PackedByUserID>
    <d2p1:PalletNumber>1</d2p1:PalletNumber>
    <d2p1:PieceDescription>sample string 4</d2p1:PieceDescription>
    <d2p1:PieceHeight>1</d2p1:PieceHeight>
    <d2p1:PieceID>1</d2p1:PieceID>
    <d2p1:PieceLength>1</d2p1:PieceLength>
    <d2p1:PieceTypeID>64</d2p1:PieceTypeID>
    <d2p1:PieceWeight>1</d2p1:PieceWeight>
    <d2p1:PieceWidth>1</d2p1:PieceWidth>
    <d2p1:Quantity>5</d2p1:Quantity>
    <d2p1:UpdatedBy>9</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:42:08.7833585Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
    <d2p1:WarehouseAlertID>1</d2p1:WarehouseAlertID>
    <d2p1:WarehouseCheck>true</d2p1:WarehouseCheck>
  </returnItem>
</UpsertRetOfordPieceDb66KPc_SrH>