POST api/Hooks

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Data		ShipEngineTrackUpdateData	None.

Request Formats

application/json, text/json

Sample:

{
  "data": {
    "tracking_number": "sample string 1",
    "status_code": "sample string 2",
    "carrier_Detail_Code": "sample string 3",
    "status_Description": "sample string 4",
    "carrier_Status_Code": "sample string 5",
    "carrier_Status_Description": "sample string 6",
    "ship_Date": "2026-03-04T16:37:10.6294527Z",
    "estimated_Delivery_Date": "2026-03-04T16:37:10.6294527Z",
    "actual_Delivery_Date": "2026-03-04T16:37:10.6294527Z",
    "exception_Description": "sample string 8",
    "events": [
      {
        "occurred_At": "2026-03-04T16:37:10.6294527Z",
        "carrier_Occurred_At": "2026-03-04T16:37:10.6294527Z",
        "description": "sample string 3",
        "city_Locality": "sample string 4",
        "state_Province": "sample string 5",
        "postal_Code": "sample string 6",
        "country_Code": "sample string 7",
        "company_Name": "sample string 8",
        "signer": "sample string 9",
        "event_Code": "sample string 10",
        "event_Description": "sample string 11",
        "carrier_Detail_Code": {},
        "status_Code": {},
        "latitude": 1.1,
        "longitude": 1.1
      },
      {
        "occurred_At": "2026-03-04T16:37:10.6294527Z",
        "carrier_Occurred_At": "2026-03-04T16:37:10.6294527Z",
        "description": "sample string 3",
        "city_Locality": "sample string 4",
        "state_Province": "sample string 5",
        "postal_Code": "sample string 6",
        "country_Code": "sample string 7",
        "company_Name": "sample string 8",
        "signer": "sample string 9",
        "event_Code": "sample string 10",
        "event_Description": "sample string 11",
        "carrier_Detail_Code": {},
        "status_Code": {},
        "latitude": 1.1,
        "longitude": 1.1
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ShipEngineTrackUpdateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ncdc.api.ViewModels">
  <Data>
    <Actual_Delivery_Date>2026-03-04T16:37:10.6294527Z</Actual_Delivery_Date>
    <Carrier_Detail_Code>sample string 3</Carrier_Detail_Code>
    <Carrier_Status_Code>sample string 5</Carrier_Status_Code>
    <Carrier_Status_Description>sample string 6</Carrier_Status_Description>
    <Estimated_Delivery_Date>2026-03-04T16:37:10.6294527Z</Estimated_Delivery_Date>
    <Events>
      <ShippingEvent>
        <Carrier_Detail_Code />
        <Carrier_Occurred_At>2026-03-04T16:37:10.6294527Z</Carrier_Occurred_At>
        <City_Locality>sample string 4</City_Locality>
        <Company_Name>sample string 8</Company_Name>
        <Country_Code>sample string 7</Country_Code>
        <Description>sample string 3</Description>
        <Event_Code>sample string 10</Event_Code>
        <Event_Description>sample string 11</Event_Description>
        <Latitude>1.1</Latitude>
        <Longitude>1.1</Longitude>
        <Occurred_At>2026-03-04T16:37:10.6294527Z</Occurred_At>
        <Postal_Code>sample string 6</Postal_Code>
        <Signer>sample string 9</Signer>
        <State_Province>sample string 5</State_Province>
        <Status_Code />
      </ShippingEvent>
      <ShippingEvent>
        <Carrier_Detail_Code />
        <Carrier_Occurred_At>2026-03-04T16:37:10.6294527Z</Carrier_Occurred_At>
        <City_Locality>sample string 4</City_Locality>
        <Company_Name>sample string 8</Company_Name>
        <Country_Code>sample string 7</Country_Code>
        <Description>sample string 3</Description>
        <Event_Code>sample string 10</Event_Code>
        <Event_Description>sample string 11</Event_Description>
        <Latitude>1.1</Latitude>
        <Longitude>1.1</Longitude>
        <Occurred_At>2026-03-04T16:37:10.6294527Z</Occurred_At>
        <Postal_Code>sample string 6</Postal_Code>
        <Signer>sample string 9</Signer>
        <State_Province>sample string 5</State_Province>
        <Status_Code />
      </ShippingEvent>
    </Events>
    <Exception_Description>sample string 8</Exception_Description>
    <Ship_Date>2026-03-04T16:37:10.6294527Z</Ship_Date>
    <Status_Description>sample string 4</Status_Description>
    <Status_code>sample string 2</Status_code>
    <Tracking_number>sample string 1</Tracking_number>
  </Data>
</ShipEngineTrackUpdateViewModel>

multipart/form-data

Sample:

<ShipEngineTrackUpdateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ncdc.api.ViewModels"><Data><Actual_Delivery_Date>2026-03-04T16:37:10.6294527Z</Actual_Delivery_Date><Carrier_Detail_Code>sample string 3</Carrier_Detail_Code><Carrier_Status_Code>sample string 5</Carrier_Status_Code><Carrier_Status_Description>sample string 6</Carrier_Status_Description><Estimated_Delivery_Date>2026-03-04T16:37:10.6294527Z</Estimated_Delivery_Date><Events><ShippingEvent><Carrier_Detail_Code /><Carrier_Occurred_At>2026-03-04T16:37:10.6294527Z</Carrier_Occurred_At><City_Locality>sample string 4</City_Locality><Company_Name>sample string 8</Company_Name><Country_Code>sample string 7</Country_Code><Description>sample string 3</Description><Event_Code>sample string 10</Event_Code><Event_Description>sample string 11</Event_Description><Latitude>1.1</Latitude><Longitude>1.1</Longitude><Occurred_At>2026-03-04T16:37:10.6294527Z</Occurred_At><Postal_Code>sample string 6</Postal_Code><Signer>sample string 9</Signer><State_Province>sample string 5</State_Province><Status_Code /></ShippingEvent><ShippingEvent><Carrier_Detail_Code /><Carrier_Occurred_At>2026-03-04T16:37:10.6294527Z</Carrier_Occurred_At><City_Locality>sample string 4</City_Locality><Company_Name>sample string 8</Company_Name><Country_Code>sample string 7</Country_Code><Description>sample string 3</Description><Event_Code>sample string 10</Event_Code><Event_Description>sample string 11</Event_Description><Latitude>1.1</Latitude><Longitude>1.1</Longitude><Occurred_At>2026-03-04T16:37:10.6294527Z</Occurred_At><Postal_Code>sample string 6</Postal_Code><Signer>sample string 9</Signer><State_Province>sample string 5</State_Province><Status_Code /></ShippingEvent></Events><Exception_Description>sample string 8</Exception_Description><Ship_Date>2026-03-04T16:37:10.6294527Z</Ship_Date><Status_Description>sample string 4</Status_Description><Status_code>sample string 2</Status_code><Tracking_number>sample string 1</Tracking_number></Data></ShipEngineTrackUpdateViewModel>

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, multipart/form-data

Sample:

Sample not available.