NAV Navbar
Shell HTTP JavaScript Node.JS Ruby Python Java Go

Rose Rocket Platform REST API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Platform REST API lets you integrate with Rose Rocket applications using simple HTTP methods, in JSON formats, making this an ideal API for developing mobile applications or external clients.

A sample implementation has been provided and can be access by clicking on this sample link.

Base URLs:

Terms of service Email: Support

Authentication

Scope Scope Description
orders manage orders
customers manage customers
legs manage legs
manifests manage manifests
emanifests manage emanifests
invoices manage invoice
users manage users
bills manage bills
services manage services
partner_portal manage partner portal
connectors_orgs manage connector orgs

order

Manage orders

searchOrders

Code samples

# You can also use wget
curl -X GET https://platform.roserocket.com/v1/orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://platform.roserocket.com/v1/orders HTTP/1.1
Host: platform.roserocket.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/orders',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://platform.roserocket.com/v1/orders',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://platform.roserocket.com/v1/orders', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://platform.roserocket.com/v1/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders

Search orders

Parameters

Name In Type Required Description
created_start_at query string(date-time) false Date range (start)
created_end_at query string(date-time) false Date range (end)
search_term query string false Search term
external_id query string false External ID to filter by
in_external_ids query array[string] false External ID’s to filter by
sort query string false Sort Results
offset query integer false Pagination offset
limit query integer false Pagination limit

Example responses

200 Response

