Create upload URL

POST/api/files/uploads/presign

Creates a presigned object-storage URL for a file upload.

Request Body

application/json

Request payload for Create upload URL.

TypeScript Definitions

Use the request body type in TypeScript.

fileName*string

Original file name that will be uploaded.

Example"quote.pdf"

directory?|

Optional storage directory prefix.

Example"orders/order_123"

Response Body

`application/json`

curl -X POST "https://example.com/api/files/uploads/presign" \  -H "Content-Type: application/json" \  -d '{    "fileName": "quote.pdf"  }'

{  "presignedUrl": "https://s3.example.com/presigned-upload",  "fileId": "file_123"}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`