POST api/OdysseyOrder

Request Information

URI Parameters

None.

Body Parameters

OdysseyOrder
NameDescriptionTypeAdditional information
AccountCode

string

Required

CostCap

integer

None.

OrderNumber

string

Required

AccountContact

string

Required

AccountContactEmail

string

Required

AccountContactALT

string

None.

AccountContactALTEmail

string

None.

Comments

string

None.

VIP

string

Required

TransfereeFirstName

string

Required

TransfereeLastName

string

Required

PreferredContact

string

None.

PreferredPhone

string

None.

PreferredEmail

string

None.

SpousePartnerFirstName

string

None.

SpousePartnerLastName

string

None.

SecondaryPhone

string

None.

SecondaryEmail

string

None.

OriginStreet1

string

Required

OriginStreet2

string

None.

OriginCity

string

Required

OriginState

string

Required

OriginCountry

string

None.

OriginZip

string

Required

OriginResidenceType

string

None.

DestinationStreet1

string

None.

DestinationStreet2

string

None.

DestinationCity

string

Required

DestinationState

string

Required

DestinationCountry

string

None.

DestinationZip

string

None.

DestinationResidenceType

string

None.

HHGMoveTier

string

Required

PrimaryPhone

string

Required

PrimaryEmail

string

Required

PreferredPackFrom

date

None.

PreferredPackTo

date

None.

PreferredLoadFrom

date

None.

PreferredLoadTo

date

None.

StorageAuthorized

integer

None.

NumberOfBedrooms

integer

None.

WeightCap

string

None.

SquareFootage

integer

None.

_ccr

globally unique identifier

None.

_shipmentClass

globally unique identifier

None.

_account

globally unique identifier

None.

_accountContactWhoCalled

globally unique identifier

None.

_cmm_accountcontactalt

globally unique identifier

None.

_transactioncurrency

globally unique identifier

None.

_cmm_transfereesortname

string

None.

_cmm_transfereefullname

string

None.

_cmm_vip

boolean

None.

_cmm_origincountry

integer

None.

_cmm_destinationcountry

integer

None.

_cmm_residencetype

integer

None.

_cmm_destinationresidencetype

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountCode": "sample string 1",
  "CostCap": 1,
  "OrderNumber": "sample string 2",
  "AccountContact": "sample string 3",
  "AccountContactEmail": "sample string 4",
  "AccountContactALT": "sample string 5",
  "AccountContactALTEmail": "sample string 6",
  "Comments": "sample string 7",
  "VIP": "sample string 8",
  "TransfereeFirstName": "sample string 9",
  "TransfereeLastName": "sample string 10",
  "PreferredContact": "sample string 11",
  "PreferredPhone": "sample string 12",
  "PreferredEmail": "sample string 13",
  "SpousePartnerFirstName": "sample string 14",
  "SpousePartnerLastName": "sample string 15",
  "SecondaryPhone": "sample string 16",
  "SecondaryEmail": "sample string 17",
  "OriginStreet1": "sample string 18",
  "OriginStreet2": "sample string 19",
  "OriginCity": "sample string 20",
  "OriginState": "sample string 21",
  "OriginCountry": "sample string 22",
  "OriginZip": "sample string 23",
  "OriginResidenceType": "sample string 24",
  "DestinationStreet1": "sample string 25",
  "DestinationStreet2": "sample string 26",
  "DestinationCity": "sample string 27",
  "DestinationState": "sample string 28",
  "DestinationCountry": "sample string 29",
  "DestinationZip": "sample string 30",
  "DestinationResidenceType": "sample string 31",
  "HHGMoveTier": "sample string 32",
  "PrimaryPhone": "sample string 33",
  "PrimaryEmail": "sample string 34",
  "PreferredPackFrom": "2026-11-10T23:04:50.5292246-06:00",
  "PreferredPackTo": "2026-11-10T23:04:50.5292246-06:00",
  "PreferredLoadFrom": "2026-11-10T23:04:50.5292246-06:00",
  "PreferredLoadTo": "2026-11-10T23:04:50.5292246-06:00",
  "StorageAuthorized": 1,
  "NumberOfBedrooms": 1,
  "WeightCap": "sample string 35",
  "SquareFootage": 1,
  "_ccr": "aeddefe0-b7e0-4bbd-8506-9142bbe911b5",
  "_shipmentClass": "324e6e18-192f-4fd7-a94a-a488d59e9056",
  "_account": "f6cbcfe2-7666-4aa0-b393-5006cebf3e7e",
  "_accountContactWhoCalled": "8fdd7ee8-bd07-496e-9c0f-aff6a043a5c9",
  "_cmm_accountcontactalt": "1f5d73aa-62a9-4592-9e62-e93d716d2eae",
  "_transactioncurrency": "772f5a5a-0131-4bed-8022-f09b6608fb1b",
  "_cmm_transfereesortname": "sample string 42",
  "_cmm_transfereefullname": "sample string 43",
  "_cmm_vip": true,
  "_cmm_origincountry": 45,
  "_cmm_destinationcountry": 46,
  "_cmm_residencetype": 47,
  "_cmm_destinationresidencetype": 48
}

