POST api/v1/shipment

Add a new Shipment

Request Information

URI Parameters

None.

Body Parameters

Shipment object that needs to be added

Name	Type	Additional information
TransactionDate	date	Required
TransactionID	string	Required
ShipmentID	string	None.
ShipDate	date	None.
ShipTracking	string	None.
ShipCarrier	string	None.
ShipClass	string	None.
ShipBy	string	None.
PostageApplied	decimal number	None.
Weight	decimal number	None.
ShippingAddress	PostalAddressFull	None.
LineNumbers	Collection of LineNumber	None.

Request Formats

application/json, text/json

Sample:

{
  "TransactionDate": "2025-09-04T15:06:12.756",
  "TransactionID": "sample string 2",
  "ShipmentID": "sample string 3",
  "ShipDate": "2025-09-04T15:06:12.756",
  "ShipTracking": "sample string 5",
  "ShipCarrier": "sample string 6",
  "ShipClass": "sample string 7",
  "ShipBy": "sample string 8",
  "PostageApplied": 9.0,
  "Weight": 10.0,
  "ShippingAddress": {
    "RecipientName": "sample string 1",
    "Line1": "sample string 2",
    "Line2": "sample string 3",
    "Line3": "sample string 4",
    "City": "sample string 5",
    "StatePR": "sample string 6",
    "PostalCode": "sample string 7",
    "Country": "sample string 8"
  },
  "LineNumbers": [
    {
      "Line": "sample string 1"
    },
    {
      "Line": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<Shipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <LineNumbers>
    <LineNumber>
      <Line>sample string 1</Line>
    </LineNumber>
    <LineNumber>
      <Line>sample string 1</Line>
    </LineNumber>
  </LineNumbers>
  <PostageApplied>9</PostageApplied>
  <ShipBy>sample string 8</ShipBy>
  <ShipCarrier>sample string 6</ShipCarrier>
  <ShipClass>sample string 7</ShipClass>
  <ShipDate>2025-09-04T15:06:12.7564116+00:00</ShipDate>
  <ShipTracking>sample string 5</ShipTracking>
  <ShipmentID>sample string 3</ShipmentID>
  <ShippingAddress>
    <City>sample string 5</City>
    <Country>sample string 8</Country>
    <Line1>sample string 2</Line1>
    <Line2>sample string 3</Line2>
    <Line3>sample string 4</Line3>
    <PostalCode>sample string 7</PostalCode>
    <StatePR>sample string 6</StatePR>
    <RecipientName>sample string 1</RecipientName>
  </ShippingAddress>
  <TransactionDate>2025-09-04T15:06:12.7564116+00:00</TransactionDate>
  <TransactionID>sample string 2</TransactionID>
  <Weight>10</Weight>
</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.