Tracktor liquid object documentation (1.0)

Get liquid payload

Responses

Response Schema: application/json

object
The Tracktor object contains order data and app configuration properties.
Response samples

Content type
application/json
{"tracktor": {"config": {"uuid": "example-store",
"shop": "example-store.myshopify.com",
"strings": {"track_your_order": "Track Your Order",
"order_number": "Order Number",
"email": "Email",
"track": "Track",
"tracking_packages": "Tracking Packages",
"still_tracking_packages": "Waiting for tracking information",
"order": "Order",
"status": "Status",
"payment_pending": "Payment Pending",
"paid": "Paid",
"could_not_find_order": "Could not find order",
"incorrect_email": "Incorrect email",
"finding_your_order": "Finding Your Order...",
"no_fulfillment_with_order": "This order has not been fulfilled yet",
"no_tracking_number_with_order": "This fulfillment doesn't have a tracking number associated with it",
"unknown_status": "Waiting for carrier to update tracking information, please try again later",
"unknown_carrier": "We could not determine the appropriate carrier for your tracking number",
"package": "Package {number} of {total}",
"delivered": "Delivered",
"ordered": "Ordered",
"order_ready": "Order Ready",
"in_transit": "In Transit",
"shipped": "Shipped",
"out_for_delivery": "Out for Delivery",
"shipping_details": "Shipping Details",
"latest_update": "Latest Update",
"returned_to_sender": "Returned to Sender",
"carrier": "Carrier",
"signed_by": "Signed By",
"package_location": "Package Location",
"estimated_delivery_date": "Estimated Delivery Date",
"tracking_number": "Tracking Number",
"package_contents": "Package Contents",
"shipping_to": "Shipping To",
"email_alerts": "Get email alerts",
"sign_up": "Sign up",
"sign_up_success": "You're signed up for alerts for this package",
"exceed_limit_message": "Please contact our customer support for inquiries about your order.",
"short_date_format": "MMM D",
"long_date_format": "MMM Do YYYY",
"time_format": "h:mma",
"no_shippable_items": "No shippable items",
"items_not_yet_shipped": "These items have not yet shipped",
"recommendations_title": "You may also like...",
"awaiting_tracking_data": "Retrieval of your tracking details is still in progress. Please wait a minute, then try again",
"refunded_fulfillment": "This order contains refunded items",
"exception": "Exception",
"shipping_exception": "Shipping Exception",
"shipping_exception_description": "Your package cannot progress at this time"
},
"tracking_url": "https://example-store.myshopify.com/apps/tracktor/track",
"page_width": "1200px",
"theme": "light",
"format": "liquid",
"css": "",
"header": "",
"footer": "",
"liquid": "<!--\n  Tracktor Customizable Tracking Page Template\n  Docs:\n    - https://docs.theshoppad.com/article/158-customize-your-tracktor-page\n    - https://theshoppad.com/apps/tracktor/api/docs/liquid\n-->\n\n<!-- base_stylesheet -  includes helper classes for icons and animations -->\n{{ tracktor.config.base_stylesheet }}\n<!-- layout_stylesheet - contains all the styles used for the default layout -->\n{{ tracktor.config.layout_stylesheet }}\n<!-- Include HTML markup configured in the tracking page settings -->\n{{ tracktor.config.header }}\n\n<div id=\"tracktor\" class=\"theme{{ tracktor.config.theme | capitalize }}\">\n  <div id=\"tracktorContainer\" style=\"max-width:{{ tracktor.config.page_width }}\">\n\n  <!-- Track Order form -->\n  {{ tracktor.snippets.form }}\n\n  <!-- Error handling -->\n  {% if tracktor.error.key and tracktor.order == false and tracktor.captcha == false %}\n    <span class=\"tracktorDivider\"></span>\n    <h1 class=\"tracktorError\">{{ tracktor.error.message }}</h1>\n  {% endif %}\n\n  <!-- Order data -->\n  {% if tracktor.order %}\n    <span class=\"tracktorDivider\"></span>\n    <div class=\"tracktorOrder {% if tracktor.product_recommendations == false %}tracktorCenter{% endif %}\"> \n      {% for fulfillment in tracktor.order.fulfillments %}\n        <div class=\"tracktorFulfillment tracktor_{{ fulfillment.tracking_details[0].status }}\">\n          <div class=\"tracktorProgressWrapper\">\n            <span class=\"tracktorProgressIconWrapper\">\n              <span class=\"tracktorProgressIcon\"></span>\n            </span>\n            <span class=\"tracktorProgressLine\">\n              <span class=\"tracktorProgressActive\"></span>\n            </span>\n          </div>\n          {% if tracktor.config.estimated_delivery_date and fulfillment.est_delivery_date and fulfillment.latest_status.key != 'delivered' %}\n            <div class=\"tracktorEstimatedDelivery\">\n              <div class=\"tracktorEstimatedDeliveryTitle\">\n                <h3>{{ tracktor.config.strings.estimated_delivery_date }}</h3>\n              </div><div class=\"tracktorEstimatedDeliveryDate\">\n                <h3>{{ fulfillment.est_delivery_date | datetime: 'M j' }}</h3>\n              </div>\n            </div>\n          {% endif %}\n          <div><span class=\"tracktorOrderName tracktorSubdued\">{{ tracktor.config.strings.order }} {{ tracktor.order.name }}</span></div>\n          <div class=\"tracktorOrderStatusWrapper\">\n            {% if fulfillment.tracking_details[0].status == 'exception' %}\n            <h3 class=\"tracktorOrderStatusLabel\">{{ fulfillment.tracking_details[0].status_label }}:<div>{{ tracktor.config.strings.shipping_exception_description }}</div></h3>\n            {% else %}\n              <h3 class=\"tracktorOrderStatusLabel\">{{ fulfillment.tracking_details[0].status_label }}</h3><span class=\"tracktorOrderStatusDatetime\">{{ fulfillment.tracking_details[0].datetime | datetime: 'M j g:ia' }}</span>\n            {% endif %}\n          </div>\n          {% if tracktor.config.show_contents %}\n            <div class=\"tracktorProductCard\">\n              {% for line_item in fulfillment.line_items %}\n                <div class=\"tracktorProductDetails\">\n                  <div class=\"tracktorProductMain\">\n                    <div class=\"tracktorProductImage\">\n                      <img src=\"{{ line_item | image_url }}\" />\n                    </div><div class=\"tracktorProductName\">\n                      <div><span>{{ line_item.title }}</span></div>\n                      {% if line_item.variant_title %}\n                        <div><span class=\"tracktorSubdued\">{{ line_item.variant_title }}</span></div>\n                      {% endif %}\n                    </div>\n                  </div><div class=\"tracktorProductQuantity\">\n                    <span class=\"tracktorSubdued\">&#215; {{ line_item.quantity }}</span>\n                  </div>\n                </div>\n              {% endfor %}\n            </div>\n          {% endif %}\n          {% if fulfillment.tracking_details %}\n            <div class=\"tracktorDetailsCard\">\n              <div class=\"tracktorAccordionHeader\">\n                <span class=\"tracktorAccordionArrow\"></span><span class=\"tracktorSubdued\">More Details</span>\n              </div>\n              <div class=\"tracktorDetailContainer\">\n                {% for tracking_detail in fulfillment.tracking_details %}\n                  <div class=\"tracktorTrackingDetail\">\n                    <div class=\"tracktorDetailMessage\">\n                      <div><span>{{ tracking_detail.message }}</span></div>\n                      <span class=\"tracktorSubdued tracktorMinor\">{{ tracking_detail.location_string }}</span>\n                    </div><div class=\"tracktorDetailDatetime\"><span class=\"tracktorSubdued tracktorMinor\">{{ tracking_detail.datetime | datetime: 'M j g:ia'}}</span></div>\n                  </div>\n                {% endfor %}\n                {% if tracktor.config.show_carrier and fulfillment.tracking_number %}\n                  <div class=\"tracktorCarrierDetails\">\n                    <div class=\"tracktorCarrierDetailsImage\">\n                      <img src=\"{{ fulfillment.carrier.picture }}\" />\n                    </div><div class=\"tracktorCarrierDetailsInfo\">\n                      <div><span>{{ fulfillment.carrier.name }}</span></div>\n                      {% if tracktor.config.show_tracking_number %}\n                        <div><span class=\"tracktorSubdued\">{{ fulfillment.tracking_number }}</span></div>\n                      {% endif %}\n                    </div>\n                  </div>\n                {% endif %}\n              </div>\n            </div>\n          {% endif %}\n        </div>\n      {% endfor %}\n    </div>{% if tracktor.product_recommendations %}<div class=\"tracktorProductRecommendations\"><div class=\"tracktorProductRecommendationsHeader\"><span>You might also like...</span></div>{{ tracktor.product_recommendations }}</div>\n    {% endif %}\n  {% endif %}\n  </div>\n</div>\n\n<!-- Include styles + set progress bar color -->\n<style>\n{{ tracktor.config.css }}\n\nbody:not('.tracktorLoading') #tracktor #tracktorContainer .tracktorProgressActive {\n  background-color: {{ tracktor.config.progress_bar_color }};\n}\n\n#tracktor #tracktorContainer .tracktorProgressActive {\n  background-color: {{ tracktor.config.progress_bar_color }};\n}\n\n#tracktor #tracktorContainer .tracktorProgressLine:before {\n  background: {{ tracktor.config.progress_bar_color }};\n  border-color: {{ tracktor.config.progress_bar_color }};\n}\n\n#tracktor #tracktorContainer .tracktorProgressIconWrapper {\n  border-color: {{ tracktor.config.progress_bar_color }};\n  background-color: {{ tracktor.config.progress_bar_color }};\n}\n</style>\n\n<!-- Loading class for animations -->\n<script>\n  document.body.classList.add('tracktorLoading');\n\n  window.addEventListener(\"DOMContentLoaded\", showPage);\n\n  function showPage() {\n    setTimeout(function() {\n      document.body.classList.remove('tracktorLoading');\n    }, 150);\n  }\n</script>\n\n<!-- Accordian for tracking details -->\n<script>\n(function() {\n  var accordion = document.getElementsByClassName(\"tracktorAccordionHeader\");\n  for (var i = 0; i < accordion.length; i++) {\n    accordion[i].addEventListener(\"click\", function() {\n      this.classList.toggle(\"accordionActive\");\n      var panel = this.nextElementSibling;\n      if (panel.style.maxHeight) {\n        panel.style.maxHeight = null;\n      } else {\n        panel.style.maxHeight = panel.scrollHeight + \"px\";\n      } \n    });\n  } \n})();\n</script>\n\n<!-- Include HTML markup configured in the tracking page settings -->\n{{ tracktor.config.footer }}<script>(function() { function doLog() { return typeof window.spLogCallback === 'function'; } function spLog(data, label, color = true) { const logApp = 'tracktor'; const logDefaultColor = 'MediumPurple'; if (doLog()) { window.spLogCallback(logApp, data, label, color === true ? logDefaultColor : color); } try { if (localStorage.getItem('spLog') === 'on') { console.log([logApp, label, data]); } } catch (e) { } } function spLogJson(data, label) { if (doLog()) { try { spLog(JSON.parse(JSON.stringify(data)), label, true); } catch (jsonError) { spLog(jsonError, 'JSON parse failed while logging', true); spLog(data, label, true); } } }; var query = encodeURIComponent(JSON.stringify({ uuid: 'example-store', order_id: '2652304408670' })); spLog('https://homeroom.theshoppad.com/admin/#/tracktor/' + query, 'View in Tracktor Superadmin'); spLog(window.location.href + '&json_string=verbose', 'View Tracktor JSON data'); }());</script>",
"progress_bar_color": "#52CA30",
"show_carrier": true,
"show_tracking_number": true,
"show_contents": true,
"carrier_mapping": [{"tracking_company": "dhl-global-mail",
"when_tracking_company": "Correios"
}
],
"product_recommendations": true,
"estimated_delivery_date": true,
"translation_language": "custom",
"base_stylesheet": "<link rel=\"stylesheet\" href=\"//d1liekpayvooaz.cloudfront.net/apps/tracktor/assets/client/dist/css/base.css\">",
"layout_stylesheet": "<link rel=\"stylesheet\" href=\"//d1liekpayvooaz.cloudfront.net/apps/tracktor/assets/client/dist/css/layout.css\">"
},
"order": {"order_id": 2652304208670,
"order_name": "#1001",
"order_email": "donotreply@theshoppad.net",
"order_phone": null,
"order_source_name": "shopify_draft_order",
"order_created_at": "Nov 4 2020",
"customer_id": 5051103434,
"customer_first_name": "John",
"customer_last_name": "Doe",
"customer_full_name": "John Doe",
"total_price": 19.99,
"line_item_count": 2,
"days_since_ordered": 124,
"fulfillment_status": "fulfilled",
"created_at": "Nov 4 2020",
"updated_at": "Nov 4 2020",
"name": "#1001",
"email": "donotreply@theshoppad.net",
"phone": null,
"shipping_address": {"latitude": 37.78871,
"longitude": -122.40153,
"city": "San Francisco",
"province": null,
"province_code": "CA",
"country": "United States",
"country_code": "US"
},
"address_string": "San Francisco, CA, United States",
"fulfillments": [{"shopify_carrier": "dhl-global-mail",
"carrier": {"slug": "dhl-global-mail",
"name": "DHL eCommerce",
"website": "http://webtrack.dhlglobalmail.com/",
"phone": "+1 317-554-5191",
"picture": "//tracktor.cdn.theshoppad.net/images/carriers/dhl-global-mail.png"
},
"tracking_number": "420786029361369903506243336994",
"fulfillment_id": 2573906933902,
"fulfillment_status": "success",
"shipment_status": "delivered",
"line_items": [{"name": "Example Product",
"title": "Example Product",
"variant_title": "",
"quantity": 1,
"requires_shipping": true,
"id": 5494914187318,
"product_id": 7822223143,
"variant_id": 24783459527
}
],
"est_delivery_date": "",
"tracking_details": [{"message": "Delivered, In/at Mailbox, Your Item Was Delivered In Or At The Mailbox At 1:23 PM On February 6, 2021 In San Francisco, CA.",
"datetime": "2021-02-06T13:23:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": null,
"country": null,
"zip": null,
"location": null,
"coordinates": {"lat": 37.78871,
"lng": -122.40153,
"is_fallback": true
}
},
"location_string": "San Francisco",
"address_string": "San Francisco",
"is_custom": false,
"status": "delivered",
"status_label": "Delivered"
},
{"message": "Delivered",
"datetime": "2021-02-06T13:23:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "delivered",
"status_label": "Delivered"
},
{"message": "Out For Delivery",
"datetime": "2021-02-06T06:10:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "out_for_delivery",
"status_label": "Out for Delivery"
},
{"message": "Out For Delivery",
"datetime": "2021-02-06T06:10:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "out_for_delivery",
"status_label": "Out for Delivery"
},
{"message": "Arrival At Post Office",
"datetime": "2021-02-06T05:06:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Arrived At Post Office",
"datetime": "2021-02-06T05:06:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Arrived USPS Sort Facility",
"datetime": "2021-02-06T03:51:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Accepted At USPS Destination Facility",
"datetime": "2021-02-06T03:51:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Tendered To Delivery Service Provider",
"datetime": "2021-02-05T02:50:51+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Arrival Destination DHL Ecommerce Facility",
"datetime": "2021-02-04T09:36:14+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Arrived Shipping Partner Facility, USPS Awaiting Item",
"datetime": "2021-02-04T09:36:00+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "San Francisco, CA",
"address_string": "San Francisco",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Departure Origin DHL Ecommerce Facility",
"datetime": "2021-02-03T13:02:31+00:00",
"tracking_location": {"city": "San Francisco",
"state": "CA",
"country": null,
"zip": null,
"location": null
},
"location_string": "Grand Prairie, TX",
"address_string": "Grand Prairie",
"is_custom": false,
"status": "in_transit",
"status_label": "In Transit"
},
{"message": "Departed Shipping Partner Facility, USPS Awaiting Item",
"datetime":