POST utils/v2/ExternalShipment/UpdateShipmentStatus
Updates the shipment status.
Request Information
URI Parameters
None.
Body Parameters
The Event data.
Event| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
|
| created_at | date |
None. |
|
| updated_at | date |
None. |
|
| result | Dictionary of string [key] and Object [value] |
None. |
|
| description | string |
None. |
|
| mode | string |
None. |
|
| previous_attributes | Dictionary of string [key] and Object [value] |
None. |
|
| pending_urls | Collection of string |
None. |
|
| completed_urls | Collection of string |
None. |
|
| status | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "sample string 1",
"created_at": "2025-12-16T12:56:03.6894219+00:00",
"updated_at": "2025-12-16T12:56:03.6894219+00:00",
"result": {
"sample string 1": {},
"sample string 3": {}
},
"description": "sample string 2",
"mode": "sample string 3",
"previous_attributes": {
"sample string 1": {},
"sample string 3": {}
},
"pending_urls": [
"sample string 1",
"sample string 2"
],
"completed_urls": [
"sample string 1",
"sample string 2"
],
"status": "sample string 4"
}
application/xml, text/xml
Sample:
<Event xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EasyPost">
<completed_urls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</completed_urls>
<created_at>2025-12-16T12:56:03.6894219+00:00</created_at>
<description>sample string 2</description>
<id>sample string 1</id>
<mode>sample string 3</mode>
<pending_urls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</pending_urls>
<previous_attributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</previous_attributes>
<result xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</result>
<status>sample string 4</status>
<updated_at>2025-12-16T12:56:03.6894219+00:00</updated_at>
</Event>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The .
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.