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.

GEThttps://api.shiptify.com//shipments/{id}/tracking-points

Authorization

ApiKey

Path parameters

id*number

Point identifier.

Header parameters

Response

200400401500

OK

Body

application/json

idinteger

Point identifier.

shipment_idinteger

carrier_idinteger

shipper_idinteger

address_idinteger

Location identifier.

positioninteger

commentstring

typestring

incidentstring

planned_datestring

planned_date_initstring

real_datestring

planned_timestring

planned_time_initstring

real_timestring

external_keyinteger

addressobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//shipments/{id}/tracking-points', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401500

[
  {
    "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",
    "address": {
      "recipient_name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "company": {
        "name": "text"
      },
      "country": "text",
      "email": "text",
      "instructions": "Ring the bell 3 times.",
      "internal_ref": "text",
      "name": "text",
      "phone_number": "text",
      "state": "text",
      "type": "store",
      "zipcode": "text",
      "skip_zipcode_validation": false,
      "slot_booking_url": "text"
    }
  }
]

Create shipment tracking points by shipment identifier.

POSThttps://api.shiptify.com//shipments/{id}/tracking-points

Authorization

ApiKey

Path parameters

id*number

Shipment identifier.

Header parameters

Body

application/json

code*string

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_date*string

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

planned_time*string

Expected time confirm. Format: HH:mm.

skip_departure_confirmationboolean

Skip departure confirmation

skip_arrival_confirmationboolean

Skip arrival confirmation

locationobject

Tracking point location

objectobjectobject

Response

200400401500

OK

Body

application/json

successfulboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//shipments/{id}/tracking-points', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "code": "STY0001",
        "planned_date": "text",
        "planned_time": "text"
      }
    ]),
});
const data = await response.json();

Response

200400401500

{
  "successful": false
}

Сonfirm shipment pickup by shipment identifier

PUThttps://api.shiptify.com//shipments/{id}/pickup/confirm

Authorization

ApiKey

Path parameters

id*integer

Shipment identifier.

Header parameters

Body

application/json

incidentenum

Tracking point incident.

Example: "Strike"

``Customs clearanceStrikeTruck incidentAnomalyBlocking situationPublic HolidayDelayed groupage departureDeparture ship cancelDeparture ship delayedExport customs system downExport customs strikeDeparture port handling strikeDelayed arrival ship at arrival portArrival port handling strikeImport customs strikeImport customs system downDelivery truck failureWaiting at pick up placeWaiting at delivery placeUnreachable recipientBooked slot refused

commentstring

Tracking point comment.

Example: ""

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//shipments/{id}/pickup/confirm', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}

Сonfirm shipment delivery by shipment identifier

PUThttps://api.shiptify.com//shipments/{id}/delivery/confirm

Authorization

ApiKey

Path parameters

id*integer

Shipment identifier.

Header parameters

Body

application/json

incidentenum

Tracking point incident.

Example: "Strike"

``Customs clearanceStrikeTruck incidentAnomalyBlocking situationPublic HolidayDelayed groupage departureDeparture ship cancelDeparture ship delayedExport customs system downExport customs strikeDeparture port handling strikeDelayed arrival ship at arrival portArrival port handling strikeImport customs strikeImport customs system downDelivery truck failureWaiting at pick up placeWaiting at delivery placeUnreachable recipientBooked slot refused

commentstring

Tracking point comment.

Example: ""

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//shipments/{id}/delivery/confirm', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}

Replan shipment pickup by shipment identifier

PUThttps://api.shiptify.com//shipments/{id}/pickup/replan

Authorization

ApiKey

Path parameters

id*integer

Shipment identifier.

Header parameters

Body

application/json

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//shipments/{id}/pickup/replan', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}

Replan shipment delivery by shipment identifier

PUThttps://api.shiptify.com//shipments/{id}/delivery/replan

Authorization

ApiKey

Path parameters

id*integer

Shipment identifier.

Header parameters

Body

application/json

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//shipments/{id}/delivery/replan', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}

Get tracking point by point identifier.

GEThttps://api.shiptify.com//tracking-points/{id}

Authorization

ApiKey

Path parameters

id*number

Point identifier.

Header parameters

Response

200400401403404500

OK

Body

application/json

idinteger

Point identifier.

