Operation Page Breadcrumb

Developer APIs Order Details API

Order Details API

Get Order Details

Retrieve order details for the various types of orders handled by the system.

Try it

Request

Request URL

Request parameters

  • string

    Unique identifier for an order.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from JB Hunt OAuth 2.0 Provider (RHSSO - Security360). Supported grant types: Authorization code.

Request body

Responses

200 OK

Retrieved order detail records.

Representations

{
  "orderDisplayType": "string",
  "value": {
    "orderSummary": {
      "orderStatus": "string",
      "lineOfBusiness": {
        "aliasCode": "string",
        "id": "string",
        "name": "string"
      },
      "referenceNumbers": [
        {
          "referenceNumber": "string",
          "referenceNumberType": "string",
          "referenceNumberTypeDescription": "string"
        }
      ],
      "requestType": "string",
      "trackingNumber": "string",
      "orderCreationDate": {},
      "targetDate": {
        "date": {},
        "time": {}
      },
      "scheduledDeliveryDate": {
        "appointmentBegin": {
          "date": {},
          "time": {}
        },
        "appointmentEnd": {
          "date": {},
          "time": {}
        }
      },
      "location": {
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "postalCode": "string",
          "state": "string"
        },
        "id": "string",
        "partyName": "string"
      },
      "contact": {
        "contactId": "string",
        "contactName": "string",
        "firstName": "string",
        "lastName": "string",
        "phoneNumbers": [
          {
            "number": "string",
            "extension": "string",
            "phoneNumberType": "Home",
            "allowsSms": true
          }
        ],
        "emailAddresses": [
          "string"
        ]
      },
      "consumerClassificationType": "string",
      "comments": [
        {
          "commentText": "string",
          "commentTypeCode": "string",
          "creation": {
            "createdAt": {},
            "createdBy": "string",
            "creatingProgram": "string"
          },
          "lastUpdate": {
            "updatedAt": {},
            "updatedBy": "string",
            "updatingProgram": "string"
          },
          "id": "string"
        }
      ]
    }
  }
}
{
  "title": "Order Details Response",
  "type": "object",
  "properties": {
    "orderDisplayType": {
      "type": "string",
      "description": "The order type for display purposes. This may or may not be one to one with the type from an underlying domain point of view."
    },
    "value": {
      "allOf": [
        {
          "title": "FinalMile Order Details",
          "type": "object",
          "properties": {
            "orderSummary": {
              "type": "object",
              "properties": {
                "orderStatus": {
                  "type": "string",
                  "description": "Status of order."
                },
                "lineOfBusiness": {
                  "title": "Line of Business",
                  "type": "object",
                  "properties": {
                    "aliasCode": {
                      "title": "Alias Code",
                      "type": "string",
                      "description": "a.k.a the project code."
                    },
                    "id": {
                      "title": "ID",
                      "type": "string",
                      "description": "The identifier for the line of business under which this order falls."
                    },
                    "name": {
                      "title": "Name",
                      "type": "string",
                      "description": "The name of the line of business under which this order falls."
                    }
                  },
                  "description": "The line of business under which an order falls."
                },
                "referenceNumbers": {
                  "title": "Reference Numbers",
                  "type": "array",
                  "items": {
                    "title": "Reference Number",
                    "type": "object",
                    "properties": {
                      "referenceNumber": {
                        "title": "Reference Number",
                        "type": "string",
                        "description": "The value of the reference number"
                      },
                      "referenceNumberType": {
                        "title": "Reference Number Type",
                        "type": "string",
                        "description": "The type of the reference number (e.g. BOL, PO #, etc.)."
                      },
                      "referenceNumberTypeDescription": {
                        "title": "Reference Number Type Description",
                        "type": "string",
                        "description": "The human-readable description of the reference number (e.g. Bill-of-Landing)."
                      }
                    },
                    "description": "A reference number provided for an order."
                  },
                  "description": "Order-level reference numbers."
                },
                "requestType": {
                  "type": "string",
                  "description": "Request type."
                },
                "trackingNumber": {
                  "title": "Tracking Number",
                  "type": "string",
                  "description": "Auto-generated tracking number."
                },
                "orderCreationDate": {
                  "title": "Order Creation Date",
                  "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"
                    }
                  ],
                  "description": "Date on which order was created."
                },
                "targetDate": {
                  "title": "Target Date",
                  "allOf": [
                    {
                      "title": "Date With Optional Time",
                      "required": [
                        "date"
                      ],
                      "type": "object",
                      "properties": {
                        "date": {
                          "allOf": [
                            {
                              "title": "Full Date",
                              "type": "string",
                              "description": "As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
                              "format": "date"
                            }
                          ],
                          "description": "The date portion of the date-time."
                        },
                        "time": {
                          "allOf": [
                            {
                              "title": "Full Time",
                              "pattern": "^\\d\\d:\\d\\d:\\d\\d(\\.\\d+)?([Zz]|[+-]\\d\\d:\\d\\d)$",
                              "type": "string",
                              "description": "As defined by `full-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
                              "example": "01:23:45.6789+01:23"
                            }
                          ],
                          "description": "The optional time portion of the date-time."
                        }
                      },
                      "description": "A date that may also have a timezone-qualified time attached."
                    }
                  ],
                  "description": "Target date."
                },
                "scheduledDeliveryDate": {
                  "title": "Scheduled Delivery Date",
                  "allOf": [
                    {
                      "title": "Appointment",
                      "type": "object",
                      "properties": {
                        "appointmentBegin": {
                          "title": "Appointment Begin",
                          "allOf": [
                            {
                              "title": "Date With Optional Time",
                              "required": [
                                "date"
                              ],
                              "type": "object",
                              "properties": {
                                "date": {
                                  "allOf": [
                                    {
                                      "title": "Full Date",
                                      "type": "string",
                                      "description": "As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
                                      "format": "date"
                                    }
                                  ],
                                  "description": "The date portion of the date-time."
                                },
                                "time": {
                                  "allOf": [
                                    {
                                      "title": "Full Time",
                                      "pattern": "^\\d\\d:\\d\\d:\\d\\d(\\.\\d+)?([Zz]|[+-]\\d\\d:\\d\\d)$",
                                      "type": "string",
                                      "description": "As defined by `full-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
                                      "example": "01:23:45.6789+01:23"
                                    }
                                  ],
                                  "description": "The optional time portion of the date-time."
                                }
                              },
                              "description": "A date that may also have a timezone-qualified time attached."
                            }
                          ],
                          "description": "The beginning time of the appointment window."
                        },
                        "appointmentEnd": {
                          "title": "Appointment End",
                          "allOf": [
                            {
                              "title": "Date With Optional Time",
                              "required": [
                                "date"
                              ],
                              "type": "object",
                              "properties": {
                                "date": {
                                  "allOf": [
                                    {
                                      "title": "Full Date",
                                      "type": "string",
                                      "description": "As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
                                      "format": "date"
                                    }
                                  ],
                                  "description": "The date portion of the date-time."
                                },
                                "time": {
                                  "allOf": [
                                    {
                                      "title": "Full Time",
                                      "pattern": "^\\d\\d:\\d\\d:\\d\\d(\\.\\d+)?([Zz]|[+-]\\d\\d:\\d\\d)$",
                                      "type": "string",
                                      "description": "As defined by `full-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
                                      "example": "01:23:45.6789+01:23"
                                    }
                                  ],
                                  "description": "The optional time portion of the date-time."
                                }
                              },
                              "description": "A date that may also have a timezone-qualified time attached."
                            }
                          ],
                          "description": "The end time of the appointment window."
                        }
                      },
                      "description": "An appointment related to a stop."
                    }
                  ],
                  "description": "Date on which the delivery will occur."
                },
                "location": {
                  "title": "Location",
                  "type": "object",
                  "allOf": [
                    {
                      "title": "Location",
                      "type": "object",
                      "properties": {
                        "address": {
                          "title": "Address",
                          "allOf": [
                            {
                              "title": "Address",
                              "type": "object",
                              "properties": {
                                "addressLine1": {
                                  "type": "string",
                                  "description": "Street address line 1."
                                },
                                "addressLine2": {
                                  "type": "string",
                                  "description": "Street address line 2."
                                },
                                "city": {
                                  "type": "string",
                                  "description": "City"
                                },
                                "postalCode": {
                                  "type": "string",
                                  "description": "Postal Code"
                                },
                                "state": {
                                  "type": "string",
                                  "description": "State"
                                }
                              },
                              "description": "Address associated to stops within this order."
                            }
                          ],
                          "description": "The address at which the location exists."
                        },
                        "id": {
                          "title": "Id",
                          "type": "string",
                          "description": "The identifier for the location."
                        },
                        "partyName": {
                          "title": "Party Name",
                          "type": "string",
                          "description": "The name of the party at the described location."
                        }
                      },
                      "description": "A place that at which a stop is located."
                    }
                  ],
                  "description": "Location details for this particular stop."
                },
                "contact": {
                  "title": "Contact",
                  "type": "object",
                  "properties": {
                    "contactId": {
                      "title": "Contact Id",
                      "type": "string",
                      "description": "The unique identifier for a stop contact on an order."
                    },
                    "contactName": {
                      "title": "Contact Name",
                      "type": "string",
                      "description": "The name of the contact to be made."
                    },
                    "firstName": {
                      "title": "First Name",
                      "type": "string",
                      "description": "The first name of the person to be contacted."
                    },
                    "lastName": {
                      "title": "Last Name",
                      "type": "string",
                      "description": "The last name of the person to be contacted."
                    },
                    "phoneNumbers": {
                      "title": "Phone Numbers",
                      "type": "array",
                      "items": {
                        "title": "Phone Number",
                        "required": [
                          "number"
                        ],
                        "type": "object",
                        "properties": {
                          "number": {
                            "title": "Number",
                            "type": "string",
                            "description": "Phone number"
                          },
                          "extension": {
                            "title": "Extension",
                            "type": "string",
                            "description": "Extension number"
                          },
                          "phoneNumberType": {
                            "title": "Phone Number Type",
                            "type": "string",
                            "description": "The type of phone number being described.",
                            "example": "Home"
                          },
                          "allowsSms": {
                            "title": "Allow SMS",
                            "type": "boolean",
                            "description": "Indicates whether notifications about the order should be sent via SMS"
                          }
                        },
                        "description": "Contact details for a phone number"
                      },
                      "description": "A list of phone numbers associated with this contact."
                    },
                    "emailAddresses": {
                      "title": "Email Addresses",
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "A list of email addresses associated with this contact."
                    }
                  },
                  "description": "A contact associated with a stop."
                },
                "consumerClassificationType": {
                  "type": "string",
                  "description": "Consumer classification for an order."
                },
                "comments": {
                  "title": "Comments",
                  "type": "array",
                  "items": {
                    "title": "Comment",
                    "type": "object",
                    "properties": {
                      "commentText": {
                        "title": "Comment Text",
                        "type": "string",
                        "description": "The body text of the comment."
                      },
                      "commentTypeCode": {
                        "title": "Comment Type Code",
                        "type": "string",
                        "description": "Comment type code."
                      },
                      "creation": {
                        "title": "Creation Information",
                        "type": "object",
                        "properties": {
                          "createdAt": {
                            "title": "Created At",
                            "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"
                              }
                            ],
                            "description": "The date and time at which the current entity was created."
                          },
                          "createdBy": {
                            "title": "Created By",
                            "type": "string",
                            "description": "The user ID of the user who created the current entity."
                          },
                          "creatingProgram": {
                            "title": "Creating Program",
                            "type": "string",
                            "description": "The program or client used to create the current entity."
                          }
                        },
                        "description": "Creation audit information."
                      },
                      "lastUpdate": {
                        "title": "Update Information",
                        "type": "object",
                        "properties": {
                          "updatedAt": {
                            "title": "Updated At",
                            "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"
                              }
                            ],
                            "description": "The date at which the last update was performed."
                          },
                          "updatedBy": {
                            "title": "Last Updated By",
                            "type": "string",
                            "description": "The user who performed the last updated against the current entity."
                          },
                          "updatingProgram": {
                            "title": "Updating Program",
                            "type": "string",
                            "description": "The name of the program or client that performed the last update."
                          }
                        },
                        "description": "Last update audit information."
                      },
                      "id": {
                        "title": "ID",
                        "type": "string",
                        "description": "The identifier for a comment."
                      }
                    },
                    "description": "A comment associated with an order."
                  },
                  "description": "The comments related to the stop."
                }
              },
              "description": "Top level summary information for the order."
            }
          },
          "description": "Order details required to display a Final Mile Order."
        }
      ]
    }
  },
  "description": "Response containing details for the requested order."
}

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"
            }
          ],
          "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"
            }
          ],
          "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."
}

