Sign in
latestOpenAPI 3.0.02026-08-105585620.8 KB

18e2f2e178dd

Mockup Generator API

Mockup generation task result

Returns asynchronous mockup generation task result. If generation task is completed, it will contain a list of generated mockups.

get/mockup-generator/task

Query parameters

task_keystring required

Task key retrieved when creating the generation task.

Headers

X-PF-Store-Idstring

Use this to specify which store you want to use (required only for account level token).

The store IDs can be retrieved with the Get basic information about stores endpoint.

Response

OK

codeinteger

Response status code 200

Example response

{
  "code": 200,
  "result": {
    "task_key": "123456",
    "status": "completed",
    "mockups": [
      {
        "placement": "front",
        "display_name": "Front Print",
        "variant_ids": [
          4011,
          4012,
          4013
        ],
        "extra": [
          {
            "url": "​https://url-to/extra-mockup.png"
          }
        ]
      }
    ],
    "printfiles": [
      {
        "variant_ids": [
          4012,
          4013,
          4014,
          4017,
          4018,
          4019
        ],
        "placement": "front",
        "url": "​https://url-to/printfile.png"
      }
    ]
  }
}