Update product

Updates an existing product. For base SERIALS products, sending the serials field replaces the full base-product serial inventory. Use /dev/v1/products/{id}/serials when you need append/remove behavior instead of full replacement.

PATCH /dev/v1/products/{id}

Update product

cURL

curl --request PATCH \
  --url https://api.shoppex.io/dev/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "DYNAMIC",
  "dynamic_webhook": "https://example.com/updated",
  "delivery_instructions": {
    "required": false,
    "label": "Setup note",
    "max_length": 300
  },
  "custom_fields": [
    {
      "name": "Display Name",
      "type": "text",
      "required": false
    }
  ]
}
'

200

{
  "data": {
    "id": "prod_db_1",
    "uniqid": "prod_1",
    "shop_id": "shop_1",
    "slug": null,
    "type": "DYNAMIC",
    "subtype": null,
    "title": "Product One",
    "currency": "USD",
    "price": 19.99,
    "price_display": 19.99,
    "description": "Product description",
    "gateways": [
      "PAYPAL"
    ],
    "custom_fields": [
      {
        "name": "Display Name",
        "type": "text",
        "required": false
      }
    ],
    "delivery_instructions": {
      "enabled": true,
      "required": false,
      "label": "Setup note",
      "max_length": 300
    },
    "quantity_min": 1,
    "quantity_max": -1,
    "quantity_warning": 0,
    "stock": 0,
    "stock_delimiter": "\n",
    "unlisted": false,
    "private": false,
    "on_hold": false,
    "sort_priority": 0,
    "crypto_confirmations": 1,
    "max_risk_level": 0,
    "block_vpn_proxies": false,
    "delivery_text": "",
    "delivery_time": null,
    "service_text": "",
    "dynamic_webhook": "https://example.com/updated",
    "watermark_enabled": true,
    "image_id": null,
    "image_url": null,
    "variants": [],
    "created_at": 1711965600,
    "updated_at": 1711969200
  }
}

Authorizations

Authorization · string · header · required

Use your Shoppex API key in the Authorization header.

Path Parameters

id · string · required

Body

application/jsonmultipart/form-datatext/plain

title · string

price · number

cost · number | null

description · string

currency · string

gateways · string[]

type · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string> Option 5 · enum<string> Option 6 · enum<string> Option 7 · enum<string> Option 8 · enum<string>

Available options: SERIALS

subtype · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string> Option 5 · enum<string> Option 6 · enum<string> Option 7 · enum<string> Option 8 · enum<string>

Available options: SINGLE

serials · string[]

serialsRemoveDuplicates · boolean

serials_remove_duplicates · boolean

serviceText · string

service_text · string

stock · number

dynamicWebhook · string | null

dynamic_webhook · string | null

dynamicWebhookSecret · string

dynamic_webhook_secret · string

stockDelimiter · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Available options: comma

stock_delimiter · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Available options: comma

quantity · object

Show child attributes

quantity_min · number

quantity_max · number

deliveryText · string

delivery_text · string

customFields · object[]

Show child attributes

custom_fields · object[]

Show child attributes

deliveryInstructions · object

Show child attributes

delivery_instructions · object

Show child attributes

cryptoConfirmationsNeeded · number

crypto_confirmations_needed · number

crypto_confirmations · number

maxRiskLevel · number

max_risk_level · number

unlisted · boolean

private · boolean

blockVpnProxies · boolean

block_vpn_proxies · boolean

sortPriority · number

sort_priority · number

webhooks · string[]

onHold · boolean

on_hold · boolean

termsOfService · string | null

terms_of_service · string | null

warrantyDays · number

warranty_days · number

warrantyText · string | null

warranty_text · string | null

volumeDiscounts · object[]

Show child attributes

volume_discounts · object[]

Show child attributes

recurringInterval · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string>

Available options: DAY

recurring_interval · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string>

Available options: DAY

recurringIntervalCount · number | null

recurring_interval_count · number | null

trialPeriod · number | null

trial_period · number | null

discountPercent · number

discount_percent · number

deliveryTime · number | null

delivery_time · number | null

categoryId · string | null

category_id · string | null

youtubeLink · string | null

youtube_link · string | null

watermarkEnabled · boolean

watermark_enabled · boolean

watermarkText · string | null

watermark_text · string | null

redirectLink · string | null

redirect_link · string | null

redirectTime · number | null

redirect_time · number | null

variants · object[] | null

Show child attributes

discordIntegration · boolean

discord_integration · boolean

discordSetRole · boolean

discord_set_role · boolean

discordServerId · string | null

discord_server_id · string | null

discordRoleId · string | null

discord_role_id · string | null

discordRemoveRole · boolean

discord_remove_role · boolean

payWhatYouWant · boolean

pay_what_you_want · boolean

affiliateRevenuePercent · number

affiliate_revenue_percent · number

affiliateCustomerDiscountMode · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Available options: USE_STORE_DEFAULT

affiliate_customer_discount_mode · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Available options: USE_STORE_DEFAULT

affiliateCustomerDiscountPercent · number | null

affiliate_customer_discount_percent · number | null

discordOptional · boolean

discord_optional · boolean

licensingEnabled · boolean

licensing_enabled · boolean

licensePeriod · string | null

license_period · string | null

label_singular · string

label_plural · string

slug · string | null

Response

200 - application/json

Successful response

data · object