Create a File · Commerce Cloud

`POST` Create a File

https://api.moltin.com/v2/files

Request

Response

Headers:

Name	Required	Type	Description
`Authorization`	Required	`string`	The Bearer token required to get access to the API.

Form Data Parameters - Upload Image:

When you are uploading a file, specify the following parameters.

Name	Required	Type	Description
`file`	Required	`string`	The file you want to upload.
`public`	Required	`boolean`	Whether the file is public.

Form Data Parameters - Image URL:

When you are referencing a file stored elsewhere, specify the following parameter.

Name	Required	Type	Description
`file_location`	`string`	Required	The URL that points to an image file.

Note: If you include either file or public with file_location, the service returns a 400 error.

201 Created

{
  "data": {
    "type": "file",
    "id": "f8cf26b3-6d38-4275-937a-624a83994702",
    "link": {
      "href":
        "https://s3-eu-west-1.amazonaws.com/bkt-svc-files-cmty-api-moltin-com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png"
    },
    "file_name": "f6669358-85db-4367-9cde-1deb77acb5f4.png",
    "mime_type": "image/png",
    "file_size": 110041,
    "public": true,
    "meta": {
      "dimensions": {
        "width": 1000,
        "height": 1000
      },
      "timestamps": {
        "created_at": "2018-03-13T13:45:21.673Z"
      }
    },
    "links": {
      "self":
        "https://api.moltin.com/v2/files/f8cf26b3-6d38-4275-937a-624a83994702"
    }
  }
}

cURL - Upload Image

cURL - Image URL

Node.js SDK

curl -X POST https://api.moltin.com/v2/files \
    -H "Content-Type: multipart/form-data" \
    -H "Authorization: Bearer XXXX" \
    -F file=@path/to/file \
    -F public=true

curl -X POST https://api.moltin.com/v2/files \
    -H "Content-Type: multipart/form-data" \
    -H "Authorization: Bearer XXXX" \
    -F file-location=https://my.example.com/images/abc.png \

const { MoltinClient } = require('@moltin/request')
const FormData = require("form-data")

const moltin = new MoltinClient({
  client_id: 'X',
  client_secret: 'X'
})

const formData = new FormData()

formData.append("file_name", fileName)
formData.append("public", "true")
formData.append("file", buffer, { filename: fileName })

const headers = {
  "Content-Type": formData.getHeaders()["content-type"]
}

const data = {
  body: formData
}

moltin
  .post("files", data, headers)
  .then(console.log(data))
  .error(console.error(error))

POST Create a File

`POST` Create a File