POST api/Shipment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ShipmentID	integer	None.
OrderID	integer	None.
OrderBatchID	integer	None.
ClientID	integer	None.
P3PLClientID	integer	None.
OrderSourceCode	string	None.
WarehouseID	integer	None.
ShippedByID	integer	None.
Status	string	None.
Workstation	string	None.
ReferenceNumber	string	None.
ReferenceAdditional	string	None.
PONumber	string	None.
ShipViaID	integer	None.
CarrierZone	string	None.
ShipDate	date	None.
PackageCount	integer	None.
ConsigneeCustomerID	string	None.
ConsigneeCompany	string	None.
ConsigneeName	string	None.
ConsigneeAddress1	string	None.
ConsigneeAddress2	string	None.
ConsigneeCity	string	None.
ConsigneeStateProvince	string	None.
ConsigneePostalCode	string	None.
ConsigneeCountry	string	None.
ConsigneeEmail	string	None.
ConsigneePhone	string	None.
ReturnCompany	string	None.
ReturnWarehouse	string	None.
ReturnName	string	None.
ReturnAddress1	string	None.
ReturnAddress2	string	None.
ReturnCity	string	None.
ReturnStateProvince	string	None.
ReturnPostalCode	string	None.
ReturnCountry	string	None.
ReturnEmail	string	None.
ReturnPhone	string	None.
FreightPaymentTypeID	integer	None.
FreightPaymentAccount	string	None.
DutiesPaymentTypeID	integer	None.
DutiesPaymentAccount	string	None.
ITN	string	None.
FTRExemption	string	None.
DiscountDimFactor	integer	None.
ClientDimFactor	integer	None.
TotalShipWeight	decimal number	None.
CreatedBy	integer	None.
CreatedDate	date	None.
UpdatedBy	integer	None.
UpdatedDate	date	None.
UpdatedByName	string	None.
ShippedByName	string	None.
DateShipped	date	None.
AddressTypeAPI	string	None.
AddressTypeShipped	string	None.
results	Collection of ValidationResult	None.

Request Formats

application/json, text/json

Sample:

{
  "results": null,
  "ShipmentID": 1,
  "OrderID": 2,
  "OrderBatchID": 1,
  "ClientID": 3,
  "P3PLClientID": 4,
  "OrderSourceCode": "sample string 5",
  "WarehouseID": 6,
  "ShippedByID": 1,
  "Status": "sample string 7",
  "Workstation": "sample string 8",
  "ReferenceNumber": "sample string 9",
  "ReferenceAdditional": "sample string 10",
  "PONumber": "sample string 11",
  "ShipViaID": 12,
  "CarrierZone": "sample string 13",
  "ShipDate": "2026-04-03T21:23:10.8667925-07:00",
  "PackageCount": 15,
  "ConsigneeCustomerID": "sample string 16",
  "ConsigneeCompany": "sample string 17",
  "ConsigneeName": "sample string 18",
  "ConsigneeAddress1": "sample string 19",
  "ConsigneeAddress2": "sample string 20",
  "ConsigneeCity": "sample string 21",
  "ConsigneeStateProvince": "sample string 22",
  "ConsigneePostalCode": "sample string 23",
  "ConsigneeCountry": "sample string 24",
  "ConsigneeEmail": "sample string 25",
  "ConsigneePhone": "sample string 26",
  "ReturnCompany": "sample string 27",
  "ReturnWarehouse": "sample string 28",
  "ReturnName": "sample string 29",
  "ReturnAddress1": "sample string 30",
  "ReturnAddress2": "sample string 31",
  "ReturnCity": "sample string 32",
  "ReturnStateProvince": "sample string 33",
  "ReturnPostalCode": "sample string 34",
  "ReturnCountry": "sample string 35",
  "ReturnEmail": "sample string 36",
  "ReturnPhone": "sample string 37",
  "FreightPaymentTypeID": 1,
  "FreightPaymentAccount": "sample string 38",
  "DutiesPaymentTypeID": 1,
  "DutiesPaymentAccount": "sample string 39",
  "ITN": "sample string 40",
  "FTRExemption": "sample string 41",
  "DiscountDimFactor": 42,
  "ClientDimFactor": 43,
  "TotalShipWeight": 1.0,
  "CreatedBy": 44,
  "CreatedDate": "2026-04-03T21:23:10.8667925-07:00",
  "UpdatedBy": 46,
  "UpdatedDate": "2026-04-03T21:23:10.8667925-07:00",
  "UpdatedByName": "sample string 48",
  "ShippedByName": "sample string 49",
  "DateShipped": "2026-04-03T21:23:10.8667925-07:00",
  "AddressTypeAPI": "sample string 50",
  "AddressTypeShipped": "sample string 51"
}

