Products: Updates an existing invoice product by id.

PUT /api/invoicing/products/{id} deprecated

Requires: Invoicing.Products, Invoicing.Products.Update, merchant scope.

Changing `productCode` to one another of the biller's products already holds (compared case-insensitively) is refused as a validation error on that field. A product keeping its own code is never re-checked, so an edit that touches other fields is not refused over it.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a InvoiceProductUpdateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/invoicing/products/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": ""
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "name": ""
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/invoicing/products/{id}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.invoiceProductUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "name": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/products/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": ""
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<InvoiceProductUpdateDto>("""
    {
      "name": ""
    }
    """);

var result = await api.InvoiceProductUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/invoicing/products/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": ""
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    body = winkpg_api.InvoiceProductUpdateDto.from_dict({
      "name": ""
    })
    result = api.invoice_product_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "name": ""
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/invoicing/products/{id}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`name` required	string	nullablemax length 200
`description` required	string	Conditional: When Description is not empty. Max length: 1000. nullable
`productCode` required	string	Optional SKU or product code. Stored trimmed, with its letter case kept. Unique within the biller, compared case-insensitively: a code another of the biller's products already holds is rejected with a validation error naming this field. Leave it empty (or send whitespace, which is stored as no code) for a product without a code; any number of those may exist. Conditional: When ProductCode is not empty. Max length: 50. nullable
`imageBlobName` required	string	Bare blob filename of the product image, as returned by the hosted-page image upload endpoint (`POST /api/hostedpaymentpages/images/upload`). Omit or send null to leave the product without an image; an empty string also clears it. Never a URL, a path, or inline image data. nullable
`defaultPrice` required	number (double)	min 0
`taxCategoryId` required	string (uuid)	Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted and stored as sent, and never applied to a line item. nullable
`defaultTaxRateId` required	string (uuid)	Optional. The id of one of the biller's active tax rates, applied to an invoice line when this product is picked. Must belong to the same biller as the product; a rate that does not exist, belongs to another biller, or has been deactivated is rejected with a validation error naming this field. Omit or send null for no default. nullable
`isActive` required	boolean	nullable
`sortOrder` required	integer (int32)	nullable
`currency` required	string	Conditional: When Currency is not empty. Max length: 3. nullable
`pricingModel` required	all of PricingModel	nullable
`allowCustomPrice` required	boolean	nullable
`productType` required	all of ProductType	nullable
`isTaxable` required	boolean	nullable
`taxCode` required	string	Conditional: When TaxCode is not empty. Max length: 50. nullable
`unitOfMeasure` required	string	Conditional: When UnitOfMeasure is not empty. Max length: 50. nullable
`allowFractionalQuantity` required	boolean	nullable
`minimumQuantity` required	number (double)	Conditional: When MinimumQuantity is not null. Must be >= 0. nullable
`maximumQuantity` required	number (double)	Conditional: When MaximumQuantity is not null. Must be >= 0. nullable
`requiresShipping` required	boolean	nullable
`weight` required	number (double)	nullablemin 0max 999999.9999
`weightUnit` required	all of ShippingWeightUnit	Required: When Weight is not null. nullable
`length` required	number (double)	nullablemin 0max 99999.9999
`width` required	number (double)	nullablemin 0max 99999.9999
`height` required	number (double)	nullablemin 0max 99999.9999
`dimensionUnit` required	all of ShippingDimensionUnit	Required: When Length is not null or Width is not null or Height is not null. nullable
`revenueAccount` required	string	Conditional: When RevenueAccount is not empty. Max length: 100. nullable
`deferredRevenue` required	boolean	nullable
`recognitionRuleId` required	string (uuid)	nullable
`tags` required	array of EntityTag	nullable
`concurrencyStamp` required	string	nullable

This request body has no documented fields.