Operation Page Breadcrumb

Developer APIs Orders Capture API

Orders Capture API

Create Final Mile Order

Create an order on the J. B. Hunt 360 platform that corresponds to the characteristics of a Final Mile order.

Try it

Request

Request URL

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

A Final Mile order request.

{
  "orders": [
    {
      "account": {
        "name": "ACME"
      },
      "networkFlows": {
        "name": "FULL RDC"
      },
      "orderSubtype": "ORDER",
      "orderType": "FinalMileOrderCreationRequest",
      "referenceNumbers": [
        {
          "referenceNumberValue": "Z819233",
          "referenceType": "PRO NBR"
        },
        {
          "referenceNumberValue": "ASDF123",
          "referenceType": "PrimaryRefNumber",
          "lineItems": [
            {
              "manufacturerName": "ACME Corporation",
              "modelNumber": "JPU-1",
              "description": "Jet-Propelled Unicycle",
              "serialNumber": "13944ABDE991F",
              "quantity": {
                "unitOfMeasure": "Pieces",
                "value": 1
              },
              "weight": {
                "unitOfMeasure": "Pounds",
                "value": 50
              },
              "length": {
                "unitOfMeasure": "Inches",
                "value": 80.5
              },
              "width": {
                "unitOfMeasure": "Inches",
                "value": 71.5
              },
              "height": {
                "unitOfMeasure": "Inches",
                "value": 6.75
              },
              "childLineItems": [
                {
                  "itemServiceType": {
                    "description": "ASSEMBLY"
                  },
                  "quantity": 1
                },
                {
                  "itemServiceType": {
                    "description": "UNCRATE"
                  },
                  "quantity": 1
                }
              ]
            },
            {
              "manufacturerName": "ACME Corporation",
              "modelNumber": "JPU-1",
              "description": "Jet-Propelled Unicycle",
              "serialNumber": "ZZ391",
              "quantity": {
                "unitOfMeasure": "Pieces",
                "value": 1
              },
              "weight": {
                "unitOfMeasure": "Pounds",
                "value": 50
              },
              "length": {
                "unitOfMeasure": "Inches",
                "value": 80.5
              },
              "width": {
                "unitOfMeasure": "Inches",
                "value": 71.5
              },
              "height": {
                "unitOfMeasure": "Inches",
                "value": 6.75
              }
            }
          ]
        }
      ],
      "stops": [
        {
          "location": {
            "address": {
              "city": "Chicago",
              "name": "JBH Chicago",
              "postalCode": "60632",
              "state": "IL",
              "streetAddress1": "9931 W 49th St",
              "streetAddress2": ""
            }
          },
          "sequenceNumber": 1,
          "stopReason": "Pickup"
        },
        {
          "contacts": [
            {
              "emailAddress": "fake_email@fakeemail.com",
              "firstName": "JB",
              "lastName": "Hunt",
              "phoneNumber": {
                "phoneNumberValue": "8005555555"
              }
            }
          ],
          "location": {
            "address": {
              "city": "Lowell",
              "name": "JB Hunt Corporate",
              "postalCode": "72745",
              "state": "AR",
              "streetAddress1": "615 JB Hunt Corporate Dr",
              "streetAddress2": ""
            }
          },
          "sequenceNumber": 2,
          "stopReason": "Delivery"
        }
      ]
    }
  ]
}

Responses

201 Created

The order was received and will be processed asynchronously.

Response headers

Representations

{
  "createdOrderIdentifiers": [
    {
      "orderId": "373c1eb2-527b-496a-9fd5-36e338f52985",
      "customerReferenceNumber": 0.0,
      "trackingNumber": "ZYN3321"
    },
    {
      "orderId": "978d7b8f-8bf6-4983-83d2-e60fa8fea312",
      "customerReferenceNumber": "388883333",
      "trackingNumber": "ABC221"
    }
  ],
  "errors": [
    {
      "dateTime": "2019-10-22T19:30:05.112+00:00",
      "issues": [
        {
          "description": "Primary Reference Number found was not unique.",
          "field": "orders.referenceNumbers.referenceNumberValue",
          "location": "body",
          "value": "TEST_ORDER_123"
        }
      ]
    },
    {
      "dateTime": "2019-10-22T19:30:05.112+00:00",
      "issues": [
        {
          "description": "Primary Reference Number found was not unique.",
          "field": "orders.referenceNumbers.referenceNumberValue",
          "location": "body",
          "value": "TEST_ORDER_456"
        }
      ]
    }
  ]
}
{
  "title": "Create Order Response",
  "type": "object",
  "properties": {
    "createdOrderIdentifiers": {
      "title": "Created Order Identifiers",
      "type": "array",
      "items": {
        "title": "Order Identifier",
        "type": "object",
        "properties": {
          "orderId": {
            "title": "Order ID",
            "type": "string",
            "description": "Order ID"
          },
          "customerReferenceNumber": {
            "title": "Customer Reference Number",
            "type": "string",
            "description": "Customer reference number provided with the order."
          },
          "trackingNumber": {
            "title": "Tracking Number",
            "type": "string",
            "description": "The auto-generated tracking number associated with this order."
          }
        },
        "description": "Order identifiers generated as part of order creation."
      },
      "description": "A list of identifiers for orders created."
    },
    "errors": {
      "title": "Errors",
      "type": "array",
      "items": {
        "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."
      },
      "description": "A list of problems encountered while attempting to create orders"
    }
  },
  "description": "Contains details about the created order.",
  "example": {
    "createdOrderIdentifiers": [
      {
        "orderId": "373c1eb2-527b-496a-9fd5-36e338f52985",
        "customerReferenceNumber": 0.0,
        "trackingNumber": "ZYN3321"
      },
      {
        "orderId": "978d7b8f-8bf6-4983-83d2-e60fa8fea312",
        "customerReferenceNumber": "388883333",
        "trackingNumber": "ABC221"
      }
    ],
    "errors": [
      {
        "dateTime": "2019-10-22T19:30:05.112Z",
        "issues": [
          {
            "description": "Primary Reference Number found was not unique.",
            "field": "orders.referenceNumbers.referenceNumberValue",
            "location": "body",
            "value": "TEST_ORDER_123"
          }
        ]
      },
      {
        "dateTime": "2019-10-22T19:30:05.112Z",
        "issues": [
          {
            "description": "Primary Reference Number found was not unique.",
            "field": "orders.referenceNumbers.referenceNumberValue",
            "location": "body",
            "value": "TEST_ORDER_456"
          }
        ]
      }
    ]
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.jbhunt.com/orders-api-v2/v2/orders/create-final-mile-order"
-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}");

            var uri = "https://api.jbhunt.com/orders-api-v2/v2/orders/create-final-mile-order?" + 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-api-v2/v2/orders/create-final-mile-order");


            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
        };
      
        $.ajax({
            url: "https://api.jbhunt.com/orders-api-v2/v2/orders/create-final-mile-order?" + $.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-api-v2/v2/orders/create-final-mile-order";
    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:@"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-api-v2/v2/orders/create-final-mile-order');
$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
);

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

try:
    conn = httplib.HTTPSConnection('api.jbhunt.com')
    conn.request("POST", "/orders-api-v2/v2/orders/create-final-mile-order?%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({
})

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


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