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

Rose Rocket 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.

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
consolidated_bills manage consolidated bills
services manage services
partner_portal manage partner portal
connectors_orgs manage connector orgs
equipment manage equipment
bill_item_types manage bill_item_types
exchange_rates manage exchange_rates

Bill Item Types

Find Bill Item Types

Code samples

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


GET https://platform.roserocket.com/api/v1/bill_item_types 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/api/v1/bill_item_types',
  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/api/v1/bill_item_types',
{
  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/api/v1/bill_item_types',
  params: {
  }, headers: headers

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/bill_item_types");
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/api/v1/bill_item_types", data)
    req.Header = headers

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

GET /bill_item_types

Search bill_item_types

Search all bill_item_types of organization

Parameters

Name In Type Required Description
search_term query string false Search term
names query array[string] false Bill Item Type names to filter by
offset query integer false Pagination offset
limit query integer false Pagination limit

Example responses

200 Response

{
  "bill_item_types": [
    {
      "id": "string",
      "external_id": "string",
      "qb_external_id": "string",
      "name": "string",
      "class": "string",
      "org_id": "string",
      "created_at": "2021-09-16T18:11:26Z",
      "updated_at": "2021-09-16T18:11:26Z"
    }
  ],
  "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
» bill_item_types [BillItemType] false none [Represents a bill item type]
»» id string(uuid) false read-only Auto generated system ID
»» external_id string false none External ID representing the bill item type
»» qb_external_id string false none External ID representing the bill item type in quickbooks
»» name string false none The name of the bill item type
»» class string false none The class of the bill item type
»» org_id string(uuid) false none Id of the org to which the bill item type belongs to
»» created_at string(date-time) false none The time of the equipment type’s creation
»» updated_at string(date-time) false none The time of the equipment type’s last update
» offset integer false none none
» limit integer false none none
» total integer false none none

Bill

Find Bills

Code samples

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


GET https://platform.roserocket.com/api/v1/bills 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/api/v1/bills',
  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/api/v1/bills',
{
  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/api/v1/bills',
  params: {
  }, headers: headers

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/bills");
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/api/v1/bills", data)
    req.Header = headers

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

GET /bills

Search bills

Search all bills of organization

Parameters

Name In Type Required Description
in_manifest_ids query array[string] false Manifest ID’s to filter by
status_ids query array[string] false Status ID’s to filter by
created_start_at query string(date-time) false created_at date range (start)
created_end_at query string(date-time) false created_at date range (end)
update_start_at query string(date-time) false updated_at date range (start)
updated_end_at query string(date-time) false updated_at date range (end)
offset query integer false Pagination offset
limit query integer false Pagination limit

Enumerated Values

Parameter Value
status_ids draft
status_ids saved
status_ids sent
status_ids edited
status_ids paid

Example responses

200 Response

{
  "bills": [
    {
      "created_at": "2021-09-16T18:11:26Z",
      "updated_at": "2021-09-16T18:11:26Z",
      "id": "string",
      "created_by": "string",
      "org_id": "string",
      "status_id": "string",
      "currency_id": "string",
      "pay_term_id": "string",
      "master_trip_id": "string",
      "partner_carrier_id": "string",
      "full_id": "string",
      "external_id": "string",
      "qb_external_id": "string",
      "qb_error_msg": "string",
      "revision": 0,
      "bill_date": "2021-09-16T18:11:26Z",
      "due_date": "2021-09-16T18:11:26Z",
      "sent_at": "2021-09-16T18:11:26Z",
      "paid_at": "2021-09-16T18:11:26Z",
      "qb_exported_at": "2021-09-16T18:11:26Z",
      "send_to_email": "string",
      "cc_to_email": "string",
      "bill_to": {
        "company_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postal": "string",
        "country": "string"
      },
      "is_tax_on": true,
      "notes": "string",
      "remit_to": {
        "company_name": "string",
        "contact_name": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postal": "string",
        "country": "string"
      },
      "reference_number": "string",
      "sub_total_amount": 0,
      "tax_amount": 0,
      "total_amount": 0
    }
  ],
  "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
» bills [Bill] false none [Bill for an Order]
»» created_at string(date-time) false none The timestamp for the creation of the bill
»» updated_at string(date-time) false none The timestamp for the last update of the bill
»» id string(uuid) false none ID of the Bill
»» created_by string false none none
»» org_id string(uuid) false none ID of associated org
»» status_id string false none ID of Bill Status
»» currency_id string false none ID of currency
»» pay_term_id string false none ID of bill pay term
»» master_trip_id string(uuid) false none ID of master trip related to the bill
»» partner_carrier_id string(uuid) false none Id of the partner/carrier that corresponds to the bill
»» full_id string(uuid) false none Full ID associated with, and used to reference the Bill
»» external_id string false read-only Customer external id. This field value can be null
»» qb_external_id string false none The external identifier for the partner carrier in QBO
»» qb_error_msg string false none Error message for QBO
»» revision integer false none The revision number of the payment
»» bill_date string(date-time) false none Bill creation date
»» due_date string(date-time) false none Due date for bill payment
»» sent_at string(date-time) false none Date the bill was sent
»» paid_at string(date-time) false none Date the bill was paid
»» qb_exported_at string(date-time) false none Date invoice was exported to QB
»» send_to_email string false none The email of the recipient of the payment
»» cc_to_email string false none The email of the cc recipient of the payment
»» bill_to object false none none
»»» company_name string false none The company name of the billing party
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» is_tax_on boolean false none none
»» notes string false none Notes associated to the Bill
»» remit_to object false none none
»»» company_name string false none The company name of the recipient of the payment
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» reference_number string false none Reference number associated to the Bill
»» sub_total_amount integer false none Bill sub total amount
»» tax_amount integer false none Amount of tax applied
»» total_amount integer false none Total amount for the bill
» offset integer false none none
» limit integer false none none
» total integer false none none

Get Bill

Code samples

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


GET https://platform.roserocket.com/api/v1/bills/{billID} 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/api/v1/bills/{billID}',
  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/api/v1/bills/{billID}',
{
  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/api/v1/bills/{billID}',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.get('https://platform.roserocket.com/api/v1/bills/{billID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/bills/{billID}");
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/api/v1/bills/{billID}", data)
    req.Header = headers

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

GET /bills/{billID}

Get bill by Id

Parameters

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

Example responses

200 Response

{
  "bill": {
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "id": "string",
    "created_by": "string",
    "org_id": "string",
    "status_id": "string",
    "currency_id": "string",
    "pay_term_id": "string",
    "master_trip_id": "string",
    "partner_carrier_id": "string",
    "full_id": "string",
    "external_id": "string",
    "qb_external_id": "string",
    "qb_error_msg": "string",
    "revision": 0,
    "bill_date": "2021-09-16T18:11:26Z",
    "due_date": "2021-09-16T18:11:26Z",
    "sent_at": "2021-09-16T18:11:26Z",
    "paid_at": "2021-09-16T18:11:26Z",
    "qb_exported_at": "2021-09-16T18:11:26Z",
    "send_to_email": "string",
    "cc_to_email": "string",
    "bill_to": {
      "company_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "country": "string"
    },
    "is_tax_on": true,
    "notes": "string",
    "remit_to": {
      "company_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "country": "string"
    },
    "reference_number": "string",
    "sub_total_amount": 0,
    "tax_amount": 0,
    "total_amount": 0
  },
  "created_by": "string",
  "bill_item": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "bill_id": "string",
    "bill_item_type_id": "string",
    "manifest_payment_item_id": "string",
    "unit_price": 0,
    "quantity": 0,
    "total_amount": 0,
    "description": "string"
  },
  "pay_term": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "org_id": "string",
    "number_of_days": 0,
    "name": "string",
    "connector_mappings": {
      "property1": {
        "connector_id": "string",
        "vendor_pay_term_id": "string",
        "pay_term_id": null,
        "org_id": null
      },
      "property2": {
        "connector_id": "string",
        "vendor_pay_term_id": "string",
        "pay_term_id": null,
        "org_id": null
      }
    }
  },
  "currency_info": {
    "id": "string",
    "name": "string",
    "description": "string",
    "iso_4217": "string",
    "symbol": "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
» bill Bill false none Bill for an Order
»» created_at string(date-time) false none The timestamp for the creation of the bill
»» updated_at string(date-time) false none The timestamp for the last update of the bill
»» id string(uuid) false none ID of the Bill
»» created_by string false none none
»» org_id string(uuid) false none ID of associated org
»» status_id string false none ID of Bill Status
»» currency_id string false none ID of currency
»» pay_term_id string false none ID of bill pay term
»» master_trip_id string(uuid) false none ID of master trip related to the bill
»» partner_carrier_id string(uuid) false none Id of the partner/carrier that corresponds to the bill
»» full_id string(uuid) false none Full ID associated with, and used to reference the Bill
»» external_id string false read-only Customer external id. This field value can be null
»» qb_external_id string false none The external identifier for the partner carrier in QBO
»» qb_error_msg string false none Error message for QBO
»» revision integer false none The revision number of the payment
»» bill_date string(date-time) false none Bill creation date
»» due_date string(date-time) false none Due date for bill payment
»» sent_at string(date-time) false none Date the bill was sent
»» paid_at string(date-time) false none Date the bill was paid
»» qb_exported_at string(date-time) false none Date invoice was exported to QB
»» send_to_email string false none The email of the recipient of the payment
»» cc_to_email string false none The email of the cc recipient of the payment
»» bill_to object false none none
»»» company_name string false none The company name of the billing party
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» is_tax_on boolean false none none
»» notes string false none Notes associated to the Bill
»» remit_to object false none none
»»» company_name string false none The company name of the recipient of the payment
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» reference_number string false none Reference number associated to the Bill
»» sub_total_amount integer false none Bill sub total amount
»» tax_amount integer false none Amount of tax applied
»» total_amount integer false none Total amount for the bill
» created_by string false none none
» bill_item BillItem false none List of Items in a Bill
»» id string(uuid) false none none
»» created_at string(date-time) false none The time of the item’s creation
»» updated_at string(date-time) false none The time the item was last updated
»» bill_id string(uuid) false none ID of the associated Bill
»» bill_item_type_id string(uuid) false none ID of Item Type
»» manifest_payment_item_id string(uuid) false none ID of Manifest Payment Item
»» unit_price integer false none Unit price for the item
»» quantity integer false none Quantity of the commodity
»» total_amount integer false none Total amount for the specified item
»» description string false none Description of the item
» pay_term PayTerm false none Pay term for Invoice
»» id string(uuid) false none none
»» created_at string(date-time) false none The time of the event’s creation
»» updated_at string(date-time) false none The time the event was last updated
»» org_id string(uuid) false none ID of the associated organization
»» number_of_days integer false none Number of days in the pay term
»» name string false none Name of the partner carrier
»» connector_mappings PayTermConnectorMappings false none A (key, object) map, where the key is connector ID (represents the vendor) and the object contains vendor details associated with this Rose Rocket pay term.
»»» additionalProperties PayTermConnectorMapping false none Maps Rose Rocket pay term to vendor pay term. For use with 3rd-party software integration.
»»»» connector_id string true none The connector ID representing the vendor
»»»» vendor_pay_term_id string true none The vendor’s pay term ID for this Rose Rocket pay term
»»»» pay_term_id uuid false none The Rose Rocket pay term ID
»»»» org_id uuid false none The Rose Rocket org ID
»»» currency_info Currency false none Currency
»»»» id string false read-only Identifier for the currency
»»»» name string false read-only Name of the currency
»»»» description string false read-only Description of the currency
»»»» iso_4217 string false read-only The currency code as per the ISO4217 specification
»»»» symbol string false read-only Symbol representing the currency

Update Bill

Code samples

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


PUT https://platform.roserocket.com/api/v1/bills/{billID} 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/api/v1/bills/{billID}',
  method: 'put',

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


const fetch = require('node-fetch');
const inputBody = '{
  "created_at": "2021-09-16T18:11:26Z",
  "updated_at": "2021-09-16T18:11:26Z",
  "id": "string",
  "created_by": "string",
  "org_id": "string",
  "status_id": "string",
  "currency_id": "string",
  "pay_term_id": "string",
  "master_trip_id": "string",
  "partner_carrier_id": "string",
  "full_id": "string",
  "qb_external_id": "string",
  "qb_error_msg": "string",
  "revision": 0,
  "bill_date": "2021-09-16T18:11:26Z",
  "due_date": "2021-09-16T18:11:26Z",
  "sent_at": "2021-09-16T18:11:26Z",
  "paid_at": "2021-09-16T18:11:26Z",
  "qb_exported_at": "2021-09-16T18:11:26Z",
  "send_to_email": "string",
  "cc_to_email": "string",
  "bill_to": {
    "company_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "postal": "string",
    "country": "string"
  },
  "is_tax_on": true,
  "notes": "string",
  "remit_to": {
    "company_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "postal": "string",
    "country": "string"
  },
  "reference_number": "string",
  "sub_total_amount": 0,
  "tax_amount": 0,
  "total_amount": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/api/v1/bills/{billID}',
{
  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/api/v1/bills/{billID}',
  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/api/v1/bills/{billID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/bills/{billID}");
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/api/v1/bills/{billID}", data)
    req.Header = headers

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

PUT /bills/{billID}

Update an Bill by ID

Body parameter

{
  "created_at": "2021-09-16T18:11:26Z",
  "updated_at": "2021-09-16T18:11:26Z",
  "id": "string",
  "created_by": "string",
  "org_id": "string",
  "status_id": "string",
  "currency_id": "string",
  "pay_term_id": "string",
  "master_trip_id": "string",
  "partner_carrier_id": "string",
  "full_id": "string",
  "qb_external_id": "string",
  "qb_error_msg": "string",
  "revision": 0,
  "bill_date": "2021-09-16T18:11:26Z",
  "due_date": "2021-09-16T18:11:26Z",
  "sent_at": "2021-09-16T18:11:26Z",
  "paid_at": "2021-09-16T18:11:26Z",
  "qb_exported_at": "2021-09-16T18:11:26Z",
  "send_to_email": "string",
  "cc_to_email": "string",
  "bill_to": {
    "company_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "postal": "string",
    "country": "string"
  },
  "is_tax_on": true,
  "notes": "string",
  "remit_to": {
    "company_name": "string",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "postal": "string",
    "country": "string"
  },
  "reference_number": "string",
  "sub_total_amount": 0,
  "tax_amount": 0,
  "total_amount": 0
}

Parameters

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

Example responses

200 Response

{
  "bill": {
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "id": "string",
    "created_by": "string",
    "org_id": "string",
    "status_id": "string",
    "currency_id": "string",
    "pay_term_id": "string",
    "master_trip_id": "string",
    "partner_carrier_id": "string",
    "full_id": "string",
    "external_id": "string",
    "qb_external_id": "string",
    "qb_error_msg": "string",
    "revision": 0,
    "bill_date": "2021-09-16T18:11:26Z",
    "due_date": "2021-09-16T18:11:26Z",
    "sent_at": "2021-09-16T18:11:26Z",
    "paid_at": "2021-09-16T18:11:26Z",
    "qb_exported_at": "2021-09-16T18:11:26Z",
    "send_to_email": "string",
    "cc_to_email": "string",
    "bill_to": {
      "company_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "country": "string"
    },
    "is_tax_on": true,
    "notes": "string",
    "remit_to": {
      "company_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "country": "string"
    },
    "reference_number": "string",
    "sub_total_amount": 0,
    "tax_amount": 0,
    "total_amount": 0
  },
  "created_by": "string",
  "bill_item": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "bill_id": "string",
    "bill_item_type_id": "string",
    "manifest_payment_item_id": "string",
    "unit_price": 0,
    "quantity": 0,
    "total_amount": 0,
    "description": "string"
  },
  "pay_term": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "org_id": "string",
    "number_of_days": 0,
    "name": "string",
    "connector_mappings": {
      "property1": {
        "connector_id": "string",
        "vendor_pay_term_id": "string",
        "pay_term_id": null,
        "org_id": null
      },
      "property2": {
        "connector_id": "string",
        "vendor_pay_term_id": "string",
        "pay_term_id": null,
        "org_id": null
      }
    }
  }
}

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
» bill Bill false none Bill for an Order
»» created_at string(date-time) false none The timestamp for the creation of the bill
»» updated_at string(date-time) false none The timestamp for the last update of the bill
»» id string(uuid) false none ID of the Bill
»» created_by string false none none
»» org_id string(uuid) false none ID of associated org
»» status_id string false none ID of Bill Status
»» currency_id string false none ID of currency
»» pay_term_id string false none ID of bill pay term
»» master_trip_id string(uuid) false none ID of master trip related to the bill
»» partner_carrier_id string(uuid) false none Id of the partner/carrier that corresponds to the bill
»» full_id string(uuid) false none Full ID associated with, and used to reference the Bill
»» external_id string false read-only Customer external id. This field value can be null
»» qb_external_id string false none The external identifier for the partner carrier in QBO
»» qb_error_msg string false none Error message for QBO
»» revision integer false none The revision number of the payment
»» bill_date string(date-time) false none Bill creation date
»» due_date string(date-time) false none Due date for bill payment
»» sent_at string(date-time) false none Date the bill was sent
»» paid_at string(date-time) false none Date the bill was paid
»» qb_exported_at string(date-time) false none Date invoice was exported to QB
»» send_to_email string false none The email of the recipient of the payment
»» cc_to_email string false none The email of the cc recipient of the payment
»» bill_to object false none none
»»» company_name string false none The company name of the billing party
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» is_tax_on boolean false none none
»» notes string false none Notes associated to the Bill
»» remit_to object false none none
»»» company_name string false none The company name of the recipient of the payment
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» reference_number string false none Reference number associated to the Bill
»» sub_total_amount integer false none Bill sub total amount
»» tax_amount integer false none Amount of tax applied
»» total_amount integer false none Total amount for the bill
» created_by string false none none
» bill_item BillItem false none List of Items in a Bill
»» id string(uuid) false none none
»» created_at string(date-time) false none The time of the item’s creation
»» updated_at string(date-time) false none The time the item was last updated
»» bill_id string(uuid) false none ID of the associated Bill
»» bill_item_type_id string(uuid) false none ID of Item Type
»» manifest_payment_item_id string(uuid) false none ID of Manifest Payment Item
»» unit_price integer false none Unit price for the item
»» quantity integer false none Quantity of the commodity
»» total_amount integer false none Total amount for the specified item
»» description string false none Description of the item
» pay_term PayTerm false none Pay term for Invoice
»» id string(uuid) false none none
»» created_at string(date-time) false none The time of the event’s creation
»» updated_at string(date-time) false none The time the event was last updated
»» org_id string(uuid) false none ID of the associated organization
»» number_of_days integer false none Number of days in the pay term
»» name string false none Name of the partner carrier
»» connector_mappings PayTermConnectorMappings false none A (key, object) map, where the key is connector ID (represents the vendor) and the object contains vendor details associated with this Rose Rocket pay term.
»»» additionalProperties PayTermConnectorMapping false none Maps Rose Rocket pay term to vendor pay term. For use with 3rd-party software integration.
»»»» connector_id string true none The connector ID representing the vendor
»»»» vendor_pay_term_id string true none The vendor’s pay term ID for this Rose Rocket pay term
»»»» pay_term_id uuid false none The Rose Rocket pay term ID
»»»» org_id uuid false none The Rose Rocket org ID

Consolidated Bill

Get consolidated bill

Code samples

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


GET https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID} 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/api/v1/consolidated_bills/{consolidatedBillID}',
  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/api/v1/consolidated_bills/{consolidatedBillID}',
{
  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/api/v1/consolidated_bills/{consolidatedBillID}',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.get('https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}");
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/api/v1/consolidated_bills/{consolidatedBillID}", data)
    req.Header = headers

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

GET /consolidated_bills/{consolidatedBillID}

Get consolidated bill by ID

Parameters

Name In Type Required Description
consolidatedBillID path string(uuid) true The Rose Rocket consolidated bill ID

Example responses

200 Response

{
  "consolidated_bill": {
    "id": "string",
    "org_id": "string",
    "sequence_id": 0,
    "partner_carrier_id": "string",
    "consolidated_bill_type_id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "notes": "string",
    "full_id": "string",
    "pay_term_id": "string",
    "bill_date": "2021-09-16",
    "due_date": "2021-09-16",
    "pay_period_start": "2021-09-16",
    "pay_period_end": "2021-09-16",
    "bill_to": {
      "company_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "country": "string"
    },
    "remit_to": {
      "company_name": "string",
      "contact_name": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "country": "string"
    },
    "misc_amount": 0,
    "bill_amount": 0,
    "sub_total_amount": 0,
    "tax_amount": 0,
    "total_amount": 0,
    "bills": [
      {
        "bill_items": [
          {
            "exchange_currency_id": "string",
            "exchange_rate": 0,
            "home_value": 0,
            "bill_item_type": {
              "id": "string",
              "external_id": "string",
              "qb_external_id": "string",
              "name": "string",
              "class": "string",
              "org_id": "string",
              "created_at": "2021-09-16T18:11:26Z",
              "updated_at": "2021-09-16T18:11:26Z"
            },
            "id": "string",
            "created_at": "2021-09-16T18:11:26Z",
            "updated_at": "2021-09-16T18:11:26Z",
            "bill_id": "string",
            "bill_item_type_id": "string",
            "manifest_payment_item_id": "string",
            "unit_price": 0,
            "quantity": 0,
            "total_amount": 0,
            "description": "string"
          }
        ],
        "manifest_full_id": "string",
        "created_at": "2021-09-16T18:11:26Z",
        "updated_at": "2021-09-16T18:11:26Z",
        "id": "string",
        "created_by": "string",
        "org_id": "string",
        "status_id": "string",
        "currency_id": "string",
        "pay_term_id": "string",
        "master_trip_id": "string",
        "partner_carrier_id": "string",
        "full_id": "string",
        "external_id": "string",
        "qb_external_id": "string",
        "qb_error_msg": "string",
        "revision": 0,
        "bill_date": "2021-09-16T18:11:26Z",
        "due_date": "2021-09-16T18:11:26Z",
        "sent_at": "2021-09-16T18:11:26Z",
        "paid_at": "2021-09-16T18:11:26Z",
        "qb_exported_at": "2021-09-16T18:11:26Z",
        "send_to_email": "string",
        "cc_to_email": "string",
        "bill_to": {
          "company_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "city": "string",
          "state": "string",
          "postal": "string",
          "country": "string"
        },
        "is_tax_on": true,
        "notes": "string",
        "remit_to": {
          "company_name": "string",
          "contact_name": "string",
          "address_1": "string",
          "address_2": "string",
          "city": "string",
          "state": "string",
          "postal": "string",
          "country": "string"
        },
        "reference_number": "string",
        "sub_total_amount": 0,
        "tax_amount": 0,
        "total_amount": 0
      }
    ],
    "bill_items": [
      {
        "id": "string",
        "consolidated_bill_id": "string",
        "bill_item_type_id": "string",
        "type_label": "string",
        "tax_label": "string",
        "tax_id": "string",
        "quantity": 0,
        "unit_price": 0,
        "total_amount": 0,
        "description": "string",
        "created_at": "2021-09-16T18:11:26Z",
        "updated_at": "2021-09-16T18:11:26Z",
        "exchange_currency_id": "string",
        "exchange_rate": 0,
        "home_value": 0,
        "bill_item_type": {
          "id": "string",
          "external_id": "string",
          "qb_external_id": "string",
          "name": "string",
          "class": "string",
          "org_id": "string",
          "created_at": "2021-09-16T18:11:26Z",
          "updated_at": "2021-09-16T18:11:26Z"
        },
        "tax": {
          "id": "string",
          "created_at": "2021-09-16T18:11:26Z",
          "updated_at": "2021-09-16T18:11:26Z",
          "org_id": "string",
          "tax": 0,
          "name": "string",
          "qb_external_id": "string",
          "xero_external_id": "string",
          "bill_xero_external_id": "string",
          "is_active": true,
          "inbound_state_short_code": "string",
          "outbound_state_short_code": "string",
          "inbound_country_short_code": "string",
          "outbound_country_short_code": "string",
          "inbound_country_excl_qc": "string",
          "tax_breakdown": {
            "tax_lines": [
              {
                "name": "string",
                "amount": 0
              }
            ]
          }
        }
      }
    ],
    "connector_export_info_mappings": {
      "property1": {
        "connector_id": "string",
        "vendor_bill_id": "string",
        "consolidated_bill_id": "string",
        "org_id": "string",
        "created_at": "2021-09-16T18:11:26Z",
        "updated_at": "2021-09-16T18:11:26Z",
        "vendor_error_msg": "string"
      },
      "property2": {
        "connector_id": "string",
        "vendor_bill_id": "string",
        "consolidated_bill_id": "string",
        "org_id": "string",
        "created_at": "2021-09-16T18:11:26Z",
        "updated_at": "2021-09-16T18:11:26Z",
        "vendor_error_msg": "string"
      }
    }
  },
  "driver": {
    "id": "string",
    "profile": {
      "remit_to": {
        "first_name": "string",
        "last_name": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postal": "string",
        "country": "string",
        "phone": "string",
        "phone_ext": "string",
        "email": "string",
        "fax": "string"
      },
      "connector_mappings": {
        "property1": {
          "connector_id": "string",
          "vendor_user_profile_id": "string",
          "user_profile_id": null,
          "org_id": null
        },
        "property2": {
          "connector_id": "string",
          "vendor_user_profile_id": "string",
          "user_profile_id": null,
          "org_id": null
        }
      }
    },
    "pay_amount_id": 0,
    "pay2_amount": 0,
    "pay2_type_id": "string",
    "pay3_amount": 0,
    "pay3_type_id": "string",
    "driver_license_expiry_date": "2021-09-16T18:11:26Z",
    "insurance_company_name": "string",
    "insurance_policy_no": "string"
  },
  "partner_carrier": {
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "id": "string",
    "org_id": "string",
    "identity_org_id": "string",
    "qb_external_id": "string",
    "external_id": "string",
    "short_code": "string",
    "name": "string",
    "address_1": "string",
    "address_2": "string",
    "suite": "string",
    "city": "string",
    "postal": "string",
    "phone": "string",
    "phone_ext": "string",
    "fax": "string",
    "email": "string",
    "country": "string",
    "state": "string",
    "timezone": "string",
    "dispatch_contact_name": "string",
    "dispatch_contact_email": "string",
    "billing_contact_name": "string",
    "billing_contact_email": "string",
    "sales_contact_name": "string",
    "sales_contact_email": "string",
    "sales_contact_number": "string",
    "motor_carrier_id": "string",
    "dept_of_transportation_id": "string",
    "standard_carrier_alpha_code": "string",
    "provincial_operating_authority_num": "string",
    "check_insurances_before_dispatch": true,
    "cargo_ins_policy_num": "string",
    "cargo_ins_amount": 0,
    "cargo_ins_exp_date": "2021-09-16T18:11:26Z",
    "cargo_ins_allow_dispatch": true,
    "cargo_ins_file_url": "string",
    "cargo_ins_file_uploaded_at": "2021-09-16T18:11:26Z",
    "cargo_ins_file_uploaded_by": "string",
    "liability_ins_policy_num": "string",
    "liability_ins_amount": 0,
    "liability_ins_exp_date": "2021-09-16T18:11:26Z",
    "liability_ins_allow_dispatch": true,
    "liability_ins_file_url": "string",
    "liability_ins_file_uploaded_at": "2021-09-16T18:11:26Z",
    "liability_ins_file_uploaded_by": "string",
    "auto_liability_ins_policy_num": "string",
    "auto_liability_ins_amount": 0,
    "auto_liability_ins_exp_date": "2021-09-16T18:11:26Z",
    "auto_liability_ins_allow_dispatch": true,
    "auto_liability_ins_file_url": "string",
    "auto_liability_ins_file_uploaded_at": "2021-09-16T18:11:26Z",
    "auto_liability_ins_file_uploaded_by": "string"
  },
  "pay_term": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "org_id": "string",
    "number_of_days": 0,
    "name": "string",
    "connector_mappings": {
      "property1": {
        "connector_id": "string",
        "vendor_pay_term_id": "string",
        "pay_term_id": null,
        "org_id": null
      },
      "property2": {
        "connector_id": "string",
        "vendor_pay_term_id": "string",
        "pay_term_id": null,
        "org_id": null
      }
    }
  },
  "currency_info": {
    "id": "string",
    "name": "string",
    "description": "string",
    "iso_4217": "string",
    "symbol": "string"
  },
  "org_default_bill_tax": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "org_id": "string",
    "tax": 0,
    "name": "string",
    "qb_external_id": "string",
    "xero_external_id": "string",
    "bill_xero_external_id": "string",
    "is_active": true,
    "inbound_state_short_code": "string",
    "outbound_state_short_code": "string",
    "inbound_country_short_code": "string",
    "outbound_country_short_code": "string",
    "inbound_country_excl_qc": "string",
    "tax_breakdown": {
      "tax_lines": [
        {
          "name": "string",
          "amount": 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
» consolidated_bill ConsolidatedBill false none Consolidated Bill
»» id string false none The Rose Rocket consolidated bill ID
»» org_id string(uuid) false none The Rose Rocket org ID
»» sequence_id integer false none Auto generated sequence ID per customer
»» partner_carrier_id string false none The ID of the partner/carrier that corresponds to the consolidated bill
»» consolidated_bill_type_id string false none The consolidated bill type ID
»» created_at string(date-time) false none The timestamp of the consolidated bill’s creation
»» updated_at string(date-time) false none The timestamp of the consolidated bill’s last update
»» notes string false none The notes on a Rose Rocket consolidated bill
»» full_id string(uuid) false none The Rose Rocket consolidated bill full ID
»» pay_term_id string(uuid) false none The Rose Rocket pay term ID
»» bill_date string(date) false none The consolidated bill’s creation date
»» due_date string(date) false none The consolidated bill’s due date
»» pay_period_start string(date) false none The consolidated bill’s payment start date
»» pay_period_end string(date) false none The consolidated bill’s payment end date
»» bill_to object false none none
»»» company_name string false none The company name of the billing party
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» remit_to object false none none
»»» company_name string false none The company name of the recipient of the payment
»»» contact_name string false none Contact Name
»»» address_1 string false none Address line 1
»»» address_2 string false none Address line 2
»»» city string false none City name
»»» state string false none State name
»»» postal string false none Postal code
»»» country string false none Country
»» misc_amount number(float) false none Miscellaneous Amount
»» bill_amount number(float) false none Bill Amount
»» sub_total_amount number(float) false none Subtotal Amount
»» tax_amount number(float) false none Tax amount
»» total_amount number(float) false none Total Amount
»» bills [allOf] false none none
»»» bill_items [allOf] false none none
»»»» exchange_currency_id string false none The Rose Rocket exchange currency ID (e.g. “cad”)
»»»» exchange_rate number false none The exchange rate from the source currency to the target currency
»»»» home_value number(float) false none none
»»»» bill_item_type BillItemType false none Represents a bill item type
»»»»» id string(uuid) false read-only Auto generated system ID
»»»»» external_id string false none External ID representing the bill item type
»»»»» qb_external_id string false none External ID representing the bill item type in quickbooks
»»»»» name string false none The name of the bill item type
»»»»» class string false none The class of the bill item type
»»»»» org_id string(uuid) false none Id of the org to which the bill item type belongs to
»»»»» created_at string(date-time) false none The time of the equipment type’s creation
»»»»» updated_at string(date-time) false none The time of the equipment type’s last update

allOf

Name Type Required Restrictions Description
»»»» anonymous BillItem false none List of Items in a Bill
»»»»» id string(uuid) false none none
»»»»» created_at string(date-time) false none The time of the item’s creation
»»»»» updated_at string(date-time) false none The time the item was last updated
»»»»» bill_id string(uuid) false none ID of the associated Bill
»»»»» bill_item_type_id string(uuid) false none ID of Item Type
»»»»» manifest_payment_item_id string(uuid) false none ID of Manifest Payment Item
»»»»» unit_price integer false none Unit price for the item
»»»»» quantity integer false none Quantity of the commodity
»»»»» total_amount integer false none Total amount for the specified item
»»»»» description string false none Description of the item

and

Name Type Required Restrictions Description
»»»» anonymous object false none none

continued

Name Type Required Restrictions Description
»»» manifest_full_id string false none The full manifest ID of the associated manifest, usually it is the manifest ID prepended with the org’s subdomain you see from the UI.

allOf

Name Type Required Restrictions Description
»»» anonymous Bill false none Bill for an Order
»»»» created_at string(date-time) false none The timestamp for the creation of the bill
»»»» updated_at string(date-time) false none The timestamp for the last update of the bill
»»»» id string(uuid) false none ID of the Bill
»»»» created_by string false none none
»»»» org_id string(uuid) false none ID of associated org
»»»» status_id string false none ID of Bill Status
»»»» currency_id string false none ID of currency
»»»» pay_term_id string false none ID of bill pay term
»»»» master_trip_id string(uuid) false none ID of master trip related to the bill
»»»» partner_carrier_id string(uuid) false none Id of the partner/carrier that corresponds to the bill
»»»» full_id string(uuid) false none Full ID associated with, and used to reference the Bill
»»»» external_id string false read-only Customer external id. This field value can be null
»»»» qb_external_id string false none The external identifier for the partner carrier in QBO
»»»» qb_error_msg string false none Error message for QBO
»»»» revision integer false none The revision number of the payment
»»»» bill_date string(date-time) false none Bill creation date
»»»» due_date string(date-time) false none Due date for bill payment
»»»» sent_at string(date-time) false none Date the bill was sent
»»»» paid_at string(date-time) false none Date the bill was paid
»»»» qb_exported_at string(date-time) false none Date invoice was exported to QB
»»»» send_to_email string false none The email of the recipient of the payment
»»»» cc_to_email string false none The email of the cc recipient of the payment
»»»» bill_to object false none none
»»»»» company_name string false none The company name of the billing party
»»»»» contact_name string false none Contact Name
»»»»» address_1 string false none Address line 1
»»»»» address_2 string false none Address line 2
»»»»» city string false none City name
»»»»» state string false none State name
»»»»» postal string false none Postal code
»»»»» country string false none Country
»»»» is_tax_on boolean false none none
»»»» notes string false none Notes associated to the Bill
»»»» remit_to object false none none
»»»»» company_name string false none The company name of the recipient of the payment
»»»»» contact_name string false none Contact Name
»»»»» address_1 string false none Address line 1
»»»»» address_2 string false none Address line 2
»»»»» city string false none City name
»»»»» state string false none State name
»»»»» postal string false none Postal code
»»»»» country string false none Country
»»»» reference_number string false none Reference number associated to the Bill
»»»» sub_total_amount integer false none Bill sub total amount
»»»» tax_amount integer false none Amount of tax applied
»»»» total_amount integer false none Total amount for the bill

and

Name Type Required Restrictions Description
»»» anonymous object false none none

continued

Name Type Required Restrictions Description
»» bill_items [ConsolidatedBillItem] false none [Bill Item for a consolidated bill]
»»» id string(uuid) false none The Rose Rocket consolidated bill item ID
»»» consolidated_bill_id string(uuid) false none The Rose Rocket consolidated bill ID
»»» bill_item_type_id string(uuid) false none The Rose Rocket bill item type ID
»»» type_label string false none none
»»» tax_label string false none none
»»» tax_id string(uuid) false none The Rose Rocket tax ID
»»» quantity number(float) false none none
»»» unit_price number(float) false none none
»»» total_amount number(float) false none none
»»» description string false none none
»»» created_at string(date-time) false none The timestamp of the consolidated bill item’s creation
»»» updated_at string(date-time) false none The timestamp of the consolidated bill item’s last update
»»» exchange_currency_id string false none The Rose Rocket exchange currency ID (e.g. “cad”)
»»» exchange_rate number false none The exchange rate from the source currency to the target currency
»»» home_value number(float) false none none
»»» bill_item_type BillItemType false none Represents a bill item type
»»» tax Tax false none Tax
»»»» id string(uuid) false none The Rose Rocket tax ID
»»»» created_at string(date-time) false none The timestamp of the tax’s creation
»»»» updated_at string(date-time) false none The timestamp of the tax’s last update
»»»» org_id string(uuid) false none The Rose Rocket org ID
»»»» tax number(float) false none The tax percentage
»»»» name string false none The Rose Rocket tax name
»»»» qb_external_id string false none The tax ID in QuickBooks
»»»» xero_external_id string false none The tax ID in Xero
»»»» bill_xero_external_id string false none The Xero line item tax type
»»»» is_active boolean false none Boolean indicates if the Rose Rocket tax is active
»»»» inbound_state_short_code string false none none
»»»» outbound_state_short_code string false none none
»»»» inbound_country_short_code string false none none
»»»» outbound_country_short_code string false none none
»»»» inbound_country_excl_qc string false none none
»»»» tax_breakdown object false none none
»»»»» tax_lines [object] false none none
»»»»»» name string false none none
»»»»»» amount number(float) false none none
»»»»» connector_export_info_mappings ConsolidatedBillConnectorExportInfoMappings false none A (key, object) map displaying the Rose Rocket consolidated bill’s export information to 3rd party financial management integrations.
»»»»»» additionalProperties ConsolidatedBillConnectorExportInfo false none Displays the consolidated bill’s 3rd party financial management integration export information.
»»»»»»» connector_id string false none The Rose Rocket connector ID representing the vendor (e.g. “quickbooks”)
»»»»»»» vendor_bill_id string false none The vendor’s bill ID for this Rose Rocket consolidated bill (e.g. “85”)
»»»»»»» consolidated_bill_id string(uuid) false none The Rose Rocket consolidated bill ID
»»»»»»» org_id string(uuid) false none The Rose Rocket org ID
»»»»»»» created_at string(date-time) false none The timestamp of the consolidated bill’s first export
»»»»»»» updated_at string(date-time) false none The timestamp of the consolidated bill’s last export
»»»»»»» vendor_error_msg string false none The error message from vendor. It could be the raw JSON string format of the error from the vendor.
»»»»»» driver User false none A User
»»»»»»» id string(uuid) false none none
»»»»»»» profile object false none none
»»»»»»»» remit_to object false none none
»»»»»»»»» first_name string false none none
»»»»»»»»» last_name string false none none
»»»»»»»»» address_1 string false none none
»»»»»»»»» address_2 string false none none
»»»»»»»»» city string false none none
»»»»»»»»» state string false none none
»»»»»»»»» postal string false none none
»»»»»»»»» country string false none none
»»»»»»»»» phone string false none none
»»»»»»»»» phone_ext string false none none
»»»»»»»»» email string false none none
»»»»»»»»» fax string false none none
»»»»»»»» connector_mappings UserProfileConnectorMappings false none A (key, object) map displaying the vendor external IDs (and related information) that have been assigned to the Rose Rocket user profile by a range of 3rd-party software integrations. Useful for tracking the use of the Rose Rocket user profile by a range of vendors.
»»»»»»»»» additionalProperties UserProfileConnectorMapping false none Displays the vendor external ID (and related information) that has been assigned to the Rose Rocket user profile by a 3rd-party software integration (e.g. QuickBooks assigns an external ID to the user profile because it represents a Rose Rocket driver profile attached to an exported bill). Useful for tracking the use of the Rose Rocket user profile by a specific vendor.
»»»»»»»»»» connector_id string true none The connector ID representing the vendor (e.g. “quickbooks”)
»»»»»»»»»» vendor_user_profile_id string true none The vendor’s user profile ID for this Rose Rocket user profile (e.g. “85”)
»»»»»»»»»» user_profile_id uuid false none The Rose Rocket user profile ID
»»»»»»»»»» org_id uuid false none The Rose Rocket org ID
»»»»»»»»» pay_amount_id number false none none
»»»»»»»»» pay2_amount number false none none
»»»»»»»»» pay2_type_id string false none none
»»»»»»»»» pay3_amount number false none none
»»»»»»»»» pay3_type_id string false none none
»»»»»»»»» driver_license_expiry_date string(date-time) false none none
»»»»»»»»» insurance_company_name string false none none
»»»»»»»»» insurance_policy_no string false none none
»»»»»»»» partner_carrier PartnerCarrier false none A partner carrier
»»»»»»»»» created_at string(date-time) false none The timestamp for the creation of the partner carrier
»»»»»»»»» updated_at string(date-time) false none The timestamp for the last update of the partner carrier
»»»»»»»»» id string(uuid) false none none
»»»»»»»»» org_id string(uuid) false none The uuid for the organization the partner carrier belongs to
»»»»»»»»» identity_org_id string(uuid) false none The uuid for the identity organization of the partner carrier
»»»»»»»»» qb_external_id string false none The external identifier for the partner carrier in QBO
»»»»»»»»» external_id string false none the external identifier for the partner carrier
»»»»»»»»» short_code string false none The short code identifier of the partner carrier
»»»»»»»»» name string false none The name of the partner carrier
»»»»»»»»» address_1 string false none The first address line of the partner carrier
»»»»»»»»» address_2 string false none The second address line of the partner carrier
»»»»»»»»» suite string false none The suite of the partner carrier’s address
»»»»»»»»» city string false none The city of the partner carrier’s address
»»»»»»»»» postal string false none The postal code of the partner carrier’s address
»»»»»»»»» phone string false none The phone number of the partner carrier
»»»»»»»»» phone_ext string false none The phone extension of the partner carrier
»»»»»»»»» fax string false none The fax number of the partner carrier
»»»»»»»»» email string false none The email address of the partner carrier
»»»»»»»»» country string false none The country of the partner carrier
»»»»»»»»» state string false none The state of the partner carrier
»»»»»»»»» timezone string false none The timezone in which the partner carrier resides
»»»»»»»»» dispatch_contact_name string false none The contact name for dispatches to partner carrier
»»»»»»»»» dispatch_contact_email string false none The contact email for dispatches to partner carrier
»»»»»»»»» billing_contact_name string false none The contact name for billing to partner carrier
»»»»»»»»» billing_contact_email string false none The contact email for billing to partner carrier
»»»»»»»»» sales_contact_name string false none The contact name for sales to partner carrier
»»»»»»»»» sales_contact_email string false none The contact email for sales to partner carrier
»»»»»»»»» sales_contact_number string false none The contact phone number for sales to partner carrier
»»»»»»»»» motor_carrier_id string false none The motor carrier id of the partner carrier
»»»»»»»»» dept_of_transportation_id string false none The partner carrier’s department of transportation id
»»»»»»»»» standard_carrier_alpha_code string false none The SCAC of the partner carrier
»»»»»»»»» provincial_operating_authority_num string false none The provincial operating authority number for the partner carrier
»»»»»»»»» check_insurances_before_dispatch boolean false none Checking insurances before dispatching
»»»»»»»»» cargo_ins_policy_num string false none The cargo insurance policy number for the partner carrier. This field value can be null
»»»»»»»»» cargo_ins_amount number(float) false none The cargo insurance amount for the partner carrier. This field value can be null
»»»»»»»»» cargo_ins_exp_date string(date-time) false none The cargo insurance expiry date for the partner carrier. This field value can be null
»»»»»»»»» cargo_ins_allow_dispatch boolean false none Allow dispatches related to cargo insurance for the partner carrier. This field value can be null
»»»»»»»»» cargo_ins_file_url string false none The cargo insurance file URL for the partner carrier. This field value can be null
»»»»»»»»» cargo_ins_file_uploaded_at string(date-time) false none The cargo insurance file uploaded at date for the partner carrier. This field value can be null
»»»»»»»»» cargo_ins_file_uploaded_by string false none The cargo insurance policy file uploaded by user for the partner carrier. This field value can be null
»»»»»»»»» liability_ins_policy_num string false none The liability insurance policy number for the partner carrier. This field value can be null
»»»»»»»»» liability_ins_amount number(float) false none The liability insurance amount for the partner carrier. This field value can be null
»»»»»»»»» liability_ins_exp_date string(date-time) false none The liability insurance expiry date for the partner carrier. This field value can be null
»»»»»»»»» liability_ins_allow_dispatch boolean false none Allow dispatches related to liability insurance for the partner carrier. This field value can be null
»»»»»»»»» liability_ins_file_url string false none The liability insurance file URL for the partner carrier. This field value can be null
»»»»»»»»» liability_ins_file_uploaded_at string(date-time) false none The liability insurance file uploaded at date for the partner carrier. This field value can be null
»»»»»»»»» liability_ins_file_uploaded_by string false none The liability insurance policy file uploaded by user for the partner carrier. This field value can be null
»»»»»»»»» auto_liability_ins_policy_num string false none The auto liability insurance policy number for the partner carrier. This field value can be null
»»»»»»»»» auto_liability_ins_amount number(float) false none The auto liability insurance amount for the partner carrier. This field value can be null
»»»»»»»»» auto_liability_ins_exp_date string(date-time) false none The auto liability insurance expiry date for the partner carrier. This field value can be null
»»»»»»»»» auto_liability_ins_allow_dispatch boolean false none Allow dispatches related to auto liability insurance for the partner carrier. This field value can be null
»»»»»»»»» auto_liability_ins_file_url string false none The auto liability insurance file URL for the partner carrier. This field value can be null
»»»»»»»»» auto_liability_ins_file_uploaded_at string(date-time) false none The auto liability insurance file uploaded at date for the partner carrier. This field value can be null
»»»»»»»»» auto_liability_ins_file_uploaded_by string false none The auto liability insurance policy file uploaded by user for the partner carrier. This field value can be null
»»»»»»»» pay_term PayTerm false none Pay term for Invoice
»»»»»»»»» id string(uuid) false none none
»»»»»»»»» created_at string(date-time) false none The time of the event’s creation
»»»»»»»»» updated_at string(date-time) false none The time the event was last updated
»»»»»»»»» org_id string(uuid) false none ID of the associated organization
»»»»»»»»» number_of_days integer false none Number of days in the pay term
»»»»»»»»» name string false none Name of the partner carrier
»»»»»»»»» connector_mappings PayTermConnectorMappings false none A (key, object) map, where the key is connector ID (represents the vendor) and the object contains vendor details associated with this Rose Rocket pay term.
»»»»»»»»»» additionalProperties PayTermConnectorMapping false none Maps Rose Rocket pay term to vendor pay term. For use with 3rd-party software integration.
»»»»»»»»»»» connector_id string true none The connector ID representing the vendor
»»»»»»»»»»» vendor_pay_term_id string true none The vendor’s pay term ID for this Rose Rocket pay term
»»»»»»»»»»» pay_term_id uuid false none The Rose Rocket pay term ID
»»»»»»»»»»» org_id uuid false none The Rose Rocket org ID
»»»»»»»»»» currency_info Currency false none Currency
»»»»»»»»»»» id string false read-only Identifier for the currency
»»»»»»»»»»» name string false read-only Name of the currency
»»»»»»»»»»» description string false read-only Description of the currency
»»»»»»»»»»» iso_4217 string false read-only The currency code as per the ISO4217 specification
»»»»»»»»»»» symbol string false read-only Symbol representing the currency
»»»»»»»»»» org_default_bill_tax Tax false none Tax

Get consolidated bill’s pdf

Code samples

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


GET https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/pdf HTTP/1.1
Host: platform.roserocket.com
Accept: application/pdf


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

};

$.ajax({
  url: 'https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/pdf',
  method: 'get',

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


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

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

};

fetch('https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/pdf',
{
  method: 'GET',

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


require 'rest-client'
require 'json'

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

result = RestClient.get 'https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/pdf',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.get('https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/pdf', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/pdf");
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/pdf"},
        "Authorization": []string{"Bearer {access-token}"},

    }

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

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

GET /consolidated_bills/{consolidatedBillID}/pdf

Get consolidated bill’s pdf by ID

Parameters

Name In Type Required Description
consolidatedBillID path string(uuid) true The Rose Rocket consolidated bill ID

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK The PDF file of the consolidated bill string
400 Bad Request Bad request ApiError

Update consolidated bill’s vendor export info

Code samples

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


POST https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info 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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info',
  method: 'post',

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


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

};

fetch('https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info',
{
  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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info',
  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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info");
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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info", data)
    req.Header = headers

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

POST /consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info

Update consolidated bill’s connector export info

Body parameter

{
  "vendor_bill_id": "string",
  "vendor_error_msg": "string"
}

Parameters

Name In Type Required Description
consolidatedBillID path string(uuid) true The Rose Rocket consolidated bill ID
connectorID path string true The Rose Rocket connector ID (e.g. “quickbooks”)
body body object true Fields required to create connector export info object
» vendor_bill_id body string false The vendor’s bill ID for the corresponding Rose Rocket consolidated bill (e.g. “85”)
» vendor_error_msg body string false The error message from vendor. It could be the raw JSON string format of the error from the vendor.

Example responses

200 Response

{
  "connector_export_info": {
    "connector_id": "string",
    "vendor_bill_id": "string",
    "consolidated_bill_id": "string",
    "org_id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "vendor_error_msg": "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
» connector_export_info ConsolidatedBillConnectorExportInfo false none Displays the consolidated bill’s 3rd party financial management integration export information.
»» connector_id string false none The Rose Rocket connector ID representing the vendor (e.g. “quickbooks”)
»» vendor_bill_id string false none The vendor’s bill ID for this Rose Rocket consolidated bill (e.g. “85”)
»» consolidated_bill_id string(uuid) false none The Rose Rocket consolidated bill ID
»» org_id string(uuid) false none The Rose Rocket org ID
»» created_at string(date-time) false none The timestamp of the consolidated bill’s first export
»» updated_at string(date-time) false none The timestamp of the consolidated bill’s last export
»» vendor_error_msg string false none The error message from vendor. It could be the raw JSON string format of the error from the vendor.

Delete a consolidated bill’s vendor export info

Code samples

# You can also use wget
curl -X DELETE https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info 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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info',
  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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info',
{
  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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.delete('https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info");
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/api/v1/consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info", data)
    req.Header = headers

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

DELETE /consolidated_bills/{consolidatedBillID}/connectors/{connectorID}/connector_export_info

Delete consolidated bill’s connector export info

Parameters

Name In Type Required Description
consolidatedBillID path string(uuid) true The Rose Rocket consolidated bill ID
connectorID path string true The Rose Rocket connector ID (e.g. “quickbooks”).

Example responses

200 Response

{
  "status": "success",
  "rows_affected": 1
}

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
» status string false none The status of the request.
» rows_affected integer false none The rows deleted of the request.

Enumerated Values

Property Value
status success

Connector Orgs

Update a Connector Org

Code samples

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


PUT https://platform.roserocket.com/api/v1/connectors_orgs/{connectorOrgID} 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/api/v1/connectors_orgs/{connectorOrgID}',
  method: 'put',

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


const fetch = require('node-fetch');
const inputBody = '{
  "id": "string",
  "created_at": "2021-09-16T18:11:26Z",
  "updated_at": "2021-09-16T18:11:26Z",
  "connector_id": "string",
  "org_id": "string",
  "app_id": "string",
  "integration_user_id": "string",
  "external_id": "string",
  "is_active": true,
  "activated_by_user_id": "string",
  "activated_at": "2021-09-16T18:11:26Z",
  "deactivated_by_user_id": "string",
  "deactivated_at": "2021-09-16T18:11:26Z",
  "config": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://platform.roserocket.com/api/v1/connectors_orgs/{connectorOrgID}',
{
  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/api/v1/connectors_orgs/{connectorOrgID}',
  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/api/v1/connectors_orgs/{connectorOrgID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/connectors_orgs/{connectorOrgID}");
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/api/v1/connectors_orgs/{connectorOrgID}", data)
    req.Header = headers

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

PUT /connectors_orgs/{connectorOrgID}

Update a Connector org by Id

Body parameter

{
  "id": "string",
  "created_at": "2021-09-16T18:11:26Z",
  "updated_at": "2021-09-16T18:11:26Z",
  "connector_id": "string",
  "org_id": "string",
  "app_id": "string",
  "integration_user_id": "string",
  "external_id": "string",
  "is_active": true,
  "activated_by_user_id": "string",
  "activated_at": "2021-09-16T18:11:26Z",
  "deactivated_by_user_id": "string",
  "deactivated_at": "2021-09-16T18:11:26Z",
  "config": {}
}

Parameters

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

Example responses

200 Response

{
  "connector_org": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "connector_id": "string",
    "org_id": "string",
    "app_id": "string",
    "integration_user_id": "string",
    "external_id": "string",
    "is_active": true,
    "activated_by_user_id": "string",
    "activated_at": "2021-09-16T18:11:26Z",
    "deactivated_by_user_id": "string",
    "deactivated_at": "2021-09-16T18:11:26Z",
    "config": {}
  }
}

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
» connector_org ConnectorOrg false none Connector Org
»» id string(uuid) false none none
»» created_at string(date-time) false none The timestamp for the creation of the connector org
»» updated_at string(date-time) false none The timestamp for the last update of the connector org
»» connector_id string(uuid) false none Id for the connector
»» org_id string(uuid) false none ID of the organization
»» app_id string(uuid) false none ID of the associated application
»» integration_user_id string(uuid) false none asdfasdf
»» external_id string(uuid) false none External ID
»» is_active boolean false none none
»» activated_by_user_id string(uuid) false none User ID of the user who activated the connector org. This field value can be null
»» activated_at string(date-time) false none The timestamp for the activation of the connector org. This field value can be null
»» deactivated_by_user_id string(uuid) false none User ID of the user who deactivated the connector org. This field value can be null
»» deactivated_at string(date-time) false none The timestamp for the de-activation of the connector org. This field value can be null
»» config object false none JSON Configuration file

Get a Connector Org

Code samples

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


GET https://platform.roserocket.com/api/v1/connectors_orgs/{connectorOrgID} 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/api/v1/connectors_orgs/{connectorOrgID}',
  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/api/v1/connectors_orgs/{connectorOrgID}',
{
  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/api/v1/connectors_orgs/{connectorOrgID}',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.get('https://platform.roserocket.com/api/v1/connectors_orgs/{connectorOrgID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/connectors_orgs/{connectorOrgID}");
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/api/v1/connectors_orgs/{connectorOrgID}", data)
    req.Header = headers

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

GET /connectors_orgs/{connectorOrgID}

Get a Connector org by Id

Parameters

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

Example responses

200 Response

{
  "connector_org": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "connector_id": "string",
    "org_id": "string",
    "app_id": "string",
    "integration_user_id": "string",
    "external_id": "string",
    "is_active": true,
    "activated_by_user_id": "string",
    "activated_at": "2021-09-16T18:11:26Z",
    "deactivated_by_user_id": "string",
    "deactivated_at": "2021-09-16T18:11:26Z",
    "config": {}
  }
}

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
» connector_org ConnectorOrg false none Connector Org
»» id string(uuid) false none none
»» created_at string(date-time) false none The timestamp for the creation of the connector org
»» updated_at string(date-time) false none The timestamp for the last update of the connector org
»» connector_id string(uuid) false none Id for the connector
»» org_id string(uuid) false none ID of the organization
»» app_id string(uuid) false none ID of the associated application
»» integration_user_id string(uuid) false none asdfasdf
»» external_id string(uuid) false none External ID
»» is_active boolean false none none
»» activated_by_user_id string(uuid) false none User ID of the user who activated the connector org. This field value can be null
»» activated_at string(date-time) false none The timestamp for the activation of the connector org. This field value can be null
»» deactivated_by_user_id string(uuid) false none User ID of the user who deactivated the connector org. This field value can be null
»» deactivated_at string(date-time) false none The timestamp for the de-activation of the connector org. This field value can be null
»» config object false none JSON Configuration file

Get a Connector Org by Company ID

Code samples

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


GET https://platform.roserocket.com/api/v1/connectors_orgs/by_company_id/{companyID} 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/api/v1/connectors_orgs/by_company_id/{companyID}',
  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/api/v1/connectors_orgs/by_company_id/{companyID}',
{
  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/api/v1/connectors_orgs/by_company_id/{companyID}',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.get('https://platform.roserocket.com/api/v1/connectors_orgs/by_company_id/{companyID}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/connectors_orgs/by_company_id/{companyID}");
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/api/v1/connectors_orgs/by_company_id/{companyID}", data)
    req.Header = headers

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

GET /connectors_orgs/by_company_id/{companyID}

Get a Connector org by company Id

Parameters

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

Example responses

200 Response

{
  "connector_org": {
    "id": "string",
    "created_at": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "connector_id": "string",
    "org_id": "string",
    "app_id": "string",
    "integration_user_id": "string",
    "external_id": "string",
    "is_active": true,
    "activated_by_user_id": "string",
    "activated_at": "2021-09-16T18:11:26Z",
    "deactivated_by_user_id": "string",
    "deactivated_at": "2021-09-16T18:11:26Z",
    "config": {}
  }
}

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
» connector_org ConnectorOrg false none Connector Org
»» id string(uuid) false none none
»» created_at string(date-time) false none The timestamp for the creation of the connector org
»» updated_at string(date-time) false none The timestamp for the last update of the connector org
»» connector_id string(uuid) false none Id for the connector
»» org_id string(uuid) false none ID of the organization
»» app_id string(uuid) false none ID of the associated application
»» integration_user_id string(uuid) false none asdfasdf
»» external_id string(uuid) false none External ID
»» is_active boolean false none none
»» activated_by_user_id string(uuid) false none User ID of the user who activated the connector org. This field value can be null
»» activated_at string(date-time) false none The timestamp for the activation of the connector org. This field value can be null
»» deactivated_by_user_id string(uuid) false none User ID of the user who deactivated the connector org. This field value can be null
»» deactivated_at string(date-time) false none The timestamp for the de-activation of the connector org. This field value can be null
»» config object false none JSON Configuration file

Order

Create Order

Code samples

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


POST https://platform.roserocket.com/api/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/api/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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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/api/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/api/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/api/v1/customers/{customerID}/orders', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/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/api/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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "port_of_entry": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2021-09-16T18:11:26Z",
    "pickup_start_at_local": "2021-09-16T18:11:26Z",
    "pickup_end_at": "2021-09-16T18:11:26Z",
    "pickup_end_at_local": "2021-09-16T18:11:26Z",
    "pickup_appt_start_at": "2021-09-16T18:11:26Z",
    "pickup_appt_start_at_local": "2021-09-16T18:11:26Z",
    "pickup_appt_end_at": "2021-09-16T18:11:26Z",
    "pickup_appt_end_at_local": "2021-09-16T18:11:26Z",
    "delivery_start_at": "2021-09-16T18:11:26Z",
    "delivery_start_at_local": "2021-09-16T18:11:26Z",
    "delivery_end_at": "2021-09-16T18:11:26Z",
    "delivery_end_at_local": "2021-09-16T18:11:26Z",
    "delivery_appt_start_at": "2021-09-16T18:11:26Z",
    "delivery_appt_start_at_local": "2021-09-16T18:11:26Z",
    "delivery_appt_end_at": "2021-09-16T18:11:26Z",
    "delivery_appt_end_at_local": "2021-09-16T18:11:26Z",
    "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
»»» timezone string false read-only Timezone of address
»» 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
»» port_of_entry string false none Port of entry in cross-border order
»» 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) in UTC
»» pickup_start_at_local string(date-time) false read-only Pickup time range (start) in local time
»» pickup_end_at string(date-time) false none Pickup time range (end) in UTC
»» pickup_end_at_local string(date-time) false read-only Pickup time range (end) in local time
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start) in UTC. This field value can be null
»» pickup_appt_start_at_local string(date-time) false read-only Pickup appointment time range (start) in local time. This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end) in UTC. This field value can be null
»» pickup_appt_end_at_local string(date-time) false read-only Pickup appointment time range (end) in local time. This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start) in UTC. This field value can be null
»» delivery_start_at_local string(date-time) false read-only Expected delivery time range (start) in local time. This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end) in UTC. This field value can be null
»» delivery_end_at_local string(date-time) false read-only Expected delivery time range (end) in local time. This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start) in UTC. This field value can be null
»» delivery_appt_start_at_local string(date-time) false read-only Delivery appointment time range (start) in local time. This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end) in UTC. This field value can be null
»» delivery_appt_end_at_local string(date-time) false read-only Delivery appointment time range (end) in local time. 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

Create Order Problem

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/api/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/api/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/api/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/api/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/api/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/api/v1/customers/{customerID}/orders/{orderID}/problems', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/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/api/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 a problem on an 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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "port_of_entry": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2021-09-16T18:11:26Z",
    "pickup_start_at_local": "2021-09-16T18:11:26Z",
    "pickup_end_at": "2021-09-16T18:11:26Z",
    "pickup_end_at_local": "2021-09-16T18:11:26Z",
    "pickup_appt_start_at": "2021-09-16T18:11:26Z",
    "pickup_appt_start_at_local": "2021-09-16T18:11:26Z",
    "pickup_appt_end_at": "2021-09-16T18:11:26Z",
    "pickup_appt_end_at_local": "2021-09-16T18:11:26Z",
    "delivery_start_at": "2021-09-16T18:11:26Z",
    "delivery_start_at_local": "2021-09-16T18:11:26Z",
    "delivery_end_at": "2021-09-16T18:11:26Z",
    "delivery_end_at_local": "2021-09-16T18:11:26Z",
    "delivery_appt_start_at": "2021-09-16T18:11:26Z",
    "delivery_appt_start_at_local": "2021-09-16T18:11:26Z",
    "delivery_appt_end_at": "2021-09-16T18:11:26Z",
    "delivery_appt_end_at_local": "2021-09-16T18:11:26Z",
    "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": "2021-09-16T18:11:26Z",
    "updated_at": "2021-09-16T18:11:26Z",
    "order_id": "string",
    "type": "string",
    "title": "string",
    "description": "string",
    "created_by": "string",
    "resolved_by": "string",
    "resolved_at": "2021-09-16T18:11:26Z"
  }
}

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
»»» timezone string false read-only Timezone of address
»» 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
»» port_of_entry string false none Port of entry in cross-border order
»» 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) in UTC
»» pickup_start_at_local string(date-time) false read-only Pickup time range (start) in local time
»» pickup_end_at string(date-time) false none Pickup time range (end) in UTC
»» pickup_end_at_local string(date-time) false read-only Pickup time range (end) in local time
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start) in UTC. This field value can be null
»» pickup_appt_start_at_local string(date-time) false read-only Pickup appointment time range (start) in local time. This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end) in UTC. This field value can be null
»» pickup_appt_end_at_local string(date-time) false read-only Pickup appointment time range (end) in local time. This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start) in UTC. This field value can be null
»» delivery_start_at_local string(date-time) false read-only Expected delivery time range (start) in local time. This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end) in UTC. This field value can be null
»» delivery_end_at_local string(date-time) false read-only Expected delivery time range (end) in local time. This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start) in UTC. This field value can be null
»» delivery_appt_start_at_local string(date-time) false read-only Delivery appointment time range (start) in local time. This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end) in UTC. This field value can be null
»» delivery_appt_end_at_local string(date-time) false read-only Delivery appointment time range (end) in local time. 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

