Operation Page Breadcrumb

Developer APIs Order Search API

Order Search API

Search Orders

Search orders across various fields.

Try it

Request

Request URL

Request parameters

  • (optional)

    The ordinal of the page to be retrieved.

  • (optional)

    The page size of the result to be returned. Will default to 100 if no value is specified.

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • 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

{
  "searchCriteria": {
    "trackingNumber": "string",
    "shipmentIdentification": "string",
    "tradingPartner": "string",
    "accounts": [
      {
        "accountRole": "Bill To",
        "accountName": "string"
      }
    ],
    "status": "string",
    "locations": [
      {
        "locationType": "Code",
        "locationValue": "72745"
      }
    ],
    "appointment": {
      "stopReason": "Delivery",
      "appointmentStatus": "Scheduled"
    },
    "pickupDate": {},
    "deliveryDate": {},
    "orderCreateDate": {},
    "originMarketingArea": "string",
    "destinationMarketingArea": "string",
    "referenceNumbers": [
      {
        "referenceNumberType": "string",
        "referenceNumberValue": "string"
      }
    ],
    "loadNumber": "string",
    "solicitorContact": "string",
    "fleetCode": "string",
    "orderOwnerId": "string",
    "orderCreatorId": "string",
    "orderCreationChannel": "string",
    "orderType": "Standard",
    "secondaryOrderType": "Will Call",
    "orderAcceptanceMethod": "Manual Select",
    "reasonForOrderStatus": "string",
    "serviceLevel": "Standard",
    "deliveryServiceType": "Home",
    "internationalServices": "Shore to Door",
    "shipmentRequirements": "High Value",
    "operationServices": "Team Driving",
    "externalAppointmentWeblink": "string"
  },
  "optionalColumns": [
    "string"
  ]
}
{
  "title": "Order Search Request",
  "type": "object",
  "properties": {
    "searchCriteria": {
      "title": "Search Criteria",
      "allOf": [
        {
          "title": "Order Search Criteria",
          "properties": {
            "trackingNumber": {
              "title": "Tracking Number",
              "type": "string",
              "description": "Auto-generated tracking number."
            },
            "shipmentIdentification": {
              "title": "Shipment Identification",
              "type": "string",
              "description": "The shipment identifier on an order."
            },
            "tradingPartner": {
              "title": "Trading Partner",
              "type": "string",
              "description": "The trading partner who submitted the order."
            },
            "accounts": {
              "title": "Accounts",
              "type": "array",
              "items": {
                "title": "Account Search Criterion",
                "type": "object",
                "properties": {
                  "accountRole": {
                    "title": "Account Role",
                    "type": "string",
                    "description": "The role an account plays on this particular order.",
                    "example": "Bill To"
                  },
                  "accountName": {
                    "title": "Account Name",
                    "type": "string",
                    "description": "The name of the account to be sought."
                  }
                },
                "description": "An account to check for matching orders."
              },
              "description": "A list of accounts to search for orders."
            },
            "status": {
              "title": "Status",
              "type": "string",
              "description": "The status expected of orders to return."
            },
            "locations": {
              "title": "Locations",
              "type": "array",
              "items": {
                "title": "Location Search Criterion",
                "type": "object",
                "properties": {
                  "locationType": {
                    "title": "Location Type",
                    "type": "string",
                    "description": "The type of location-like value to search.",
                    "example": "Code"
                  },
                  "locationValue": {
                    "title": "Location Value",
                    "type": "string",
                    "description": "The value of the location.",
                    "example": "72745"
                  }
                },
                "description": "A location to use as a filter criterion for orders."
              },
              "description": "Locations to filter search results against."
            },
            "appointment": {
              "title": "Appointment",
              "allOf": [
                {
                  "title": "Appointment Search Criterion",
                  "type": "object",
                  "properties": {
                    "stopReason": {
                      "title": "Stop Reason",
                      "type": "string",
                      "description": "The reason for making a stop, i.e. pickup or delivery.",
                      "example": "Delivery"
                    },
                    "appointmentStatus": {
                      "title": "Appointment Status",
                      "type": "string",
                      "description": "A value indicating the status of an appointment.",
                      "example": "Scheduled"
                    }
                  },
                  "description": "Criterion describing an appointment search."
                }
              ],
              "description": "Search criterion describing appointment statuses."
            },
            "pickupDate": {
              "title": "Pick-Up 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": "Search by day on which the initial pickup will occur."
            },
            "deliveryDate": {
              "title": "Delivery 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": "Search by day on which the delivery will occur."
            },
            "orderCreateDate": {
              "title": "Order Create 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": "Search by day on which the order was created."
            },
            "originMarketingArea": {
              "title": "Origin Marketing Area",
              "type": "string",
              "description": "The marketing area in which the first stop is located."
            },
            "destinationMarketingArea": {
              "title": "Destination Marketing Area",
              "type": "string",
              "description": "The marketing area in which the final stop is located."
            },
            "referenceNumbers": {
              "title": "Reference Numbers",
              "type": "array",
              "items": {
                "title": "Reference Number Search Criterion",
                "type": "object",
                "properties": {
                  "referenceNumberType": {
                    "title": "Reference Number Type",
                    "type": "string",
                    "description": "The type of the reference number to search."
                  },
                  "referenceNumberValue": {
                    "title": "Reference Number Value",
                    "type": "string",
                    "description": "The value of the reference number to be searched."
                  }
                },
                "description": "A search number filter criterion."
              },
              "description": "Search for orders with the given reference numbers."
            },
            "loadNumber": {
              "title": "Load Number",
              "type": "string",
              "description": "Search for orders on a given load number."
            },
            "solicitorContact": {
              "title": "Solicitor Contact",
              "type": "string",
              "description": "The name of the solicitor contact for the order."
            },
            "fleetCode": {
              "title": "Fleet Code",
              "type": "string",
              "description": "The code of the fleet expected to move this order."
            },
            "orderOwnerId": {
              "title": "Order Owner ID",
              "type": "string",
              "description": "The identifier of the order owner."
            },
            "orderCreatorId": {
              "title": "Order Creator ID",
              "type": "string",
              "description": "The identifier of the order creator."
            },
            "orderCreationChannel": {
              "title": "Order Creation Channel",
              "type": "string",
              "description": "The channel by which the order was submitted."
            },
            "orderType": {
              "title": "Order Type",
              "type": "string",
              "description": "The type of order to be sought.",
              "example": "Standard"
            },
            "secondaryOrderType": {
              "title": "Secondary Order type",
              "type": "string",
              "description": "The secondary type of the order to be sought.",
              "example": "Will Call"
            },
            "orderAcceptanceMethod": {
              "title": "Order Acceptance Method",
              "type": "string",
              "description": "Whether the order was manually or automatically accepted.",
              "example": "Manual Select"
            },
            "reasonForOrderStatus": {
              "title": "Reason For Order Status",
              "type": "string",
              "description": "The identifier for the order status reason"
            },
            "serviceLevel": {
              "title": "Service Level",
              "type": "string",
              "description": "The service level applied to the order. Most commonly used for Intermodal orders.",
              "example": "Standard"
            },
            "deliveryServiceType": {
              "title": "Delivery Service Type",
              "type": "string",
              "description": "The delivery service type for the order.",
              "example": "Home"
            },
            "internationalServices": {
              "title": "International Services",
              "type": "string",
              "description": "The international services on the order.",
              "example": "Shore to Door"
            },
            "shipmentRequirements": {
              "title": "Shipment Requirements",
              "type": "string",
              "description": "Tags indicating requirements on the order.",
              "example": "High Value"
            },
            "operationServices": {
              "title": "Operation Services",
              "type": "string",
              "description": "The operational services on the order.",
              "example": "Team Driving"
            },
            "externalAppointmentWeblink": {
              "title": "External Appointment Weblink",
              "type": "string",
              "description": "One-time use GUID used to allow an end-consumer to negotiate an appointment."
            }
          },
          "description": "The criteria to be applied when filtering orders."
        }
      ],
      "description": "The filters to be applied when searching for orders."
    },
    "optionalColumns": {
      "title": "Optional Columns",
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of optional columns that should be returned by the request."
    }
  },
  "description": "A request describing an order search."
}

