POST api/shipmentdespatch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ShipmentId	string	None.
Type	string	None.
Stu	string	None.
Values	string	None.
Carrier	string	None.
ShipMethod	string	None.
CarrierTrack	string	None.
CarrierTrackURL	string	None.
CarrierRef1	string	None.
CarrierRef2	string	None.
CarrierRef3	string	None.
CarrierRef4	string	None.
Freight	decimal number	None.
DateShipment	date	None.
ManifestInd	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ShipmentId": "sample string 1",
  "Type": "sample string 2",
  "Stu": "sample string 3",
  "Values": "sample string 4",
  "Carrier": "sample string 5",
  "ShipMethod": "sample string 6",
  "CarrierTrack": "sample string 7",
  "CarrierTrackURL": "sample string 8",
  "CarrierRef1": "sample string 9",
  "CarrierRef2": "sample string 10",
  "CarrierRef3": "sample string 11",
  "CarrierRef4": "sample string 12",
  "Freight": 1.0,
  "DateShipment": "2025-05-13T23:40:01.0484043+01:00",
  "ManifestInd": "sample string 13"
}

application/xml, text/xml

Sample:

<ShipmentDespatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Snapfulfil.Domain">
  <Carrier>sample string 5</Carrier>
  <CarrierRef1>sample string 9</CarrierRef1>
  <CarrierRef2>sample string 10</CarrierRef2>
  <CarrierRef3>sample string 11</CarrierRef3>
  <CarrierRef4>sample string 12</CarrierRef4>
  <CarrierTrack>sample string 7</CarrierTrack>
  <CarrierTrackURL>sample string 8</CarrierTrackURL>
  <DateShipment>2025-05-13T23:40:01.0484043+01:00</DateShipment>
  <Freight>1</Freight>
  <ManifestInd>sample string 13</ManifestInd>
  <ShipMethod>sample string 6</ShipMethod>
  <ShipmentId>sample string 1</ShipmentId>
  <Stu>sample string 3</Stu>
  <Type>sample string 2</Type>
  <Values>sample string 4</Values>
</ShipmentDespatch>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ShipmentId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Type"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Stu"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Values"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Carrier"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ShipMethod"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CarrierTrack"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CarrierTrackURL"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CarrierRef1"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CarrierRef2"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CarrierRef3"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CarrierRef4"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Freight"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DateShipment"

2025-05-13T23:40:01.0484043+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ManifestInd"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TransactionType"

SHIPMENT
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UpdateSegment"

_UPDATE
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DeleteSegment"

_DELETE
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.