Upsert Order by External ID

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/api/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/api/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/api/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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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/api/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/api/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/api/v1/customers/{customerID}/orders/{orderID}/upsert', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/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/api/v1/customers/{customerID}/orders/{orderID}/upsert", data)
    req.Header = headers

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

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

Upsert an 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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "port_of_entry": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "pickup_start_at": "2021-09-16T18:11:26Z",
    "pickup_start_at_local": "2021-09-16T18:11:26Z",
    "pickup_end_at": "2021-09-16T18:11:26Z",
    "pickup_end_at_local": "2021-09-16T18:11:26Z",
    "pickup_appt_start_at": "2021-09-16T18:11:26Z",
    "pickup_appt_start_at_local": "2021-09-16T18:11:26Z",
    "pickup_appt_end_at": "2021-09-16T18:11:26Z",
    "pickup_appt_end_at_local": "2021-09-16T18:11:26Z",
    "delivery_start_at": "2021-09-16T18:11:26Z",
    "delivery_start_at_local": "2021-09-16T18:11:26Z",
    "delivery_end_at": "2021-09-16T18:11:26Z",
    "delivery_end_at_local": "2021-09-16T18:11:26Z",
    "delivery_appt_start_at": "2021-09-16T18:11:26Z",
    "delivery_appt_start_at_local": "2021-09-16T18:11:26Z",
    "delivery_appt_end_at": "2021-09-16T18:11:26Z",
    "delivery_appt_end_at_local": "2021-09-16T18:11:26Z",
    "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
