POST api/TransferOrder

Request Information

URI Parameters

None.

Body Parameters

Shipment
NameDescriptionTypeAdditional information
AccountCode

string

None.

AccountContact

string

None.

AccountContactEmail

string

None.

ActualWeight

integer

None.

AutoShipment

string

None.

AuthStorageDays

integer

None.

ClientReference

string

None.

CCR

string

None.

DestinationCity

string

None.

DestinationCountry

string

None.

DestinationResidenceType

string

None.

DestinationState

string

None.

DestinationStreet1

string

None.

DestinationStreet2

string

None.

DestinationWillAdvise

string

None.

DestinationZip

string

None.

EstimatedWeight

integer

None.

MoveDistance

string

None.

NewJobStart

date

None.

NumberOfVehicles

integer

None.

OriginBedrooms

integer

None.

OriginCity

string

None.

OriginCountry

string

None.

OriginExtraPickup

string

None.

OriginResidenceType

string

None.

OriginSqFootage

integer

None.

OriginState

string

None.

OriginStreet1

string

None.

OriginStreet2

string

None.

OriginTotalRooms

integer

None.

OriginZip

string

None.

PartnerFirstName

string

None.

PartnerLastName

string

None.

PreferredDeliveryFrom

date

None.

PreferredDeliveryTo

date

None.

PreferredFollowUp

string

None.

PreferredLoadFrom

date

None.

PreferredLoadTo

date

None.

PreferredPackFrom

date

None.

PreferredPackTo

date

None.

PreferredPhone

string

None.

PreferredSurveyDate

date

None.

PrimaryContact

string

None.

PrimaryEmail

string

None.

PrimaryPhone

string

None.

PromoveNumber

string

None.

RegistrationNumber

string

None.

ReloPolicy

string

None.

Rush

string

None.

ScheduledLoadFrom

date

None.

ScheduledDeliveryFrom

date

None.

ScheduledDeliveryTo

date

None.

ScheduledStartDate

date

None.

ScheduledLoadTo

date

None.

ScheduledPackFrom

date

None.

ScheduledPackTo

date

None.

SecondaryEmail

string

None.

SecondaryPhone

string

None.

ShipmentNumber

string

None.

ShipmentNotes

string

None.

Storage

string

None.

StorageStartDate

date

None.

SurveyNotes

string

None.

TransfereeFirstName

string

None.

TransfereeLastName

string

None.

TransfereeFullName

string

None.

VIP

string

None.

TenderedTo

string

None.

ShipmentClaims

Collection of ShipmentClaim

None.

ShipmentVehicleSummaries

ShipmentVehicleSummary

None.

ShipmentVehicles

