Update Price by ID for a Product

The “Update Price by ID for a Product” API allows modifying information for a specific price associated with a particular product using its unique identifier. Use this endpoint to update details for a single price based on the provided price ID and product ID.

PUT https://services.leadconnectorhq.com/products/{productId}/price/{priceId}

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Path parameters

string

default:"6578278e879ad2646715ba9c"

required

ID of the product that needs to be used

string

default:"6578278e879ad2646715ba9c"

required

ID of the price that needs to be returned

Body

string

default:"Price Name"

required

The name of the price.

string

default:"one_time"

required

The type of the price. Posibles valores: ‘one_time’, ‘recurring’

string

default:"USD"

required

The currency of the price.

number

default:"99.99"

required

The amount of the price. ( min: 0 )

object

The recurring details of the price (if type is recurring).

string

A brief description of the price.

object[]

An array of membership offers associated with the price.

Show cada item

string

default:"top_50"

required

Membership offer label

string

default:"50"

required

Membership offer label

string

default:"655b33aa2209e60b6adb87a7"

required

The unique identifier for the membership offer.

number

default:"7"

The trial period duration in days (if applicable).

number

default:"12"

The total number of billing cycles for the price. ( min: 1 )

number

default:"10.99"

The setup fee for the price.

string[]

An array of variant option IDs associated with the price.

number

default:"19.99"

The compare at price for the price.

string

default:"6578278e879ad2646715ba9c"

required

The unique identifier of the account associated with the price.

string

default:"6578278e879ad2646715ba9c"

The unique identifier of the user who created the price.

object

Additional metadata associated with the price.

boolean

default:"True"

Need to track inventory stock quantity

number

default:"5"

Available inventory stock quantity

boolean

default:"True"

Continue selling when out of stock

string

default:"sku_123"

The unique identifier of the SKU associated with the price

object

Shipping options of the Price

boolean

default:"True"

Is the product a digital product

string[]

Digital delivery options

Respuestas

200 - Successful response

string

default:"655b33aa2209e60b6adb87a7"

required

The unique identifier for the price.

object[]

An array of membership offers associated with the price.

Show cada item

string

default:"top_50"

required

Membership offer label

string

default:"50"

required

Membership offer label

string

default:"655b33aa2209e60b6adb87a7"

required

The unique identifier for the membership offer.

string[]

An array of variant option IDs associated with the price.

string

default:"3SwdhCsvxI8Au3KsPJt6"

The unique identifier for the account.

string

default:"655b33a82209e60b6adb87a5"

The unique identifier for the associated product.

string

default:"6YAtzfzpmHAdj0e8GkKp"

The unique identifier for the user.

string

default:"Red / S"

required

The name of the price.

string

default:"one_time"

required

The type of the price (e.g., one_time). Posibles valores: ‘one_time’, ‘recurring’

string

default:"INR"

required

The currency code for the price.

number

default:"199999"

required

The amount of the price.

object

The recurring details of the price (if type is recurring).

string

default:"2023-11-20T10:23:38.645Z"

The creation timestamp of the price.

string

default:"2024-01-23T09:57:04.852Z"

The last update timestamp of the price.

number

default:"2000000"

The compare-at price for comparison purposes.

boolean

Indicates whether inventory tracking is enabled.

number

default:"5"

Available inventory stock quantity

boolean

default:"True"

Continue selling when out of stock

{
  "_id": "655b33aa2209e60b6adb87a7",
  "membershipOffers": [
    {
      "label": "top_50",
      "value": "50",
      "_id": "655b33aa2209e60b6adb87a7"
    }
  ],
  "variantOptionIds": [
    "h4z7u0im2q8",
    "h3nst2ltsnn"
  ],
  "locationId": "3SwdhCsvxI8Au3KsPJt6",
  "product": "655b33a82209e60b6adb87a5",
  "userId": "6YAtzfzpmHAdj0e8GkKp",
  "name": "Red / S",
  "type": "one_time",
  "currency": "INR",
  "amount": 199999,
  "createdAt": "2023-11-20T10:23:38.645Z",
  "updatedAt": "2024-01-23T09:57:04.852Z",
  "compareAtPrice": 2000000,
  "availableQuantity": 5,
  "allowOutOfStockPurchases": true
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X PUT 'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Price Name",
  "type": "one_time",
  "currency": "USD",
  "amount": 99.99,
  "description": "string",
  "membershipOffers": [
    {
      "label": "top_50",
      "value": "50",
      "_id": "655b33aa2209e60b6adb87a7"
    }
  ],
  "trialPeriod": 7,
  "totalCycles": 12,
  "setupFee": 10.99,
  "variantOptionIds": [
    "option_id_1",
    "option_id_2"
  ],
  "compareAtPrice": 19.99,
  "locationId": "6578278e879ad2646715ba9c",
  "userId": "6578278e879ad2646715ba9c",
  "trackInventory": true,
  "availableQuantity": 5,
  "allowOutOfStockPurchases": true,
  "sku": "sku_123",
  "isDigitalProduct": true,
  "digitalDelivery": [
    "string"
  ]
}'

const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name": "Price Name", "type": "one_time", "currency": "USD", "amount": 99.99, "description": "string", "membershipOffers": [{"label": "top_50", "value": "50", "_id": "655b33aa2209e60b6adb87a7"}], "trialPeriod": 7, "totalCycles": 12, "setupFee": 10.99, "variantOptionIds": ["option_id_1", "option_id_2"], "compareAtPrice": 19.99, "locationId": "6578278e879ad2646715ba9c", "userId": "6578278e879ad2646715ba9c", "trackInventory": true, "availableQuantity": 5, "allowOutOfStockPurchases": true, "sku": "sku_123", "isDigitalProduct": true, "digitalDelivery": ["string"]}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'PUT',
    'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"name": "Price Name", "type": "one_time", "currency": "USD", "amount": 99.99, "description": "string", "membershipOffers": [{"label": "top_50", "value": "50", "_id": "655b33aa2209e60b6adb87a7"}], "trialPeriod": 7, "totalCycles": 12, "setupFee": 10.99, "variantOptionIds": ["option_id_1", "option_id_2"], "compareAtPrice": 19.99, "locationId": "6578278e879ad2646715ba9c", "userId": "6578278e879ad2646715ba9c", "trackInventory": true, "availableQuantity": 5, "allowOutOfStockPurchases": true, "sku": "sku_123", "isDigitalProduct": true, "digitalDelivery": ["string"]},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'name': 'Price Name', 'type': 'one_time', 'currency': 'USD', 'amount': 99.99, 'description': 'string', 'membershipOffers': [{'label': 'top_50', 'value': '50', '_id': '655b33aa2209e60b6adb87a7'}], 'trialPeriod': 7, 'totalCycles': 12, 'setupFee': 10.99, 'variantOptionIds': ['option_id_1', 'option_id_2'], 'compareAtPrice': 19.99, 'locationId': '6578278e879ad2646715ba9c', 'userId': '6578278e879ad2646715ba9c', 'trackInventory': true, 'availableQuantity': 5, 'allowOutOfStockPurchases': true, 'sku': 'sku_123', 'isDigitalProduct': true, 'digitalDelivery': ['string']}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Update Price by ID for a Product

Autorización

Path parameters

Body

Respuestas

Ejemplo

​Autorización

​Path parameters

​Body

​Respuestas

​Ejemplo

Autorización

Path parameters

Body

Respuestas

Ejemplo