FleetRunnr API documentation

Get Order

GET /orders

Retrieve a single order by order_number or external_id

Query parameters

external_id string Required

The ID generated by your system (required if order_number is not specified)
order_number string Required

The unique order number generated by FleetRunnr (required if external_id is not specified)

Responses

• 200
Hide response attributes Show response attributes object
- message string
- data object
  
  Hide data attribute Show data attribute
  
  order object
  
  Hide order attributes Show order attributes
  
  source_contact object
  
  Hide source_contact attributes Show source_contact attributes
  
  uuid string
  
  name string
  
  email string(email)
  
  phone string(phone)
  
  Contact's phone number in E.164 international format
  
  destination_location object
  
  Hide destination_location attributes Show destination_location attributes
  
  id integer
  
  external_id string
  
  name string
  
  line_1 string
  
  line_2 string
  
  city string
  
  region string
  
  country string
  
  Country code in ISO-2 format
  
  coordinates object
  
  Hide coordinates attributes Show coordinates attributes
  
  lat number
  
  Minimum value is -90, maximum value is 90.
  
  lng number
  
  Minimum value is -180, maximum value is 180.
  
  zip_code string
  
  directions string
  
  verified_at string(date-time)
  
  can_edit boolean
  
  destination_contact object
  
  Hide destination_contact attributes Show destination_contact attributes
  
  uuid string
  
  name string
  
  email string(email)
  
  phone string(phone)
  
  Contact's phone number in E.164 international format
  
  skills array[string]
  
  Values are cooler, freezer, narcotics, heater, pos_machine, driver_assistant, or lift.
  
  proof_of_delivery object
  
  Hide proof_of_delivery attributes Show proof_of_delivery attributes
  
  signature boolean
  
  Indicate whether to require a signature upon delivery
  
  image boolean
  
  Indicate whether to require a picture to be taken upon delivery
  
  pickup_schedule object
  
  Hide pickup_schedule attributes Show pickup_schedule attributes
  
  from string(date-time)
  
  Should be in UTC timezone
  
  Format should match the following pattern: YYYY-MM-DD HH:MM.
  
  to string(date-time)
  
  Should be in UTC timezone
  
  Format should match the following pattern: YYYY-MM-DD HH:MM.
  
  delivery_schedule object
  
  Hide delivery_schedule attributes Show delivery_schedule attributes
  
  from string(date-time)
  
  Should be in UTC timezone
  
  Format should match the following pattern: YYYY-MM-DD HH:MM.
  
  to string(date-time)
  
  Should be in UTC timezone
  
  Format should match the following pattern: YYYY-MM-DD HH:MM.
  
  packages array[object]
  
  Hide packages attributes Show packages attributes
  
  uuid string(uuid)
  
  external_id string
  
  barcode string
  
  The unique barcode for this package
  
  type string
  
  Values are ENVELOPE, BAG, or BOX.
  
  length number
  
  Minimum value is 0.
  
  width number
  
  Minimum value is 0.
  
  height number
  
  Minimum value is 0.
  
  weight number
  
  Minimum value is 0.
  
  length_unit string
  
  Values are cm or in.
  
  weight_unit string
  
  Values are kg or oz.
  
  collections array[object]
  
  The collections to be expected on delivery (multiple collections can be present for different currencies)
  
  Hide collections attributes Show collections attributes
  
  uuid string
  
  type string
  
  Collection's payment method
  
  Values are CASH, CHEQUE, or CREDIT_CARD.
  
  amount number
  
  Minimum value is 0.
  
  currency string
  
  Currency in ISO-3 format
  
  amount_formatted string
  
  is_prepayment boolean
  
  prepaid_at string(date-time)
  
  collected_at string(date-time)
  
  tags array[string]
  
  The tags should be sent as an array of strings
  
  is_return boolean
  
  Indicates that the order is using the return workflow (sourced from a customer)
  
  notes string
  
  created_at string(date-time)
  
  The timestamp when the order was created
  
  Format should match the following pattern: YYYY-MM-DD HH:MM.
  
  uuid string(uuid)
  
  order_number string
  
  The unique order number used for tracking purposes
  
  external_id string
  
  The order ID generated from a third-party system such as a CRM, POS, or accounting software
  
  tracking_url string(uri)
  
  The tracking URL for this order
  
  status string
  
  Values are NEW, READY, DISPATCHED, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, DELIVERY_ATTEMPTED, CANCELLED, CLOSED, DISPATCHED_FOR_RETURN, RETURN_IN_PROGRESS, or RETURN_ATTEMPTED.
  
  carrier object
  
  Hide carrier attributes Show carrier attributes
  
  uuid string
  
  name string
  
  agent string
  
  shipping_method object
  
  Hide shipping_method attributes Show shipping_method attributes
  
  name string
  
  currency string
  
  base_fee number
  
  fees array[object]
  
  Hide fees attributes Show fees attributes
  
  type string
  
  currency string
  
  amount number
  
  customer object
  
  Hide customer attributes Show customer attributes
  
  id integer
  
  uuid string(uuid)
  
  external_id string
  
  Customer's ID generated from a third-party system such as a CRM, POS, or accounting software
  
  name string
  
  email string(email)
  
  phone string(phone)
  
  Customer's phone number in E.164 international format
  
  avatar string
  
  source_location object
  
  Hide source_location attributes Show source_location attributes
  
  region string
  
  country string
  
  Country code in ISO-2 format
  
  coordinates object
  
  Hide coordinates attributes Show coordinates attributes
  
  lat number
  
  Minimum value is -90, maximum value is 90.
  
  lng number
  
  Minimum value is -180, maximum value is 180.
  
  zip_code string
  
  directions string
  
  verified_at string(date-time)
  
  can_edit boolean
  
  id integer
  
  external_id string
  
  name string
  
  line_1 string
  
  line_2 string
  
  city string

