Trackings

Push trackings through Shiptify Public API

Requirements – API Key

For this section you will be requested for an .

Before you start using our REST API services, you will need to obtain your API key with your SHIPTIFY sales representative. Api-key is persistant and has no time limit.

Workflow

Summary of available actions

TP Type	Action	Endpoint to use	#ID Required
Necessary TP	Replan Pickup	/shipments/{id}/pickup/replan	#SH ID
Necessary TP	Confirm Pickup	/shipments/{id}/pickup/confirm	#SH ID
Necessary TP	Replan Delivery	/shipments/{id}/delivery/replan	#SH ID
Necessary TP	Confirm Delivery	/shipments/{id}/delivery/confirm	#SH ID
Complementary TP	Create New	/shipments/{id}/tracking-points	#SH ID
Complementary TP	Replan	/tracking-points/{id}/replan	#TP ID
Complementary TP	Confirm	/tracking-points/{id}/confirm	#TP ID
Complementary TP	Archive	/tracking-points/{id}/cancel	#TP ID
Complementary TP	Modify & Confirm	/tracking-points/{id}	#TP ID
Complementary TP	Modify Address	/tracking-points/{id}/location	#TP ID

Endpoints to use

Get shipment tracking points by shipment identifier.

get

/shipments/{id}/tracking-points

Authorizations

Path parameters

idnumberrequired

Point identifier.

Header parameters

X-Account-IDinteger

Account identifier

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.shiptify.com//shipments/{id}/tracking-points' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

500

200

[
  {
    "id": 1,
    "shipment_id": 1,
    "carrier_id": 1,
    "shipper_id": 1,
    "address_id": 1,
    "position": 1,
    "comment": "text",
    "type": "text",
    "incident": "text",
    "planned_date": "text",
    "planned_date_init": "text",
    "real_date": "text",
    "planned_time": "text",
    "planned_time_init": "text",
    "real_time": "text",
    "external_key": 1,
    "address": {
      "id": 1,
      "recipient_name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "country": "text",
      "email": "text",
      "instructions": "Ring the bell 3 times.",
      "internal_ref": "text",
      "name": "text",
      "phone_number": "text",
      "state": "text",
      "zipcode": "text",
      "skip_zipcode_validation": true,
      "slot_booking_url": "text",
      "type": "store",
      "company": {
        "id": 1,
        "name": "text"
      }
    }
  }
]

OK

Create shipment tracking points by shipment identifier.

post

/shipments/{id}/tracking-points

Authorizations

Path parameters

idnumberrequired

Shipment identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

codestringrequired

Tracking point code.

Example: STY0001

commentstring

Tracking point comment.

incidentstring

Tracking point incident.

real_datestring

Date confirm. Format: YYYY-MM-DD.

real_timestring

Time confirm. Format: HH:mm.

planned_datestringrequired

Expected date confirm. Format: YYYY-MM-DD.

planned_timestringrequired

Expected time confirm. Format: HH:mm.

skip_departure_confirmationboolean

Skip departure confirmation

skip_arrival_confirmationboolean

Skip arrival confirmation

locationobject

Tracking point location

Example: {"country":"string","city":"string","zipcode":"string","address_1":"string"}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.shiptify.com//shipments/{id}/tracking-points' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "code": "STY0001",
      "comment": "text",
      "incident": "text",
      "real_date": "text",
      "real_time": "text",
      "planned_date": "text",
      "planned_time": "text",
      "skip_departure_confirmation": true,
      "skip_arrival_confirmation": true,
      "location": {
        "country": "string",
        "city": "string",
        "zipcode": "string",
        "address_1": "string"
      }
    }
  ]'

200

400

401

500

200

{
  "successful": true
}

OK

Сonfirm shipment pickup by shipment identifier

put

/shipments/{id}/pickup/confirm

Authorizations

Path parameters

idintegerrequired

Shipment identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

commentstring

Tracking point comment.

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

incidentstring · enum · max: 128

Tracking point incident.

Example: Strike

Options: ``, Customs clearance, Strike, Truck incident, Anomaly, Blocking situation, Public Holiday, Delayed groupage departure, Departure ship cancel, Departure ship delayed, Export customs system down, Export customs strike, Departure port handling strike, Delayed arrival ship at arrival port, Arrival port handling strike, Import customs strike, Import customs system down, Delivery truck failure, Waiting at pick up place, Waiting at delivery place, Unreachable recipient, Booked slot refused

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.shiptify.com//shipments/{id}/pickup/confirm' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "",
    "date": "text",
    "time": "text",
    "incident": "Strike"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK

Сonfirm shipment delivery by shipment identifier

put

/shipments/{id}/delivery/confirm

Authorizations

Path parameters

idintegerrequired

Shipment identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

commentstring

Tracking point comment.

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

incidentstring · enum · max: 128

Tracking point incident.

Example: Strike

Options: ``, Customs clearance, Strike, Truck incident, Anomaly, Blocking situation, Public Holiday, Delayed groupage departure, Departure ship cancel, Departure ship delayed, Export customs system down, Export customs strike, Departure port handling strike, Delayed arrival ship at arrival port, Arrival port handling strike, Import customs strike, Import customs system down, Delivery truck failure, Waiting at pick up place, Waiting at delivery place, Unreachable recipient, Booked slot refused

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.shiptify.com//shipments/{id}/delivery/confirm' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "",
    "date": "text",
    "time": "text",
    "incident": "Strike"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK

