Sign in

v1

latestOpenAPI 3.0.32026-07-242666111.1 KB
shipments

Update the destination address of a shipment. The shipment must be in one of the following statuses:

DRAFT CONFIRMED UNSUCCESSFULLPICKUP ONROADTOPICKUP COLLECTED STORED

patch/api/v3/shipments/{id}

Path parameters

idstring required

Request body

Response

idstring required
internalKeystring required

Unique shipment identifier. You can use this field to store your unique identifier of the shipment. All of our tracking systems support searching by internalKey. We strongly suggest you always use this field and make sure it is unique.If its not given we will assign an uuid for this field.

deliveryType'SMD' | 'SPT' | '99M' | 'CO2F' | 'RET' | 'NAL' | 'P2P' required
trackingIdinteger required
apiVersioninteger

Example response

{
  "sender": {
    "phone": "+525547596221"
  },
  "recipient": {
    "phone": "+525547596221"
  }
}