Update shipment location

This endpoint is used to update the location of a shipment. The location is updated with the latitude, longitude, and additional details of the shipment.

Header Parameters

Authorization string required

API Key generated in the settings. For third-party apps, Chaine will provide this key.

application/json

Request Body required

latitude number

Latitude of the shipment location. Either latitude/longitude or city/stateCode must be provided.

longitude number

Longitude of the shipment location. Either latitude/longitude or city/stateCode must be provided.

dateTime date-time

Date and time of the location update. If not provided, the current date and time is assumed.

street string

Street address of the shipment location.

city string

City of the shipment location. Either latitude/longitude or city/stateCode must be provided.

stateCode string

State code of the shipment location. Either latitude/longitude or city/stateCode must be provided.

zipCode string

Zip code of the shipment location.

countryCode string

Country code of the shipment location.

shipmentNumber string required

Shipment number unique to the Chaine customer.

Responses

• 200
• 400
• 401

---

OK

application/json

Schema

Example (from schema)

Example

---

Schema

message string

{
  "message": "string"
}

{
  "message": "Location updated successfully"
}

Bad Request

application/json

Schema

Example (from schema)

Example

---

Schema

error string

{
  "error": "string"
}

{
  "error": "Invalid input data"
}

Unauthorized

application/json

Schema

Example (from schema)

Example

---

Schema

error string

{
  "error": "string"
}

{
  "error": "Invalid API key"
}

Loading...