»»» timezone string false read-only Timezone of address
»» 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
»» port_of_entry string false none Port of entry in cross-border order
»» 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) in UTC
»» pickup_start_at_local string(date-time) false read-only Pickup time range (start) in local time
»» pickup_end_at string(date-time) false none Pickup time range (end) in UTC
»» pickup_end_at_local string(date-time) false read-only Pickup time range (end) in local time
»» pickup_appt_start_at string(date-time) false none Pickup appointment time range (start) in UTC. This field value can be null
»» pickup_appt_start_at_local string(date-time) false read-only Pickup appointment time range (start) in local time. This field value can be null
»» pickup_appt_end_at string(date-time) false none Pickup appointment time range (end) in UTC. This field value can be null
»» pickup_appt_end_at_local string(date-time) false read-only Pickup appointment time range (end) in local time. This field value can be null
»» delivery_start_at string(date-time) false none Expected delivery time range (start) in UTC. This field value can be null
»» delivery_start_at_local string(date-time) false read-only Expected delivery time range (start) in local time. This field value can be null
»» delivery_end_at string(date-time) false none Expected delivery time range (end) in UTC. This field value can be null
»» delivery_end_at_local string(date-time) false read-only Expected delivery time range (end) in local time. This field value can be null
»» delivery_appt_start_at string(date-time) false none Delivery appointment time range (start) in UTC. This field value can be null
»» delivery_appt_start_at_local string(date-time) false read-only Delivery appointment time range (start) in local time. This field value can be null
»» delivery_appt_end_at string(date-time) false none Delivery appointment time range (end) in UTC. This field value can be null
»» delivery_appt_end_at_local string(date-time) false read-only Delivery appointment time range (end) in local time. 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