Collection of ShipmentVehicle

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountCode": "sample string 1",
  "AccountContact": "sample string 2",
  "AccountContactEmail": "sample string 3",
  "ActualWeight": 1,
  "AutoShipment": "sample string 4",
  "AuthStorageDays": 1,
  "ClientReference": "sample string 5",
  "CCR": "sample string 6",
  "DestinationCity": "sample string 7",
  "DestinationCountry": "sample string 8",
  "DestinationResidenceType": "sample string 9",
  "DestinationState": "sample string 10",
  "DestinationStreet1": "sample string 11",
  "DestinationStreet2": "sample string 12",
  "DestinationWillAdvise": "sample string 13",
  "DestinationZip": "sample string 14",
  "EstimatedWeight": 1,
  "MoveDistance": "sample string 15",
  "NewJobStart": "2026-05-27T00:46:48.6502965-05:00",
  "NumberOfVehicles": 1,
  "OriginBedrooms": 1,
  "OriginCity": "sample string 16",
  "OriginCountry": "sample string 17",
  "OriginExtraPickup": "sample string 18",
  "OriginResidenceType": "sample string 19",
  "OriginSqFootage": 1,
  "OriginState": "sample string 20",
  "OriginStreet1": "sample string 21",
  "OriginStreet2": "sample string 22",
  "OriginTotalRooms": 1,
  "OriginZip": "sample string 23",
  "PartnerFirstName": "sample string 24",
  "PartnerLastName": "sample string 25",
  "PreferredDeliveryFrom": "2026-05-27T00:46:48.6502965-05:00",
  "PreferredDeliveryTo": "2026-05-27T00:46:48.6502965-05:00",
  "PreferredFollowUp": "sample string 26",
  "PreferredLoadFrom": "2026-05-27T00:46:48.6502965-05:00",
  "PreferredLoadTo": "2026-05-27T00:46:48.6502965-05:00",
  "PreferredPackFrom": "2026-05-27T00:46:48.6502965-05:00",
  "PreferredPackTo": "2026-05-27T00:46:48.6502965-05:00",
  "PreferredPhone": "sample string 27",
  "PreferredSurveyDate": "2026-05-27T00:46:48.6502965-05:00",
  "PrimaryContact": "sample string 28",
  "PrimaryEmail": "sample string 29",
  "PrimaryPhone": "sample string 30",
  "PromoveNumber": "sample string 31",
  "RegistrationNumber": "sample string 32",
  "ReloPolicy": "sample string 33",
  "Rush": "sample string 34",
  "ScheduledLoadFrom": "2026-05-27T00:46:48.6502965-05:00",
  "ScheduledDeliveryFrom": "2026-05-27T00:46:48.6502965-05:00",
  "ScheduledDeliveryTo": "2026-05-27T00:46:48.6502965-05:00",
  "ScheduledStartDate": "2026-05-27T00:46:48.6502965-05:00",
  "ScheduledLoadTo": "2026-05-27T00:46:48.6502965-05:00",
  "ScheduledPackFrom": "2026-05-27T00:46:48.6502965-05:00",
  "ScheduledPackTo": "2026-05-27T00:46:48.6502965-05:00",
  "SecondaryEmail": "sample string 35",
  "SecondaryPhone": "sample string 36",
  "ShipmentNumber": "sample string 37",
  "ShipmentNotes": "sample string 38",
  "Storage": "sample string 39",
  "StorageStartDate": "2026-05-27T00:46:48.6502965-05:00",
  "SurveyNotes": "sample string 40",
  "TransfereeFirstName": "sample string 41",
  "TransfereeLastName": "sample string 42",
  "TransfereeFullName": "sample string 43",
  "VIP": "sample string 44",
  "TenderedTo": "sample string 45",
  "ShipmentClaims": [
    {
      "ClaimFileDate": "2026-05-27T00:46:48.6502965-05:00",
      "ActualDeliveryDate": "2026-05-27T00:46:48.6502965-05:00",
      "OfferToSettleDate": "2026-05-27T00:46:48.6502965-05:00",
      "ActualSettleDate": "2026-05-27T00:46:48.6502965-05:00",
      "DaysOpen": 1,
      "AmountClaimed": 1.0,
      "RepairCostToCustomer": 2.0,
      "RepairCostToVendor": 3.0,
      "GoodWill": 4.0,
      "TotalClaimCost": 5.0,
      "CashSettlement": 6.0,
      "ShipmentClaimNote": "sample string 7"
    },
    {
      "ClaimFileDate": "2026-05-27T00:46:48.6502965-05:00",
      "ActualDeliveryDate": "2026-05-27T00:46:48.6502965-05:00",
      "OfferToSettleDate": "2026-05-27T00:46:48.6502965-05:00",
      "ActualSettleDate": "2026-05-27T00:46:48.6502965-05:00",
      "DaysOpen": 1,
      "AmountClaimed": 1.0,
      "RepairCostToCustomer": 2.0,
      "RepairCostToVendor": 3.0,
      "GoodWill": 4.0,
      "TotalClaimCost": 5.0,
      "CashSettlement": 6.0,
      "ShipmentClaimNote": "sample string 7"
    }
  ],
  "ShipmentVehicleSummaries": {
    "TotalNumberOfVehicles": 1,
    "EarliestScheduledPickup": "2026-05-27T00:46:48.6502965-05:00",
    "EarliestScheduledDelivery": "2026-05-27T00:46:48.6502965-05:00"
  },
  "ShipmentVehicles": [
    {
      "Classification": "sample string 1",
      "Year": "sample string 2",
      "Make": "sample string 3",
      "Model": "sample string 4",
      "Vendor": "sample string 5",
      "ScheduledPickupFrom": "2026-05-27T00:46:48.6502965-05:00",
      "ScheduledPickupTo": "2026-05-27T00:46:48.6502965-05:00",
      "ScheduledDeliveryFrom": "2026-05-27T00:46:48.6502965-05:00",
      "ScheduledDeliveryTo": "2026-05-27T00:46:48.6502965-05:00"
    },
    {
      "Classification": "sample string 1",
      "Year": "sample string 2",
      "Make": "sample string 3",
      "Model": "sample string 4",
      "Vendor": "sample string 5",
      "ScheduledPickupFrom": "2026-05-27T00:46:48.6502965-05:00",
      "ScheduledPickupTo": "2026-05-27T00:46:48.6502965-05:00",
      "ScheduledDeliveryFrom": "2026-05-27T00:46:48.6502965-05:00",
      "ScheduledDeliveryTo": "2026-05-27T00:46:48.6502965-05:00"
    }
  ]
}