application/xml, text/xml

Sample:

<ShipmentDB xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models.SendIt">
  <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" />
  <AddressTypeAPI>sample string 50</AddressTypeAPI>
  <AddressTypeShipped>sample string 51</AddressTypeShipped>
  <CarrierZone>sample string 13</CarrierZone>
  <ClientDimFactor>43</ClientDimFactor>
  <ClientID>3</ClientID>
  <ConsigneeAddress1>sample string 19</ConsigneeAddress1>
  <ConsigneeAddress2>sample string 20</ConsigneeAddress2>
  <ConsigneeCity>sample string 21</ConsigneeCity>
  <ConsigneeCompany>sample string 17</ConsigneeCompany>
  <ConsigneeCountry>sample string 24</ConsigneeCountry>
  <ConsigneeCustomerID>sample string 16</ConsigneeCustomerID>
  <ConsigneeEmail>sample string 25</ConsigneeEmail>
  <ConsigneeName>sample string 18</ConsigneeName>
  <ConsigneePhone>sample string 26</ConsigneePhone>
  <ConsigneePostalCode>sample string 23</ConsigneePostalCode>
  <ConsigneeStateProvince>sample string 22</ConsigneeStateProvince>
  <CreatedBy>44</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:23:10.8667925Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </CreatedDate>
  <DateShipped xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:23:10.8667925Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </DateShipped>
  <DiscountDimFactor>42</DiscountDimFactor>
  <DutiesPaymentAccount>sample string 39</DutiesPaymentAccount>
  <DutiesPaymentTypeID>1</DutiesPaymentTypeID>
  <FTRExemption>sample string 41</FTRExemption>
  <FreightPaymentAccount>sample string 38</FreightPaymentAccount>
  <FreightPaymentTypeID>1</FreightPaymentTypeID>
  <ITN>sample string 40</ITN>
  <OrderBatchID>1</OrderBatchID>
  <OrderID>2</OrderID>
  <OrderSourceCode>sample string 5</OrderSourceCode>
  <P3PLClientID>4</P3PLClientID>
  <PONumber>sample string 11</PONumber>
  <PackageCount>15</PackageCount>
  <ReferenceAdditional>sample string 10</ReferenceAdditional>
  <ReferenceNumber>sample string 9</ReferenceNumber>
  <ReturnAddress1>sample string 30</ReturnAddress1>
  <ReturnAddress2>sample string 31</ReturnAddress2>
  <ReturnCity>sample string 32</ReturnCity>
  <ReturnCompany>sample string 27</ReturnCompany>
  <ReturnCountry>sample string 35</ReturnCountry>
  <ReturnEmail>sample string 36</ReturnEmail>
  <ReturnName>sample string 29</ReturnName>
  <ReturnPhone>sample string 37</ReturnPhone>
  <ReturnPostalCode>sample string 34</ReturnPostalCode>
  <ReturnStateProvince>sample string 33</ReturnStateProvince>
  <ReturnWarehouse>sample string 28</ReturnWarehouse>
  <ShipDate>2026-04-03T21:23:10.8667925-07:00</ShipDate>
  <ShipViaID>12</ShipViaID>
  <ShipmentID>1</ShipmentID>
  <ShippedByID>1</ShippedByID>
  <ShippedByName>sample string 49</ShippedByName>
  <Status>sample string 7</Status>
  <TotalShipWeight>1</TotalShipWeight>
  <UpdatedBy>46</UpdatedBy>
  <UpdatedByName>sample string 48</UpdatedByName>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:23:10.8667925Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </UpdatedDate>
  <WarehouseID>6</WarehouseID>
  <Workstation>sample string 8</Workstation>
</ShipmentDB>

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 'ShipmentDB'.

Response Information

