Tracktor API

Fulfillments 1

raw

Retrieve the tracking status of a Fulfillment | GET https://www.theshoppad.com/apps/tracktor/api/admin/{{uuid}}/fulfillments/{{fulfillment_id}}.json

Description

Response Attributes

shop_url
string		URL of the store where the order was placed
order_id
integer		The Shopify ID of the order
order_name
string		The human-readable name of the order, typically prefixed by a #
shopify_carrier
string		The tracking_company on the Shopify fulfillment
carrier
object

Full details about the actual carrier used (either from shopify_carrier or after Carrier Mapping). Attributes (see response for full details):

  • slug
  • name
tracking_number
string		The tracking number set on the Shopify fulfillment
fulfillment_idintegerThe Shopify ID of the fulfillment
fulfillment_status
string		The status of an order in terms of the line items being fulfilled. Valid values: fulfilled, null, or partial.
shipment_status
string

Options:

  • order_ready
  • in_transit
  • out_for_delivery
  • delivered
  • any custom statuses configured in Tracktor
exception_status
string		Only set if this fulfillment has an issue. Options:
  • ‘not_found’ = Needs Attention (previously ‘Not Found’)
  • ‘exception’ = Shipping Exception
  • ‘undelivered’ = Failed Attempt
  • ‘pending’ = Pending Details
  • ‘expired’ = Needs Attention
is_automatic
boolean		true by default. false if we are not getting automatic updates from the carrier (typically this is toggled off for each order in the Tracktor dashboard).
line_items
array of objects

One for every line item in the fulfillment. Attributes:

  • name
  • quantity
  • requires_shipping
  • id
  • product_id
  • variant_id
latest_statusobjectAdvanced: Details about the latest status update for this fulfillment. Can be useful for email templates. See payload for details.
status
array of objects		Advanced: Details about all of the potential statuses for this fulfillment. Can be useful for email templates. See payload for details.


