---
updatedAt: 2025-09-10T20:59:36.000Z
agentTools:
projectIndex: https://shipcars.readme.io/llms.txt
---
# Upload a file
This method uploads a new file with no links
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "User Management",
"description": "Ship.Cars User Management",
"contact": {
"url": "https://ship.cars",
"email": "support@ship.cars"
},
"version": "1.0.0"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "oauth2",
"flows": {
"password": {
"tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token",
"scopes": {}
}
}
}
}
},
"servers": [
{
"url": "https://ship.cars/api"
}
],
"paths": {
"/shipperlite/posting/v3/files": {
"post": {
"tags": [
"Attachments API"
],
"summary": "Upload a file",
"description": "This method uploads a new file with no links",
"operationId": "createAttachment_1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"attachment": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string",
"description": "Unique Url of the attachment.",
"example": "https://www.media.com/attachment1.jpg"
},
"shareWith": {
"type": "string",
"description": "CARRIER - Shared with the carrier.
\nDRIVER - Shared with the driver.
\nALL - Shared with both carrier and driver.
\n",
"example": "CARRIER",
"default": "ALL",
"enum": [
"CARRIER",
"DRIVER",
"ALL"
]
},
"id": {
"type": "string",
"description": "Internal ID of the attachment.",
"example": "YK41K"
},
"lbExternalId": {
"type": "string",
"description": "External ID of the attachment.",
"example": "CS1235XX"
},
"loadLegId": {
"type": "string",
"description": "Load leg ID linked to the attachment.",
"example": "YK41K"
},
"shippingItemId": {
"type": "string",
"description": "Shipping item ID linked to the attachment.",
"example": "YK41K"
},
"creatorType": {
"type": "string",
"description": "Type of user who created the attachment. Can be either SHIPPER or CARRIER",
"example": "SHIPPER",
"enum": [
"CARRIER",
"SHIPPER"
]
},
"attachmentType": {
"type": "string",
"description": "The type of the attachment",
"example": "DISPATCH_SHEET",
"enum": [
"SHIPPER_ATTACHMENT",
"DISPATCH_SHEET",
"PICKUP_BOL",
"DELIVERY_BOL",
"EXTERNAL_BOL",
"INVOICE",
"PICKUP_DAMAGES_PICTURE",
"PICKUP_ODOMETER_PICTURE",
"DELIVERY_DAMAGES_PICTURE",
"DELIVERY_ODOMETER_PICTURE",
"OTHER"
]
},
"originalFileName": {
"type": "string",
"description": "Original name of the attachment as it was defined outside the platform.",
"example": "Dispatch Sheet"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
}
},
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier."
}
}
}
},
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"attachment": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string",
"description": "Unique Url of the attachment.",
"example": "https://www.media.com/attachment1.jpg"
},
"shareWith": {
"type": "string",
"description": "CARRIER - Shared with the carrier.
\nDRIVER - Shared with the driver.
\nALL - Shared with both carrier and driver.
\n",
"example": "CARRIER",
"default": "ALL",
"enum": [
"CARRIER",
"DRIVER",
"ALL"
]
},
"id": {
"type": "string",
"description": "Internal ID of the attachment.",
"example": "YK41K"
},
"lbExternalId": {
"type": "string",
"description": "External ID of the attachment.",
"example": "CS1235XX"
},
"loadLegId": {
"type": "string",
"description": "Load leg ID linked to the attachment.",
"example": "YK41K"
},
"shippingItemId": {
"type": "string",
"description": "Shipping item ID linked to the attachment.",
"example": "YK41K"
},
"creatorType": {
"type": "string",
"description": "Type of user who created the attachment. Can be either SHIPPER or CARRIER",
"example": "SHIPPER",
"enum": [
"CARRIER",
"SHIPPER"
]
},
"attachmentType": {
"type": "string",
"description": "The type of the attachment",
"example": "DISPATCH_SHEET",
"enum": [
"SHIPPER_ATTACHMENT",
"DISPATCH_SHEET",
"PICKUP_BOL",
"DELIVERY_BOL",
"EXTERNAL_BOL",
"INVOICE",
"PICKUP_DAMAGES_PICTURE",
"PICKUP_ODOMETER_PICTURE",
"DELIVERY_DAMAGES_PICTURE",
"DELIVERY_ODOMETER_PICTURE",
"OTHER"
]
},
"originalFileName": {
"type": "string",
"description": "Original name of the attachment as it was defined outside the platform.",
"example": "Dispatch Sheet"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
}
},
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier."
}
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string",
"description": "Unique Url of the attachment.",
"example": "https://www.media.com/attachment1.jpg"
},
"shareWith": {
"type": "string",
"description": "CARRIER - Shared with the carrier.
\nDRIVER - Shared with the driver.
\nALL - Shared with both carrier and driver.
\n",
"example": "CARRIER",
"default": "ALL",
"enum": [
"CARRIER",
"DRIVER",
"ALL"
]
},
"id": {
"type": "string",
"description": "Internal ID of the attachment.",
"example": "YK41K"
},
"lbExternalId": {
"type": "string",
"description": "External ID of the attachment.",
"example": "CS1235XX"
},
"loadLegId": {
"type": "string",
"description": "Load leg ID linked to the attachment.",
"example": "YK41K"
},
"shippingItemId": {
"type": "string",
"description": "Shipping item ID linked to the attachment.",
"example": "YK41K"
},
"creatorType": {
"type": "string",
"description": "Type of user who created the attachment. Can be either SHIPPER or CARRIER",
"example": "SHIPPER",
"enum": [
"CARRIER",
"SHIPPER"
]
},
"attachmentType": {
"type": "string",
"description": "The type of the attachment",
"example": "DISPATCH_SHEET",
"enum": [
"SHIPPER_ATTACHMENT",
"DISPATCH_SHEET",
"PICKUP_BOL",
"DELIVERY_BOL",
"EXTERNAL_BOL",
"INVOICE",
"PICKUP_DAMAGES_PICTURE",
"PICKUP_ODOMETER_PICTURE",
"DELIVERY_DAMAGES_PICTURE",
"DELIVERY_ODOMETER_PICTURE",
"OTHER"
]
},
"originalFileName": {
"type": "string",
"description": "Original name of the attachment as it was defined outside the platform.",
"example": "Dispatch Sheet"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
}
},
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier."
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"httpStatus": {
"type": "integer",
"format": "int32"
},
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorMessage": {
"type": "string"
},
"errorDetails": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```