Upload product file

Upload a file to a product (E-goods) using binary data or external URL.

When uploading a file for a product, the file itself needs to be sent in the body of your request in a form of binary data. The file you wish to upload needs to be prepared for that format and then sent to Ecwid API endpoint.

Alternatively, you can specify an externalUrl to your file as a request parameter and Ecwid will download it from there. You can also use a fileName and description as a request parameter to specify the image title and description.

Headers

NameTypeDescription
AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.

Response

A JSON object of type 'UploadStatus' with the following fields:

UploadStatus

FieldTypeDescription
idnumberInternal file ID

Errors

In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description

HTTP codes

HTTP StatusDescription
400Request parameters are malformed
402The functionality/method is not available on the merchant plan
403Access token doesn't have update_catalog scope
404Product is not found
413The file size exceeds allowed size for plan
415Unsupported content-type: expected application/octet-stream
500Uploading of the file failed or there was an internal server error while processing a file

Error response body (optional)

FieldTypeDescription
errorMessagestringError message
Language