Sign Customiser

Navigation

Dark mode

Products

retry_product_production_files

write

Retry product production files

Copy page

Recover a retained-metal template product whose production files failed or stalled, so its manufacturer hand-off can complete.

Overview

Starts the derived production files (EPS, Illustrator PDF or cut outline DXF) of a retained-metal template product again, as Retry does on the product in the merchant admin. Only a package that failed, or one that stayed pending longer than expected, starts again; retried is then true and the package is back at pending. Any other package is left as it stands, with retried false. A product that owes no derived files is refused. Manufacturer order emails that wait for the files are sent when the files complete, as the order already scheduled. Each connection can make six retry attempts a minute, refused ones included; a replay does not count. It requires the products:write scope and an idempotency_key.

Permission

Requires theproducts:writepermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHintfalse
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • The id of a retained-metal template product, from list_integration_products.
  • A merchant has connected this store and approved the products:write scope.

Side effects

  • Sets the failed or stalled files of the package back to pending and queues them to be made again. A package that cannot be retried now is not changed.
  • Uses one of the six retry attempts this connection may make in a minute, even when the attempt is refused. A replay uses none.
  • Claims the idempotency_key for at least 24 hours.

Arguments

product_idintegerrequired

The product id, from list_integration_products.

idempotency_keystringrequired

A client-generated key unique to this logical write, such as a UUID. Required: repeating the call with the same key and the same arguments replays the original result instead of writing twice, and the same key with different arguments is an idempotency_key_conflict.

Result

Whether the package started again, and the package as it now stands: its status, each owed file and its status, whether a retry is possible, whether it is delayed, and how many manufacturer order emails wait for it.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
product_idintegeralways present
retriedbooleanalways present

True when the package started again; false when it could not be retried now and was left as it stands.

production_packageobjectalways present
production_package.statusstringalways present

pending while any owed file is being made, failed when any failed, complete when every owed file exists.

One of: pending, failed, complete

production_package.filesarray of objectalways present
production_package.files[].typestringalways present

One of: eps, illustrator_pdf, cut_outline_dxf

production_package.files[].statusstringalways present

One of: pending, failed, complete

production_package.can_retrybooleanalways present
production_package.delayedbooleanalways present
production_package.held_order_emailsintegeralways present

How many manufacturer order emails wait for these files.

production_package.updated_atstring or null
idempotent_replayboolean

True when this call replayed a previously recorded response for the same idempotency_key instead of applying the write again.

Error cases

idempotency_key_conflict

That key was used for another call. Re-send the original arguments or issue a new key.

insufficient_scope

The connection was approved without products:write.

no_production_package

The product owes no derived production files, so there is nothing to retry.

rate_limited

This connection has made six retry attempts in the last minute. Wait retry_after seconds.

resource_not_found

No product with that id belongs to this store. Call list_integration_products to find a valid id.

Start a failed EPS file again

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "retry_product_production_files",
    "arguments": {
      "product_id": 731,
      "idempotency_key": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "product_id": 731,
      "retried": true,
      "production_package": {
        "status": "pending",
        "files": [
          {
            "type": "cut_outline_dxf",
            "status": "complete"
          },
          {
            "type": "eps",
            "status": "pending"
          }
        ],
        "can_retry": false,
        "delayed": false,
        "held_order_emails": 1,
        "updated_at": "2026-07-18T03:20:00Z"
      },
      "idempotent_replay": false
    }
  }
}

A product without production files (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "retry_product_production_files",
    "arguments": {
      "product_id": 732,
      "idempotency_key": "2c3d4e5f-6071-4b8c-9d0e-1f2a3b4c5d6e"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "no_production_package",
        "title": "No production package",
        "detail": "This product has no production files to retry.",
        "recovery": "The product owes no derived production files, so there is nothing to retry. Only a retained-metal template product has them."
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.