FleetRunnr API documentation

Changelog

Last update:
Compare

API structure has changed

Modified 3
GET /orders
  • Response
  • 200 response Modified
    • data attribute Modified
PATCH /orders/{order_uuid}
  • Body
  • content type Modified
    • tags attribute Added
POST /orders
  • Body
  • content type Modified
    • tags attribute Modified
  • Response
  • 200 response Modified
    • data attribute Modified

API structure has changed

Modified 2
GET /orders
  • Response
  • 200 response Modified
    • data attribute Modified
POST /orders
  • Body
  • content type Modified
    • requirements attribute Added

API structure has changed

Added 1
POST /locations

API structure has changed

Modified 9 Breaking
GET /carriers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /customers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /locations
  • Response
  • 200 response Modified
    • data attribute Modified
GET /orders
  • Response
  • 200 response Modified
    • data attribute Modified
PATCH /orders/{order_uuid}
  • Body
  • content type Modified
    • source_contact, destination_contact, collections attributes Added
POST /carriers/rates
  • Body
  • content type Modified
    • source_location, destination_location attributes Removed
    • source, destination, length, width, height, dimensions_unit attributes Added
POST /customers
  • Body
  • content type Modified
    • type, metafields attributes Added
POST /orders
  • Body
  • content type Modified
    • source_location, destination_location, packages attributes Modified
    • tags attribute Added
PUT /customers/{customer_uuid}
  • Body
  • content type Modified
    • type, metafields attributes Added

API structure has changed

Modified 1
POST /carriers/rates
  • Body
  • content type Added

API structure has changed

Modified 1
POST /orders
  • Body
  • content type Modified
    • packages attribute Modified

API structure has changed

Modified 1
GET /orders
  • Response
  • 200 response Modified
    • data attribute Modified

API structure has changed

Modified 9 Breaking
GET /carriers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /customers
  • Query
  • phone, email query parameters Modified
  • Response
  • 200 response Modified
    • data attribute Modified
GET /locations
  • Response
  • 200 response Modified
    • data attribute Modified
GET /orders
  • Query
  • external_id, order_number query parameters Modified
  • Response
  • 200 response Modified
    • data attribute Modified
PATCH /orders/{order_uuid}
  • Body
  • content type Modified
    • tags, pickup_scheduled_from, pickup_scheduled_to, delivery_scheduled_from, shipping_method_id, requirements attributes Removed
    • proof_of_delivery, pickup_schedule, delivery_schedule attributes Added
  • Response
  • 200 response Modified
    • data attribute Removed
POST /carriers/rates
  • Response
  • 200 response Modified
    • data attribute Modified
POST /customers
  • Body
  • content type Modified
    • email, phone attributes Modified
POST /orders
  • Body
  • content type Modified
    • customer, collections, packages attributes Modified
    • requirements, pickup_scheduled_from, pickup_scheduled_to, delivery_scheduled_from, delivery_scheduled_to, tags, source, destination attributes Removed
    • source_location, source_contact, destination_location, destination_contact, proof_of_delivery, pickup_schedule, delivery_schedule attributes Added
  • Response
  • 200 response Modified
    • data attribute Modified
PUT /customers/{customer_uuid}
  • Body
  • content type Modified
    • external_id, notes attributes Modified
  • Response
  • 200 response Modified
    • data attribute Removed
Removed 1 Breaking
POST /orders/{order_uuid}/cancel
Added 1
POST /orders/{order_uuid}/cancel

API structure has changed

Modified 11 Breaking
GET /carriers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /customers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /locations
  • Response
  • 200 response Modified
    • data attribute Modified
GET /orders
  • Response
  • 200 response Modified
    • data attribute Modified
PATCH /orders/{order_uuid}
  • Body
  • content type Modified
    • delivery_scheduled_from attribute Modified
  • Response
  • 200 response Modified
    • data attribute Modified
POST /carriers/rates
  • Body
  • content type Modified
    • weight_unit attribute Added
  • Response
  • 200 response Modified
    • data attribute Modified
POST /customers
  • Response
  • 200 response Modified
    • data attribute Modified
POST /orders
  • Response
  • 200 response Modified
    • data attribute Modified
POST /orders/generate-labels
  • Body
  • content type Modified
    • shipping_label_id attribute Removed
    • size attribute Added
POST /orders/{order_uuid}/assign
  • Body
  • content type Modified
    • carrier_account_id, shipping_method_id attributes Removed
    • carrier_uuid, shipping_method_uuid attributes Added
  • Response
  • 200 response Modified
    • data attribute Removed
PUT /customers/{customer_uuid}
  • Response
  • 200 response Modified
    • data attribute Modified

API structure has changed

Modified 5 Breaking
GET /carriers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /customers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /locations
  • Response
  • 200 response Modified
    • data attribute Modified
PATCH /orders/{order_uuid}
  • Body
  • content type Modified
    • delivery_scheduled_from attribute Modified
POST /carriers/rates
  • Response
  • 200 response Modified
    • data attribute Modified

API structure has changed

Modified 2 Breaking
PATCH /orders/{order_uuid}
  • Body
  • content type Modified
    • delivery_scheduled_from attribute Modified
POST /carriers/rates
  • Body
  • content type Modified
    • total_weight attribute Modified
    • latitude, longitude attributes Removed
    • source, destination, departure_time attributes Added

