Sign in
latestOpenAPI 3.0.02026-08-105585620.8 KB

18e2f2e178dd

Products API

Modify a Sync Product

Modifies an existing Sync Product with its Sync Variants.

Please note that in the request body you only need to specify the fields that need to be changed. Furthermore, if you want to update existing sync variants, then in the sync variants array you must specify the IDs of all existing sync variants. All omitted existing sync variants will be deleted. All new sync variants without an ID will be created. See examples for more insights.

Rate limiting: Up to 10 requests per 60 seconds. A 60 seconds lockout is applied if request count is exceeded.

See examples

put/store/products/{id}

Path parameters

integer required
OR
string required

Sync Product ID (integer) or External ID (if prefixed with @)

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.

Request body

Example request

{
  "sync_product": {
    "id": 13,
    "external_id": "4235234213",
    "name": "T-shirt",
    "variants": 10,
    "synced": 10,
    "thumbnail": "​http://your-domain.com/path/to/thumbnail.png",
    "thumbnail_url": "​https://your-domain.com/path/to/image.png"
  },
  "sync_variants": [
    {
      "id": 10,
      "external_id": "12312414",
      "sync_product_id": 71,
      "name": "Red T-Shirt",
      "synced": true,
      "variant_id": 3001,
      "retail_price": "29.99",
      "currency": "USD",
      "is_ignored": true,
      "sku": "SKU1234",
      "product": {
        "variant_id": 3001,
        "product_id": 301,
        "image": "https://files.cdn.printful.com/products/71/5309_1581412541.jpg",
        "name": "Bella + Canvas 3001 Unisex Short Sleeve Jersey T-Shirt with Tear Away Label (White / 4XL)"
      },
      "files": [
        {
          "type": "default",
          "id": 10,
          "url": "​https://www.example.com/files/tshirts/example.png",
          "options": [
            {
              "id": "template_type",
              "value": "native"
            }
          ],
          "hash": "ea44330b887dfec278dbc4626a759547",
          "filename": "shirt1.png",
          "mime_type": "image/png",
          "size": 45582633,
          "width": 1000,
          "height": 1000,
          "dpi": 300,
          "status": "ok",
          "created": 1590051937,
          "thumbnail_url": "https://files.cdn.printful.com/files/ea4/ea44330b887dfec278dbc4626a759547_thumb.png",
          "preview_url": "https://files.cdn.printful.com/files/ea4/ea44330b887dfec278dbc4626a759547_thumb.png",
          "visible": true,
          "stitch_count_tier": "stitch_tier_1"
        }
      ],
      "options": [
        {
          "id": "embroidery_type",
          "value": "flat"
        }
      ],
      "main_category_id": 24,
      "warehouse_product_id": 3002,
      "warehouse_product_variant_id": 3002,
      "size": "XS",
      "color": "White"
    }
  ]
}

Response

OK

codeinteger

Response status code 200

Example response

{
  "code": 200,
  "result": {
    "id": 13,
    "external_id": "4235234213",
    "name": "T-shirt",
    "variants": 10,
    "synced": 10,
    "thumbnail": "​http://your-domain.com/path/to/thumbnail.png",
    "thumbnail_url": "​https://your-domain.com/path/to/image.png"
  }
}