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
Authorizations
Path parameters
idnumberRequired

Point identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Responses
200
OK
application/json
get
GET //shipments/{id}/tracking-points HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "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",
      "company": {
        "id": 1,
        "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": true,
      "slot_booking_url": "text"
    }
  }
]

Create shipment tracking points by shipment identifier.

post
Authorizations
Path parameters
idnumberRequired

Shipment identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body

Array of tracking points

codestringRequired

Tracking point code.

Example: STY0001
commentstringOptional

Tracking point comment.

incidentstringOptional

Tracking point incident.

real_datestringOptional

Date confirm. Format: YYYY-MM-DD.

real_timestringOptional

Time confirm. Format: HH:mm.

planned_datestringRequired

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

planned_timestringRequired

Expected time confirm. Format: HH:mm.

skip_departure_confirmationbooleanOptional

Skip departure confirmation

skip_arrival_confirmationbooleanOptional

Skip arrival confirmation

locationone ofOptional

Tracking point location

Example: {"country":"string","city":"string","zipcode":"string","address_1":"string"}
or
or
Responses
200
OK
application/json
post
POST //shipments/{id}/tracking-points HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 293

[
  {
    "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"
    }
  }
]
{
  "successful": true
}

Сonfirm shipment pickup by shipment identifier

put
Authorizations
Path parameters
idintegerRequired

Shipment identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
incidentstring · enum · max: 128Optional

Tracking point incident.

Example: StrikePossible values:
commentstringOptional

Tracking point comment.

datestringOptional

Date confirm. Format: YYYY-MM-DD.

timestringOptional

Time confirm. Format: HH:mm.

Responses
200
OK
application/json
put
PUT //shipments/{id}/pickup/confirm HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "incident": "Strike",
  "comment": "",
  "date": "text",
  "time": "text"
}
{
  "successful": true,
  "id": 1
}

Сonfirm shipment delivery by shipment identifier

put
Authorizations
Path parameters
idintegerRequired

Shipment identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
incidentstring · enum · max: 128Optional

Tracking point incident.

Example: StrikePossible values:
commentstringOptional

Tracking point comment.

datestringOptional

Date confirm. Format: YYYY-MM-DD.

timestringOptional

Time confirm. Format: HH:mm.

Responses
200
OK
application/json
put
PUT //shipments/{id}/delivery/confirm HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "incident": "Strike",
  "comment": "",
  "date": "text",
  "time": "text"
}
{
  "successful": true,
  "id": 1
}

Replan shipment pickup by shipment identifier

put
Authorizations
Path parameters
idintegerRequired

Shipment identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
datestringOptional

Date confirm. Format: YYYY-MM-DD.

timestringOptional

Time confirm. Format: HH:mm.

Responses
200
OK
application/json
put
PUT //shipments/{id}/pickup/replan HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "date": "text",
  "time": "text"
}
{
  "successful": true,
  "id": 1
}

Replan shipment delivery by shipment identifier

put
Authorizations
Path parameters
idintegerRequired

Shipment identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
datestringOptional

Date confirm. Format: YYYY-MM-DD.

timestringOptional

Time confirm. Format: HH:mm.

Responses
200
OK
application/json
put
PUT //shipments/{id}/delivery/replan HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "date": "text",
  "time": "text"
}
{
  "successful": true,
  "id": 1
}

Get tracking point by point identifier.

get
Authorizations
Path parameters
idnumberRequired

Point identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Responses
200
OK
application/json
get
GET //tracking-points/{id} HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "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",
    "company": {
      "id": 1,
      "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": true,
    "slot_booking_url": "text"
  }
}

Update tracking point by point identifier.

patch
Authorizations
Path parameters
idintegerRequired

Tracking point by point identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
incidentstring · enum · max: 128Optional

Tracking point incident.

Example: StrikePossible values:
commentstringOptional

Tracking point comment.

Responses
200
OK
application/json
patch
PATCH //tracking-points/{id} HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "incident": "Strike",
  "comment": ""
}
{
  "successful": true,
  "id": 1
}

Сonfirm tracking point by point identifier

put
Authorizations
Path parameters
idintegerRequired

Tracking point by point identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
incidentstring · enum · max: 128Optional

Tracking point incident.

Example: StrikePossible values:
commentstringOptional

Tracking point comment.

datestringOptional

Date confirm. Format: YYYY-MM-DD.

timestringOptional

Time confirm. Format: HH:mm.

Responses
200
OK
application/json
put
PUT //tracking-points/{id}/confirm HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "incident": "Strike",
  "comment": "",
  "date": "text",
  "time": "text"
}
{
  "successful": true,
  "id": 1
}

Replan tracking point by point identifier.

put
Authorizations
Path parameters
idintegerRequired

Tracking point by point identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
datestringOptional

Date confirm. Format: YYYY-MM-DD.

timestringOptional

Time confirm. Format: HH:mm.

Responses
200
OK
application/json
put
PUT //tracking-points/{id}/replan HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "date": "text",
  "time": "text"
}
{
  "successful": true,
  "id": 1
}

Cancel tracking point by point identifier.

put
Authorizations
Path parameters
idintegerRequired

Tracking point by point identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
incidentstring · enum · max: 128Optional

Tracking point incident.

Example: StrikePossible values:
commentstringOptional

Tracking point comment.

Responses
200
OK
application/json
put
PUT //tracking-points/{id}/cancel HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "incident": "Strike",
  "comment": ""
}
{
  "successful": true,
  "id": 1
}

Update location in tracking point by point identifier.

patch
Authorizations
Path parameters
idintegerRequired

Tracking point by point identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Body
one ofOptional

Tracking point location

Example: {"country":"string","city":"string","zipcode":"string","address_1":"string"}
or
or
Responses
200
OK
application/json
patch
PATCH //tracking-points/{id}/location HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "country": "string",
  "city": "string",
  "zipcode": "string",
  "address_1": "string"
}
{
  "successful": true,
  "id": 1
}
PreviousPayloads for CarrierNextDocuments

Last updated