403 Forbidden

The server understood the request but refuses to authorize it. See RFC 7231, Section 6.5.3.

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"
            }
          ],
          "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."
}

404 Not Found

No matching order found with the orderId.

Representations

{
  "title": "Resource not found",
  "status": 404,
  "detail": "Order not found",
  "instance": "urn:uuid:d3ba38b8-54c1-4d20-b9f8-c6b81bb1913b",
  "dateTime": "2019-10-22T19:30:05.1120000+00:00",
  "issues": [
    {
      "description": "Order already Cancelled",
      "field": "orderId",
      "location": "path",
      "value": 397160
    }
  ]
}
{
  "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"
            }
          ],
          "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"
            }
          ],
          "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.jbhunt.com/order-details-api/order-details/{orderId}"
-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}");

            var uri = "https://api.jbhunt.com/order-details-api/order-details/{orderId}?" + 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.jbhunt.com/order-details-api/order-details/{orderId}");


            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
        };
      
        $.ajax({
            url: "https://api.jbhunt.com/order-details-api/order-details/{orderId}?" + $.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.jbhunt.com/order-details-api/order-details/{orderId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    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.jbhunt.com/order-details-api/order-details/{orderId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Api-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('api.jbhunt.com')
    conn.request("GET", "/order-details-api/order-details/{orderId}?%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({
})

try:
    conn = http.client.HTTPSConnection('api.jbhunt.com')
    conn.request("GET", "/order-details-api/order-details/{orderId}?%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.jbhunt.com/order-details-api/order-details/{orderId}')


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