Sources

Get presigned URL for source upload

Creates a new source record and returns a presigned URL for uploading a rate sheet file.

Workflow:

  1. Call this endpoint with file metadata
  2. Upload the file directly to the returned presigned URL using PUT
  3. Call POST /sources/{sourceId}/process to start processing

Supported file types: Excel (.xlsx, .xls), CSV, PDF

File size limit: 50MB

post/api/v1/external/sources/upload

Request

Request body

filenamestring required

The filename of the rate sheet to upload

contentTypestring

MIME type of the file

sourceType'contract' | 'spot' | 'tariff'

Type of rate sheet

carrierIdstring

Optional carrier ID to associate with this source

effectiveDatestring date

Date when rates become effective

expiryDatestring date

Date when rates expire

descriptionstring

Optional description of the source

Example request

{
  "filename": "carrier_rates_2024.xlsx",
  "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
}

Response

Source created successfully with upload URL

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.