Bulk Upload Images

Uploads up to 10 images from base64 encoded strings or URLs. Supports automatic product/variant association via filename matching with SKU or slug. Generates blurhash automatically if not provided. Returns lists of successful and failed uploads with detailed error reasons.

POST/api/v1/{team_slug}/{app_slug}/images/bulk
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/images/bulk

Uploads up to 10 images from base64 encoded strings or URLs. Supports automatic product/variant association via filename matching with SKU or slug. Generates blurhash automatically if not provided. Returns lists of successful and failed uploads with detailed error reasons.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/images/bulk
  • Summary: Bulk Upload Images
  • Description: Uploads up to 10 images from base64 encoded strings or URLs. Supports automatic product/variant association via filename matching with SKU or slug. Generates blurhash automatically if not provided. Returns lists of successful and failed uploads with detailed error reasons.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
team_slugpathYesstringTeam slug
app_slugpathYesstringApp slug
Request bodyDocumented body
  • Required: Yes
  • Description: Images to upload
  • Content: application/json (object)

Bulk Upload Images Payload

PropertyTypeRequiredDetails
imagesobject[]YesmaxItems: 10

Bulk Upload Image Item

PropertyTypeRequiredDetails
altstringNo-
blurhashstringNo-
connect_to_skubooleanNo-
connect_to_slugbooleanNo-
connect_to_variant_groupbooleanNo-
copyrightstringNo-
customobjectNo-
filenamestringNo-
image_base64stringNo-
parent_idstringNo-
statusenum("active", "inactive", "draft")No-
titlestringNo-
urlstringNo-

Generated example (synthetic):

{
  "images": [
    {
      "alt": "string",
      "blurhash": "string",
      "connect_to_sku": false,
      "connect_to_slug": false,
      "connect_to_variant_group": false,
      "copyright": "string",
      "custom": {},
      "filename": "string",
      "image_base64": "string",
      "parent_id": "string",
      "status": "active",
      "title": "string",
      "url": "string"
    }
  ]
}
Responses4 statuses
StatusDescriptionContent
200Images uploaded successfullyapplication/json (object)
400Invalid requestapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Bulk Upload Images Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Bulk Upload Images
PropertyTypeRequiredDetails
failedobject[]No-
successfulobject[]No-
Bulk Upload Image Failed Op
PropertyTypeRequiredDetails
filenamestringNo-
reasonstringNo-
Image With Used By
PropertyTypeRequiredDetails
altstringNo-
app_idstringNo-
attributesobject[]No-
blurhashstringNo-
copyrightstringNo-
customobjectNo-
folder_idstringNo-
idstringNo-
parent_idstringNo-
publicbooleanNo-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
titlestringNo-
translationsobjectNo-
urlstringNo-
used_byobject[]No-
variantsobject[]No-

Generated example (synthetic):

{
  "data": {
    "failed": [
      {
        "filename": "string",
        "reason": "string"
      }
    ],
    "successful": [
      {
        "alt": "string",
        "app_id": "string",
        "attributes": [],
        "blurhash": "string",
        "copyright": "string",
        "custom": {},
        "folder_id": "string",
        "id": "string",
        "parent_id": "string",
        "public": false,
        "source_app_id": "string",
        "source_id": "string",
        "status": "string",
        "title": "string",
        "translations": {
          "alt": null,
          "copyright": null,
          "title": null
        },
        "url": "string",
        "used_by": [],
        "variants": []
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/images/bulk
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Images, Bulk
  • OpenAPI summary: Bulk Upload Images

Bulk Upload Images

# Bulk Upload Images Uploads up to 10 images from base64 encoded strings or URLs. Supports automatic product/variant association via filename matching with SKU or slug. Generates blurhash automatically if not provided. Returns lists of successful and failed uploads with detailed error reasons.
POST /api/v1/{team_slug}/{app_slug}/images/bulk
Purpose

Uploads up to 10 images from base64 encoded strings or URLs.

Required inputs

team_slug path app_slug path

Primary response

200 ยท Images uploaded successfully

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/images/bulk

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/images/bulk` - Summary: Bulk Upload Images - Description: Uploads up to 10 images from base64 encoded strings or URLs. Supports automatic product/variant association via filename matching with SKU or slug. Generates blurhash automatically if not provided. Returns lists of successful and failed uploads with detailed error reasons. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/images/bulk` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | team_slug | path | Yes | string | Team slug | | app_slug | path | Yes | string | App slug | ## Request body - Required: Yes - Description: Images to upload - Content: application/json (object) ### Bulk Upload Images Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `images` | object[] | Yes | maxItems: 10 | #### Bulk Upload Image Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `alt` | string | No | - | | `blurhash` | string | No | - | | `connect_to_sku` | boolean | No | - | | `connect_to_slug` | boolean | No | - | | `connect_to_variant_group` | boolean | No | - | | `copyright` | string | No | - | | `custom` | object | No | - | | `filename` | string | No | - | | `image_base64` | string | No | - | | `parent_id` | string | No | - | | `status` | enum("active", "inactive", "draft") | No | - | | `title` | string | No | - | | `url` | string | No | - | **Generated example (synthetic):** ```json { "images": [ { "alt": "string", "blurhash": "string", "connect_to_sku": false, "connect_to_slug": false, "connect_to_variant_group": false, "copyright": "string", "custom": {}, "filename": "string", "image_base64": "string", "parent_id": "string", "status": "active", "title": "string", "url": "string" } ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Images uploaded successfully | application/json (object) | | 400 | Invalid request | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Bulk Upload Images Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Bulk Upload Images | Property | Type | Required | Details | | --- | --- | --- | --- | | `failed` | object[] | No | - | | `successful` | object[] | No | - | ##### Bulk Upload Image Failed Op | Property | Type | Required | Details | | --- | --- | --- | --- | | `filename` | string | No | - | | `reason` | string | No | - | ##### Image With Used By | Property | Type | Required | Details | | --- | --- | --- | --- | | `alt` | string | No | - | | `app_id` | string | No | - | | `attributes` | object[] | No | - | | `blurhash` | string | No | - | | `copyright` | string | No | - | | `custom` | object | No | - | | `folder_id` | string | No | - | | `id` | string | No | - | | `parent_id` | string | No | - | | `public` | boolean | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `title` | string | No | - | | `translations` | object | No | - | | `url` | string | No | - | | `used_by` | object[] | No | - | | `variants` | object[] | No | - | **Generated example (synthetic):** ```json { "data": { "failed": [ { "filename": "string", "reason": "string" } ], "successful": [ { "alt": "string", "app_id": "string", "attributes": [], "blurhash": "string", "copyright": "string", "custom": {}, "folder_id": "string", "id": "string", "parent_id": "string", "public": false, "source_app_id": "string", "source_id": "string", "status": "string", "title": "string", "translations": { "alt": null, "copyright": null, "title": null }, "url": "string", "used_by": [], "variants": [] } ] }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/images/bulk` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/images/bulk` - OpenAPI tag: Images, Bulk - OpenAPI summary: Bulk Upload Images