shipment_idinteger

carrier_idinteger

shipper_idinteger

address_idinteger

Location identifier.

positioninteger

commentstring

typestring

incidentstring

planned_datestring

planned_date_initstring

real_datestring

planned_timestring

planned_time_initstring

real_timestring

external_keyinteger

addressobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//tracking-points/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "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",
  "address": {
    "recipient_name": "text",
    "address_1": "text",
    "address_2": "text",
    "city": "text",
    "company": {
      "name": "text"
    },
    "country": "text",
    "email": "text",
    "instructions": "Ring the bell 3 times.",
    "internal_ref": "text",
    "name": "text",
    "phone_number": "text",
    "state": "text",
    "type": "store",
    "zipcode": "text",
    "skip_zipcode_validation": false,
    "slot_booking_url": "text"
  }
}

Update tracking point by point identifier.

PATCHhttps://api.shiptify.com//tracking-points/{id}

Authorization

ApiKey

Path parameters

id*integer

Tracking point by point identifier.

Header parameters

Body

application/json

incidentenum

Tracking point incident.

Example: "Strike"

``Customs clearanceStrikeTruck incidentAnomalyBlocking situationPublic HolidayDelayed groupage departureDeparture ship cancelDeparture ship delayedExport customs system downExport customs strikeDeparture port handling strikeDelayed arrival ship at arrival portArrival port handling strikeImport customs strikeImport customs system downDelivery truck failureWaiting at pick up placeWaiting at delivery placeUnreachable recipientBooked slot refused

commentstring

Tracking point comment.

Example: ""

Response

200400401404

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//tracking-points/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404

{
  "successful": false,
  "id": 0
}

Сonfirm tracking point by point identifier

PUThttps://api.shiptify.com//tracking-points/{id}/confirm

Authorization

ApiKey

Path parameters

id*integer

Tracking point by point identifier.

Header parameters

Body

application/json

incidentenum

Tracking point incident.

Example: "Strike"

``Customs clearanceStrikeTruck incidentAnomalyBlocking situationPublic HolidayDelayed groupage departureDeparture ship cancelDeparture ship delayedExport customs system downExport customs strikeDeparture port handling strikeDelayed arrival ship at arrival portArrival port handling strikeImport customs strikeImport customs system downDelivery truck failureWaiting at pick up placeWaiting at delivery placeUnreachable recipientBooked slot refused

commentstring

Tracking point comment.

Example: ""

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//tracking-points/{id}/confirm', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}

Replan tracking point by point identifier.

PUThttps://api.shiptify.com//tracking-points/{id}/replan

Authorization

ApiKey

Path parameters

id*integer

Tracking point by point identifier.

Header parameters

Body

application/json

datestring

Date confirm. Format: YYYY-MM-DD.

timestring

Time confirm. Format: HH:mm.

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//tracking-points/{id}/replan', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}

Cancel tracking point by point identifier.

PUThttps://api.shiptify.com//tracking-points/{id}/cancel

Authorization

ApiKey

Path parameters

id*integer

Tracking point by point identifier.

Header parameters

Body

application/json

incidentenum

Tracking point incident.

Example: "Strike"

``Customs clearanceStrikeTruck incidentAnomalyBlocking situationPublic HolidayDelayed groupage departureDeparture ship cancelDeparture ship delayedExport customs system downExport customs strikeDeparture port handling strikeDelayed arrival ship at arrival portArrival port handling strikeImport customs strikeImport customs system downDelivery truck failureWaiting at pick up placeWaiting at delivery placeUnreachable recipientBooked slot refused

commentstring

Tracking point comment.

Example: ""

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//tracking-points/{id}/cancel', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}

Update location in tracking point by point identifier.

PATCHhttps://api.shiptify.com//tracking-points/{id}/location

Authorization

ApiKey

Path parameters

id*integer

Tracking point by point identifier.

Header parameters

Body

application/json

object

Tracking point location

objectobjectobject

Response

200400401404500

OK

Body

application/json

successfulboolean

idnumber

Tracking point by point identifier.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//tracking-points/{id}/location', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "country": "string",
      "city": "string",
      "zipcode": "string",
      "address_1": "string"
    }),
});
const data = await response.json();

Response

200400401404500

{
  "successful": false,
  "id": 0
}