Replan shipment pickup by shipment identifier

put

/shipments/{id}/pickup/replan

Authorizations

Path parameters

idintegerrequired

Shipment identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.shiptify.com//shipments/{id}/pickup/replan' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "text",
    "time": "text"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK

Replan shipment delivery by shipment identifier

put

/shipments/{id}/delivery/replan

Authorizations

Path parameters

idintegerrequired

Shipment identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.shiptify.com//shipments/{id}/delivery/replan' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "text",
    "time": "text"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK

Get tracking point by point identifier.

get

/tracking-points/{id}

Authorizations

Path parameters

idnumberrequired

Point identifier.

Header parameters

X-Account-IDinteger

Account identifier

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.shiptify.com//tracking-points/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

200

{
  "id": 1,
  "shipment_id": 1,
  "carrier_id": 1,
  "shipper_id": 1,
  "address_id": 1,
  "position": 1,
  "comment": "text",
  "type": "text",
  "incident": "text",
  "planned_date": "text",
  "planned_date_init": "text",
  "real_date": "text",
  "planned_time": "text",
  "planned_time_init": "text",
  "real_time": "text",
  "external_key": 1,
  "address": {
    "id": 1,
    "recipient_name": "text",
    "address_1": "text",
    "address_2": "text",
    "city": "text",
    "country": "text",
    "email": "text",
    "instructions": "Ring the bell 3 times.",
    "internal_ref": "text",
    "name": "text",
    "phone_number": "text",
    "state": "text",
    "zipcode": "text",
    "skip_zipcode_validation": true,
    "slot_booking_url": "text",
    "type": "store",
    "company": {
      "id": 1,
      "name": "text"
    }
  }
}

OK

Update tracking point by point identifier.

patch

/tracking-points/{id}

Authorizations

Path parameters

idintegerrequired

Tracking point by point identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

commentstring

Tracking point comment.

incidentstring · enum · max: 128

Tracking point incident.

Example: Strike

Options: ``, Customs clearance, Strike, Truck incident, Anomaly, Blocking situation, Public Holiday, Delayed groupage departure, Departure ship cancel, Departure ship delayed, Export customs system down, Export customs strike, Departure port handling strike, Delayed arrival ship at arrival port, Arrival port handling strike, Import customs strike, Import customs system down, Delivery truck failure, Waiting at pick up place, Waiting at delivery place, Unreachable recipient, Booked slot refused

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.shiptify.com//tracking-points/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "",
    "incident": "Strike"
  }'

200

400

401

404

200

{
  "successful": true,
  "id": 1
}

OK

Сonfirm tracking point by point identifier

put

/tracking-points/{id}/confirm

Authorizations

Path parameters

idintegerrequired

Tracking point by point identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

commentstring

Tracking point comment.

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

incidentstring · enum · max: 128

Tracking point incident.

Example: Strike

Options: ``, Customs clearance, Strike, Truck incident, Anomaly, Blocking situation, Public Holiday, Delayed groupage departure, Departure ship cancel, Departure ship delayed, Export customs system down, Export customs strike, Departure port handling strike, Delayed arrival ship at arrival port, Arrival port handling strike, Import customs strike, Import customs system down, Delivery truck failure, Waiting at pick up place, Waiting at delivery place, Unreachable recipient, Booked slot refused

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.shiptify.com//tracking-points/{id}/confirm' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "",
    "date": "text",
    "time": "text",
    "incident": "Strike"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK

Replan tracking point by point identifier.

put

/tracking-points/{id}/replan

Authorizations

Path parameters

idintegerrequired

Tracking point by point identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.shiptify.com//tracking-points/{id}/replan' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "text",
    "time": "text"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK

Cancel tracking point by point identifier.

put

/tracking-points/{id}/cancel

Authorizations

Path parameters

idintegerrequired

Tracking point by point identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

commentstring

Tracking point comment.

incidentstring · enum · max: 128

Tracking point incident.

Example: Strike

Options: ``, Customs clearance, Strike, Truck incident, Anomaly, Blocking situation, Public Holiday, Delayed groupage departure, Departure ship cancel, Departure ship delayed, Export customs system down, Export customs strike, Departure port handling strike, Delayed arrival ship at arrival port, Arrival port handling strike, Import customs strike, Import customs system down, Delivery truck failure, Waiting at pick up place, Waiting at delivery place, Unreachable recipient, Booked slot refused

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.shiptify.com//tracking-points/{id}/cancel' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "",
    "incident": "Strike"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK

Update location in tracking point by point identifier.

patch

/tracking-points/{id}/location

Authorizations

Path parameters

idintegerrequired

Tracking point by point identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

object

Tracking point location

Example: {"country":"string","city":"string","zipcode":"string","address_1":"string"}

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.shiptify.com//tracking-points/{id}/location' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "country": "string",
    "city": "string",
    "zipcode": "string",
    "address_1": "string"
  }'

200

400

401

404

500

200

{
  "successful": true,
  "id": 1
}

OK