Headers
KeyValueDescription
Content-Typeapplication/json
x-api-key{{api_key}}
Response
Found fulfillment | Code: 200
{ "fulfillments": { "shop_url": "https://myshop.myshopify.com", "order_id": 2031829090338, "order_name": "#1078", "shopify_carrier": "China Post", "carrier": { "slug": "china-post", "name": "China Post", "required_fields": [], "website": "http://yjcx.ems.com.cn/qps/yjcx", "phone": "86 20 11185", "picture": "//s.trackingmore.com/images/icons/express/companylogo/3010.jpg" }, "tracking_number": "UJ509851438CN", "fulfillment_id": 1910857990178, "fulfillment_status": "success", "shipment_status": "order_ready", "exception_status": "not_found", "is_automatic": true, "line_items": [ { "name": "Poulet1", "quantity": 1, "requires_shipping": true, "id": 5046976512034, "product_id": 10692440015, "variant_id": 7214955855905 } ], "convert_to_local": null, "latest_status": { "key": "order_ready", "label": "Order Ready", "message": "Order Ready", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true, "convert_to_local": true }, "status": { "ordered": { "latest": { "message": "Ordered", "datetime": "2020-03-18T14:29:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": false, "convert_to_local": true }, "all": [ { "message": "Ordered", "datetime": "2020-03-18T14:29:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": false, "convert_to_local": true } ], "label": "Ordered" }, "custom0": { "latest": { "message": "1", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "1", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "1" }, "custom1": { "latest": { "message": "2", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "2", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "2" }, "custom2": { "latest": { "message": "3", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "3", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "3" }, "order_ready": { "latest": { "message": "Order Ready", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true, "convert_to_local": true }, "all": [ { "message": "Order Ready", "datetime": "2020-03-18T14:30:55-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true, "convert_to_local": true } ], "label": "Order Ready", "static": true }, "in_transit": { "latest": { "message": "In Transit", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "In Transit", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "In Transit", "static": true }, "out_for_delivery": { "latest": { "message": "Out for Delivery", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "Out for Delivery", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "Out for Delivery", "static": true }, "delivered": { "latest": { "message": "Delivered", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "Delivered", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "Delivered", "static": true } } } }

Orders 3

raw

Get the current package tracking status options for this shop | GET https://www.theshoppad.com/apps/tracktor/api/admin/{{uuid}}/status-options.json

Headers
KeyValueDescription
Content-Typeapplication/json
x-api-key{{api_key}}
Response
Success | Code: 200
[ { "label": "Ordered", "value": "ordered" }, { "label": "Order Ready", "value": "pre_transit" }, { "label": "Painting", "value": "painting" }, { "label": "Packaging", "value": "packaging" }, { "label": "Fulfilling", "value": "fulfilling" }, { "label": "In Transit", "value": "in_transit" }, { "label": "Out For Delivery", "value": "out_for_delivery" }, { "label": "Delivered", "value": "delivered" } ]
raw

Retrieve the tracking statuses of an Order | GET https://www.theshoppad.com/apps/tracktor/api/admin/{{uuid}}/orders/{{order_id}}.json

Description

Response Attributes

order_id
integer		The Shopify ID of the order
order_name
string		The human-readable name of the order, typically prefixed by a #
order_email
string		The email address of the customer that placed the order. If only a phone number was provided this will be empty.
order_phone
string		Phone number from the order, typically including country code, if provided
order_source_name
string		How the order was placed. One of: web, pos, shopify_draft_order, iphone, and android.
order_created_at
string		Date order was placed
customer_first_name
string
customer_last_name
string
customer_full_name
string
total_price
float		 The total price of the order, including taxes and shipping
line_item_count
integer		 Total number of line items on the order
statuses
array of strings

One item per fulfillment. Options:

  • order_ready
  • in_transit
  • out_for_delivery
  • delivered
  • any custom statuses configured in Tracktor
exception_statuses
array of strings

One item per fulfillment with an exception. Options:

  • ‘not_found’ = Needs Attention (previously ‘Not Found’)
  • ‘exception’ = Shipping Exception
  • ‘undelivered’ = Failed Attempt
  • ‘pending’ = Pending Details
  • ‘expired’ = Needs Attention
days_since_ordered
integer		If the order is delivered: The number of days it took to go from Ordered to Delivered
automatic_carrier_updates
boolean		true by default. false if we are not getting automatic updates from the carrier (typically this is toggled off for each order in the Tracktor dashboard).
fulfillments
array of objects		See fulfillment response


Headers
KeyValueDescription
Content-Typeapplication/json
x-api-key{{api_key}}
Response
Found order | Code: 200
{ "order": { "order_id": 5217028303, "order_name": "#1002", "order_email": "example@gmail.com", "order_phone": null, "order_source_name": "shopify_draft_order", "order_created_at": "2017-04-24T18:57:32+00:00", "customer_first_name": "Frank", "customer_last_name": "Franz", "customer_full_name": "Frank Franz", "total_price": 49.16, "line_item_count": 3, "statuses": [ "in_transit" ], "exception_statuses": [ "pending" ], "days_since_ordered": 5, "automatic_carrier_updates": true, "created_at": "2020-03-11T17:09:57+00:00", "updated_at": "2020-03-26T04:42:42+00:00", "fulfillments": [ { "shop_url": "https://myshop.myshopify.com", "order_id": 5217028303, "order_name": "#1002", "shopify_carrier": "FedEx", "carrier": null, "tracking_number": null, "fulfillment_id": 1904539992098, "fulfillment_status": "success", "shipment_status": "order_ready", "exception_status": "not_found", "is_automatic": true, "line_items": [ { "name": "Poulet", "quantity": 1, "requires_shipping": true, "id": 10122897615, "product_id": 10692440015, "variant_id": 39699225807 } ], "convert_to_local": null, "error": "", "latest_status": { "key": "order_ready", "label": "Order Ready", "message": "Order Ready", "datetime": "2020-03-11T13:12:16-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true, "convert_to_local": true }, "status": { "ordered": { "latest": { "message": "Ordered", "datetime": "2017-04-24T14:57:32-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": false, "convert_to_local": true }, "all": [ { "message": "Ordered", "datetime": "2017-04-24T14:57:32-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": false, "convert_to_local": true } ], "label": "Ordered" }, "custom0": { "latest": { "message": "1", "datetime": "2014-02-16T15:45:23+00:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "1", "datetime": "2014-02-16T15:45:23+00:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "1" }, "custom1": { "latest": { "message": "2", "datetime": "2020-03-11T13:12:16-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "2", "datetime": "2020-03-11T13:12:16-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "2" }, "custom2": { "latest": { "message": "3", "datetime": "2020-03-11T13:12:16-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "3", "datetime": "2020-03-11T13:12:16-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "3" }, "order_ready": { "latest": { "message": "Order Ready", "datetime": "2020-03-11T13:12:16-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true, "convert_to_local": true }, "all": [ { "message": "Order Ready", "datetime": "2020-03-11T13:12:16-04:00", "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true, "convert_to_local": true } ], "label": "Order Ready", "static": true }, "in_transit": { "latest": { "message": "In Transit", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "In Transit", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "In Transit", "static": true }, "out_for_delivery": { "latest": { "message": "Out for Delivery", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "Out for Delivery", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "Out for Delivery", "static": true }, "delivered": { "latest": { "message": "Delivered", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true }, "all": [ { "message": "Delivered", "datetime": null, "tracking_location": null, "location_string": null, "address_string": null, "is_custom": true } ], "label": "Delivered", "static": true } } } ] } }
raw

Update the manual tracking status of an Order | POST https://www.theshoppad.com/apps/tracktor/api/admin/{{uuid}}/orders/{{order_id}}.json

Headers
KeyValueDescription
Content-Typeapplication/json
x-api-key{{api_key}}
Body
{ "order": { "status": "in_transit", "date": "2014-02-16T10:45:23-05:00", "automatic_carrier_updates": false, "force": true } }
Response
Order status updated | Code: 200
{ "order": { "uuid": "poulet-sauvage", "active": true, "order_id": 5217028303, "order_name": "#1002", "order_email": "jeffrey.m.lyon@gmail.com", "order_phone": null, "order_source_name": "shopify_draft_order", "order_created_at": "2017-04-24T18:57:32+00:00", "customer_first_name": "jeff", "customer_last_name": "lyon", "customer_full_name": "jeff lyon", "total_price": 49.16, "line_item_count": 3, "statuses": [ { "in_transit": "In Transit" } ], "exception_statuses": [ "pending" ], "trackings": [ { "fulfillment_id": 1904539992098, "shopify_carrier": "FedEx", "provider": "shippo", "tracking_company": "fedex", "tracking_number": "61297937879321429293", "fulfillment_status": "success", "line_item_count": 1, "shipment_status": "in_transit", "exception_status": null, "last_updated_source": "webhook", "update_history": [ { "source": "webhook", "datetime": "2020-03-23T13:13:28-07:00", "status_counts": { "in_transit": 9, "delivered": 1 } }, { "source": "webhook", "datetime": "2020-03-23T13:14:42-07:00", "status_counts": { "in_transit": 9, "delivered": 1 } }, { "source": "webhook", "datetime": "2020-03-23T15:42:03-07:00", "status_counts": { "in_transit": 9, "delivered": 1 } }, { "source": "webhook", "datetime": "2020-03-24T09:43:08-07:00", "status_counts": { "in_transit": 9, "delivered": 1 } }, { "source": "webhook", "datetime": "2020-03-24T09:45:47-07:00", "status_counts": { "in_transit": 9, "delivered": 1 } }, { "source": "webhook", "datetime": "2020-03-24T09:46:27-07:00", "status_counts": { "in_transit": 9, "delivered": 1 } }, { "source": "webhook", "datetime": "2020-03-24T09:46:59-07:00", "status_counts": { "in_transit": 9, "delivered": 1 } } ], "days_since_ordered": 1051, "force_update": false, "data": { "trackingParams": [], "id": null, "tracking_code": "61297937879321429293", "status": "in_transit", "created_at": "2019-01-30T18:24:00Z", "updated_at": "2019-02-05T12:51:00Z", "signed_by": "", "est_delivery_date": "2019-02-05T00:00:00Z", "carrier": "fedex", "hide_carrier": false, "tracking_details": [ { "message": "Your shipment has been processed through a USPS facilit!y.", "status": "in_transit", "datetime": "2019-01-31T02:24:00Z", "tracking_location": { "city": "Seoul International Post Office", "state": "", "country": "", "zip": "", "location": null } }, { "message": "Your shipment has been processed through a USPS facility.", "status": "in_transit", "datetime": "2019-01-31T06:59:00Z", "tracking_location": { "city": "Seoul International Post Office", "state": "", "country": "", "zip": "", "location": null } }, { "message": "Your shipment has arrived at a USPS regional facility.", "status": "in_transit", "datetime": "2019-02-02T17:00:00Z", "tracking_location": { "city": "Los Angeles Ca International Distribution Center", "state": "", "country": "US", "zip": "", "location": null } }, { "message": "Your shipment has departed a USPS regional facility.", "status": "in_transit", "datetime": "2019-02-03T04:41:00Z", "tracking_location": { "city": "Los Angeles Ca International Distribution Center", "state": "", "country": "US", "zip": "", "location": null } }, { "message": "Your package has cleared customs in the recipient's country.", "status": "in_transit", "datetime": "2019-02-03T04:41:00Z", "tracking_location": { "city": "", "state": "", "country": "", "zip": null, "location": null } }, { "message": "Your shipment has arrived at the USPS regional destination facility.", "status": "in_transit", "datetime": "2019-02-04T07:17:00Z", "tracking_location": { "city": "City Of Industry Ca Distribution Center", "state": "", "country": "US", "zip": "", "location": null } }, { "message": "Your shipment has arrived at the post office.", "status": "in_transit", "datetime": "2019-02-05T13:42:00Z", "tracking_location": { "city": "Cypress", "state": "CA", "country": "US", "zip": "90630", "location": null } }, { "message": "Your shipment has been sorted completely.", "status": "in_transit", "datetime": "2019-02-05T16:05:00Z", "tracking_location": { "city": "Cypress", "state": "CA", "country": "US", "zip": "90630", "location": null } }, { "message": "Your shipment is out for delivery.", "status": "in_transit", "datetime": "2019-02-05T16:15:00Z", "tracking_location": { "city": "Cypress", "state": "CA", "country": "US", "zip": "90630", "location": null } }, { "message": "Your shipment has been delivered.", "status": "delivered", "datetime": "2019-02-05T20:51:00Z", "tracking_location": { "city": "Cypress", "state": "CA", "country": "US", "zip": "90630", "location": null } } ], "convert_to_local": true, "exception_status": null }, "data_hash": "53228df6af01d1b98f189f3c39cde553", "_id": null, "created_at": "2020-03-11T17:12:19+00:00", "updated_at": "2020-03-24T16:46:59+00:00" } ], "custom_statuses": [ { "id": "pre_transit", "completed": true, "date": "2014-02-16T15:45:23+00:00", "_id": null, "created_at": null, "updated_at": null }, { "id": "in_transit", "completed": true, "date": "2014-02-16T15:45:23+00:00", "_id": null, "created_at": null, "updated_at": null } ], "custom_is_automatic": false, "days_since_ordered": 1086, "_id": "5e691b6578e81e60633ce792", "created_at": "2020-03-11T17:09:57+00:00", "updated_at": "2020-03-27T22:18:13+00:00" } }

Webhooks 3

raw

Retrieve a list of Webhooks | GET https://www.theshoppad.com/apps/tracktor/api/admin/{{uuid}}/webhooks.json

Headers
KeyValueDescription
Content-Typeapplication/json
x-api-key{{api_key}}
Query
KeyValueDescription
Response
Success | Code: 200
{ "webhooks": [ { "topic": "order/all", "address": "https://whatever.hostname.com/", "format": "json", "source": "mesa", "id": "5e964b4d32904d596c010ca2" }, { "topic": "order/all", "address": "https://whatever.hostname.com/another", "format": "json", "source": "mesa", "id": "5e964bb776a93d3baf7b4a33" } ] }
raw

Create a new Webhook | POST https://www.theshoppad.com/apps/tracktor/api/admin/{{uuid}}/webhooks.json

Description

Valid topics:

  • order/all
  • order/pre_transit
  • order/in_transit
  • order/out_for_delivery
  • order/delivered
  • fulfillment/all
  • fulfillment/pre_transit
  • fulfillment/in_transit
  • fulfillment/out_for_delivery
  • fulfillment/delivered


Headers
KeyValueDescription
Content-Typeapplication/json
x-api-key{{api_key}}
Body
{ "webhook": { "topic": "order/all", "address": "https://whatever.hostname.com/another", "format": "json", "source": "mesa" } }
Response
Successfully created webhook | Code: 200
{ "webhook": { "topic": "order/all", "address": "https://whatever.hostname.com/", "format": "json", "source": "mesa", "id": "5e964b4d32904d596c010ca2" } }
raw

Delete a Webhook | DELETE https://www.theshoppad.com/apps/tracktor/api/admin/{{uuid}}/webhooks/{{webhook_id}}.json

Headers
KeyValueDescription
Content-Typeapplication/json
x-api-key{{api_key}}
Response
Webhook successfully deleted | Code: 200
{ "webhook": { "topic": "order/all", "address": "https://whatever.hostname.com/", "format": "json", "source": "mesa", "id": "5e964b4d32904d596c010ca2" } }