Skip to main content

Upload Store Logo (v1)

Method + Path

POST /v1/workspace/:workspaceId/storefront/store/logo

Actual backend path: /v1/workspace/:workspaceId/storefront/store/logo

Description

Upload a logo image for the storefront store.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • storefront.update

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>
Content-TypestringYesmultipart/form-data

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Request Body

Form data with a file field named file.

Form Fields

FieldTypeRequiredDescription
filefileYesImage file to upload (JPEG, PNG, etc., max 5MB)

Response (201)

{
"logo": {
"url": "https://storage.example.com/logos/store-123.jpg",
"path": "logos/store-123.jpg",
"width": 200,
"height": 200,
"sizeBytes": 45678,
"contentType": "image/jpeg"
}
}

Common Errors

  • 400 Bad Request: Missing or invalid file
  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions (requires storefront.update)
  • 404 Not Found: Store or workspace not found
  • 413 Payload Too Large: File size exceeds 5MB limit
  • 415 Unsupported Media Type: Invalid file type
  • 500 Internal Server Error: Server error