Returns list of rate requests belonging to a tenant.

SecurityAPIKeyHeader

Request

query Parameters

page	integer (Page) >= 1 Default: 1
limit	integer (Limit) [ 1 .. 200 ] Default: 50
	Shipment Id (string) or Shipment Id (null) (Shipment Id)

Responses

200

Successful Response

Response Schema: application/json

required	Array of objects (Data)
count required	integer (Count) Number of the items within the 'data' array.
required	Total Count (integer) or Total Count (null) (Total Count) Number of items in the entire result set. Value is always >= count. Inclusion depends on the underlying result set.
required	object (PaginationLinks)

400

Validation Error

404

The resource requested was not found either because you do not have permissions to access it or it does not exist.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

get/rating

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"data": [{"preferred_currency": "USD",
"locale": "en-US",
"shipment_id": "string",
"transportation_mode": "DRAYAGE",
"capacity_providers": [{"provider_code": "AMAZON",
"account_number": "string",
"service_codes": ["string"
],
"service_options": { },
"provider_timeout": 10
}
],
"equipment": [{"equipment_type": "AUTO_CARRIER",
"temperature": {"unit": "CELSIUS",
"minimum": 32.32,
"maximum": 212.212
}
}
],
"customer_reference_number": "string",
"accessorials": ["AFTER_HOURS_DELIVERY"
],
"stops": [{"sequence_number": 1,
"account_number": "string",
"contact": {"contact_id": "string",
"contact_type": "ADMINISTRATOR",
"company_name": "string",
"person_name": "string",
"first_name": "string",
"last_name": "",
"email": "user@example.com",
"phone": "+19563838383",
"phone_ext": "string",
"fax": "string",
"title": "string"
},
"location": {"line_1": "string",
"line_2": "string",
"line_3": "string",
"locality": "string",
"country": "US",
"region": "TX",
"postal_code": "string",
"timezone": "America/Chicago",
"geolocation": {"latitude": -90,
"longitude": -180
},
"location_number": "TX-1",
"location_name": "string",
"location_type": "EXHIBITION",
"residential": false,
"is_port": false,
"iata_airport_code": "AUS",
"un_locode": "US NYC",
"formatted_address": "string"
},
"requested_window": {"earliest": "2019-08-24T14:15:22Z",
"latest": "2019-08-24T14:15:22Z"
},
"appointment": {"appointment_number": 0,
"begin": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"location_opens": "2019-08-24T14:15:22Z",
"location_closes": "2019-08-24T14:15:22Z"
},
"instructions": "string",
"accessorials": [ ]
}
],
"bill_to": {"account_number": "string",
"bill_to_type": "PREPAID",
"contact": {"contact_id": "string",
"contact_type": "ADMINISTRATOR",
"company_name": "string",
"person_name": "string",
"first_name": "string",
"last_name": "",
"email": "user@example.com",
"phone": "+19563838383",
"phone_ext": "string",
"fax": "string",
"title": "string"
},
"location": {"line_1": "string",
"line_2": "string",
"line_3": "string",
"locality": "string",
"country": "US",
"region": "TX",
"postal_code": "string",
"timezone": "America/Chicago",
"geolocation": {"latitude": -90,
"longitude": -180
},
"location_number": "TX-1",
"location_name": "string",
"location_type": "EXHIBITION",
"residential": false,
"is_port": false,
"iata_airport_code": "AUS",
"un_locode": "US NYC",
"formatted_address": "string"
},
"instructions": "string"
},
"gross_weight": {"unit": "KG",
"value": 23000.13
},
"total_declared_value": {"currency": "USD",
"amount": 9001.01
},
"references": [{"qualifier": "string",
"value": "string"
}
],
"handling_units": [{"associated_stops": [{"stop": {"sequence_id": null
},
"reason": "LOAD"
}
],
"weight": {"unit": "KG",
"value": 23000.13,
"qualifier": "PER_ITEM"
},
"description": "n/a",
"temperature": {"unit": "CELSIUS",
"minimum": 32.32,
"maximum": 212.212
},
"dimensions": {"measurement_type": "VOLUME",
"unit": "CUBIC_FT",
"value": 10023.3333
},
"quantity": 1,
"declared_value": {"currency": "USD",
"amount": 9001.01
},
"freight_class": "string",
"harmonized_code": "string",
"commodity_code": "string",
"nmfc_codes": [{"code": "string",
"sub_code": "string"
}
],
"stackable": false,
"packaging_type": "AFRAME",
"piece_type": "BAG",
"total_pieces": 1,
"packaged_items": [{"weight": {"unit": null,
"value": null,
"qualifier": null
},
"description": "n/a",
"temperature": {"unit": null,
"minimum": null,
"maximum": null
},
"dimensions": {"measurement_type": null,
"unit": null,
"value": null
},
"quantity": 1,
"declared_value": {"currency": null,
"amount": null
},
"freight_class": "string",
"harmonized_code": "string",
"commodity_code": "string",
"nmfc_codes": [null
],
"stackable": true
}
],
"packaging_code": "AFRAME",
"hazmat": {"service_type": "HAZMAT",
"hazmat_id": "string",
"packing_group": "DEFAULT",
"packing_instructions": "string",
"proper_shipping_name": "string",
"technical_name": "string",
"hazard_class": "string",
"hazard_subsidiary_class": "string",
"total_hazmat_count": "string",
"hazmat_count_unit": "string",
"accessible": true,
"container_type": "string",
"total_container_count": "string",
"cargo_aircraft_only": true,
"shipper_name_or_number": "string",
"emergency_number": "string",
"signatory": {"name": "string",
"title": "string",
"place": "string"
},
"total_package_count": "string",
"package_count_unit": "string"
}
}
],
"created_at": "2019-08-24T14:15:22Z",
"status": "CREATED",
"id": "string",
"pickup_data": { },
"delivery_data": { }
}
],
"count": 0,
"total_count": 0,
"links": {"next": "http://example.com",
"prev": "http://example.com",
"first": "http://example.com",
"last": "http://example.com"
}
}