Send product images to Shopify

Request

See AssetDownloadBatchJob for an idea of how to use this endpoint

Security

bearerToken

Bodyapplication/jsonrequired

shopstring

The "shop" slug for the specific Shopify shop to create images in

Example:"example.myshopify.com"

productIdstringrequired

The id of the product in Shopify to create images for

Example:1234

itemsArray of objectsrequired

transformationDescriptionanyrequired

curl -i -X POST \
  https://api-v2.dash.app/create-shopify-product-image-batch-jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shop": "example.myshopify.com",
    "productId": 1234,
    "items": [
      {
        "batchItemId": "my-item-1",
        "assetId": "7af90a8b-7ccd-430f-a85d-e8614015bc47",
        "assetFileId": "7af90a8b-7ccd-430f-a85d-e8614015bc47",
        "outputFilename": "string",
        "presetParameters": []
      }
    ],
    "transformationDescription": {
      "type": "CUSTOM",
      "candidateTransformations": [
        {
          "criteria": [
            {
              "type": "MATCHES_MEDIA_TYPES",
              "mediaTypes": [
                {}
              ]
            }
          ],
          "transformation": []
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json

idstringrequired

Unique identifier of the job that has been created

Example:"be161977-d44e-4888-af3c-66522e223963"

accountIdstringrequired

The ID of the account the job is happening in

Example:"cfb665ca-ce35-4418-b9d5-70ee815db4bd"

creatorIdstringrequired

The ID of the User who created the job

Example:"google-oauth2|110955770826801837334"

typestringrequired

The job type

Value:"IN_PROGRESS"

Discriminator

progressobjectrequired

statusstringrequired

Enum:"PENDING""STARTING""STARTED""STOPPING"

Response

{
  "id": "be161977-d44e-4888-af3c-66522e223963",
  "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
  "creatorId": "google-oauth2|110955770826801837334",
  "type": "IN_PROGRESS",
  "progress": {
    "steps": [ … ]
  },
  "status": "PENDING"
}