API structure has changed

Modified 4 Breaking
GET /orders
  • Response
  • 200 response Modified
    • data attribute Modified
PATCH /orders/{order_uuid}
  • Body
  • content type Modified
    • delivery_scheduled_from attribute Modified
POST /carriers/distance/rates
  • Body
  • content type Modified
    • latitude, longitude, total_weight attributes Removed
    • lat1, lon1, lat2, lon2, departure_time attributes Added
POST /orders
  • Response
  • 200 response Modified
    • data attribute Modified

API structure has changed

Modified 8 Breaking
GET /carriers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /customers
  • Response
  • 200 response Modified
    • data attribute Modified
  • Query
  • id, external_id query parameters Removed
GET /locations
  • Response
  • 200 response Modified
    • data attribute Modified
GET /orders
  • Response
  • 200 response Modified
    • data attribute Modified
POST /carriers/distance/rates
  • Body
  • content type Modified
    • sources, destination, total_weight attributes Removed
    • lat1, lon1, lat2, lon2, departure_time attributes Added
  • Response
  • 200 response Modified
    • data attribute Modified
POST /carriers/rates
  • Body
  • content type Modified
    • sources, destination attributes Removed
    • latitude, longitude attributes Added
  • Response
  • 200 response Modified
    • data attribute Modified
POST /customers
  • Body
  • content type Modified
    • external_id attribute Modified
  • Response
  • 200 response Modified
    • data attribute Added
POST /orders
  • Response
  • 200 response Modified
    • data attribute Modified
Removed 4 Breaking
PATCH /orders/{id}
POST /orders/{id}/assign
POST /orders/{id}/cancel
PUT /customers/{id}
Added 4
PATCH /orders/{order_uuid}
POST /orders/{order_uuid}/assign
POST /orders/{order_uuid}/cancel
PUT /customers/{customer_uuid}

API structure has changed

Modified 1 Breaking
PATCH /orders/{id}
  • Body
  • content type Modified
    • delivery_scheduled_from attribute Modified
Added 1
POST /orders/{id}/assign

API structure has changed

Modified 5 Breaking
GET /carriers
  • Response
  • 200 response Modified
    • data attribute Modified
GET /locations
  • Response
  • 200 response Modified
    • data attribute Modified
PATCH /orders/{id}
  • Body
  • content type Modified
    • requirements attribute Modified
    • external_id, pickup_scheduled_from, pickup_scheduled_to, delivery_scheduled_from, delivery_scheduled_from attributes Added
  • Response
  • 200 response Modified
    • data attribute Added
POST /orders
  • Body
  • content type Modified
    • customer, source, destination, requirements attributes Modified
    • external_id, collections, packages attributes Modified
    • is_return attribute Added
  • Response
  • 200 response Modified
    • data attribute Added
PUT /customers/{id}
  • Response
  • 200 response Modified
    • message attribute Modified
Removed 1 Breaking
POST /orders/{id}/cancel
Added 3
GET /orders
POST /orders/generate-labels
POST /orders/{id}/cancel

API structure has changed

Modified 9 Breaking
GET /carriers
  • Response
  • 401, 403, 404, 500 responses Removed
GET /customers
  • Response
  • 401, 403, 404, 500 responses Removed
GET /locations
  • Response
  • 200 response Modified
    • data attribute Modified
  • 401, 403, 404, 500 responses Removed
PATCH /orders/{id}
  • Response
  • 401, 403, 404, 422, 500 responses Removed
POST /carriers/rates
  • Response
  • 401, 403, 404, 422, 500 responses Removed
POST /customers
  • Response
  • 401, 403, 422, 500 responses Removed
POST /orders
  • Response
  • 401, 403, 422, 500 responses Removed
POST /orders/{id}/cancel
  • Response
  • 401, 403, 404, 500 responses Removed
PUT /customers/{id}
  • Response
  • 401, 403, 404, 422, 500 responses Removed

API structure has changed

Modified 7 Breaking
GET /customers
  • Response
  • 200 response Modified
    • message, data attributes Modified
  • response Removed
  • 401, 403, 404, 500 responses Added
GET /locations
  • Response
  • 200 response Modified
    • message, data attributes Modified
  • 401, 403, 404, 500 responses Added
PATCH /orders/{id}
  • Response
  • 200 response Modified
    • data attribute Removed
  • 401, 403, 404, 422, 500 responses Added
POST /customers
  • Response
  • 200 response Modified
    • message attribute Modified
    • data attribute Removed
  • 401, 403, 422, 500 responses Added
POST /orders
  • Body
  • content type Modified
    • source, destination attributes Modified
    • carrier_account_id, shipping_method_id, reference_number attributes Removed
    • external_id attribute Added
  • Response
  • 200 response Modified
    • data attribute Removed
  • 401, 403, 422, 500 responses Added
POST /orders/{id}/cancel
  • Response
  • 200 response Modified
    • data attribute Removed
  • response Removed
  • 401, 403, 404, 500 responses Added
PUT /customers/{id}
  • Response
  • 200 response Modified
    • message attribute Modified
    • data attribute Removed
  • 401, 403, 404, 422, 500 responses Added
Removed 1 Breaking
POST /orders/{id}/assign
Added 2
GET /carriers
POST /carriers/rates

API documentation has been created