{
  "orders": [
    {
      "id": "string",
      "sequence_id": 0,
      "external_id": "string",
      "public_id": "string",
      "tender_id": "string",
      "customer": {
        "id": "string",
        "external_id": "string",
        "short_code": "string"
      },
      "origin": {
        "address_book_id": "string",
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "destination": {
        "address_book_id": "string",
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing": {
        "address_book_id": "string",
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "status": "new",
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "pickup_appt_start_at": "2019-08-22T22:09:11Z",
      "pickup_appt_end_at": "2019-08-22T22:09:11Z",
      "delivery_start_at": "2019-08-22T22:09:11Z",
      "delivery_end_at": "2019-08-22T22:09:11Z",
      "delivery_appt_start_at": "2019-08-22T22:09:11Z",
      "delivery_appt_end_at": "2019-08-22T22:09:11Z",
      "dim_type": "ltl",
      "default_measurement_unit_id": "string",
      "default_weight_unit_id": "string",
      "commodities": [
        {
          "id": "string",
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ]
    }
  ],
  "offset": 0,
  "limit": 0,
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» orders [Order] false none [Customer’s order]
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none
» offset integer false none none
» limit integer false none none
» total integer false none none

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

createOrder

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders

Create new customer’s order

Body parameter

{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
body body Order true Order object

Example responses

200 Response

{
  "customer": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» customer Order false none Customer’s order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

createProblem

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "title": "string",
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/problems", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/{orderID}/problems

Create problem on order event

Body parameter

{
  "title": "string",
  "description": "string"
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body OrderProblemRequest true Create problem request object

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  },
  "problem": {
    "id": "string",
    "created_at": "2019-08-22T22:09:11Z",
    "updated_at": "2019-08-22T22:09:11Z",
    "order_id": "string",
    "type": "string",
    "title": "string",
    "description": "string",
    "created_by": "string",
    "resolved_by": "string",
    "resolved_at": "2019-08-22T22:09:11Z"
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order Order false none Customer’s order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none
» problem OrderProblem false none Order Problem
»» id string(uuid) false none none
»» created_at string(date-time) false none The timestamp for the creation of the problem
»» updated_at string(date-time) false none The timestamp for the last update of the problem
»» order_id string false none Related order ID
»» type string false none Type of problem
»» title string false none title for problem
»» description string false none description of problem
»» created_by string(uuid) false none The id of the user who created the problem
»» resolved_by string(uuid) false none The id of the user who resolved the problem
»» resolved_at string(date-time) false none The timestamp for the resolution of the problem

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

upsertByExternalID

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/upsert", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/{orderID}/upsert

Create/Update order by External ID

Body parameter

{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body Order true Order object

Example responses

200 Response

{
  "customer": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» customer Order false none Customer’s order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

reviseOrder

Code samples

# You can also use wget
curl -X PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /customers/{customerID}/orders/{orderID}/revise

Revise Order

Body parameter

{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body Order true Order object

Example responses

200 Response

{
  "id": "string",
  "sequence_id": 0,
  "external_id": "string",
  "public_id": "string",
  "tender_id": "string",
  "customer": {
    "id": "string",
    "external_id": "string",
    "short_code": "string"
  },
  "origin": {
    "address_book_id": "string",
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_id": "string",
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_id": "string",
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "status": "new",
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "id": "string",
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Order
400 Bad Request Bad request ApiError

markInTransit

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit HTTP/1.1
Host: platform.roserocket.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/mark_in_transit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/{orderID}/mark_in_transit

Mark order in transit

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.

Example responses

200 Response

{
  "id": "string",
  "sequence_id": 0,
  "external_id": "string",
  "public_id": "string",
  "tender_id": "string",
  "customer": {
    "id": "string",
    "external_id": "string",
    "short_code": "string"
  },
  "origin": {
    "address_book_id": "string",
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_id": "string",
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_id": "string",
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "status": "new",
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "id": "string",
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Order
400 Bad Request Bad request ApiError

bulkCreateOrder

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "orders": [
    {
      "external_id": "string",
      "customer": {},
      "origin": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "destination": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "pickup_appt_start_at": "2019-08-22T22:09:11Z",
      "pickup_appt_end_at": "2019-08-22T22:09:11Z",
      "delivery_start_at": "2019-08-22T22:09:11Z",
      "delivery_end_at": "2019-08-22T22:09:11Z",
      "delivery_appt_start_at": "2019-08-22T22:09:11Z",
      "delivery_appt_end_at": "2019-08-22T22:09:11Z",
      "dim_type": "ltl",
      "default_measurement_unit_id": "string",
      "default_weight_unit_id": "string",
      "commodities": [
        {
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/bulk_create

Bulk create orders for a given customer.

Body parameter

{
  "orders": [
    {
      "external_id": "string",
      "customer": {},
      "origin": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "destination": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "pickup_appt_start_at": "2019-08-22T22:09:11Z",
      "pickup_appt_end_at": "2019-08-22T22:09:11Z",
      "delivery_start_at": "2019-08-22T22:09:11Z",
      "delivery_end_at": "2019-08-22T22:09:11Z",
      "delivery_appt_start_at": "2019-08-22T22:09:11Z",
      "delivery_appt_end_at": "2019-08-22T22:09:11Z",
      "dim_type": "ltl",
      "default_measurement_unit_id": "string",
      "default_weight_unit_id": "string",
      "commodities": [
        {
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ]
    }
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
body body bulkCreateOrderBody true Bulk create request object
» orders body [Order] false [Customer’s order]
»» id body string(uuid) false Auto generated system ID
»» sequence_id body integer false Auto generated sequence ID per customer
»» external_id body string false External ID for mapping the order to an external system. This field value can be null
»» public_id body string false Auto generated human readable ID
»» tender_id body string false Tender ID that is related to the order. This field can be null
»» customer body OrderCustomer false Customer
»»» id body string(uuid) false Auto generated customer id
»»» external_id body string false Customer external id. This field value can be null
»»» short_code body string false Customer’s short code
»» origin body OrderAddress true Order address
»»» address_book_id body string(uuid) false Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id body string(uuid) false Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name body string false Organization name
»»» contact_name body string false Contact name
»»» address_1 body string false Address line 1
»»» address_2 body string false Address line 2
»»» suite body string false Suite number
»»» city body string false City
»»» state body string false State / Province
»»» country body string false Country (2 letter ISO)
»»» postal body string false Postal / Zip code
»»» phone body string false Phone number
»»» phone_ext body string false Phone extension
»»» email body string false Email
»»» fax body string false Fax
»»» latitude body number(float) false Coordinate (latitude). This field value can be null
»»» longitude body number(float) false Coordinate (longitude). This field value can be null
»»» bus_hours_start_at body string(date-time) false Business hours range (start). This field value can be null
»»» bus_hours_end_at body string(date-time) false Business hours range (end). This field value can be null
»» destination body OrderAddress true Order address
»» billing body OrderAddress true Order address
»» status body string false Order Status
»» billing_option body string false Billing Option
»» notes body string false Notes that will appear on BOL
»» po_num body string false Purchase order numbers (if multiple use comma separated values)
»» tender_num body string false Tender number
»» ref_num body string false Reference number
»» custom_broker body string false Custom broker information
»» declared_value body number(float) false Declared value
»» declared_value_currency body string false Declared value currency
»» pickup_start_at body string(date-time) false Pickup time range (start)
»» pickup_end_at body string(date-time) false Pickup time range (end)
»» pickup_appt_start_at body string(date-time) false Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at body string(date-time) false Pickup appointment time range (end). This field value can be null
»» delivery_start_at body string(date-time) false Expected delivery time range (start). This field value can be null
»» delivery_end_at body string(date-time) false Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at body string(date-time) false Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at body string(date-time) false Delivery appointment time range (end). This field value can be null
»» dim_type body string false Dimension type
»» default_measurement_unit_id body string false Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id body string false Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities body [Commodity] false Commodities items
»»» id body string(uuid) false Auto generated commodity id
»»» measurement_unit body string false Measurement unit
»»» weight_unit body string false Weight unit
»»» freight_class body string false Freight class
»»» commodity_type body string false Commodity type
»»» commodity_type_other body string false If commodity type is set to other, then this field must have value
»»» description body string false Description of the commodity
»»» feet body number(float) false Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume body number(float) false Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length body number(float) false Length of the commodity
»»» width body number(float) false Width of the commodity
»»» height body number(float) false Height of the commodity
»»» weight body number(float) false Weight of the commodity
»»» nmfc body string false NMFC number
»»» is_stackable body boolean false Is this commodity can be stacked?
»»» quantity body integer false Quantity of the commodity
»»» pieces body integer false Total number of pieces. This field value can be null
»»» sku body string false SKU number
»» accessorials body [string] false none

Enumerated Values

Parameter Value
»» status new
»» status saved
»» status cancelled
»» status quoting
»» status quoted
»» status no-quote
»» status spot-quote-requested
»» status pending-dispatch
»» status dispatched
»» status in-transit
»» status delivered
»» status archived
»» status invoice-created
»» status invoice-sent
»» status invoice-paid
»» status claim
»» status draft-quick-quote
»» status quick-quoting
»» status quick-quoted
»» status no-quick-quote
»» status spot-qq-requested
»» status pickup-request
»» status rejected
»» billing_option prepaid
»» billing_option collect
»» billing_option thirdparty
»» declared_value_currency cad
»» declared_value_currency usd
»» dim_type ltl
»» dim_type ftl
»» dim_type volume
»»» measurement_unit inch
»»» measurement_unit cm
»»» weight_unit lb
»»» weight_unit kg
»»» commodity_type skid
»»» commodity_type other

Example responses

200 Response

{
  "job_id": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation BulkOrderCreateResponse
400 Bad Request Bad request ApiError

bulkCreateOrderCustomerAgnostic

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/orders/bulk_create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/orders/bulk_create HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/orders/bulk_create',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "orders": [
    {
      "order": {
        "external_id": "string",
        "customer": {},
        "origin": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "destination": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "billing": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "billing_option": "prepaid",
        "notes": "string",
        "po_num": "string",
        "tender_num": "string",
        "ref_num": "string",
        "custom_broker": "string",
        "declared_value": 0,
        "declared_value_currency": "cad",
        "pickup_start_at": "2019-08-22T22:09:11Z",
        "pickup_end_at": "2019-08-22T22:09:11Z",
        "pickup_appt_start_at": "2019-08-22T22:09:11Z",
        "pickup_appt_end_at": "2019-08-22T22:09:11Z",
        "delivery_start_at": "2019-08-22T22:09:11Z",
        "delivery_end_at": "2019-08-22T22:09:11Z",
        "delivery_appt_start_at": "2019-08-22T22:09:11Z",
        "delivery_appt_end_at": "2019-08-22T22:09:11Z",
        "dim_type": "ltl",
        "default_measurement_unit_id": "string",
        "default_weight_unit_id": "string",
        "commodities": [
          {
            "measurement_unit": "inch",
            "weight_unit": "lb",
            "freight_class": "string",
            "commodity_type": "skid",
            "commodity_type_other": "string",
            "description": "string",
            "feet": 0,
            "volume": 0,
            "length": 0,
            "width": 0,
            "height": 0,
            "weight": 0,
            "nmfc": "string",
            "is_stackable": true,
            "quantity": 0,
            "pieces": 0,
            "sku": "string"
          }
        ],
        "accessorials": [
          "string"
        ]
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/orders/bulk_create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/orders/bulk_create',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/orders/bulk_create', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/orders/bulk_create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/orders/bulk_create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/bulk_create

Bulk create orders for several customers.

Body parameter

{
  "orders": [
    {
      "order": {
        "external_id": "string",
        "customer": {},
        "origin": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "destination": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "billing": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "billing_option": "prepaid",
        "notes": "string",
        "po_num": "string",
        "tender_num": "string",
        "ref_num": "string",
        "custom_broker": "string",
        "declared_value": 0,
        "declared_value_currency": "cad",
        "pickup_start_at": "2019-08-22T22:09:11Z",
        "pickup_end_at": "2019-08-22T22:09:11Z",
        "pickup_appt_start_at": "2019-08-22T22:09:11Z",
        "pickup_appt_end_at": "2019-08-22T22:09:11Z",
        "delivery_start_at": "2019-08-22T22:09:11Z",
        "delivery_end_at": "2019-08-22T22:09:11Z",
        "delivery_appt_start_at": "2019-08-22T22:09:11Z",
        "delivery_appt_end_at": "2019-08-22T22:09:11Z",
        "dim_type": "ltl",
        "default_measurement_unit_id": "string",
        "default_weight_unit_id": "string",
        "commodities": [
          {
            "measurement_unit": "inch",
            "weight_unit": "lb",
            "freight_class": "string",
            "commodity_type": "skid",
            "commodity_type_other": "string",
            "description": "string",
            "feet": 0,
            "volume": 0,
            "length": 0,
            "width": 0,
            "height": 0,
            "weight": 0,
            "nmfc": "string",
            "is_stackable": true,
            "quantity": 0,
            "pieces": 0,
            "sku": "string"
          }
        ],
        "accessorials": [
          "string"
        ]
      }
    }
  ]
}

Parameters

Name In Type Required Description
body body object true Bulk create request object
» orders body [object] false none
»» order body Order false Customer’s order
»»» id body string(uuid) false Auto generated system ID
»»» sequence_id body integer false Auto generated sequence ID per customer
»»» external_id body string false External ID for mapping the order to an external system. This field value can be null
»»» public_id body string false Auto generated human readable ID
»»» tender_id body string false Tender ID that is related to the order. This field can be null
»»» customer body OrderCustomer false Customer
»»»» id body string(uuid) false Auto generated customer id
»»»» external_id body string false Customer external id. This field value can be null
»»»» short_code body string false Customer’s short code
»»» origin body OrderAddress true Order address
»»»» address_book_id body string(uuid) false Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»»» address_book_external_id body string(uuid) false Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»»» org_name body string false Organization name
»»»» contact_name body string false Contact name
»»»» address_1 body string false Address line 1
»»»» address_2 body string false Address line 2
»»»» suite body string false Suite number
»»»» city body string false City
»»»» state body string false State / Province
»»»» country body string false Country (2 letter ISO)
»»»» postal body string false Postal / Zip code
»»»» phone body string false Phone number
»»»» phone_ext body string false Phone extension
»»»» email body string false Email
»»»» fax body string false Fax
»»»» latitude body number(float) false Coordinate (latitude). This field value can be null
»»»» longitude body number(float) false Coordinate (longitude). This field value can be null
»»»» bus_hours_start_at body string(date-time) false Business hours range (start). This field value can be null
»»»» bus_hours_end_at body string(date-time) false Business hours range (end). This field value can be null
»»» destination body OrderAddress true Order address
»»» billing body OrderAddress true Order address
»»» status body string false Order Status
»»» billing_option body string false Billing Option
»»» notes body string false Notes that will appear on BOL
»»» po_num body string false Purchase order numbers (if multiple use comma separated values)
»»» tender_num body string false Tender number
»»» ref_num body string false Reference number
»»» custom_broker body string false Custom broker information
»»» declared_value body number(float) false Declared value
»»» declared_value_currency body string false Declared value currency
»»» pickup_start_at body string(date-time) false Pickup time range (start)
»»» pickup_end_at body string(date-time) false Pickup time range (end)
»»» pickup_appt_start_at body string(date-time) false Pickup appointment time range (start). This field value can be null
»»» pickup_appt_end_at body string(date-time) false Pickup appointment time range (end). This field value can be null
»»» delivery_start_at body string(date-time) false Expected delivery time range (start). This field value can be null
»»» delivery_end_at body string(date-time) false Expected delivery time range (end). This field value can be null
»»» delivery_appt_start_at body string(date-time) false Delivery appointment time range (start). This field value can be null
»»» delivery_appt_end_at body string(date-time) false Delivery appointment time range (end). This field value can be null
»»» dim_type body string false Dimension type
»»» default_measurement_unit_id body string false Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»»» default_weight_unit_id body string false Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»»» commodities body [Commodity] false Commodities items
»»»» id body string(uuid) false Auto generated commodity id
»»»» measurement_unit body string false Measurement unit
»»»» weight_unit body string false Weight unit
»»»» freight_class body string false Freight class
»»»» commodity_type body string false Commodity type
»»»» commodity_type_other body string false If commodity type is set to other, then this field must have value
»»»» description body string false Description of the commodity
»»»» feet body number(float) false Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»»» volume body number(float) false Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»»» length body number(float) false Length of the commodity
»»»» width body number(float) false Width of the commodity
»»»» height body number(float) false Height of the commodity
»»»» weight body number(float) false Weight of the commodity
»»»» nmfc body string false NMFC number
»»»» is_stackable body boolean false Is this commodity can be stacked?
»»»» quantity body integer false Quantity of the commodity
»»»» pieces body integer false Total number of pieces. This field value can be null
»»»» sku body string false SKU number
»»» accessorials body [string] false none

Enumerated Values

Parameter Value
»»» status new
»»» status saved
»»» status cancelled
»»» status quoting
»»» status quoted
»»» status no-quote
»»» status spot-quote-requested
»»» status pending-dispatch
»»» status dispatched
»»» status in-transit
»»» status delivered
»»» status archived
»»» status invoice-created
»»» status invoice-sent
»»» status invoice-paid
»»» status claim
»»» status draft-quick-quote
»»» status quick-quoting
»»» status quick-quoted
»»» status no-quick-quote
»»» status spot-qq-requested
»»» status pickup-request
»»» status rejected
»»» billing_option prepaid
»»» billing_option collect
»»» billing_option thirdparty
»»» declared_value_currency cad
»»» declared_value_currency usd
»»» dim_type ltl
»»» dim_type ftl
»»» dim_type volume
»»»» measurement_unit inch
»»»» measurement_unit cm
»»»» weight_unit lb
»»»» weight_unit kg
»»»» commodity_type skid
»»»» commodity_type other

Example responses

200 Response

{
  "job_id": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation BulkOrderCreateResponse
400 Bad Request Bad request ApiError

Create Multistop Order

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "external_id": "string",
  "customer": {},
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/multistop", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/multistop

Create a multistop order

Body parameter

{
  "external_id": "string",
  "customer": {},
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad"
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
body body MultistopOrder true Multistop Order object

Example responses

200 Response

{
  "customer": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad"
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» customer MultistopOrder false none Customer’s multistop order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» billing OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd

Bulk Create Multistop Orders

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "orders": [
    {
      "order": {
        "external_id": "string",
        "customer": {},
        "billing": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "billing_option": "prepaid",
        "notes": "string",
        "po_num": "string",
        "tender_num": "string",
        "ref_num": "string",
        "custom_broker": "string",
        "declared_value": 0,
        "declared_value_currency": "cad"
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/bulk_multistop", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/bulk_multistop

Create a multistop order in bulk

Body parameter

{
  "orders": [
    {
      "order": {
        "external_id": "string",
        "customer": {},
        "billing": {
          "address_book_external_id": "string",
          "org_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "suite": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "phone": "string",
          "phone_ext": "string",
          "email": "string",
          "fax": "string",
          "latitude": 0,
          "longitude": 0,
          "bus_hours_start_at": "2019-08-22T22:09:11Z",
          "bus_hours_end_at": "2019-08-22T22:09:11Z"
        },
        "billing_option": "prepaid",
        "notes": "string",
        "po_num": "string",
        "tender_num": "string",
        "ref_num": "string",
        "custom_broker": "string",
        "declared_value": 0,
        "declared_value_currency": "cad"
      }
    }
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
body body object false Multistop Orders
» orders body [object] false none
»» order body MultistopOrder false Customer’s multistop order
»»» id body string(uuid) false Auto generated system ID
»»» sequence_id body integer false Auto generated sequence ID per customer
»»» external_id body string false External ID for mapping the order to an external system. This field value can be null
»»» public_id body string false Auto generated human readable ID
»»» customer body OrderCustomer false Customer
»»»» id body string(uuid) false Auto generated customer id
»»»» external_id body string false Customer external id. This field value can be null
»»»» short_code body string false Customer’s short code
»»» billing body OrderAddress true Order address
»»»» address_book_id body string(uuid) false Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»»» address_book_external_id body string(uuid) false Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»»» org_name body string false Organization name
»»»» contact_name body string false Contact name
»»»» address_1 body string false Address line 1
»»»» address_2 body string false Address line 2
»»»» suite body string false Suite number
»»»» city body string false City
»»»» state body string false State / Province
»»»» country body string false Country (2 letter ISO)
»»»» postal body string false Postal / Zip code
»»»» phone body string false Phone number
»»»» phone_ext body string false Phone extension
»»»» email body string false Email
»»»» fax body string false Fax
»»»» latitude body number(float) false Coordinate (latitude). This field value can be null
»»»» longitude body number(float) false Coordinate (longitude). This field value can be null
»»»» bus_hours_start_at body string(date-time) false Business hours range (start). This field value can be null
»»»» bus_hours_end_at body string(date-time) false Business hours range (end). This field value can be null
»»» status body string false Order Status
»»» billing_option body string false Billing Option
»»» notes body string false Notes that will appear on BOL
»»» po_num body string false Purchase order numbers (if multiple use comma separated values)
»»» tender_num body string false Tender number
»»» ref_num body string false Reference number
»»» custom_broker body string false Custom broker information
»»» declared_value body number(float) false Declared value
»»» declared_value_currency body string false Declared value currency

Enumerated Values

Parameter Value
»»» status new
»»» status saved
»»» status cancelled
»»» status quoting
»»» status quoted
»»» status no-quote
»»» status spot-quote-requested
»»» status pending-dispatch
»»» status dispatched
»»» status in-transit
»»» status delivered
»»» status archived
»»» status invoice-created
»»» status invoice-sent
»»» status invoice-paid
»»» status claim
»»» status draft-quick-quote
»»» status quick-quoting
»»» status quick-quoted
»»» status no-quick-quote
»»» status spot-qq-requested
»»» status pickup-request
»»» status rejected
»»» billing_option prepaid
»»» billing_option collect
»»» billing_option thirdparty
»»» declared_value_currency cad
»»» declared_value_currency usd

Example responses

200 Response

{
  "customer": {
    "response": [
      {
        "order_id": "string",
        "stop_ids": "string",
        "status": "string",
        "error": "string"
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» customer BulkMultiStopOrders false none Bulk response for multistop orders
»» response [object] false none none
»»» order_id string false none Order ID of multistop order
»»» stop_ids string false none none
»»» status string false none none
»»» error string false none none

consolidateExistingOrder

Code samples

# You can also use wget
curl -X PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate HTTP/1.1
Host: platform.roserocket.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/consolidate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /customers/{customerID}/orders/{orderID}/consolidate

Create a multistop order with stop from an existing order.

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234

Example responses

200 Response

{
  "job_id": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation BulkOrderCreateResponse
400 Bad Request Bad request ApiError

bulkCreateQuotes

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "quotes": [
    {
      "order_id": "string",
      "currency": "cad",
      "customer_service_id": "string",
      "is_expired": true,
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "est_delivery_start_at": "2019-08-22T22:09:11Z",
      "est_delivery_end_at": "2019-08-22T22:09:11Z",
      "notes": "string",
      "error_message": "string",
      "status": "quote-success",
      "charges": {
        "freight": 0,
        "fuel": 0,
        "accessorials": 0,
        "total": 0
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/{orderID}/quotes/create_bulk

Bulk create quotes for a given customer.

Body parameter

{
  "quotes": [
    {
      "order_id": "string",
      "currency": "cad",
      "customer_service_id": "string",
      "is_expired": true,
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "est_delivery_start_at": "2019-08-22T22:09:11Z",
      "est_delivery_end_at": "2019-08-22T22:09:11Z",
      "notes": "string",
      "error_message": "string",
      "status": "quote-success",
      "charges": {
        "freight": 0,
        "fuel": 0,
        "accessorials": 0,
        "total": 0
      }
    }
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body object true Bulk create quote request object
» quotes body [Quote] false [Quote]
»» id body string(uuid) false Auto generated quote id
»» order_id body string(uuid) false Order id this quote is associated to
»» currency body string false Declared value currency
»» customer_service_id body string(uuid) false Customer’s service of this quote generated from
»» is_expired body boolean false Is this quote has expired?
»» pickup_start_at body string(date-time) false Pickup time range (start)
»» pickup_end_at body string(date-time) false Pickup time range (end)
»» est_delivery_start_at body string(date-time) false Estimated delivery time range (start). This field value can be null
»» est_delivery_end_at body string(date-time) false Estimated delivery time range (end). This field value can be null
»» notes body string false Notes
»» error_message body string false Error message
»» status body string false Status
»» charges body object false none
»»» type body string(uuid) false Type
»»» quote_id body string(uuid) false Quote id this item is associated to
»»» description body string false Description
»»» quantity body integer false Unit quantity
»»» unit_price body integer false Unit price
»»» total body integer false Total
»» freight body number(float) false Freight charge
»» fuel body number(float) false Fuel charge
»» accessorials body number(float) false Accessorials charge
»» total body number(float) false Total charge

Enumerated Values

Parameter Value
»» currency cad
»» currency usd
»» status quote-success
»» status quote-pending
»» status quote-rejected
»» status quote-error
»» status dispatch-success
»» status dispatch-pending
»» status dispatch-rejected
»» status dispatch-error
»»» type freight
»»» type freight-cwt
»»» type freight-cwt-min
»»» type freight-spot
»»» type freight-pallets
»»» type freight-pallets-min
»»» type accessorial
»»» type fuel
»»» type misc

Example responses

200 Response

{
  "quotes": [
    {
      "id": "string",
      "order_id": "string",
      "currency": "cad",
      "customer_service_id": "string",
      "is_expired": true,
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "est_delivery_start_at": "2019-08-22T22:09:11Z",
      "est_delivery_end_at": "2019-08-22T22:09:11Z",
      "notes": "string",
      "error_message": "string",
      "status": "quote-success",
      "charges": {
        "freight": 0,
        "fuel": 0,
        "accessorials": 0,
        "total": 0
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» quotes [Quote] false none [Quote]
»» id string(uuid) false read-only Auto generated quote id
»» order_id string(uuid) false none Order id this quote is associated to
»» currency string false none Declared value currency
»» customer_service_id string(uuid) false none Customer’s service of this quote generated from
»» is_expired boolean false none Is this quote has expired?
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» est_delivery_start_at string(date-time) false none Estimated delivery time range (start). This field value can be null
»» est_delivery_end_at string(date-time) false none Estimated delivery time range (end). This field value can be null
»» notes string false none Notes
»» error_message string false none Error message
»» status string false none Status
»» charges object false none none
»»» type string(uuid) false none Type
»»» quote_id string(uuid) false read-only Quote id this item is associated to
»»» description string false none Description
»»» quantity integer false none Unit quantity
»»» unit_price integer false none Unit price
»»» total integer false none Total
»» freight number(float) false none Freight charge
»» fuel number(float) false none Fuel charge
»» accessorials number(float) false none Accessorials charge
»» total number(float) false none Total charge

Enumerated Values

Property Value
currency cad
currency usd
status quote-success
status quote-pending
status quote-rejected
status quote-error
status dispatch-success
status dispatch-pending
status dispatch-rejected
status dispatch-error
type freight
type freight-cwt
type freight-cwt-min
type freight-spot
type freight-pallets
type freight-pallets-min
type accessorial
type fuel
type misc

bulkCreateBookedOrder

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "orders": [
    {
      "external_id": "string",
      "customer": {},
      "origin": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "destination": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "pickup_appt_start_at": "2019-08-22T22:09:11Z",
      "pickup_appt_end_at": "2019-08-22T22:09:11Z",
      "delivery_start_at": "2019-08-22T22:09:11Z",
      "delivery_end_at": "2019-08-22T22:09:11Z",
      "delivery_appt_start_at": "2019-08-22T22:09:11Z",
      "delivery_appt_end_at": "2019-08-22T22:09:11Z",
      "dim_type": "ltl",
      "default_measurement_unit_id": "string",
      "default_weight_unit_id": "string",
      "commodities": [
        {
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/bulk_create_booked_order", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/bulk_create_booked_order

Bulk create booked orders for a given customer.

Body parameter

{
  "orders": [
    {
      "external_id": "string",
      "customer": {},
      "origin": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "destination": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing": {
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "pickup_appt_start_at": "2019-08-22T22:09:11Z",
      "pickup_appt_end_at": "2019-08-22T22:09:11Z",
      "delivery_start_at": "2019-08-22T22:09:11Z",
      "delivery_end_at": "2019-08-22T22:09:11Z",
      "delivery_appt_start_at": "2019-08-22T22:09:11Z",
      "delivery_appt_end_at": "2019-08-22T22:09:11Z",
      "dim_type": "ltl",
      "default_measurement_unit_id": "string",
      "default_weight_unit_id": "string",
      "commodities": [
        {
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ]
    }
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
body body bulkCreateOrderBody true Bulk create request object
» orders body [Order] false [Customer’s order]
»» id body string(uuid) false Auto generated system ID
»» sequence_id body integer false Auto generated sequence ID per customer
»» external_id body string false External ID for mapping the order to an external system. This field value can be null
»» public_id body string false Auto generated human readable ID
»» tender_id body string false Tender ID that is related to the order. This field can be null
»» customer body OrderCustomer false Customer
»»» id body string(uuid) false Auto generated customer id
»»» external_id body string false Customer external id. This field value can be null
»»» short_code body string false Customer’s short code
»» origin body OrderAddress true Order address
»»» address_book_id body string(uuid) false Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id body string(uuid) false Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name body string false Organization name
»»» contact_name body string false Contact name
»»» address_1 body string false Address line 1
»»» address_2 body string false Address line 2
»»» suite body string false Suite number
»»» city body string false City
»»» state body string false State / Province
»»» country body string false Country (2 letter ISO)
»»» postal body string false Postal / Zip code
»»» phone body string false Phone number
»»» phone_ext body string false Phone extension
»»» email body string false Email
»»» fax body string false Fax
»»» latitude body number(float) false Coordinate (latitude). This field value can be null
»»» longitude body number(float) false Coordinate (longitude). This field value can be null
»»» bus_hours_start_at body string(date-time) false Business hours range (start). This field value can be null
»»» bus_hours_end_at body string(date-time) false Business hours range (end). This field value can be null
»» destination body OrderAddress true Order address
»» billing body OrderAddress true Order address
»» status body string false Order Status
»» billing_option body string false Billing Option
»» notes body string false Notes that will appear on BOL
»» po_num body string false Purchase order numbers (if multiple use comma separated values)
»» tender_num body string false Tender number
»» ref_num body string false Reference number
»» custom_broker body string false Custom broker information
»» declared_value body number(float) false Declared value
»» declared_value_currency body string false Declared value currency
»» pickup_start_at body string(date-time) false Pickup time range (start)
»» pickup_end_at body string(date-time) false Pickup time range (end)
»» pickup_appt_start_at body string(date-time) false Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at body string(date-time) false Pickup appointment time range (end). This field value can be null
»» delivery_start_at body string(date-time) false Expected delivery time range (start). This field value can be null
»» delivery_end_at body string(date-time) false Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at body string(date-time) false Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at body string(date-time) false Delivery appointment time range (end). This field value can be null
»» dim_type body string false Dimension type
»» default_measurement_unit_id body string false Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id body string false Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities body [Commodity] false Commodities items
»»» id body string(uuid) false Auto generated commodity id
»»» measurement_unit body string false Measurement unit
»»» weight_unit body string false Weight unit
»»» freight_class body string false Freight class
»»» commodity_type body string false Commodity type
»»» commodity_type_other body string false If commodity type is set to other, then this field must have value
»»» description body string false Description of the commodity
»»» feet body number(float) false Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume body number(float) false Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length body number(float) false Length of the commodity
»»» width body number(float) false Width of the commodity
»»» height body number(float) false Height of the commodity
»»» weight body number(float) false Weight of the commodity
»»» nmfc body string false NMFC number
»»» is_stackable body boolean false Is this commodity can be stacked?
»»» quantity body integer false Quantity of the commodity
»»» pieces body integer false Total number of pieces. This field value can be null
»»» sku body string false SKU number
»» accessorials body [string] false none

Enumerated Values

Parameter Value
»» status new
»» status saved
»» status cancelled
»» status quoting
»» status quoted
»» status no-quote
»» status spot-quote-requested
»» status pending-dispatch
»» status dispatched
»» status in-transit
»» status delivered
»» status archived
»» status invoice-created
»» status invoice-sent
»» status invoice-paid
»» status claim
»» status draft-quick-quote
»» status quick-quoting
»» status quick-quoted
»» status no-quick-quote
»» status spot-qq-requested
»» status pickup-request
»» status rejected
»» billing_option prepaid
»» billing_option collect
»» billing_option thirdparty
»» declared_value_currency cad
»» declared_value_currency usd
»» dim_type ltl
»» dim_type ftl
»» dim_type volume
»»» measurement_unit inch
»»» measurement_unit cm
»»» weight_unit lb
»»» weight_unit kg
»»» commodity_type skid
»»» commodity_type other

Example responses

200 Response

{
  "job_id": "string",
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation BulkOrderCreateResponse
400 Bad Request Bad request ApiError

reviseOrderOriginByID

Code samples

# You can also use wget
curl -X PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "address": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_origin", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /customers/{customerID}/orders/{orderID}/revise_origin

Revise the origin of an order by ID

Body parameter

{
  "address": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  }
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body OrderAddressReviseRequest true Revise order address request object

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  },
  "legs": [
    {
      "id": "string",
      "sequence_id": 0,
      "version": 0,
      "external_id": "string",
      "public_id": "string",
      "order_id": "string",
      "manifest_id": "string",
      "origin_stop_id": "string",
      "destination_stop_id": "string",
      "origin": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "destination": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "status": "available",
      "origin_start_at": "2019-08-22T22:09:11Z",
      "origin_end_at": "2019-08-22T22:09:11Z",
      "origin_appt_start_at": "2019-08-22T22:09:11Z",
      "origin_appt_end_at": "2019-08-22T22:09:11Z",
      "destination_start_at": "2019-08-22T22:09:11Z",
      "destination_end_at": "2019-08-22T22:09:11Z",
      "destination_appt_start_at": "2019-08-22T22:09:11Z",
      "destination_appt_end_at": "2019-08-22T22:09:11Z",
      "commodities": [
        {
          "id": "string",
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ],
      "history": {
        "origin_arrived_at": "2019-08-22T22:09:11Z",
        "origin_in_at": "2019-08-22T22:09:11Z",
        "origin_pickedup_at": "2019-08-22T22:09:11Z",
        "origin_out_at": "2019-08-22T22:09:11Z",
        "destination_arrived_at": "2019-08-22T22:09:11Z",
        "destination_in_at": "2019-08-22T22:09:11Z",
        "destination_delivered_at": "2019-08-22T22:09:11Z",
        "destination_out_at": "2019-08-22T22:09:11Z"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation OrderAndLegsResponse
400 Bad Request Bad request ApiError

reviseOrderDestinationByID

Code samples

# You can also use wget
curl -X PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "address": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_destination", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /customers/{customerID}/orders/{orderID}/revise_destination

Revise the destination of an order by ID

Body parameter

{
  "address": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  }
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body OrderAddressReviseRequest true Revise order address request object

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  },
  "legs": [
    {
      "id": "string",
      "sequence_id": 0,
      "version": 0,
      "external_id": "string",
      "public_id": "string",
      "order_id": "string",
      "manifest_id": "string",
      "origin_stop_id": "string",
      "destination_stop_id": "string",
      "origin": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "destination": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "status": "available",
      "origin_start_at": "2019-08-22T22:09:11Z",
      "origin_end_at": "2019-08-22T22:09:11Z",
      "origin_appt_start_at": "2019-08-22T22:09:11Z",
      "origin_appt_end_at": "2019-08-22T22:09:11Z",
      "destination_start_at": "2019-08-22T22:09:11Z",
      "destination_end_at": "2019-08-22T22:09:11Z",
      "destination_appt_start_at": "2019-08-22T22:09:11Z",
      "destination_appt_end_at": "2019-08-22T22:09:11Z",
      "commodities": [
        {
          "id": "string",
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ],
      "history": {
        "origin_arrived_at": "2019-08-22T22:09:11Z",
        "origin_in_at": "2019-08-22T22:09:11Z",
        "origin_pickedup_at": "2019-08-22T22:09:11Z",
        "origin_out_at": "2019-08-22T22:09:11Z",
        "destination_arrived_at": "2019-08-22T22:09:11Z",
        "destination_in_at": "2019-08-22T22:09:11Z",
        "destination_delivered_at": "2019-08-22T22:09:11Z",
        "destination_out_at": "2019-08-22T22:09:11Z"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation OrderAndLegsResponse
400 Bad Request Bad request ApiError

reviseOrderCommoditiesByID

Code samples

# You can also use wget
curl -X PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/revise_commodities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /customers/{customerID}/orders/{orderID}/revise_commodities

Revise the commodities of an order by ID

Body parameter

{
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body CommodityReviseRequest true Revise order commodities request object

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  },
  "legs": [
    {
      "id": "string",
      "sequence_id": 0,
      "version": 0,
      "external_id": "string",
      "public_id": "string",
      "order_id": "string",
      "manifest_id": "string",
      "origin_stop_id": "string",
      "destination_stop_id": "string",
      "origin": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "destination": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "status": "available",
      "origin_start_at": "2019-08-22T22:09:11Z",
      "origin_end_at": "2019-08-22T22:09:11Z",
      "origin_appt_start_at": "2019-08-22T22:09:11Z",
      "origin_appt_end_at": "2019-08-22T22:09:11Z",
      "destination_start_at": "2019-08-22T22:09:11Z",
      "destination_end_at": "2019-08-22T22:09:11Z",
      "destination_appt_start_at": "2019-08-22T22:09:11Z",
      "destination_appt_end_at": "2019-08-22T22:09:11Z",
      "commodities": [
        {
          "id": "string",
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ],
      "history": {
        "origin_arrived_at": "2019-08-22T22:09:11Z",
        "origin_in_at": "2019-08-22T22:09:11Z",
        "origin_pickedup_at": "2019-08-22T22:09:11Z",
        "origin_out_at": "2019-08-22T22:09:11Z",
        "destination_arrived_at": "2019-08-22T22:09:11Z",
        "destination_in_at": "2019-08-22T22:09:11Z",
        "destination_delivered_at": "2019-08-22T22:09:11Z",
        "destination_out_at": "2019-08-22T22:09:11Z"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation OrderAndLegsResponse
400 Bad Request Bad request ApiError

getAuditHistory

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "internal_note": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/{orderID}/events/internal_notes

Create an order note

Body parameter

{
  "internal_note": "string"
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body InternalNote true Note Text

Example responses

200 Response

{
  "order_note": {
    "id": "string",
    "created_at": "2019-08-22T22:09:11Z",
    "updated_at": "2019-08-22T22:09:11Z",
    "user_id": "string",
    "order_id": "string",
    "data": {}
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order_note OrderAuditEvent false none An order audit event
»» id string(uuid) false none none
»» created_at string(date-time) false none The timestamp for the creation of the order file
»» updated_at string(date-time) false none The timestamp for the last update of the order file
»» user_id string(uuid) false none none
»» order_id string(uuid) false none none
»» data object false none none

GetAuditHistory

Code samples

# You can also use wget
curl -X GET https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes HTTP/1.1
Host: platform.roserocket.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/internal_notes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /customers/{customerID}/orders/{orderID}/events/internal_notes

Get an internal event by orderID

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.

Example responses

200 Response

{
  "order_audit_history": [
    {
      "id": "string",
      "created_at": "2019-08-22T22:09:11Z",
      "updated_at": "2019-08-22T22:09:11Z",
      "user_id": "string",
      "order_id": "string",
      "data": {}
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order_audit_history [OrderAuditEvent] false none [An order audit event]
»» id string(uuid) false none none
»» created_at string(date-time) false none The timestamp for the creation of the order file
»» updated_at string(date-time) false none The timestamp for the last update of the order file
»» user_id string(uuid) false none none
»» order_id string(uuid) false none none
»» data object false none none

createComment

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "comment": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/events/comments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/{orderID}/events/comments

Create comment on order event

Body parameter

{
  "comment": "string"
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body Comment true Create internal note request object

Example responses

200 Response

{
  "order_audit_history": [
    {
      "id": "string",
      "sequence_id": 0,
      "external_id": "string",
      "public_id": "string",
      "tender_id": "string",
      "customer": {
        "id": "string",
        "external_id": "string",
        "short_code": "string"
      },
      "origin": {
        "address_book_id": "string",
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "destination": {
        "address_book_id": "string",
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "billing": {
        "address_book_id": "string",
        "address_book_external_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0,
        "bus_hours_start_at": "2019-08-22T22:09:11Z",
        "bus_hours_end_at": "2019-08-22T22:09:11Z"
      },
      "status": "new",
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2019-08-22T22:09:11Z",
      "pickup_end_at": "2019-08-22T22:09:11Z",
      "pickup_appt_start_at": "2019-08-22T22:09:11Z",
      "pickup_appt_end_at": "2019-08-22T22:09:11Z",
      "delivery_start_at": "2019-08-22T22:09:11Z",
      "delivery_end_at": "2019-08-22T22:09:11Z",
      "delivery_appt_start_at": "2019-08-22T22:09:11Z",
      "delivery_appt_end_at": "2019-08-22T22:09:11Z",
      "dim_type": "ltl",
      "default_measurement_unit_id": "string",
      "default_weight_unit_id": "string",
      "commodities": [
        {
          "id": "string",
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order_audit_history [Order] false none [Customer’s order]
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

getOrderByID

Code samples

# You can also use wget
curl -X GET https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID} HTTP/1.1
Host: platform.roserocket.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /customers/{customerID}/orders/{orderID}

Get customer’s order by ID

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order Order false none Customer’s order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

updateOrderByID

Code samples

# You can also use wget
curl -X PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


PUT https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID} HTTP/1.1
Host: platform.roserocket.com
Content-Type: application/json
Accept: application/json


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /customers/{customerID}/orders/{orderID}

Update customer’s order by ID

Body parameter

{
  "external_id": "string",
  "customer": {},
  "origin": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "destination": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing": {
    "address_book_external_id": "string",
    "org_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "email": "string",
    "fax": "string",
    "latitude": 0,
    "longitude": 0,
    "bus_hours_start_at": "2019-08-22T22:09:11Z",
    "bus_hours_end_at": "2019-08-22T22:09:11Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2019-08-22T22:09:11Z",
  "pickup_end_at": "2019-08-22T22:09:11Z",
  "pickup_appt_start_at": "2019-08-22T22:09:11Z",
  "pickup_appt_end_at": "2019-08-22T22:09:11Z",
  "delivery_start_at": "2019-08-22T22:09:11Z",
  "delivery_end_at": "2019-08-22T22:09:11Z",
  "delivery_appt_start_at": "2019-08-22T22:09:11Z",
  "delivery_appt_end_at": "2019-08-22T22:09:11Z",
  "dim_type": "ltl",
  "default_measurement_unit_id": "string",
  "default_weight_unit_id": "string",
  "commodities": [
    {
      "measurement_unit": "inch",
      "weight_unit": "lb",
      "freight_class": "string",
      "commodity_type": "skid",
      "commodity_type_other": "string",
      "description": "string",
      "feet": 0,
      "volume": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "nmfc": "string",
      "is_stackable": true,
      "quantity": 0,
      "pieces": 0,
      "sku": "string"
    }
  ],
  "accessorials": [
    "string"
  ]
}

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.
body body Order true Order object

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order Order false none Customer’s order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

deleteOrderByID

Code samples

# You can also use wget
curl -X DELETE https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID} HTTP/1.1
Host: platform.roserocket.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /customers/{customerID}/orders/{orderID}

Delete customer’s order by ID

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order Order false none Customer’s order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet number(float) false none Total feet in length of the truck the commodity is occupying. This field must have value if order’s dimension type is set to ftl
»»» volume number(float) false none Total volume of the commodity item. This field must have value if order’s dimension type is set to volume
»»» length number(float) false none Length of the commodity
»»» width number(float) false none Width of the commodity
»»» height number(float) false none Height of the commodity
»»» weight number(float) false none Weight of the commodity
»»» nmfc string false none NMFC number
»»» is_stackable boolean false none Is this commodity can be stacked?
»»» quantity integer false none Quantity of the commodity
»»» pieces integer false none Total number of pieces. This field value can be null
»»» sku string false none SKU number
»» accessorials [string] false none none

Enumerated Values

Property Value
status new
status saved
status cancelled
status quoting
status quoted
status no-quote
status spot-quote-requested
status pending-dispatch
status dispatched
status in-transit
status delivered
status archived
status invoice-created
status invoice-sent
status invoice-paid
status claim
status draft-quick-quote
status quick-quoting
status quick-quoted
status no-quick-quote
status spot-qq-requested
status pickup-request
status rejected
billing_option prepaid
billing_option collect
billing_option thirdparty
declared_value_currency cad
declared_value_currency usd
dim_type ltl
dim_type ftl
dim_type volume
measurement_unit inch
measurement_unit cm
weight_unit lb
weight_unit kg
commodity_type skid
commodity_type other

book

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book HTTP/1.1
Host: platform.roserocket.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://platform.roserocket.com/v1/customers/{customerID}/orders/{orderID}/book", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /customers/{customerID}/orders/{orderID}/book

Book an existing Order

Parameters

Name In Type Required Description
customerID path string true ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer’s external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.
orderID path string(uuid) true ID of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order’s external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.

Example responses

200 Response

{
  "order": {
    "id": "string",
    "sequence_id": 0,
    "external_id": "string",
    "public_id": "string",
    "tender_id": "string",
    "customer": {
      "id": "string",
      "external_id": "string",
      "short_code": "string"
    },
    "origin": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "destination": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "billing": {
      "address_book_id": "string",
      "address_book_external_id": "string",
      "org_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "suite": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "phone": "string",
      "phone_ext": "string",
      "email": "string",
      "fax": "string",
      "latitude": 0,
      "longitude": 0,
      "bus_hours_start_at": "2019-08-22T22:09:11Z",
      "bus_hours_end_at": "2019-08-22T22:09:11Z"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "pickup_appt_start_at": "2019-08-22T22:09:11Z",
    "pickup_appt_end_at": "2019-08-22T22:09:11Z",
    "delivery_start_at": "2019-08-22T22:09:11Z",
    "delivery_end_at": "2019-08-22T22:09:11Z",
    "delivery_appt_start_at": "2019-08-22T22:09:11Z",
    "delivery_appt_end_at": "2019-08-22T22:09:11Z",
    "dim_type": "ltl",
    "default_measurement_unit_id": "string",
    "default_weight_unit_id": "string",
    "commodities": [
      {
        "id": "string",
        "measurement_unit": "inch",
        "weight_unit": "lb",
        "freight_class": "string",
        "commodity_type": "skid",
        "commodity_type_other": "string",
        "description": "string",
        "feet": 0,
        "volume": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "nmfc": "string",
        "is_stackable": true,
        "quantity": 0,
        "pieces": 0,
        "sku": "string"
      }
    ],
    "accessorials": [
      "string"
    ]
  },
  "quote": {
    "id": "string",
    "order_id": "string",
    "currency": "cad",
    "customer_service_id": "string",
    "is_expired": true,
    "pickup_start_at": "2019-08-22T22:09:11Z",
    "pickup_end_at": "2019-08-22T22:09:11Z",
    "est_delivery_start_at": "2019-08-22T22:09:11Z",
    "est_delivery_end_at": "2019-08-22T22:09:11Z",
    "notes": "string",
    "error_message": "string",
    "status": "quote-success",
    "charges": {
      "freight": 0,
      "fuel": 0,
      "accessorials": 0,
      "total": 0
    }
  },
  "legs": [
    {
      "id": "string",
      "sequence_id": 0,
      "version": 0,
      "external_id": "string",
      "public_id": "string",
      "order_id": "string",
      "manifest_id": "string",
      "origin_stop_id": "string",
      "destination_stop_id": "string",
      "origin": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "destination": {
        "terminal_id": "string",
        "org_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "suite": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string",
        "latitude": 0,
        "longitude": 0
      },
      "status": "available",
      "origin_start_at": "2019-08-22T22:09:11Z",
      "origin_end_at": "2019-08-22T22:09:11Z",
      "origin_appt_start_at": "2019-08-22T22:09:11Z",
      "origin_appt_end_at": "2019-08-22T22:09:11Z",
      "destination_start_at": "2019-08-22T22:09:11Z",
      "destination_end_at": "2019-08-22T22:09:11Z",
      "destination_appt_start_at": "2019-08-22T22:09:11Z",
      "destination_appt_end_at": "2019-08-22T22:09:11Z",
      "commodities": [
        {
          "id": "string",
          "measurement_unit": "inch",
          "weight_unit": "lb",
          "freight_class": "string",
          "commodity_type": "skid",
          "commodity_type_other": "string",
          "description": "string",
          "feet": 0,
          "volume": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "nmfc": "string",
          "is_stackable": true,
          "quantity": 0,
          "pieces": 0,
          "sku": "string"
        }
      ],
      "accessorials": [
        "string"
      ],
      "history": {
        "origin_arrived_at": "2019-08-22T22:09:11Z",
        "origin_in_at": "2019-08-22T22:09:11Z",
        "origin_pickedup_at": "2019-08-22T22:09:11Z",
        "origin_out_at": "2019-08-22T22:09:11Z",
        "destination_arrived_at": "2019-08-22T22:09:11Z",
        "destination_in_at": "2019-08-22T22:09:11Z",
        "destination_delivered_at": "2019-08-22T22:09:11Z",
        "destination_out_at": "2019-08-22T22:09:11Z"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Bad request ApiError

Response Schema

Status Code 200

Name Type Required Restrictions Description
» order Order false none Customer’s order
»» id string(uuid) false read-only Auto generated system ID
»» sequence_id integer false read-only Auto generated sequence ID per customer
»» external_id string false none External ID for mapping the order to an external system. This field value can be null
»» public_id string false read-only Auto generated human readable ID
»» tender_id string false read-only Tender ID that is related to the order. This field can be null
»» customer OrderCustomer false none Customer
»»» id string(uuid) false read-only Auto generated customer id
»»» external_id string false read-only Customer external id. This field value can be null
»»» short_code string false read-only Customer’s short code
»» origin OrderAddress true none Order address
»»» address_book_id string(uuid) false read-only Auto generated address book id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_id, you must leave address_book_external_id empty.
»»» address_book_external_id string(uuid) false none Address book external id. This field value can be null. Leave this field as null if you want to manually specify the address. If you want to populate the address using address_book_external_id, you must leave address_book_id empty.
»»» org_name string false none Organization name
»»» contact_name string false none Contact name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» suite string false none Suite number
»»» city string false none City
»»» state string false none State / Province
»»» country string false none Country (2 letter ISO)
»»» postal string false none Postal / Zip code
»»» phone string false none Phone number
»»» phone_ext string false none Phone extension
»»» email string false none Email
»»» fax string false none Fax
»»» latitude number(float) false none Coordinate (latitude). This field value can be null
»»» longitude number(float) false none Coordinate (longitude). This field value can be null
»»» bus_hours_start_at string(date-time) false none Business hours range (start). This field value can be null
»»» bus_hours_end_at string(date-time) false none Business hours range (end). This field value can be null
»» destination OrderAddress true none Order address
»» billing OrderAddress true none Order address
»» status string false read-only Order Status
»» billing_option string false none Billing Option
»» notes string false none Notes that will appear on BOL
»» po_num string false none Purchase order numbers (if multiple use comma separated values)
»» tender_num string false none Tender number
»» ref_num string false none Reference number
»» custom_broker string false none Custom broker information
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» pickup_start_at string(date-time) false none Pickup time range (start)
»» pickup_end_at string(date-time) false none Pickup time range (end)
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start). This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end). This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start). This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end). This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start). This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end). This field value can be null
»» dim_type string false none Dimension type
»» default_measurement_unit_id string false none Identifying ID for the default unit of measurement for this order. Can be ‘cm’ or ‘inch’
»» default_weight_unit_id string false none Identifying ID for the default unit of weight for this order. Can be ‘kg’ or ‘lb’
»» commodities [Commodity] false none Commodities items
»»» id string(uuid) false read-only Auto generated commodity id
»»» measurement_unit string false none Measurement unit
»»» weight_unit string false none Weight unit
»»» freight_class string false none Freight class
»»» commodity_type string false none Commodity type
»»» commodity_type_other string false none If commodity type is set to other, then this field must have value
»»» description string false none Description of the commodity
»»» feet numbe