application/xml, text/xml

Sample:
<OdysseyOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OdysseyOrderAPI.Models">
  <AccountCode>sample string 1</AccountCode>
  <AccountContact>sample string 3</AccountContact>
  <AccountContactALT>sample string 5</AccountContactALT>
  <AccountContactALTEmail>sample string 6</AccountContactALTEmail>
  <AccountContactEmail>sample string 4</AccountContactEmail>
  <Comments>sample string 7</Comments>
  <CostCap>1</CostCap>
  <DestinationCity>sample string 27</DestinationCity>
  <DestinationCountry>sample string 29</DestinationCountry>
  <DestinationResidenceType>sample string 31</DestinationResidenceType>
  <DestinationState>sample string 28</DestinationState>
  <DestinationStreet1>sample string 25</DestinationStreet1>
  <DestinationStreet2>sample string 26</DestinationStreet2>
  <DestinationZip>sample string 30</DestinationZip>
  <HHGMoveTier>sample string 32</HHGMoveTier>
  <NumberOfBedrooms>1</NumberOfBedrooms>
  <OrderNumber>sample string 2</OrderNumber>
  <OriginCity>sample string 20</OriginCity>
  <OriginCountry>sample string 22</OriginCountry>
  <OriginResidenceType>sample string 24</OriginResidenceType>
  <OriginState>sample string 21</OriginState>
  <OriginStreet1>sample string 18</OriginStreet1>
  <OriginStreet2>sample string 19</OriginStreet2>
  <OriginZip>sample string 23</OriginZip>
  <PreferredContact>sample string 11</PreferredContact>
  <PreferredEmail>sample string 13</PreferredEmail>
  <PreferredLoadFrom>2026-11-10T23:04:50.5292246-06:00</PreferredLoadFrom>
  <PreferredLoadTo>2026-11-10T23:04:50.5292246-06:00</PreferredLoadTo>
  <PreferredPackFrom>2026-11-10T23:04:50.5292246-06:00</PreferredPackFrom>
  <PreferredPackTo>2026-11-10T23:04:50.5292246-06:00</PreferredPackTo>
  <PreferredPhone>sample string 12</PreferredPhone>
  <PrimaryEmail>sample string 34</PrimaryEmail>
  <PrimaryPhone>sample string 33</PrimaryPhone>
  <SecondaryEmail>sample string 17</SecondaryEmail>
  <SecondaryPhone>sample string 16</SecondaryPhone>
  <SpousePartnerFirstName>sample string 14</SpousePartnerFirstName>
  <SpousePartnerLastName>sample string 15</SpousePartnerLastName>
  <SquareFootage>1</SquareFootage>
  <StorageAuthorized>1</StorageAuthorized>
  <TransfereeFirstName>sample string 9</TransfereeFirstName>
  <TransfereeLastName>sample string 10</TransfereeLastName>
  <VIP>sample string 8</VIP>
  <WeightCap>sample string 35</WeightCap>
  <_account>f6cbcfe2-7666-4aa0-b393-5006cebf3e7e</_account>
  <_accountContactWhoCalled>8fdd7ee8-bd07-496e-9c0f-aff6a043a5c9</_accountContactWhoCalled>
  <_ccr>aeddefe0-b7e0-4bbd-8506-9142bbe911b5</_ccr>
  <_cmm_accountcontactalt>1f5d73aa-62a9-4592-9e62-e93d716d2eae</_cmm_accountcontactalt>
  <_cmm_destinationcountry>46</_cmm_destinationcountry>
  <_cmm_destinationresidencetype>48</_cmm_destinationresidencetype>
  <_cmm_origincountry>45</_cmm_origincountry>
  <_cmm_residencetype>47</_cmm_residencetype>
  <_cmm_transfereefullname>sample string 43</_cmm_transfereefullname>
  <_cmm_transfereesortname>sample string 42</_cmm_transfereesortname>
  <_cmm_vip>true</_cmm_vip>
  <_shipmentClass>324e6e18-192f-4fd7-a94a-a488d59e9056</_shipmentClass>
  <_transactioncurrency>772f5a5a-0131-4bed-8022-f09b6608fb1b</_transactioncurrency>
</OdysseyOrder>

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.