Printago API
PATCH /v1/skus/{id}

Update a SKU

Requires: sku.edit

Path Parameters

id required
string
The unique identifier of the SKU to update

Request Body

The partial SKU data to update

PartialSkuInsert
customMetadataoptional
Record<string, any>
Construct a type with a set of properties K of type T
descriptionoptional
string
externalIdoptionalnullable
string
externalProvideroptionalnullable
"etsy" | "shopify"
etsyshopify
folderIdoptionalnullable
string
pattern: ^[a-z0-9]{24}$
inputsoptional
object[]
connectedPropertyIdoptionalnullable
string
idoptional
string
namerequired
string
typerequired
"text" | "material" | "plate_quantities"
textmaterialplate_quantities
linkedPartsoptional
object[]
exposedParametersrequired
string[]
extensionsoptionalnullable
object
3mfoptional
object
plateLabelsoptional
Record<string, string>
plateQuantitiesrequired
Record<string, number>
skipObjectsoptional
Record<string, string[]>
Construct a type with a set of properties K of type T
labelrequired
string
materialAssignmentsoptionalnullable
Record<string, object[]>
Construct a type with a set of properties K of type T
parameterBindingsoptionalnullable
Record<string, string>
Construct a type with a set of properties K of type T
parametersrequired
object[]
namerequired
string
typerequired
"number" | "string" | "boolean" | "file"
numberstringbooleanfile
valueoptional
number | string | boolean
partIdrequired
string
pattern: ^[a-z0-9]{24}$
plateQuantitiesBindingoptionalnullable
string
quantityrequired
number
min: 0max: 500
sequenceBindingsoptionalnullable
Record<string, string>
Construct a type with a set of properties K of type T
skuIdoptional
string
pattern: ^[a-z0-9]{24}$
optionBindingsoptional
string[]
skuoptional
string
titleoptional
string

Example Request

application/json 
{
  "linkedParts": [
    {
      "skuId": "string",
      "parameters": [
        {
          "name": "string",
          "type": "number",
          "value": 1
        }
      ],
      "partId": "string",
      "quantity": 0,
      "label": "string",
      "extensions": {
        "3mf": {
          "skipObjects": {},
          "plateQuantities": {},
          "plateLabels": {}
        }
      },
      "materialAssignments": {},
      "exposedParameters": [
        "string"
      ],
      "parameterBindings": {},
      "sequenceBindings": {},
      "plateQuantitiesBinding": "string"
    }
  ],
  "inputs": [
    {
      "id": "string",
      "type": "text",
      "name": "string",
      "connectedPropertyId": "string"
    }
  ],
  "optionBindings": [
    "string"
  ],
  "description": "string",
  "externalId": "string",
  "customMetadata": {},
  "folderId": "string",
  "sku": "string",
  "title": "string",
  "externalProvider": "etsy"
}

Response Schema

Sku
createdAtrequired
string
format: date-time
customMetadataoptional
Record<string, any>
Construct a type with a set of properties K of type T
descriptionrequired
string
externalIdrequirednullable
string
externalProviderrequirednullable
"etsy" | "shopify"
etsyshopify
folderIdoptionalnullable
string
pattern: ^[a-z0-9]{24}$
idrequired
string
pattern: ^[a-z0-9]{24}$
skurequired
string
storeIdrequired
string
pattern: ^[a-z0-9]{24}$
titlerequired
string
totalCogsrequired
number
updatedAtrequired
string
format: date-time

Example Response

200 OK — application/json 
{
  "sku": "string",
  "title": "string",
  "description": "string",
  "externalId": "string",
  "externalProvider": "etsy",
  "folderId": "string",
  "totalCogs": 1,
  "customMetadata": {},
  "id": "string",
  "storeId": "string",
  "createdAt": "2025-01-15T12:00:00.000Z",
  "updatedAt": "2025-01-15T12:00:00.000Z"
}