Api tracking code

Create tracking for a specific handling unit.

POST /track-handling-unit

Sample request:

POST /track-handling-unit

application/json

Body

Information of new tracking.

  • spi string | null

    Handling unit SPI.

    Minimum length is 13, maximum length is 13.

  • reference string Required

    Reference of a handling unit

    Minimum length is 11, maximum length is 11.

  • way string

    Customs indicators

    Values are Unknown, Import, Export, Transit, Transhipment, DomesticIn, DomesticOut, or DomesticTranshipment.

  • place string | null

    Event location.

    Maximum length is 20.

  • agentCode string | null

    Agent code.

    Maximum length is 64.

  • url string Required

    Webhook URL endpoint to receive tracking events' notifications.

    Minimum length is 1. Format should match the following pattern: ^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$.

Responses

  • 201 application/json

    Created.
  • 400 application/json

    Bad request.

    Hide response attributes Show response attributes object
    • status string | null

      Error status.

    • timestamp string(date-time)

      Error timestamp.

    • code string | null

      Error code.

    • message string | null

      Error message.

    • subErrors array[object] | null

      Error details.

      Error message details.

      Hide subErrors attributes Show subErrors attributes object
      • section string | null

        Error object.

      • field string | null

        Error attribute.

      • rejectedValue string | null

        Rejection code.

      • message string | null

        Error message.
  • 401 application/json

    Unauthorized.

    Hide response attributes Show response attributes object
    • status string | null

      Error status.

    • timestamp string(date-time)

      Error timestamp.

    • code string | null

      Error code.

    • message string | null

      Error message.

    • subErrors array[object] | null

      Error details.

      Error message details.

      Hide subErrors attributes Show subErrors attributes object
      • section string | null

        Error object.

      • field string | null

        Error attribute.

      • rejectedValue string | null

        Rejection code.

      • message string | null

        Error message.
POST /track-handling-unit 
curl \
 --request POST 'https://soget-api-integration.azure-api.net/api-tracking-code/v1/track-handling-unit' \
 --header "Content-Type: application/json" \
 --data '{"spi":"CNI0000000001","url":"https://my-webhook-endpoints.com","way":"Import","place":"MTDF","agentCode":"CCGM","reference":"CGMU0000001"}'
Request example 
{
  "spi": "CNI0000000001",
  "url": "https://my-webhook-endpoints.com",
  "way": "Import",
  "place": "MTDF",
  "agentCode": "CCGM",
  "reference": "CGMU0000001"
}
Response examples (201) 
string
Response examples (400) 
{
  "status": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "code": "string",
  "message": "string",
  "subErrors": [
    {
      "section": "string",
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}
Response examples (401) 
{
  "status": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "code": "string",
  "message": "string",
  "subErrors": [
    {
      "section": "string",
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}