Responses

200 OK

Order search request completed.

Representations

{
  "totalResultCount": 0,
  "data": [
    {
      "orderId": "string",
      "orderNumber": "string",
      "trackingNumber": "string",
      "billToAccount": {
        "name": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "cityAlias": "string",
          "country": "string",
          "latitude": 0.0,
          "longitude": 0.0,
          "postalCode": "string",
          "state": "string"
        }
      },
      "origin": {
        "aliasCode": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "cityAlias": "string",
          "country": "string",
          "latitude": 0.0,
          "longitude": 0.0,
          "postalCode": "string",
          "state": "string"
        },
        "id": "string",
        "partyName": "string"
      },
      "destination": {
        "aliasCode": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "cityAlias": "string",
          "country": "string",
          "latitude": 0.0,
          "longitude": 0.0,
          "postalCode": "string",
          "state": "string"
        },
        "id": "string",
        "partyName": "string"
      },
      "pickupWindow": {
        "startDate": {
          "date": {},
          "time": {}
        },
        "endDate": {
          "date": {},
          "time": {}
        }
      },
      "deliveryWindow": {
        "startDate": {
          "date": {},
          "time": {}
        },
        "endDate": {
          "date": {},
          "time": {}
        }
      }
    }
  ]
}
{
  "title": "Order Search Response",
  "type": "object",
  "properties": {
    "totalResultCount": {
      "title": "Total Number of Results",
      "type": "integer",
      "description": "The total number of results across all pages of the search."
    },
    "data": {
      "title": "Data",
      "type": "array",
      "items": {
        "title": "Order Search Result",
        "type": "object",
        "properties": {
          "orderId": {
            "title": "Order ID",
            "type": "string",
            "description": "The identifier of the order."
          },
          "orderNumber": {
            "title": "Order Number",
            "type": "string",
            "description": "The user-visible number of the order."
          },
          "trackingNumber": {
            "title": "Tracking Number",
            "type": "string",
            "description": "The auto-generated tracking number generated at order capture time."
          },
          "billToAccount": {
            "title": "Bill-To Account",
            "type": "object",
            "properties": {
              "name": {
                "title": "Name",
                "type": "string",
                "description": "The name of the account"
              },
              "address": {
                "title": "Address",
                "allOf": [
                  {
                    "title": "Address",
                    "type": "object",
                    "properties": {
                      "addressLine1": {
                        "title": "Address Line 1",
                        "type": "string",
                        "description": "The first address line of the address."
                      },
                      "addressLine2": {
                        "title": "Address Line 2",
                        "type": "string",
                        "description": "The second address line of the address."
                      },
                      "city": {
                        "title": "City",
                        "type": "string",
                        "description": "The city at which the location exists."
                      },
                      "cityAlias": {
                        "title": "City Alias Code",
                        "type": "string",
                        "description": "The smart code alias of the city."
                      },
                      "country": {
                        "title": "Country",
                        "type": "string",
                        "description": "The code of the country at which the location exists."
                      },
                      "latitude": {
                        "title": "Latitude",
                        "type": "number",
                        "description": "The latitude of the location, if known.",
                        "format": "double"
                      },
                      "longitude": {
                        "title": "Longitude",
                        "type": "number",
                        "description": "The longitude of the location, if known.",
                        "format": "double"
                      },
                      "postalCode": {
                        "title": "Postal Code",
                        "type": "string",
                        "description": "The postal code of the address."
                      },
                      "state": {
                        "title": "State/Province",
                        "type": "string",
                        "description": "The state or province at which the location exists."
                      }
                    },
                    "description": "The address at which a location exists."
                  }
                ],
                "description": "The address for the account."
              }
            },
            "description": "The account to which the order will be billed."
          },
          "origin": {
            "title": "Origin",
            "type": "object",
            "allOf": [
              {
                "title": "Location",
                "type": "object",
                "properties": {
                  "aliasCode": {
                    "title": "Alias Code",
                    "type": "string",
                    "description": "The location alias (a.k.a. the customer code) of this location."
                  },
                  "address": {
                    "title": "Address",
                    "allOf": [
                      {
                        "title": "Address",
                        "type": "object",
                        "properties": {
                          "addressLine1": {
                            "title": "Address Line 1",
                            "type": "string",
                            "description": "The first address line of the address."
                          },
                          "addressLine2": {
                            "title": "Address Line 2",
                            "type": "string",
                            "description": "The second address line of the address."
                          },
                          "city": {
                            "title": "City",
                            "type": "string",
                            "description": "The city at which the location exists."
                          },
                          "cityAlias": {
                            "title": "City Alias Code",
                            "type": "string",
                            "description": "The smart code alias of the city."
                          },
                          "country": {
                            "title": "Country",
                            "type": "string",
                            "description": "The code of the country at which the location exists."
                          },
                          "latitude": {
                            "title": "Latitude",
                            "type": "number",
                            "description": "The latitude of the location, if known.",
                            "format": "double"
                          },
                          "longitude": {
                            "title": "Longitude",
                            "type": "number",
                            "description": "The longitude of the location, if known.",
                            "format": "double"
                          },
                          "postalCode": {
                            "title": "Postal Code",
                            "type": "string",
                            "description": "The postal code of the address."
                          },
                          "state": {
                            "title": "State/Province",
                            "type": "string",
                            "description": "The state or province at which the location exists."
                          }
                        },
                        "description": "The address at which a location exists."
                      }
                    ],
                    "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": "The location of the first stop on the order."
          },
          "destination": {
            "title": "Destination",
            "type": "object",
            "allOf": [
              {
                "title": "Location",
                "type": "object",
                "properties": {
                  "aliasCode": {
                    "title": "Alias Code",
                    "type": "string",
                    "description": "The location alias (a.k.a. the customer code) of this location."
                  },
                  "address": {
                    "title": "Address",
                    "allOf": [
                      {
                        "title": "Address",
                        "type": "object",
                        "properties": {
                          "addressLine1": {
                            "title": "Address Line 1",
                            "type": "string",
                            "description": "The first address line of the address."
                          },
                          "addressLine2": {
                            "title": "Address Line 2",
                            "type": "string",
                            "description": "The second address line of the address."
                          },
                          "city": {
                            "title": "City",
                            "type": "string",
                            "description": "The city at which the location exists."
                          },
                          "cityAlias": {
                            "title": "City Alias Code",
                            "type": "string",
                            "description": "The smart code alias of the city."
                          },
                          "country": {
                            "title": "Country",
                            "type": "string",
                            "description": "The code of the country at which the location exists."
                          },
                          "latitude": {
                            "title": "Latitude",
                            "type": "number",
                            "description": "The latitude of the location, if known.",
                            "format": "double"
                          },
                          "longitude": {
                            "title": "Longitude",
                            "type": "number",
                            "description": "The longitude of the location, if known.",
                            "format": "double"
                          },
                          "postalCode": {
                            "title": "Postal Code",
                            "type": "string",
                            "description": "The postal code of the address."
                          },
                          "state": {
                            "title": "State/Province",
                            "type": "string",
                            "description": "The state or province at which the location exists."
                          }
                        },
                        "description": "The address at which a location exists."
                      }
                    ],
                    "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": "The location of the last stop on the order."
          },
          "pickupWindow": {
            "title": "Pick Up",
            "type": "object",
            "properties": {
              "startDate": {
                "title": "Start 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": "The beginning of the pickup window."
              },
              "endDate": {
                "title": "End 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": "The end of the pickup window."
              }
            },
            "description": "The pickup window for the order."
          },
          "deliveryWindow": {
            "title": "Delivery Window",
            "type": "object",
            "properties": {
              "startDate": {
                "title": "Start 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": "The beginning of the delivery window."
              },
              "endDate": {
                "title": "End 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": "The end of the delivery window."
              }
            },
            "description": "The delivery window for the order."
          }
        },
        "description": "A single order search result. Additional columns may be returned depending on search options."
      },
      "description": "The set of data, accounting for search criteria and paging options."
    }
  },
  "description": "A response containing order data to be returned."
}

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

Code samples

@ECHO OFF

curl -v -X POST "https://api.jbhunt.com/orders-search-api/orders/search?pageIndex=0&pageSize=100"
-H "Content-Type: application/json"
-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["pageIndex"] = "0";
            queryString["pageSize"] = "100";
            var uri = "https://api.jbhunt.com/orders-search-api/orders/search?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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/orders-search-api/orders/search");

            builder.setParameter("pageIndex", "0");
            builder.setParameter("pageSize", "100");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            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
            "pageIndex": "0",
            "pageSize": "100",
        };
      
        $.ajax({
            url: "https://api.jbhunt.com/orders-search-api/orders/search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Api-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "POST",
            // 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/orders-search-api/orders/search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"pageIndex=0",
                         @"pageSize=100",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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/orders-search-api/orders/search');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'pageIndex' => '0',
    'pageSize' => '100',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// 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
    'Content-Type': 'application/json',
    'Api-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'pageIndex': '0',
    'pageSize': '100',
})

try:
    conn = httplib.HTTPSConnection('api.jbhunt.com')
    conn.request("POST", "/orders-search-api/orders/search?%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
    'Content-Type': 'application/json',
    'Api-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'pageIndex': '0',
    'pageSize': '100',
})

try:
    conn = http.client.HTTPSConnection('api.jbhunt.com')
    conn.request("POST", "/orders-search-api/orders/search?%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/orders-search-api/orders/search')

query = URI.encode_www_form({
    # Request parameters
    'pageIndex' => '0',
    'pageSize' => '100'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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