Resource Description

ShipmentDB

Name	Type	Additional information
ShipmentID	integer	None.
OrderID	integer	None.
OrderBatchID	integer	None.
ClientID	integer	None.
P3PLClientID	integer	None.
OrderSourceCode	string	None.
WarehouseID	integer	None.
ShippedByID	integer	None.
Status	string	None.
Workstation	string	None.
ReferenceNumber	string	None.
ReferenceAdditional	string	None.
PONumber	string	None.
ShipViaID	integer	None.
CarrierZone	string	None.
ShipDate	date	None.
PackageCount	integer	None.
ConsigneeCustomerID	string	None.
ConsigneeCompany	string	None.
ConsigneeName	string	None.
ConsigneeAddress1	string	None.
ConsigneeAddress2	string	None.
ConsigneeCity	string	None.
ConsigneeStateProvince	string	None.
ConsigneePostalCode	string	None.
ConsigneeCountry	string	None.
ConsigneeEmail	string	None.
ConsigneePhone	string	None.
ReturnCompany	string	None.
ReturnWarehouse	string	None.
ReturnName	string	None.
ReturnAddress1	string	None.
ReturnAddress2	string	None.
ReturnCity	string	None.
ReturnStateProvince	string	None.
ReturnPostalCode	string	None.
ReturnCountry	string	None.
ReturnEmail	string	None.
ReturnPhone	string	None.
FreightPaymentTypeID	integer	None.
FreightPaymentAccount	string	None.
DutiesPaymentTypeID	integer	None.
DutiesPaymentAccount	string	None.
ITN	string	None.
FTRExemption	string	None.
DiscountDimFactor	integer	None.
ClientDimFactor	integer	None.
TotalShipWeight	decimal number	None.
CreatedBy	integer	None.
CreatedDate	date	None.
UpdatedBy	integer	None.
UpdatedDate	date	None.
UpdatedByName	string	None.
ShippedByName	string	None.
DateShipped	date	None.
AddressTypeAPI	string	None.
AddressTypeShipped	string	None.
results	Collection of ValidationResult	None.

Response Formats

application/json, text/json

Sample:

{
  "results": null,
  "ShipmentID": 1,
  "OrderID": 2,
  "OrderBatchID": 1,
  "ClientID": 3,
  "P3PLClientID": 4,
  "OrderSourceCode": "sample string 5",
  "WarehouseID": 6,
  "ShippedByID": 1,
  "Status": "sample string 7",
  "Workstation": "sample string 8",
  "ReferenceNumber": "sample string 9",
  "ReferenceAdditional": "sample string 10",
  "PONumber": "sample string 11",
  "ShipViaID": 12,
  "CarrierZone": "sample string 13",
  "ShipDate": "2026-04-03T21:23:11.0699223-07:00",
  "PackageCount": 15,
  "ConsigneeCustomerID": "sample string 16",
  "ConsigneeCompany": "sample string 17",
  "ConsigneeName": "sample string 18",
  "ConsigneeAddress1": "sample string 19",
  "ConsigneeAddress2": "sample string 20",
  "ConsigneeCity": "sample string 21",
  "ConsigneeStateProvince": "sample string 22",
  "ConsigneePostalCode": "sample string 23",
  "ConsigneeCountry": "sample string 24",
  "ConsigneeEmail": "sample string 25",
  "ConsigneePhone": "sample string 26",
  "ReturnCompany": "sample string 27",
  "ReturnWarehouse": "sample string 28",
  "ReturnName": "sample string 29",
  "ReturnAddress1": "sample string 30",
  "ReturnAddress2": "sample string 31",
  "ReturnCity": "sample string 32",
  "ReturnStateProvince": "sample string 33",
  "ReturnPostalCode": "sample string 34",
  "ReturnCountry": "sample string 35",
  "ReturnEmail": "sample string 36",
  "ReturnPhone": "sample string 37",
  "FreightPaymentTypeID": 1,
  "FreightPaymentAccount": "sample string 38",
  "DutiesPaymentTypeID": 1,
  "DutiesPaymentAccount": "sample string 39",
  "ITN": "sample string 40",
  "FTRExemption": "sample string 41",
  "DiscountDimFactor": 42,
  "ClientDimFactor": 43,
  "TotalShipWeight": 1.0,
  "CreatedBy": 44,
  "CreatedDate": "2026-04-03T21:23:11.0699223-07:00",
  "UpdatedBy": 46,
  "UpdatedDate": "2026-04-03T21:23:11.0699223-07:00",
  "UpdatedByName": "sample string 48",
  "ShippedByName": "sample string 49",
  "DateShipped": "2026-04-03T21:23:11.0699223-07:00",
  "AddressTypeAPI": "sample string 50",
  "AddressTypeShipped": "sample string 51"
}

