TrackIt API v2
Orders - Find Orders
(WORK IN PROGRESS) Please leverage TrackIt Orders v1 until this endpoint is complete.
Fetches tracking details for all sales orders or delivery orders according to the search parameters.
Request
Request URL
Request parameters
-
(optional)array
Order tracking identifiers used to filter orders
-
(optional)array
Customer reference identifier used to filter trackables.
-
(optional)
The zero-based index of the page to include as the collection's representation.
-
(optional)
Size of the page to include in the response. This endpoint is paginated, and will only return up to a maximum of 25 results at a time.
Request headers
-
stringOAuth 2.0 access token obtained from JB Hunt OAuth 2.0 Test Provider. Supported grant types: Authorization code.
Request body
Responses
200 OK
The specified orders were found
Representations
{
"orders": [
{
"referenceIdentifiers": [
{
"type": "BOL",
"value": "CUSTXYZ123"
}
],
"orderId": "string",
"progressStatuses": [
{
"type": "InTransit",
"timeStamp": "2020-01-02T00:00:45.678Z"
}
],
"shipments": [
{
"shipmentId": "string",
"progressStatuses": [
{
"type": "InTransit",
"timeStamp": "2020-01-02T00:00:45.678Z"
}
],
"trackingEvents": [
{
"type": "Arrived",
"label": "Arrived at delivery location.",
"timeStamp": "2020-01-02T00:00:45.678Z",
"notes": [
{
"text": "Example generic comment.",
"timeStamp": "2020-01-02T00:00:45.678Z"
}
],
"location": {
"name": "WAREHOUSE 123",
"type": "RECEIVER",
"address": {
"streetAddress": "615 J B Hunt Corporate Dr",
"region": {
"code": "AR",
"name": "Arkansas"
},
"locality": "Lowell",
"postalCode": "72745",
"countryCode": "USA"
},
"coordinates": {
"longitude": -94.136986,
"latitude": 36.246883
}
}
}
],
"trackingExceptions": [
{
"type": "DeliveryAttempted",
"label": "Delivery attempted at delivery location.",
"timeStamp": "2020-01-02T00:00:45.678Z",
"notes": [
{
"text": "Example generic comment.",
"timeStamp": "2020-01-02T00:00:45.678Z"
}
],
"location": {
"name": "WAREHOUSE 123",
"type": "RECEIVER",
"address": {
"streetAddress": "615 J B Hunt Corporate Dr",
"region": {
"code": "AR",
"name": "Arkansas"
},
"locality": "Lowell",
"postalCode": "72745",
"countryCode": "USA"
},
"coordinates": {
"longitude": -94.136986,
"latitude": 36.246883
}
}
}
]
}
]
}
]
}{
"required": [
"orders"
],
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"title": "Order",
"type": "object",
"properties": {
"referenceIdentifiers": {
"type": "array",
"items": {
"title": "Reference Identifier",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of reference identifier.",
"example": "BOL"
},
"value": {
"type": "string",
"description": "Reference identifier",
"example": "CUSTXYZ123"
}
},
"description": "Identifier that can be tied to a movement.\n"
},
"description": "Reference identifiers associated with the order"
},
"orderId": {
"type": "string"
},
"progressStatuses": {
"type": "array",
"items": {
"title": "Order Progress Status",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Supported values are listed here. This list is subject to change. (OrderReceived, InTransit, Complete, Cancelled, ReturnInitiated, OutForPickup, ReturnPickedUp, ReturnCompleted, ReturnCancelled)\n",
"example": "InTransit"
},
"timeStamp": {
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
}
},
"description": "An order status at some point in time."
}
},
"shipments": {
"type": "array",
"items": {
"title": "Shipment",
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"description": "Reference number to track the shipment responsible for this move"
},
"progressStatuses": {
"type": "array",
"items": {
"title": "Shipment Progress Status",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Supported values are listed here. This list is subject to change. (Planned, InTransit, Complete, Cancelled)\n",
"example": "InTransit"
},
"timeStamp": {
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
}
},
"description": "A shipment status at some point in time."
}
},
"trackingEvents": {
"type": "array",
"items": {
"title": "Shipment Tracking Event",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Supported values are listed here. This list is subject to change. (Arrived, Departed, Loaded, Unloaded, DeliveryAppointmentAttempted, DeliveryAppointmentScheduled, DeliveryAppointmentCancelled, ReceivedAtFinalDestination, ReceivedAtDeliveryAgent, LoadedAtDeliveryAgent, OutForDelivery, PickupAppointmentAttempted, PickupApointmentScheduled, PickupAppointmentCancelled, OutForPickup, ArrivedAtSite, PickedUp)\n",
"example": "Arrived"
},
"label": {
"type": "string",
"description": "Text to be used when displayed on a front end.",
"example": "Arrived at delivery location."
},
"timeStamp": {
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
},
"notes": {
"type": "array",
"items": {
"title": "Note",
"properties": {
"text": {
"type": "string",
"description": "Comment or note text included here.",
"example": "Example generic comment."
},
"timeStamp": {
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
}
},
"description": "Unstructured text field to allow comments and notes to be included to provide more context that the structured fields do not support.\n"
},
"description": "Notes associated with this tracking event.\n"
},
"location": {
"title": "Location",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of location where stop activity occurs.",
"example": "WAREHOUSE 123"
},
"type": {
"type": "string",
"description": "Describes the type of location (useful for determining rail yards).",
"example": "RECEIVER"
},
"address": {
"title": "Address",
"required": [
"region",
"locality",
"postalCode",
"countryCode"
],
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "Address (eg. number, street, etc.)."
},
"locality": {
"type": "string",
"description": "City or town."
},
"region": {
"title": "Region",
"type": "object",
"properties": {
"code": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Region abbreviation or code, specified by [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)."
},
"name": {
"type": "string",
"description": "Full name for the region."
}
},
"description": "First-level administrative division. Typically a state, province, or other country sub-division.\n",
"example": {
"code": "AR",
"name": "Arkansas"
}
},
"neighborhood": {
"type": "string",
"description": "Neighborhood"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code."
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code."
}
},
"description": "Postal address for a location.\n",
"example": {
"streetAddress": "615 J B Hunt Corporate Dr",
"region": {
"code": "AR",
"name": "Arkansas"
},
"locality": "Lowell",
"postalCode": "72745",
"countryCode": "USA"
}
},
"coordinates": {
"title": "Coordinates",
"type": "object",
"properties": {
"longitude": {
"maximum": 180.0,
"minimum": -180.0,
"type": "number",
"description": "The arc or portion of the earth's equator intersected between the meridian of a given place and the prime meridian and expressed either in degrees or in time",
"format": "double",
"example": -94.136986
},
"latitude": {
"maximum": 90.0,
"minimum": -90.0,
"type": "number",
"description": "Angular distance north or south from the earth's equator measured through 90 degrees",
"format": "double",
"example": 36.246883
}
},
"description": "Longitude and latitude for a location along with metadata about the source data.\n"
}
},
"description": "Information about the stop, including the name, address, and coordinates.\n"
}
},
"description": "Tracking events that have occured on a shipment. These may or may not change the status."
}
},
"trackingExceptions": {
"type": "array",
"items": {
"title": "Shipment Tracking Exceptions",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Supported values are listed here. This list is subject to change. (DeliveryAttempted, PickupAttempted, DeliveryDelayed, PartialDelivery, PartsMissing, DeliveryAppointmentRescheduled, PickupAppointmentRescheduled, CustomsClearanceDelay, TrackingDataNotAvailable)\n",
"example": "DeliveryAttempted"
},
"label": {
"type": "string",
"description": "Text to be used when displayed on a front end.",
"example": "Delivery attempted at delivery location."
},
"timeStamp": {
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
},
"notes": {
"type": "array",
"items": {
"title": "Note",
"properties": {
"text": {
"type": "string",
"description": "Comment or note text included here.",
"example": "Example generic comment."
},
"timeStamp": {
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
}
},
"description": "Unstructured text field to allow comments and notes to be included to provide more context that the structured fields do not support.\n"
},
"description": "Notes associated with this tracking exception.\n"
},
"location": {
"title": "Location",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of location where stop activity occurs.",
"example": "WAREHOUSE 123"
},
"type": {
"type": "string",
"description": "Describes the type of location (useful for determining rail yards).",
"example": "RECEIVER"
},
"address": {
"title": "Address",
"required": [
"region",
"locality",
"postalCode",
"countryCode"
],
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "Address (eg. number, street, etc.)."
},
"locality": {
"type": "string",
"description": "City or town."
},
"region": {
"title": "Region",
"type": "object",
"properties": {
"code": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Region abbreviation or code, specified by [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)."
},
"name": {
"type": "string",
"description": "Full name for the region."
}
},
"description": "First-level administrative division. Typically a state, province, or other country sub-division.\n",
"example": {
"code": "AR",
"name": "Arkansas"
}
},
"neighborhood": {
"type": "string",
"description": "Neighborhood"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code."
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code."
}
},
"description": "Postal address for a location.\n",
"example": {
"streetAddress": "615 J B Hunt Corporate Dr",
"region": {
"code": "AR",
"name": "Arkansas"
},
"locality": "Lowell",
"postalCode": "72745",
"countryCode": "USA"
}
},
"coordinates": {
"title": "Coordinates",
"type": "object",
"properties": {
"longitude": {
"maximum": 180.0,
"minimum": -180.0,
"type": "number",
"description": "The arc or portion of the earth's equator intersected between the meridian of a given place and the prime meridian and expressed either in degrees or in time",
"format": "double",
"example": -94.136986
},
"latitude": {
"maximum": 90.0,
"minimum": -90.0,
"type": "number",
"description": "Angular distance north or south from the earth's equator measured through 90 degrees",
"format": "double",
"example": 36.246883
}
},
"description": "Longitude and latitude for a location along with metadata about the source data.\n"
}
},
"description": "Information about the stop, including the name, address, and coordinates.\n"
}
},
"description": "Tracking exceptions that have occured on a shipment. These may or may not change the status."
}
}
},
"description": "Summary of shipment statuses, activities, and exceptions for a shipment"
}
}
},
"description": "A sales or delivery order\n"
},
"description": "List of order objects"
}
},
"description": "List of orders retrieved"
}400 Bad Request
Cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). See RFC 7231, Section 6.5.1.
Representations
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"dateTime": {},
"issues": [
{
"description": "string",
"field": {},
"location": "body",
"value": {}
}
]
}{
"title": "Problem Details",
"allOf": [
{
"title": "Core Problem Details",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A [URI reference](https://tools.ietf.org/html/rfc3986#section-4.1) that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using [HTML](https://www.w3.org/TR/2014/REC-html5-20141028)). When this member is not present, its value is assumed to be `\"about:blank\"`.",
"default": "about:blank"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive [content negotiation](https://tools.ietf.org/html/rfc7231#section-3.4))."
},
"status": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem."
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."
}
},
"description": "The core problem details object. See [Section 3.1 of RFC 7807](https://tools.ietf.org/html/rfc7807#section-3.1)."
},
{
"title": "Problem Details Extensions",
"type": "object",
"properties": {
"dateTime": {
"allOf": [
{
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
}
],
"description": "The date and time that the problem occurred."
},
"issues": {
"type": "array",
"items": {
"title": "Issue",
"required": [
"description",
"field",
"location"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A human-readable explanation of the specific issue."
},
"field": {
"anyOf": [
{
"title": "JSON Pointer",
"pattern": "^(\\/([^/~]|~[01])*)*$",
"type": "string",
"description": "A string representing a JSON Pointer as defined by [RFC 6901](https://tools.ietf.org/html/rfc6901)."
},
{
"type": "string"
}
],
"description": "The name of the field in error. If `location` is `body`, then this MUST be either a [JSON pointer](https://tools.ietf.org/html/rfc6901) or an [XPath expression](https://www.w3.org/TR/1999/REC-xpath-19991116) referring to the field of the body."
},
"location": {
"enum": [
"body",
"header",
"path",
"query"
],
"type": "string",
"description": "The location of the issue.",
"default": "body"
},
"value": {
"allOf": [
{
"title": "Any?",
"allOf": [
{
"title": "Any",
"oneOf": [
{
"title": "Any Primitive",
"oneOf": [
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
}
],
"description": "Any non-nullable primitive JSON value"
},
{
"title": "Any Structured Value",
"oneOf": [
{
"type": "array"
},
{
"type": "object"
}
],
"description": "Any non-nullable structured JSON value"
}
],
"description": "Any non-nullable JSON value"
}
],
"description": "Any nullable JSON value",
"nullable": true
}
],
"description": "The value of the field in error."
}
},
"description": "An object describing the issue of a particular field in an HTTP request message."
},
"description": "An array of issues related to specific fields in the HTTP request message."
}
},
"description": "Custom J.B. Hunt extensions to the problems details format"
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}401 Unauthorized
The request has not been applied because it lacks valid authentication credentials for the target resource. See RFC 7235, Section 3.1.
Representations
{
"status": 401,
"title": "Missing or Invalid API Key",
"details": "Access denied due to missing API key. Make sure to include API key when making requests to an API.\n",
"instance": "urn:uuid:d7ec3301-412c-4903-a00c-524c3efc0eba"
}{
"title": "Problem Details",
"allOf": [
{
"title": "Core Problem Details",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A [URI reference](https://tools.ietf.org/html/rfc3986#section-4.1) that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using [HTML](https://www.w3.org/TR/2014/REC-html5-20141028)). When this member is not present, its value is assumed to be `\"about:blank\"`.",
"default": "about:blank"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive [content negotiation](https://tools.ietf.org/html/rfc7231#section-3.4))."
},
"status": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem."
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."
}
},
"description": "The core problem details object. See [Section 3.1 of RFC 7807](https://tools.ietf.org/html/rfc7807#section-3.1)."
},
{
"title": "Problem Details Extensions",
"type": "object",
"properties": {
"dateTime": {
"allOf": [
{
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
}
],
"description": "The date and time that the problem occurred."
},
"issues": {
"type": "array",
"items": {
"title": "Issue",
"required": [
"description",
"field",
"location"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A human-readable explanation of the specific issue."
},
"field": {
"anyOf": [
{
"title": "JSON Pointer",
"pattern": "^(\\/([^/~]|~[01])*)*$",
"type": "string",
"description": "A string representing a JSON Pointer as defined by [RFC 6901](https://tools.ietf.org/html/rfc6901)."
},
{
"type": "string"
}
],
"description": "The name of the field in error. If `location` is `body`, then this MUST be either a [JSON pointer](https://tools.ietf.org/html/rfc6901) or an [XPath expression](https://www.w3.org/TR/1999/REC-xpath-19991116) referring to the field of the body."
},
"location": {
"enum": [
"body",
"header",
"path",
"query"
],
"type": "string",
"description": "The location of the issue.",
"default": "body"
},
"value": {
"allOf": [
{
"title": "Any?",
"allOf": [
{
"title": "Any",
"oneOf": [
{
"title": "Any Primitive",
"oneOf": [
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
}
],
"description": "Any non-nullable primitive JSON value"
},
{
"title": "Any Structured Value",
"oneOf": [
{
"type": "array"
},
{
"type": "object"
}
],
"description": "Any non-nullable structured JSON value"
}
],
"description": "Any non-nullable JSON value"
}
],
"description": "Any nullable JSON value",
"nullable": true
}
],
"description": "The value of the field in error."
}
},
"description": "An object describing the issue of a particular field in an HTTP request message."
},
"description": "An array of issues related to specific fields in the HTTP request message."
}
},
"description": "Custom J.B. Hunt extensions to the problems details format"
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request. See RFC 7231, Section 6.6.1.
Representations
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"dateTime": {},
"issues": [
{
"description": "string",
"field": {},
"location": "body",
"value": {}
}
]
}{
"title": "Problem Details",
"allOf": [
{
"title": "Core Problem Details",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A [URI reference](https://tools.ietf.org/html/rfc3986#section-4.1) that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using [HTML](https://www.w3.org/TR/2014/REC-html5-20141028)). When this member is not present, its value is assumed to be `\"about:blank\"`.",
"default": "about:blank"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive [content negotiation](https://tools.ietf.org/html/rfc7231#section-3.4))."
},
"status": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem."
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."
}
},
"description": "The core problem details object. See [Section 3.1 of RFC 7807](https://tools.ietf.org/html/rfc7807#section-3.1)."
},
{
"title": "Problem Details Extensions",
"type": "object",
"properties": {
"dateTime": {
"allOf": [
{
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2020-01-02T00:00:45.678Z"
}
],
"description": "The date and time that the problem occurred."
},
"issues": {
"type": "array",
"items": {
"title": "Issue",
"required": [
"description",
"field",
"location"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A human-readable explanation of the specific issue."
},
"field": {
"anyOf": [
{
"title": "JSON Pointer",
"pattern": "^(\\/([^/~]|~[01])*)*$",
"type": "string",
"description": "A string representing a JSON Pointer as defined by [RFC 6901](https://tools.ietf.org/html/rfc6901)."
},
{
"type": "string"
}
],
"description": "The name of the field in error. If `location` is `body`, then this MUST be either a [JSON pointer](https://tools.ietf.org/html/rfc6901) or an [XPath expression](https://www.w3.org/TR/1999/REC-xpath-19991116) referring to the field of the body."
},
"location": {
"enum": [
"body",
"header",
"path",
"query"
],
"type": "string",
"description": "The location of the issue.",
"default": "body"
},
"value": {
"allOf": [
{
"title": "Any?",
"allOf": [
{
"title": "Any",
"oneOf": [
{
"title": "Any Primitive",
"oneOf": [
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
}
],
"description": "Any non-nullable primitive JSON value"
},
{
"title": "Any Structured Value",
"oneOf": [
{
"type": "array"
},
{
"type": "object"
}
],
"description": "Any non-nullable structured JSON value"
}
],
"description": "Any non-nullable JSON value"
}
],
"description": "Any nullable JSON value",
"nullable": true
}
],
"description": "The value of the field in error."
}
},
"description": "An object describing the issue of a particular field in an HTTP request message."
},
"description": "An array of issues related to specific fields in the HTTP request message."
}
},
"description": "Custom J.B. Hunt extensions to the problems details format"
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}Code samples
@ECHO OFF
curl -v -X GET "https://api.nonprod.jbhunt.com/tracking/v2/orders?orderIds={array}&referenceIdentifiers={array}&pageIndex={}&pageSize=25"
-H "Api-Key: {subscription key}"
-H "Authorization: {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Api-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
// Request parameters
queryString["orderIds"] = "{array}";
queryString["referenceIdentifiers"] = "{array}";
queryString["pageIndex"] = "{}";
queryString["pageSize"] = "25";
var uri = "https://api.nonprod.jbhunt.com/tracking/v2/orders?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.nonprod.jbhunt.com/tracking/v2/orders");
builder.setParameter("orderIds", "{array}");
builder.setParameter("referenceIdentifiers", "{array}");
builder.setParameter("pageIndex", "{}");
builder.setParameter("pageSize", "25");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Api-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"orderIds": "{array}",
"referenceIdentifiers": "{array}",
"pageIndex": "{}",
"pageSize": "25",
};
$.ajax({
url: "https://api.nonprod.jbhunt.com/tracking/v2/orders?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Api-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.nonprod.jbhunt.com/tracking/v2/orders";
NSArray* array = @[
// Request parameters
@"entities=true",
@"orderIds={array}",
@"referenceIdentifiers={array}",
@"pageIndex={}",
@"pageSize=25",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Api-Key"];
[_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.nonprod.jbhunt.com/tracking/v2/orders');
$url = $request->getUrl();
$headers = array(
// Request headers
'Api-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'orderIds' => '{array}',
'referenceIdentifiers' => '{array}',
'pageIndex' => '{}',
'pageSize' => '25',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Api-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
# Request parameters
'orderIds': '{array}',
'referenceIdentifiers': '{array}',
'pageIndex': '{}',
'pageSize': '25',
})
try:
conn = httplib.HTTPSConnection('api.nonprod.jbhunt.com')
conn.request("GET", "/tracking/v2/orders?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Api-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'orderIds': '{array}',
'referenceIdentifiers': '{array}',
'pageIndex': '{}',
'pageSize': '25',
})
try:
conn = http.client.HTTPSConnection('api.nonprod.jbhunt.com')
conn.request("GET", "/tracking/v2/orders?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.nonprod.jbhunt.com/tracking/v2/orders')
query = URI.encode_www_form({
# Request parameters
'orderIds' => '{array}',
'referenceIdentifiers' => '{array}',
'pageIndex' => '{}',
'pageSize' => '25'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Api-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body