Skip to main content
POST
/
v1
/
contracts
Upload a carrier contract
curl --request POST \
  --url https://api.opereit.com/v1/contracts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'carrier_name=<string>' \
  --form signing_date=2023-12-25 \
  --form 'contract_number=<string>' \
  --form 'account_number=<string>'
{
  "contract": {
    "id": "<string>",
    "carrier_name": "DHL Express",
    "signing_date": "2023-12-25",
    "status": "PROCESSING",
    "rate_count": 123,
    "surcharge_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "contract_number": "<string>",
    "account_number": "<string>",
    "effective_date": "2023-12-25",
    "expiration_date": "2023-12-25",
    "status_reason": "<string>",
    "file_url": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.opereit.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.