application/xml, text/xml

Sample:

<ShipmentDB xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models.SendIt">
  <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" />
  <AddressTypeAPI>sample string 50</AddressTypeAPI>
  <AddressTypeShipped>sample string 51</AddressTypeShipped>
  <CarrierZone>sample string 13</CarrierZone>
  <ClientDimFactor>43</ClientDimFactor>
  <ClientID>3</ClientID>
  <ConsigneeAddress1>sample string 19</ConsigneeAddress1>
  <ConsigneeAddress2>sample string 20</ConsigneeAddress2>
  <ConsigneeCity>sample string 21</ConsigneeCity>
  <ConsigneeCompany>sample string 17</ConsigneeCompany>
  <ConsigneeCountry>sample string 24</ConsigneeCountry>
  <ConsigneeCustomerID>sample string 16</ConsigneeCustomerID>
  <ConsigneeEmail>sample string 25</ConsigneeEmail>
  <ConsigneeName>sample string 18</ConsigneeName>
  <ConsigneePhone>sample string 26</ConsigneePhone>
  <ConsigneePostalCode>sample string 23</ConsigneePostalCode>
  <ConsigneeStateProvince>sample string 22</ConsigneeStateProvince>
  <CreatedBy>44</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:23:11.0699223Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </CreatedDate>
  <DateShipped xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:23:11.0699223Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </DateShipped>
  <DiscountDimFactor>42</DiscountDimFactor>
  <DutiesPaymentAccount>sample string 39</DutiesPaymentAccount>
  <DutiesPaymentTypeID>1</DutiesPaymentTypeID>
  <FTRExemption>sample string 41</FTRExemption>
  <FreightPaymentAccount>sample string 38</FreightPaymentAccount>
  <FreightPaymentTypeID>1</FreightPaymentTypeID>
  <ITN>sample string 40</ITN>
  <OrderBatchID>1</OrderBatchID>
  <OrderID>2</OrderID>
  <OrderSourceCode>sample string 5</OrderSourceCode>
  <P3PLClientID>4</P3PLClientID>
  <PONumber>sample string 11</PONumber>
  <PackageCount>15</PackageCount>
  <ReferenceAdditional>sample string 10</ReferenceAdditional>
  <ReferenceNumber>sample string 9</ReferenceNumber>
  <ReturnAddress1>sample string 30</ReturnAddress1>
  <ReturnAddress2>sample string 31</ReturnAddress2>
  <ReturnCity>sample string 32</ReturnCity>
  <ReturnCompany>sample string 27</ReturnCompany>
  <ReturnCountry>sample string 35</ReturnCountry>
  <ReturnEmail>sample string 36</ReturnEmail>
  <ReturnName>sample string 29</ReturnName>
  <ReturnPhone>sample string 37</ReturnPhone>
  <ReturnPostalCode>sample string 34</ReturnPostalCode>
  <ReturnStateProvince>sample string 33</ReturnStateProvince>
  <ReturnWarehouse>sample string 28</ReturnWarehouse>
  <ShipDate>2026-04-03T21:23:11.0699223-07:00</ShipDate>
  <ShipViaID>12</ShipViaID>
  <ShipmentID>1</ShipmentID>
  <ShippedByID>1</ShippedByID>
  <ShippedByName>sample string 49</ShippedByName>
  <Status>sample string 7</Status>
  <TotalShipWeight>1</TotalShipWeight>
  <UpdatedBy>46</UpdatedBy>
  <UpdatedByName>sample string 48</UpdatedByName>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:23:11.0699223Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </UpdatedDate>
  <WarehouseID>6</WarehouseID>
  <Workstation>sample string 8</Workstation>
</ShipmentDB>