Skip to main content

Create images in bulk

POST 

/v2/media/images/bulk

Create images in bulk

Request

Header Parameters

    tenant stringrequired

Body

array

required

A list of create media image inputs

  • Array [

  • productIdnumber

    Unique product identifier that image relates to

    sourcestringrequired

    External system from which image is being imported

    sourceIdstringrequired

    External identifier of the image

    alt

    object[]

    required

    Image alt description that briefly explains the contents of the image.

  • Array [

  • languagestringrequired

    Language to perform search for [min/max: 2]

    valuestringrequired

    Value of localized string

  • ]

  • description

    object[]

    required

    Image short description.

  • Array [

  • languagestringrequired

    Language to perform search for [min/max: 2]

    valuestringrequired

    Value of localized string

  • ]

  • tags

    object[]

    required

    Image tags.

  • Array [

  • languagestringrequired

    Language to perform search for [min/max: 2]

    valuesstring[]required

    Value of localized string

  • ]

  • prioritynumber

    Image display priority [Lower value has higher priority] - default: 1000

    Default value: 1000

    uploadImages

    object[]

    required

    Upload File input reference.

  • Array [

  • languagestring

    Language specific image [Default value 'en']

    Default value: en
    uploadTypestring

    Upload type. Only URL is supported for bulk import.

    Default value: URL

    urlFile

    object

    required

    urlstringrequired

    The public url to the file.

    fileNamestringrequired

    Name to use for storing the file

  • ]

  • ]

Responses

Bulk images successfully created

Schema

    productIdnumber

    Unique product identifier that image relates to

    sourcestringrequired

    External system from which image is being imported

    sourceIdstringrequired

    External identifier of the image

    alt

    object[]

    required

    Image alt description that briefly explains the contents of the image.

  • Array [

  • languagestringrequired

    Language to perform search for [min/max: 2]

    valuestringrequired

    Value of localized string

  • ]

  • description

    object[]

    required

    Image short description.

  • Array [

  • languagestringrequired

    Language to perform search for [min/max: 2]

    valuestringrequired

    Value of localized string

  • ]

  • tags

    object[]

    required

    Image tags.

  • Array [

  • languagestringrequired

    Language to perform search for [min/max: 2]

    valuesstring[]required

    Value of localized string

  • ]

  • prioritynumber

    Image display priority [Lower value has higher priority] - default: 1000

    Default value: 1000

    uploadImages

    object[]

    required

    Upload File input reference.

  • Array [

  • languagestring

    Language specific image [Default value 'en']

    Default value: en
    uploadTypestring

    Upload type. Only URL is supported for bulk import.

    Default value: URL

    urlFile

    object

    required

    urlstringrequired

    The public url to the file.

    fileNamestringrequired

    Name to use for storing the file

  • ]