Skip to main content
POST
Upload a carrier contract

Authorizations

Authorization
string
header
required

HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).

Body

multipart/form-data
file
file
required

The contract document. Accepted MIME types: application/pdf, image/png, image/jpeg, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

carrier_name
string
required

The carrier this contract belongs to (e.g. UPS, FedEx, DHL Express).

signing_date
string<date>
required

Date the contract was signed, in YYYY-MM-DD format.

contract_number
string

Optional carrier-issued contract number.

account_number
string

Optional carrier account number this contract applies to.

Response

Contract created. Extraction runs asynchronously.

contract
object

A carrier contract uploaded to Opereit. Rates and surcharges are extracted asynchronously.