PUT api/Tms/ServiceOrders/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

TmsShipmentDetailsBindingViewModel

Name	Type	Additional information
CustomerId	integer	Required
OrderIds	Collection of integer	None.
ShipperId	integer	None.
ShipperNumber	string	None.
ReqShipDate	date	None.
PuAppointment	date	None.
BillToId	integer	None.
ConsigneeId	integer	None.
ConsigneeNumber	string	None.
AppointmentDate	date	None.
Equipment	string	None.
SealNumber	string	None.
Vendors	Collection of TmsShipmentVendorBindingViewModel	None.
Charges	Collection of TransloadBillingItemViewModel	None.
ModeId	integer	None.
DeviceId	integer	None.
CustomerReferenceNumber	string	None.
MustArriveByDate	date	None.
ShipmentDate	date	None.
ConsigneeArrivalDate	date	None.
ConsigneeDepartureDate	date	None.
DeliveryAppointmentDate	date	None.
ShipperArrivalDate	date	None.
ShipperDepartureDate	date	None.
MarkEmpty	boolean	None.
ConsigneeApptRequired	boolean	None.
ShipperApptRequired	boolean	None.
ConsigneeDt	boolean	None.
ShipperDt	boolean	None.
ShipperSpecialReq	Collection of string	None.
ConsigneeSpecialReq	Collection of string	None.
PUAppointmentDt	date	None.
DeliveryAppointmentDateDt	date	None.
CapacityAssigneeId	integer	None.
PUAppointmentRecoveryDate	date	None.
DeliveryAppointmentRecoveryDate	date	None.
PUAppointementTo	date	None.
DeliveryAppointmentDateTo	date	None.
CapacityOperationId	integer	None.
CommercialAssigneeId	integer	None.
CommercialOperationId	integer	None.
CapacityOperationIsGroup	boolean	None.
CapacityAssigneeIsGroup	boolean	None.
CommercialAssigneeIsGroup	boolean	None.
CommercialOperationIsGroup	boolean	None.
FreightChargeId	integer	None.
Pod	string	None.
IsTeam	boolean	None.
ProNumber	string	None.
LoadedDate	date	None.
TotalMiles	string	None.
MaxBuy	decimal number	None.
WarehouseId	integer	None.
EmptyReturnLocationId	integer	None.
ReportedEmpty	date	None.
VesselEta	date	None.
EmptyReturnNumber	string	None.
AvailableEta	date	None.
EmptyReturnArrivalDate	date	None.
EmptyReturnDepartureDate	date	None.
LastFreeDate	date	None.
EmptyReturnDeliveryAppointmentDateTo	date	None.
EmptyReturnDeliveryAppointmentDate	date	None.
EmptyReturnPod	string	None.
VendorConfirmed	boolean	None.
ShipmentTypeId	integer	None.
ReceivingNote	string	None.
ShippingNote	string	None.
EstimatedTimeArrival	date	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "OrderIds": [
    1,
    1
  ],
  "ShipperId": 1,
  "ShipperNumber": "sample string 2",
  "ReqShipDate": "2025-12-05T23:22:12.4160801-08:00",
  "PuAppointment": "2025-12-05T23:22:12.4160801-08:00",
  "BillToId": 1,
  "ConsigneeId": 1,
  "ConsigneeNumber": "sample string 3",
  "AppointmentDate": "2025-12-05T23:22:12.4170795-08:00",
  "Equipment": "sample string 4",
  "SealNumber": "sample string 5",
  "Vendors": [
    {
      "Id": 1,
      "VendorId": 1,
      "ContactId": 1,
      "DriverName": "sample string 2",
      "DriverPhone": "sample string 3",
      "TruckNumber": "sample string 4",
      "EmptyLocation": "sample string 5",
      "Payables": [
        {
          "ChargeId": 1,
          "Quantity": 2.0,
          "Rate": 3.0,
          "FreeTime": 1.0,
          "MinCharge": 1.0,
          "MaxCharge": 1.0,
          "Code": "sample string 4",
          "InvoiceId": 1,
          "OriAddSup": 5,
          "IsReadOnly": true,
          "Note": "sample string 7",
          "DateStart": "2025-12-05T23:22:12.4190794-08:00",
          "DateEnd": "2025-12-05T23:22:12.4190794-08:00"
        },
        {
          "ChargeId": 1,
          "Quantity": 2.0,
          "Rate": 3.0,
          "FreeTime": 1.0,
          "MinCharge": 1.0,
          "MaxCharge": 1.0,
          "Code": "sample string 4",
          "InvoiceId": 1,
          "OriAddSup": 5,
          "IsReadOnly": true,
          "Note": "sample string 7",
          "DateStart": "2025-12-05T23:22:12.4190794-08:00",
          "DateEnd": "2025-12-05T23:22:12.4190794-08:00"
        }
      ],
      "IsTeam": true,
      "FreightChargeId": 1,
      "ItemVendorId": 1
    },
    {
      "Id": 1,
      "VendorId": 1,
      "ContactId": 1,
      "DriverName": "sample string 2",
      "DriverPhone": "sample string 3",
      "TruckNumber": "sample string 4",
      "EmptyLocation": "sample string 5",
      "Payables": [
        {
          "ChargeId": 1,
          "Quantity": 2.0,
          "Rate": 3.0,
          "FreeTime": 1.0,
          "MinCharge": 1.0,
          "MaxCharge": 1.0,
          "Code": "sample string 4",
          "InvoiceId": 1,
          "OriAddSup": 5,
          "IsReadOnly": true,
          "Note": "sample string 7",
          "DateStart": "2025-12-05T23:22:12.4190794-08:00",
          "DateEnd": "2025-12-05T23:22:12.4190794-08:00"
        },
        {
          "ChargeId": 1,
          "Quantity": 2.0,
          "Rate": 3.0,
          "FreeTime": 1.0,
          "MinCharge": 1.0,
          "MaxCharge": 1.0,
          "Code": "sample string 4",
          "InvoiceId": 1,
          "OriAddSup": 5,
          "IsReadOnly": true,
          "Note": "sample string 7",
          "DateStart": "2025-12-05T23:22:12.4190794-08:00",
          "DateEnd": "2025-12-05T23:22:12.4190794-08:00"
        }
      ],
      "IsTeam": true,
      "FreightChargeId": 1,
      "ItemVendorId": 1
    }
  ],
  "Charges": [
    {
      "ChargeId": 1,
      "Rate": 2.0,
      "Quantity": 3.0,
      "OriAddSup": 4,
      "InvoiceId": 1,
      "IsReadOnly": true,
      "Note": "sample string 6",
      "FreightChargeId": 1,
      "DateStart": "2025-12-05T23:22:12.4200825-08:00",
      "DateEnd": "2025-12-05T23:22:12.4200825-08:00"
    },
    {
      "ChargeId": 1,
      "Rate": 2.0,
      "Quantity": 3.0,
      "OriAddSup": 4,
      "InvoiceId": 1,
      "IsReadOnly": true,
      "Note": "sample string 6",
      "FreightChargeId": 1,
      "DateStart": "2025-12-05T23:22:12.4200825-08:00",
      "DateEnd": "2025-12-05T23:22:12.4200825-08:00"
    }
  ],
  "ModeId": 1,
  "DeviceId": 1,
  "CustomerReferenceNumber": "sample string 6",
  "MustArriveByDate": "2025-12-05T23:22:12.4210791-08:00",
  "ShipmentDate": "2025-12-05T23:22:12.4210791-08:00",
  "ConsigneeArrivalDate": "2025-12-05T23:22:12.4210791-08:00",
  "ConsigneeDepartureDate": "2025-12-05T23:22:12.4210791-08:00",
  "DeliveryAppointmentDate": "2025-12-05T23:22:12.4210791-08:00",
  "ShipperArrivalDate": "2025-12-05T23:22:12.4220774-08:00",
  "ShipperDepartureDate": "2025-12-05T23:22:12.4220774-08:00",
  "MarkEmpty": true,
  "ConsigneeApptRequired": true,
  "ShipperApptRequired": true,
  "ConsigneeDt": true,
  "ShipperDt": true,
  "ShipperSpecialReq": [
    "sample string 1",
    "sample string 2"
  ],
  "ConsigneeSpecialReq": [
    "sample string 1",
    "sample string 2"
  ],
  "PUAppointmentDt": "2025-12-05T23:22:12.4230757-08:00",
  "DeliveryAppointmentDateDt": "2025-12-05T23:22:12.4230757-08:00",
  "CapacityAssigneeId": 1,
  "PUAppointmentRecoveryDate": "2025-12-05T23:22:12.4230757-08:00",
  "DeliveryAppointmentRecoveryDate": "2025-12-05T23:22:12.4230757-08:00",
  "PUAppointementTo": "2025-12-05T23:22:12.4240714-08:00",
  "DeliveryAppointmentDateTo": "2025-12-05T23:22:12.4240714-08:00",
  "CapacityOperationId": 1,
  "CommercialAssigneeId": 1,
  "CommercialOperationId": 1,
  "CapacityOperationIsGroup": true,
  "CapacityAssigneeIsGroup": true,
  "CommercialAssigneeIsGroup": true,
  "CommercialOperationIsGroup": true,
  "FreightChargeId": 1,
  "Pod": "sample string 7",
  "IsTeam": true,
  "ProNumber": "sample string 9",
  "LoadedDate": "2025-12-05T23:22:12.4250676-08:00",
  "TotalMiles": "sample string 10",
  "MaxBuy": 1.0,
  "WarehouseId": 1,
  "EmptyReturnLocationId": 1,
  "ReportedEmpty": "2025-12-05T23:22:12.4260686-08:00",
  "VesselEta": "2025-12-05T23:22:12.4260686-08:00",
  "EmptyReturnNumber": "sample string 11",
  "AvailableEta": "2025-12-05T23:22:12.4270813-08:00",
  "EmptyReturnArrivalDate": "2025-12-05T23:22:12.4270813-08:00",
  "EmptyReturnDepartureDate": "2025-12-05T23:22:12.4270813-08:00",
  "LastFreeDate": "2025-12-05T23:22:12.4270813-08:00",
  "EmptyReturnDeliveryAppointmentDateTo": "2025-12-05T23:22:12.4270813-08:00",
  "EmptyReturnDeliveryAppointmentDate": "2025-12-05T23:22:12.4270813-08:00",
  "EmptyReturnPod": "sample string 12",
  "VendorConfirmed": true,
  "ShipmentTypeId": 1,
  "ReceivingNote": "sample string 13",
  "ShippingNote": "sample string 14",
  "EstimatedTimeArrival": "2025-12-05T23:22:12.4280739-08:00"
}