Revise Order

Code samples

# You can also use wget
curl -X PUT https://platform.roserocket.com/api/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/api/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/api/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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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/api/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/api/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/api/v1/customers/{customerID}/orders/{orderID}/revise', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/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/api/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 an Order by Customer and Order 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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "status": "new",
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_end_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at_local": "2021-09-16T18:11:26Z",
  "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

Edit Order After Dispatched

Code samples

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


PUT https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/edit_after_dispatched 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/api/v1/customers/{customerID}/orders/{orderID}/edit_after_dispatched',
  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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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/api/v1/customers/{customerID}/orders/{orderID}/edit_after_dispatched',
{
  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/api/v1/customers/{customerID}/orders/{orderID}/edit_after_dispatched',
  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/api/v1/customers/{customerID}/orders/{orderID}/edit_after_dispatched', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/edit_after_dispatched");
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/api/v1/customers/{customerID}/orders/{orderID}/edit_after_dispatched", data)
    req.Header = headers

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

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

Edit an order after it has been dispatched

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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "status": "new",
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_end_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at_local": "2021-09-16T18:11:26Z",
  "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

Mark Order In Transit

Code samples

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


POST https://platform.roserocket.com/api/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/api/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/api/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/api/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/api/v1/customers/{customerID}/orders/{orderID}/mark_in_transit', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/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/api/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 as “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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "status": "new",
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_end_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at_local": "2021-09-16T18:11:26Z",
  "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

Mark Order as Delivered

Code samples

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


POST https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/mark_delivered 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/api/v1/customers/{customerID}/orders/{orderID}/mark_delivered',
  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/api/v1/customers/{customerID}/orders/{orderID}/mark_delivered',
{
  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/api/v1/customers/{customerID}/orders/{orderID}/mark_delivered',
  params: {
  }, headers: headers

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/mark_delivered");
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/api/v1/customers/{customerID}/orders/{orderID}/mark_delivered", data)
    req.Header = headers

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

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

Mark order as “Delivered”

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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z",
    "timezone": "string"
  },
  "status": "new",
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "pickup_end_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at": "2021-09-16T18:11:26Z",
  "pickup_appt_start_at_local": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at": "2021-09-16T18:11:26Z",
  "pickup_appt_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_start_at": "2021-09-16T18:11:26Z",
  "delivery_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_end_at": "2021-09-16T18:11:26Z",
  "delivery_end_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at": "2021-09-16T18:11:26Z",
  "delivery_appt_start_at_local": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at": "2021-09-16T18:11:26Z",
  "delivery_appt_end_at_local": "2021-09-16T18:11:26Z",
  "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

Bulk Create Orders

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/api/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/api/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/api/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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "port_of_entry": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "pickup_appt_start_at": "2021-09-16T18:11:26Z",
      "pickup_appt_end_at": "2021-09-16T18:11:26Z",
      "delivery_start_at": "2021-09-16T18:11:26Z",
      "delivery_end_at": "2021-09-16T18:11:26Z",
      "delivery_appt_start_at": "2021-09-16T18:11:26Z",
      "delivery_appt_end_at": "2021-09-16T18:11:26Z",
      "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/api/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/api/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/api/v1/customers/{customerID}/orders/bulk_create', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/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/api/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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "port_of_entry": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "pickup_appt_start_at": "2021-09-16T18:11:26Z",
      "pickup_appt_end_at": "2021-09-16T18:11:26Z",
      "delivery_start_at": "2021-09-16T18:11:26Z",
      "delivery_end_at": "2021-09-16T18:11:26Z",
      "delivery_appt_start_at": "2021-09-16T18:11:26Z",
      "delivery_appt_end_at": "2021-09-16T18:11:26Z",
      "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 Bulk_Create_OrdersBody 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
»»» timezone body string false Timezone of address
»» 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
»» port_of_entry body string false Port of entry in cross-border order
»» 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) in UTC
»» pickup_start_at_local body string(date-time) false Pickup time range (start) in local time
»» pickup_end_at body string(date-time) false Pickup time range (end) in UTC
»» pickup_end_at_local body string(date-time) false Pickup time range (end) in local time
»» pickup_appt_start_at body string(date-time) false Pickup appointment time range (start) in UTC. This field value can be null
»» pickup_appt_start_at_local body string(date-time) false Pickup appointment time range (start) in local time. This field value can be null
»» pickup_appt_end_at body string(date-time) false Pickup appointment time range (end) in UTC. This field value can be null
»» pickup_appt_end_at_local body string(date-time) false Pickup appointment time range (end) in local time. This field value can be null
»» delivery_start_at body string(date-time) false Expected delivery time range (start) in UTC. This field value can be null
»» delivery_start_at_local body string(date-time) false Expected delivery time range (start) in local time. This field value can be null
»» delivery_end_at body string(date-time) false Expected delivery time range (end) in UTC. This field value can be null
»» delivery_end_at_local body string(date-time) false Expected delivery time range (end) in local time. This field value can be null
»» delivery_appt_start_at body string(date-time) false Delivery appointment time range (start) in UTC. This field value can be null
»» delivery_appt_start_at_local body string(date-time) false Delivery appointment time range (start) in local time. This field value can be null
»» delivery_appt_end_at body string(date-time) false Delivery appointment time range (end) in UTC. This field value can be null
»» delivery_appt_end_at_local body string(date-time) false Delivery appointment time range (end) in local time. 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/api/v1/customers/{customerID}/orders/multistop_orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://platform.roserocket.com/api/v1/customers/{customerID}/orders/multistop_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/api/v1/customers/{customerID}/orders/multistop_orders',
  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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "stops": [
    {
      "external_id": "string",
      "term": "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "port_of_entry": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "pickup_appt_start_at": "2021-09-16T18:11:26Z",
      "pickup_appt_end_at": "2021-09-16T18:11:26Z",
      "delivery_start_at": "2021-09-16T18:11:26Z",
      "delivery_end_at": "2021-09-16T18:11:26Z",
      "delivery_appt_start_at": "2021-09-16T18:11:26Z",
      "delivery_appt_end_at": "2021-09-16T18:11:26Z",
      "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/api/v1/customers/{customerID}/orders/multistop_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/api/v1/customers/{customerID}/orders/multistop_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/api/v1/customers/{customerID}/orders/multistop_orders', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/customers/{customerID}/orders/multistop_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/api/v1/customers/{customerID}/orders/multistop_orders", data)
    req.Header = headers

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

POST /customers/{customerID}/orders/multistop_orders

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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "stops": [
    {
      "external_id": "string",
      "term": "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "port_of_entry": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "pickup_appt_start_at": "2021-09-16T18:11:26Z",
      "pickup_appt_end_at": "2021-09-16T18:11:26Z",
      "delivery_start_at": "2021-09-16T18:11:26Z",
      "delivery_end_at": "2021-09-16T18:11:26Z",
      "delivery_appt_start_at": "2021-09-16T18:11:26Z",
      "delivery_appt_end_at": "2021-09-16T18:11:26Z",
      "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 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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "port_of_entry": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "stops": [
      {
        "id": "string",
        "sequence_id": 0,
        "external_id": "string",
        "term": "string",
        "public_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": "2021-09-16T18:11:26Z",
          "bus_hours_end_at": "2021-09-16T18:11:26Z",
          "timezone": "string"
        },
        "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": "2021-09-16T18:11:26Z",
          "bus_hours_end_at": "2021-09-16T18:11:26Z",
          "timezone": "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": "2021-09-16T18:11:26Z",
          "bus_hours_end_at": "2021-09-16T18:11:26Z",
          "timezone": "string"
        },
        "status": "new",
        "billing_option": "prepaid",
        "notes": "string",
        "po_num": "string",
        "tender_num": "string",
        "ref_num": "string",
        "custom_broker": "string",
        "port_of_entry": "string",
        "declared_value": 0,
        "declared_value_currency": "cad",
        "pickup_start_at": "2021-09-16T18:11:26Z",
        "pickup_end_at": "2021-09-16T18:11:26Z",
        "pickup_appt_start_at": "2021-09-16T18:11:26Z",
        "pickup_appt_end_at": "2021-09-16T18:11:26Z",
        "delivery_start_at": "2021-09-16T18:11:26Z",
        "delivery_end_at": "2021-09-16T18:11:26Z",
        "delivery_appt_start_at": "2021-09-16T18:11:26Z",
        "delivery_appt_end_at": "2021-09-16T18:11:26Z",
        "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 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
»»» timezone string false read-only Timezone of 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
»» port_of_entry string false none Port of entry in cross-border order
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» stops [OrderStop] false none [Customer’s multistop orders’s stop 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
»»» term string false none Billing period
»»» public_id string false read-only Auto generated human readable ID
»»» customer OrderCustomer false none Customer
»»» origin OrderAddress true none Order address
»»» 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
»»» port_of_entry string false none Port of entry in cross-border order
»»» 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
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

Update Multistop Order

Code samples

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


PUT https://platform.roserocket.com/api/v1/customers/{customerID}/orders/multistop_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/api/v1/customers/{customerID}/orders/multistop_orders',
  method: 'put',

  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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "stops": [
    {
      "external_id": "string",
      "term": "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "port_of_entry": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "pickup_appt_start_at": "2021-09-16T18:11:26Z",
      "pickup_appt_end_at": "2021-09-16T18:11:26Z",
      "delivery_start_at": "2021-09-16T18:11:26Z",
      "delivery_end_at": "2021-09-16T18:11:26Z",
      "delivery_appt_start_at": "2021-09-16T18:11:26Z",
      "delivery_appt_end_at": "2021-09-16T18:11:26Z",
      "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/api/v1/customers/{customerID}/orders/multistop_orders',
{
  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/api/v1/customers/{customerID}/orders/multistop_orders',
  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/api/v1/customers/{customerID}/orders/multistop_orders', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/customers/{customerID}/orders/multistop_orders");
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/api/v1/customers/{customerID}/orders/multistop_orders", data)
    req.Header = headers

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

PUT /customers/{customerID}/orders/multistop_orders

Update 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": "2021-09-16T18:11:26Z",
    "bus_hours_end_at": "2021-09-16T18:11:26Z"
  },
  "billing_option": "prepaid",
  "notes": "string",
  "po_num": "string",
  "tender_num": "string",
  "ref_num": "string",
  "custom_broker": "string",
  "port_of_entry": "string",
  "declared_value": 0,
  "declared_value_currency": "cad",
  "stops": [
    {
      "external_id": "string",
      "term": "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "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": "2021-09-16T18:11:26Z",
        "bus_hours_end_at": "2021-09-16T18:11:26Z"
      },
      "billing_option": "prepaid",
      "notes": "string",
      "po_num": "string",
      "tender_num": "string",
      "ref_num": "string",
      "custom_broker": "string",
      "port_of_entry": "string",
      "declared_value": 0,
      "declared_value_currency": "cad",
      "pickup_start_at": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "pickup_appt_start_at": "2021-09-16T18:11:26Z",
      "pickup_appt_end_at": "2021-09-16T18:11:26Z",
      "delivery_start_at": "2021-09-16T18:11:26Z",
      "delivery_end_at": "2021-09-16T18:11:26Z",
      "delivery_appt_start_at": "2021-09-16T18:11:26Z",
      "delivery_appt_end_at": "2021-09-16T18:11:26Z",
      "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 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": "2021-09-16T18:11:26Z",
      "bus_hours_end_at": "2021-09-16T18:11:26Z",
      "timezone": "string"
    },
    "status": "new",
    "billing_option": "prepaid",
    "notes": "string",
    "po_num": "string",
    "tender_num": "string",
    "ref_num": "string",
    "custom_broker": "string",
    "port_of_entry": "string",
    "declared_value": 0,
    "declared_value_currency": "cad",
    "stops": [
      {
        "id": "string",
        "sequence_id": 0,
        "external_id": "string",
        "term": "string",
        "public_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": "2021-09-16T18:11:26Z",
          "bus_hours_end_at": "2021-09-16T18:11:26Z",
          "timezone": "string"
        },
        "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": "2021-09-16T18:11:26Z",
          "bus_hours_end_at": "2021-09-16T18:11:26Z",
          "timezone": "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": "2021-09-16T18:11:26Z",
          "bus_hours_end_at": "2021-09-16T18:11:26Z",
          "timezone": "string"
        },
        "status": "new",
        "billing_option": "prepaid",
        "notes": "string",
        "po_num": "string",
        "tender_num": "string",
        "ref_num": "string",
        "custom_broker": "string",
        "port_of_entry": "string",
        "declared_value": 0,
        "declared_value_currency": "cad",
        "pickup_start_at": "2021-09-16T18:11:26Z",
        "pickup_end_at": "2021-09-16T18:11:26Z",
        "pickup_appt_start_at": "2021-09-16T18:11:26Z",
        "pickup_appt_end_at": "2021-09-16T18:11:26Z",
        "delivery_start_at": "2021-09-16T18:11:26Z",
        "delivery_end_at": "2021-09-16T18:11:26Z",
        "delivery_appt_start_at": "2021-09-16T18:11:26Z",
        "delivery_appt_end_at": "2021-09-16T18:11:26Z",
        "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 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
»»» timezone string false read-only Timezone of 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
»» port_of_entry string false none Port of entry in cross-border order
»» declared_value number(float) false none Declared value
»» declared_value_currency string false none Declared value currency
»» stops [OrderStop] false none [Customer’s multistop orders’s stop 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
»»» term string false none Billing period
»»» public_id string false read-only Auto generated human readable ID
»»» customer OrderCustomer false none Customer
»»» origin OrderAddress true none Order address
»»» 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
»»» port_of_entry string false none Port of entry in cross-border order
»»» 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
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

Get Order Proof of Pickup

Code samples

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


GET https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/pop 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/api/v1/customers/{customerID}/orders/{orderID}/pop',
  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/api/v1/customers/{customerID}/orders/{orderID}/pop',
{
  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/api/v1/customers/{customerID}/orders/{orderID}/pop',
  params: {
  }, headers: headers

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/pop");
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/api/v1/customers/{customerID}/orders/{orderID}/pop", data)
    req.Header = headers

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

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

Get proof of pickup order with orderID and customerID

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

{
  "created_at": "2021-09-16T18:11:26Z",
  "updated_at": "2021-09-16T18:11:26Z",
  "deleted_at": "2021-09-16T18:11:26Z",
  "id": "string",
  "Customer": "string",
  "Status": "string",
  "type": "string",
  "Date": "2021-09-16T18:11:26Z",
  "Signee": "string",
  "Latitude": "string",
  "Longitude": "string",
  "FileURL": "string",
  "SigFileURL": "string",
  "UploadedAt": "string",
  "UploadedBy": "string"
}

Responses

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

Get Order Proof of delivery

Code samples

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


GET https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/pod 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/api/v1/customers/{customerID}/orders/{orderID}/pod',
  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/api/v1/customers/{customerID}/orders/{orderID}/pod',
{
  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/api/v1/customers/{customerID}/orders/{orderID}/pod',
  params: {
  }, headers: headers

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/pod");
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/api/v1/customers/{customerID}/orders/{orderID}/pod", data)
    req.Header = headers

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

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

Get proof of Delivery order with orderID and customerID

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

{
  "created_at": "2021-09-16T18:11:26Z",
  "updated_at": "2021-09-16T18:11:26Z",
  "deleted_at": "2021-09-16T18:11:26Z",
  "id": "string",
  "Customer": "string",
  "Status": "string",
  "type": "string",
  "Date": "2021-09-16T18:11:26Z",
  "Signee": "string",
  "Latitude": "string",
  "Longitude": "string",
  "FileURL": "string",
  "SigFileURL": "string",
  "UploadedAt": "string",
  "UploadedBy": "string"
}

Responses

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

Bulk Create Quotes

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/api/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/api/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/api/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": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "est_delivery_start_at": "2021-09-16T18:11:26Z",
      "est_delivery_end_at": "2021-09-16T18:11:26Z",
      "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/api/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/api/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/api/v1/customers/{customerID}/orders/{orderID}/quotes/create_bulk', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/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/api/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": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "est_delivery_start_at": "2021-09-16T18:11:26Z",
      "est_delivery_end_at": "2021-09-16T18:11:26Z",
      "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": "2021-09-16T18:11:26Z",
      "pickup_end_at": "2021-09-16T18:11:26Z",
      "est_delivery_start_at": "2021-09-16T18:11:26Z",
      "est_delivery_end_at": "2021-09-16T18:11:26Z",
      "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

Select Order Quote

Code samples

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


POST https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/quotes/{quoteID}/select 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/api/v1/customers/{customerID}/orders/{orderID}/quotes/{quoteID}/select',
  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/api/v1/customers/{customerID}/orders/{orderID}/quotes/{quoteID}/select',
{
  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/api/v1/customers/{customerID}/orders/{orderID}/quotes/{quoteID}/select',
  params: {
  }, headers: headers

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


URL obj = new URL("https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/quotes/{quoteID}/select");
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/api/v1/customers/{customerID}/orders/{orderID}/quotes/{quoteID}/select", data)
    req.Header = headers

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

POST /customers/{customerID}/orders/{orderID}/quotes/{quoteID}/select

Select a quote for a given customer, order and quote.

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.
quoteID path string true ID of the quote to select.

Example responses

200 Response

{
  "id": "string",
  "order_id": "string",
  "currency": "cad",
  "customer_service_id": "string",
  "is_expired": true,
  "pickup_start_at": "2021-09-16T18:11:26Z",
  "pickup_end_at": "2021-09-16T18:11:26Z",
  "est_delivery_start_at": "2021-09-16T18:11:26Z",
  "est_delivery_end_at": "2021-09-16T18:11:26Z",
  "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 Quote
400 Bad Request Bad request ApiError

Bulk Create Booked Orders

Code samples

# You can also use wget
curl -X POST https://platform.roserocket.com/api/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/api/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/api/v1/customers/{customerID}/bulk_create_booked_order',
  method: 'post',

  headers