Customs Milestone

Endpoints relating to customs milestones

Create a customs milestone

Create a customs milestone for a shipment. Requires the public_api:create_customs_milestone permission, granted by the customs public API role.

The following milestones are supported:

Milestone name Description
/shipment#export_country_customs_exam Customs examination in the export country.
/shipment#export_customs_cleared Export customs clearance completed for the shipment.
Request
Request Body schema: application/json
required
milestone_name
required
string

Name of the customs milestone to create.

Enum: "/shipment#export_country_customs_exam" "/shipment#export_customs_cleared"
required
object (CustomsMilestoneShipmentMilestoneData)

Shipment data for a customs milestone.

shipment_id
required
integer

Shipment ID (FLEX-ID) for the milestone.

Responses
202

Milestone request is pending

400

Bad request

post/customs_milestones
Request samples
application/json
{
  • "milestone_name": "/shipment#export_customs_cleared",
  • "milestone_data": {
    • "shipment_id": 123
    }
}
Response samples
application/json
{}