application/xml, text/xml

Sample:

<TmsShipmentDetailsBindingViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eMpowerCore.ViewModels.TransloadShipment">
  <AppointmentDate>2025-12-05T23:22:12.4170795-08:00</AppointmentDate>
  <AvailableEta>2025-12-05T23:22:12.4270813-08:00</AvailableEta>
  <BillToId>1</BillToId>
  <CapacityAssigneeId>1</CapacityAssigneeId>
  <CapacityAssigneeIsGroup>true</CapacityAssigneeIsGroup>
  <CapacityOperationId>1</CapacityOperationId>
  <CapacityOperationIsGroup>true</CapacityOperationIsGroup>
  <Charges xmlns:d2p1="http://schemas.datacontract.org/2004/07/eMpowerCore.ViewModels.TransloadReceipt">
    <d2p1:TransloadBillingItemViewModel>
      <d2p1:ChargeId>1</d2p1:ChargeId>
      <d2p1:DateEnd>2025-12-05T23:22:12.4200825-08:00</d2p1:DateEnd>
      <d2p1:DateStart>2025-12-05T23:22:12.4200825-08:00</d2p1:DateStart>
      <d2p1:FreightChargeId>1</d2p1:FreightChargeId>
      <d2p1:InvoiceId>1</d2p1:InvoiceId>
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:Note>sample string 6</d2p1:Note>
      <d2p1:OriAddSup>4</d2p1:OriAddSup>
      <d2p1:Quantity>3</d2p1:Quantity>
      <d2p1:Rate>2</d2p1:Rate>
    </d2p1:TransloadBillingItemViewModel>
    <d2p1:TransloadBillingItemViewModel>
      <d2p1:ChargeId>1</d2p1:ChargeId>
      <d2p1:DateEnd>2025-12-05T23:22:12.4200825-08:00</d2p1:DateEnd>
      <d2p1:DateStart>2025-12-05T23:22:12.4200825-08:00</d2p1:DateStart>
      <d2p1:FreightChargeId>1</d2p1:FreightChargeId>
      <d2p1:InvoiceId>1</d2p1:InvoiceId>
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:Note>sample string 6</d2p1:Note>
      <d2p1:OriAddSup>4</d2p1:OriAddSup>
      <d2p1:Quantity>3</d2p1:Quantity>
      <d2p1:Rate>2</d2p1:Rate>
    </d2p1:TransloadBillingItemViewModel>
  </Charges>
  <CommercialAssigneeId>1</CommercialAssigneeId>
  <CommercialAssigneeIsGroup>true</CommercialAssigneeIsGroup>
  <CommercialOperationId>1</CommercialOperationId>
  <CommercialOperationIsGroup>true</CommercialOperationIsGroup>
  <ConsigneeApptRequired>true</ConsigneeApptRequired>
  <ConsigneeArrivalDate>2025-12-05T23:22:12.4210791-08:00</ConsigneeArrivalDate>
  <ConsigneeDepartureDate>2025-12-05T23:22:12.4210791-08:00</ConsigneeDepartureDate>
  <ConsigneeDt>true</ConsigneeDt>
  <ConsigneeId>1</ConsigneeId>
  <ConsigneeNumber>sample string 3</ConsigneeNumber>
  <ConsigneeSpecialReq xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ConsigneeSpecialReq>
  <CustomerId>1</CustomerId>
  <CustomerReferenceNumber>sample string 6</CustomerReferenceNumber>
  <DeliveryAppointmentDate>2025-12-05T23:22:12.4210791-08:00</DeliveryAppointmentDate>
  <DeliveryAppointmentDateDt>2025-12-05T23:22:12.4230757-08:00</DeliveryAppointmentDateDt>
  <DeliveryAppointmentDateTo>2025-12-05T23:22:12.4240714-08:00</DeliveryAppointmentDateTo>
  <DeliveryAppointmentRecoveryDate>2025-12-05T23:22:12.4230757-08:00</DeliveryAppointmentRecoveryDate>
  <DeviceId>1</DeviceId>
  <EmptyReturnArrivalDate>2025-12-05T23:22:12.4270813-08:00</EmptyReturnArrivalDate>
  <EmptyReturnDeliveryAppointmentDate>2025-12-05T23:22:12.4270813-08:00</EmptyReturnDeliveryAppointmentDate>
  <EmptyReturnDeliveryAppointmentDateTo>2025-12-05T23:22:12.4270813-08:00</EmptyReturnDeliveryAppointmentDateTo>
  <EmptyReturnDepartureDate>2025-12-05T23:22:12.4270813-08:00</EmptyReturnDepartureDate>
  <EmptyReturnLocationId>1</EmptyReturnLocationId>
  <EmptyReturnNumber>sample string 11</EmptyReturnNumber>
  <EmptyReturnPod>sample string 12</EmptyReturnPod>
  <Equipment>sample string 4</Equipment>
  <EstimatedTimeArrival>2025-12-05T23:22:12.4280739-08:00</EstimatedTimeArrival>
  <FreightChargeId>1</FreightChargeId>
  <IsTeam>true</IsTeam>
  <LastFreeDate>2025-12-05T23:22:12.4270813-08:00</LastFreeDate>
  <LoadedDate>2025-12-05T23:22:12.4250676-08:00</LoadedDate>
  <MarkEmpty>true</MarkEmpty>
  <MaxBuy>1</MaxBuy>
  <ModeId>1</ModeId>
  <MustArriveByDate>2025-12-05T23:22:12.4210791-08:00</MustArriveByDate>
  <OrderIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>1</d2p1:int>
  </OrderIds>
  <PUAppointementTo>2025-12-05T23:22:12.4240714-08:00</PUAppointementTo>
  <PUAppointmentDt>2025-12-05T23:22:12.4230757-08:00</PUAppointmentDt>
  <PUAppointmentRecoveryDate>2025-12-05T23:22:12.4230757-08:00</PUAppointmentRecoveryDate>
  <Pod>sample string 7</Pod>
  <ProNumber>sample string 9</ProNumber>
  <PuAppointment>2025-12-05T23:22:12.4160801-08:00</PuAppointment>
  <ReceivingNote>sample string 13</ReceivingNote>
  <ReportedEmpty>2025-12-05T23:22:12.4260686-08:00</ReportedEmpty>
  <ReqShipDate>2025-12-05T23:22:12.4160801-08:00</ReqShipDate>
  <SealNumber>sample string 5</SealNumber>
  <ShipmentDate>2025-12-05T23:22:12.4210791-08:00</ShipmentDate>
  <ShipmentTypeId>1</ShipmentTypeId>
  <ShipperApptRequired>true</ShipperApptRequired>
  <ShipperArrivalDate>2025-12-05T23:22:12.4220774-08:00</ShipperArrivalDate>
  <ShipperDepartureDate>2025-12-05T23:22:12.4220774-08:00</ShipperDepartureDate>
  <ShipperDt>true</ShipperDt>
  <ShipperId>1</ShipperId>
  <ShipperNumber>sample string 2</ShipperNumber>
  <ShipperSpecialReq xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ShipperSpecialReq>
  <ShippingNote>sample string 14</ShippingNote>
  <TotalMiles>sample string 10</TotalMiles>
  <VendorConfirmed>true</VendorConfirmed>
  <Vendors>
    <TmsShipmentVendorBindingViewModel>
      <ContactId>1</ContactId>
      <DriverName>sample string 2</DriverName>
      <DriverPhone>sample string 3</DriverPhone>
      <EmptyLocation>sample string 5</EmptyLocation>
      <FreightChargeId>1</FreightChargeId>
      <Id>1</Id>
      <IsTeam>true</IsTeam>
      <ItemVendorId>1</ItemVendorId>
      <Payables>
        <TransloadShipmentPayableViewModel>
          <ChargeId>1</ChargeId>
          <Code>sample string 4</Code>
          <DateEnd>2025-12-05T23:22:12.4190794-08:00</DateEnd>
          <DateStart>2025-12-05T23:22:12.4190794-08:00</DateStart>
          <FreeTime>1</FreeTime>
          <InvoiceId>1</InvoiceId>
          <IsReadOnly>true</IsReadOnly>
          <MaxCharge>1</MaxCharge>
          <MinCharge>1</MinCharge>
          <Note>sample string 7</Note>
          <OriAddSup>5</OriAddSup>
          <Quantity>2</Quantity>
          <Rate>3</Rate>
        </TransloadShipmentPayableViewModel>
        <TransloadShipmentPayableViewModel>
          <ChargeId>1</ChargeId>
          <Code>sample string 4</Code>
          <DateEnd>2025-12-05T23:22:12.4190794-08:00</DateEnd>
          <DateStart>2025-12-05T23:22:12.4190794-08:00</DateStart>
          <FreeTime>1</FreeTime>
          <InvoiceId>1</InvoiceId>
          <IsReadOnly>true</IsReadOnly>
          <MaxCharge>1</MaxCharge>
          <MinCharge>1</MinCharge>
          <Note>sample string 7</Note>
          <OriAddSup>5</OriAddSup>
          <Quantity>2</Quantity>
          <Rate>3</Rate>
        </TransloadShipmentPayableViewModel>
      </Payables>
      <TruckNumber>sample string 4</TruckNumber>
      <VendorId>1</VendorId>
    </TmsShipmentVendorBindingViewModel>
    <TmsShipmentVendorBindingViewModel>
      <ContactId>1</ContactId>
      <DriverName>sample string 2</DriverName>
      <DriverPhone>sample string 3</DriverPhone>
      <EmptyLocation>sample string 5</EmptyLocation>
      <FreightChargeId>1</FreightChargeId>
      <Id>1</Id>
      <IsTeam>true</IsTeam>
      <ItemVendorId>1</ItemVendorId>
      <Payables>
        <TransloadShipmentPayableViewModel>
          <ChargeId>1</ChargeId>
          <Code>sample string 4</Code>
          <DateEnd>2025-12-05T23:22:12.4190794-08:00</DateEnd>
          <DateStart>2025-12-05T23:22:12.4190794-08:00</DateStart>
          <FreeTime>1</FreeTime>
          <InvoiceId>1</InvoiceId>
          <IsReadOnly>true</IsReadOnly>
          <MaxCharge>1</MaxCharge>
          <MinCharge>1</MinCharge>
          <Note>sample string 7</Note>
          <OriAddSup>5</OriAddSup>
          <Quantity>2</Quantity>
          <Rate>3</Rate>
        </TransloadShipmentPayableViewModel>
        <TransloadShipmentPayableViewModel>
          <ChargeId>1</ChargeId>
          <Code>sample string 4</Code>
          <DateEnd>2025-12-05T23:22:12.4190794-08:00</DateEnd>
          <DateStart>2025-12-05T23:22:12.4190794-08:00</DateStart>
          <FreeTime>1</FreeTime>
          <InvoiceId>1</InvoiceId>
          <IsReadOnly>true</IsReadOnly>
          <MaxCharge>1</MaxCharge>
          <MinCharge>1</MinCharge>
          <Note>sample string 7</Note>
          <OriAddSup>5</OriAddSup>
          <Quantity>2</Quantity>
          <Rate>3</Rate>
        </TransloadShipmentPayableViewModel>
      </Payables>
      <TruckNumber>sample string 4</TruckNumber>
      <VendorId>1</VendorId>
    </TmsShipmentVendorBindingViewModel>
  </Vendors>
  <VesselEta>2025-12-05T23:22:12.4260686-08:00</VesselEta>
  <WarehouseId>1</WarehouseId>
</TmsShipmentDetailsBindingViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.