application/xml, text/xml

Sample:
<Shipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HHGTransferOrder.Models">
  <AccountCode>sample string 1</AccountCode>
  <AccountContact>sample string 2</AccountContact>
  <AccountContactEmail>sample string 3</AccountContactEmail>
  <ActualWeight>1</ActualWeight>
  <AuthStorageDays>1</AuthStorageDays>
  <AutoShipment>sample string 4</AutoShipment>
  <CCR>sample string 6</CCR>
  <ClientReference>sample string 5</ClientReference>
  <DestinationCity>sample string 7</DestinationCity>
  <DestinationCountry>sample string 8</DestinationCountry>
  <DestinationResidenceType>sample string 9</DestinationResidenceType>
  <DestinationState>sample string 10</DestinationState>
  <DestinationStreet1>sample string 11</DestinationStreet1>
  <DestinationStreet2>sample string 12</DestinationStreet2>
  <DestinationWillAdvise>sample string 13</DestinationWillAdvise>
  <DestinationZip>sample string 14</DestinationZip>
  <EstimatedWeight>1</EstimatedWeight>
  <MoveDistance>sample string 15</MoveDistance>
  <NewJobStart>2026-05-27T00:46:48.6502965-05:00</NewJobStart>
  <NumberOfVehicles>1</NumberOfVehicles>
  <OriginBedrooms>1</OriginBedrooms>
  <OriginCity>sample string 16</OriginCity>
  <OriginCountry>sample string 17</OriginCountry>
  <OriginExtraPickup>sample string 18</OriginExtraPickup>
  <OriginResidenceType>sample string 19</OriginResidenceType>
  <OriginSqFootage>1</OriginSqFootage>
  <OriginState>sample string 20</OriginState>
  <OriginStreet1>sample string 21</OriginStreet1>
  <OriginStreet2>sample string 22</OriginStreet2>
  <OriginTotalRooms>1</OriginTotalRooms>
  <OriginZip>sample string 23</OriginZip>
  <PartnerFirstName>sample string 24</PartnerFirstName>
  <PartnerLastName>sample string 25</PartnerLastName>
  <PreferredDeliveryFrom>2026-05-27T00:46:48.6502965-05:00</PreferredDeliveryFrom>
  <PreferredDeliveryTo>2026-05-27T00:46:48.6502965-05:00</PreferredDeliveryTo>
  <PreferredFollowUp>sample string 26</PreferredFollowUp>
  <PreferredLoadFrom>2026-05-27T00:46:48.6502965-05:00</PreferredLoadFrom>
  <PreferredLoadTo>2026-05-27T00:46:48.6502965-05:00</PreferredLoadTo>
  <PreferredPackFrom>2026-05-27T00:46:48.6502965-05:00</PreferredPackFrom>
  <PreferredPackTo>2026-05-27T00:46:48.6502965-05:00</PreferredPackTo>
  <PreferredPhone>sample string 27</PreferredPhone>
  <PreferredSurveyDate>2026-05-27T00:46:48.6502965-05:00</PreferredSurveyDate>
  <PrimaryContact>sample string 28</PrimaryContact>
  <PrimaryEmail>sample string 29</PrimaryEmail>
  <PrimaryPhone>sample string 30</PrimaryPhone>
  <PromoveNumber>sample string 31</PromoveNumber>
  <RegistrationNumber>sample string 32</RegistrationNumber>
  <ReloPolicy>sample string 33</ReloPolicy>
  <Rush>sample string 34</Rush>
  <ScheduledDeliveryFrom>2026-05-27T00:46:48.6502965-05:00</ScheduledDeliveryFrom>
  <ScheduledDeliveryTo>2026-05-27T00:46:48.6502965-05:00</ScheduledDeliveryTo>
  <ScheduledLoadFrom>2026-05-27T00:46:48.6502965-05:00</ScheduledLoadFrom>
  <ScheduledLoadTo>2026-05-27T00:46:48.6502965-05:00</ScheduledLoadTo>
  <ScheduledPackFrom>2026-05-27T00:46:48.6502965-05:00</ScheduledPackFrom>
  <ScheduledPackTo>2026-05-27T00:46:48.6502965-05:00</ScheduledPackTo>
  <ScheduledStartDate>2026-05-27T00:46:48.6502965-05:00</ScheduledStartDate>
  <SecondaryEmail>sample string 35</SecondaryEmail>
  <SecondaryPhone>sample string 36</SecondaryPhone>
  <ShipmentClaims>
    <ShipmentClaim>
      <ActualDeliveryDate>2026-05-27T00:46:48.6502965-05:00</ActualDeliveryDate>
      <ActualSettleDate>2026-05-27T00:46:48.6502965-05:00</ActualSettleDate>
      <AmountClaimed>1</AmountClaimed>
      <CashSettlement>6</CashSettlement>
      <ClaimFileDate>2026-05-27T00:46:48.6502965-05:00</ClaimFileDate>
      <DaysOpen>1</DaysOpen>
      <GoodWill>4</GoodWill>
      <OfferToSettleDate>2026-05-27T00:46:48.6502965-05:00</OfferToSettleDate>
      <RepairCostToCustomer>2</RepairCostToCustomer>
      <RepairCostToVendor>3</RepairCostToVendor>
      <ShipmentClaimNote>sample string 7</ShipmentClaimNote>
      <TotalClaimCost>5</TotalClaimCost>
    </ShipmentClaim>
    <ShipmentClaim>
      <ActualDeliveryDate>2026-05-27T00:46:48.6502965-05:00</ActualDeliveryDate>
      <ActualSettleDate>2026-05-27T00:46:48.6502965-05:00</ActualSettleDate>
      <AmountClaimed>1</AmountClaimed>
      <CashSettlement>6</CashSettlement>
      <ClaimFileDate>2026-05-27T00:46:48.6502965-05:00</ClaimFileDate>
      <DaysOpen>1</DaysOpen>
      <GoodWill>4</GoodWill>
      <OfferToSettleDate>2026-05-27T00:46:48.6502965-05:00</OfferToSettleDate>
      <RepairCostToCustomer>2</RepairCostToCustomer>
      <RepairCostToVendor>3</RepairCostToVendor>
      <ShipmentClaimNote>sample string 7</ShipmentClaimNote>
      <TotalClaimCost>5</TotalClaimCost>
    </ShipmentClaim>
  </ShipmentClaims>
  <ShipmentNotes>sample string 38</ShipmentNotes>
  <ShipmentNumber>sample string 37</ShipmentNumber>
  <ShipmentVehicleSummaries>
    <EarliestScheduledDelivery>2026-05-27T00:46:48.6502965-05:00</EarliestScheduledDelivery>
    <EarliestScheduledPickup>2026-05-27T00:46:48.6502965-05:00</EarliestScheduledPickup>
    <TotalNumberOfVehicles>1</TotalNumberOfVehicles>
  </ShipmentVehicleSummaries>
  <ShipmentVehicles>
    <ShipmentVehicle>
      <Classification>sample string 1</Classification>
      <Make>sample string 3</Make>
      <Model>sample string 4</Model>
      <ScheduledDeliveryFrom>2026-05-27T00:46:48.6502965-05:00</ScheduledDeliveryFrom>
      <ScheduledDeliveryTo>2026-05-27T00:46:48.6502965-05:00</ScheduledDeliveryTo>
      <ScheduledPickupFrom>2026-05-27T00:46:48.6502965-05:00</ScheduledPickupFrom>
      <ScheduledPickupTo>2026-05-27T00:46:48.6502965-05:00</ScheduledPickupTo>
      <Vendor>sample string 5</Vendor>
      <Year>sample string 2</Year>
    </ShipmentVehicle>
    <ShipmentVehicle>
      <Classification>sample string 1</Classification>
      <Make>sample string 3</Make>
      <Model>sample string 4</Model>
      <ScheduledDeliveryFrom>2026-05-27T00:46:48.6502965-05:00</ScheduledDeliveryFrom>
      <ScheduledDeliveryTo>2026-05-27T00:46:48.6502965-05:00</ScheduledDeliveryTo>
      <ScheduledPickupFrom>2026-05-27T00:46:48.6502965-05:00</ScheduledPickupFrom>
      <ScheduledPickupTo>2026-05-27T00:46:48.6502965-05:00</ScheduledPickupTo>
      <Vendor>sample string 5</Vendor>
      <Year>sample string 2</Year>
    </ShipmentVehicle>
  </ShipmentVehicles>
  <Storage>sample string 39</Storage>
  <StorageStartDate>2026-05-27T00:46:48.6502965-05:00</StorageStartDate>
  <SurveyNotes>sample string 40</SurveyNotes>
  <TenderedTo>sample string 45</TenderedTo>
  <TransfereeFirstName>sample string 41</TransfereeFirstName>
  <TransfereeFullName>sample string 43</TransfereeFullName>
  <TransfereeLastName>sample string 42</TransfereeLastName>
  <VIP>sample string 44</VIP>
</Shipment>

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.