GET /orders

curl \
 -X GET https://{workspace}.fleetrunnr.com/api/v1/orders?external_id=string&order_number=string \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "message": "string",
  "data": {
    "order": {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "order_number": "3453224232",
      "external_id": "66",
      "tracking_url": "http://example.com",
      "status": "NEW",
      "carrier": {
        "uuid": "a8bacf14-19ec-42b8-8911-a293295236bc",
        "name": "ABC Logistics",
        "agent": "John Doe",
        "shipping_method": {
          "name": "standard USD",
          "currency": "USD",
          "amount": 3.5
        },
        "fees": [
          {
            "type": "SHIPPING_FEE",
            "currency": "USD",
            "amount": 3.5
          }
        ]
      },
      "customer": {
        "id": 1,
        "uuid": "69e93118-a581-4a13-afea-b6d4a2d2c40c",
        "external_id": "ABCDE12345",
        "name": "John Doe",
        "email": "john.ondricka@example.com",
        "phone": "+12163547758",
        "avatar": null
      },
      "source_location": {
        "id": 1,
        "external_id": "12hh",
        "name": "Main Warehouse",
        "line_1": "2313 Retreat Avenue",
        "line_2": "Ste 300",
        "city": "Birmingham",
        "region": "Alabama",
        "country": "US",
        "coordinates": {
          "lat": 33.527805,
          "lng": -86.768112
        },
        "zip_code": "35203",
        "directions": null,
        "verified_at": null,
        "can_edit": false
      },
      "source_contact": {
        "uuid": "466816155898609664",
        "name": "Amanda Murrin",
        "email": "amanda.murrin@example.com",
        "phone": "+12025550159"
      },
      "destination_location": {
        "id": 1,
        "external_id": "12hh",
        "name": "Main Warehouse",
        "line_1": "2313 Retreat Avenue",
        "line_2": "Ste 300",
        "city": "Birmingham",
        "region": "Alabama",
        "country": "US",
        "coordinates": {
          "lat": 33.527805,
          "lng": -86.768112
        },
        "zip_code": "35203",
        "directions": null,
        "verified_at": null,
        "can_edit": false
      },
      "destination_contact": {
        "uuid": "466816155898609664",
        "name": "Amanda Murrin",
        "email": "amanda.murrin@example.com",
        "phone": "+12025550159"
      },
      "skills": [
        "cooler"
      ],
      "proof_of_delivery": {
        "signature": true,
        "image": true
      },
      "pickup_schedule": {
        "from": "2022-01-20 13:30",
        "to": "2022-01-20 15:00"
      },
      "delivery_schedule": {
        "from": "2022-01-23 09:00",
        "to": "2022-01-23 11:30"
      },
      "packages": [
        {
          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
          "external_id": "12hj",
          "barcode": "383176549899173888",
          "type": "PARCEL",
          "length": 20,
          "width": 30,
          "height": 1,
          "weight": 0.25,
          "length_unit": "cm",
          "weight_unit": "kg"
        }
      ],
      "collections": [
        {
          "uuid": "5fba3265-8a6a-4969-9682-889f410e9193",
          "type": "CASH",
          "amount": 120.75,
          "currency": "USD",
          "amount_formatted": "$120.75",
          "is_prepayment": false
        }
      ],
      "tags": [
        "Tag1",
        "Tag2"
      ],
      "is_return": true,
      "notes": "some notes here..",
      "created_at": "2022-01-20 13:30"
    }
  }
}