1. S3 Files
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
      • Invoice Items
        • List all Invoice Items
        • Deleted Invoice Items
      • Financials
        • Retrieve Financial Information
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
      • Ens Declarations
        • Create an Ens Declaration
        • Download an Ens Declaration
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
        • Get All Positions
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
        • List Company Credit Limits
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
        GET
      • Create an S3File
        POST
      • Delete an S3File
        DELETE
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. S3 Files

Create an S3File

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
POST
/api/v1/s3files
Creates S3File for the related record.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://demo.modaltrans.com/api/v1/s3files' \
--header 'Authorization: Bearer <token>' \
--form 'parent_type="Logistics::Loading"' \
--form 'parent_id="9093ab21-1926-409e-a82f-3a6b1d7a4921"' \
--form 's3file[file]=@""' \
--form 's3file[name]="ExampleName"' \
--form 's3file[file_class]="other"' \
--form 's3file[file_type]="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"' \
--form 's3file[auth_code]="0"'

Responses

🟢200OK
application/json
Body

Example
{
    "id": 3723780,
    "name": "ExampleName",
    "file_data": "{\"id\":\"a0ee6447f492eaf7f3b84461f48e6538.xlsx\",\"storage\":\"store\",\"metadata\":{\"filename\":\"DEMODENEM.xlsx\",\"size\":6600,\"mime_type\":\"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\"}}",
    "size": null,
    "file_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
    "created_at": "2024-08-27T11:32:07.815+03:00",
    "parent_type": "Logistics::Loading",
    "parent_id": 1850495,
    "document_url": "https://patronfiles.s3.eu-central-1.amazonaws.com/store/a0ee6447f492eaf7f3b84461f48e6538.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4QUYXP6RPX77AVCX%2F20240827%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240827T083207Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=3e2436b406dcc9e9a0ff4c7e04e95150274900f8ed76a95049dde07f9eb65ed6",
    "user_id": 8091,
    "user_name": "Muhammet Demirhan",
    "file_class": "other"
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠422Unprocessable Entity
Modified at 2024-09-10 12:14:37
Previous
List all S3Files
Next
Delete an S3File
Built with