Update a Product

PATCH
https://app.sparklayer.io/api/v1/products/{id}
Live
Path Parameters
id
string
*
Header Parameters
Site-Id
string
*
Body Parameters
body
object
*
All Of
ProductWrite  +
id
string
created_at
string<date-time>
updated_at
string<date-time>
external_id
string
title
string
slug
string
variants
ProductVariantWrite[]
*
Responses
200
Successful response
Product
All Of
Product-2  +
id
string
created_at
string<date-time>
updated_at
string<date-time>
external_id
string
title
string
slug
string
variants
ProductVariant[]
*
409
Conflict Response
default
Error Response
﻿
﻿

Get a Product

Get Product Variant

Docs powered by Archbee

Curl

Ruby

Python

curl --location --globoff --request PATCH 'https://app.sparklayer.io/api/v1/products/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{}}'

Responses

200

409

default

// Successful response 
{
  "id": "pp_123",
  "created_at": "",
  "updated_at": "",
  "external_id": "ID001",
  "title": "Striped Jumper",
  "slug": "striped-jumper",
  "variants": [
    {
      "product_id": "pp_123",
      "id": "pv_234",
      "created_at": "",
      "updated_at": "",
      "external_id": "IDV001",
      "sku": "IDV001",
      "barcode": 837493612362,
      "weight_in_grams": 0,
      "tax_type": 0,
      "position": 0,
      "cart_image_url": "",
      "rrp": [
        {
          "value": 10.49,
          "currency_code": "gbp"
        }
      ],
      "options": [
        {
          "group": "Color",
          "value": "Blue"
        }
      ],
      "status": "live",
      "settings": [
        {
          "customer_group": "default",
          "pack_size": 0,
          "reserve_stock_quantity": 0,
          "min_order_quantity": 0,
          "max_order_quantity": 0,
          "min_order_parent_quantity": 0,
          "max_order_parent_quantity": 0,
          "display": false,
          "sell": false
        }
      ],
      "stock_management": "none"
    }
  ]
}

// Successful response 
{
  "id": "pp_123",
  "created_at": "",
  "updated_at": "",
  "external_id": "ID001",
  "title": "Striped Jumper",
  "slug": "striped-jumper",
  "variants": [
    {
      "product_id": "pp_123",
      "id": "pv_234",
      "created_at": "",
      "updated_at": "",
      "external_id": "IDV001",
      "sku": "IDV001",
      "barcode": 837493612362,
      "weight_in_grams": 0,
      "tax_type": 0,
      "position": 0,
      "cart_image_url": "",
      "rrp": [
        {
          "value": 10.49,
          "currency_code": "gbp"
        }
      ],
      "options": [
        {
          "group": "Color",
          "value": "Blue"
        }
      ],
      "status": "live",
      "settings": [
        {
          "customer_group": "default",
          "pack_size": 0,
          "reserve_stock_quantity": 0,
          "min_order_quantity": 0,
          "max_order_quantity": 0,
          "min_order_parent_quantity": 0,
          "max_order_parent_quantity": 0,
          "display": false,
          "sell": false
        }
      ],
      "stock_management": "none"
    }
  ]
}