Partially update product price

Partially update price

curl --request PATCH \
  --url https://api.noyax.com/api/v1/products/{productId}/prices/{priceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-CompanyID: <x-companyid>' \
  --header 'X-UserID: <x-userid>' \
  --data '
{
  "PriceType": 2,
  "Price": 450,
  "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "IncludesVat": false,
  "Discount": 10,
  "IsDiscountPercentage": true,
  "UnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "StartDate": "2023-11-07T05:31:56Z",
  "EndDate": "2023-11-07T05:31:56Z",
  "CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "CustomerGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "CustomerGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "Description": "<string>"
}
'

using RestSharp;


var options = new RestClientOptions("https://api.noyax.com/api/v1/products/{productId}/prices/{priceId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"PriceType\": 2,\n  \"Price\": 450,\n  \"CurrencyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"IncludesVat\": false,\n  \"Discount\": 10,\n  \"IsDiscountPercentage\": true,\n  \"UnitId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"StartDate\": \"2023-11-07T05:31:56Z\",\n  \"EndDate\": \"2023-11-07T05:31:56Z\",\n  \"CustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"CustomerGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"CustomerGroupDetailId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"Description\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {
    'X-UserID': '<x-userid>',
    'X-CompanyID': '<x-companyid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    PriceType: 2,
    Price: 450,
    CurrencyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    IncludesVat: false,
    Discount: 10,
    IsDiscountPercentage: true,
    UnitId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    StartDate: '2023-11-07T05:31:56Z',
    EndDate: '2023-11-07T05:31:56Z',
    CustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    CustomerGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    CustomerGroupDetailId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    Description: '<string>'
  })
};

fetch('https://api.noyax.com/api/v1/products/{productId}/prices/{priceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.noyax.com/api/v1/products/{productId}/prices/{priceId}"

payload = {
    "PriceType": 2,
    "Price": 450,
    "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "IncludesVat": False,
    "Discount": 10,
    "IsDiscountPercentage": True,
    "UnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Description": "<string>"
}
headers = {
    "X-UserID": "<x-userid>",
    "X-CompanyID": "<x-companyid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "Success": true,
  "ResultCode": "0000",
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ProductId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CurrencyCode": "TRY",
    "UnitName": "<string>",
    "CustomerName": "<string>",
    "CustomerGroupName": "<string>",
    "CustomerGroupDetailName": "<string>",
    "PriceType": 2,
    "Price": 450,
    "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "IncludesVat": false,
    "Discount": 10,
    "IsDiscountPercentage": true,
    "UnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Description": "<string>"
  },
  "Message": "<string>"
}

{
  "Success": false,
  "ResultCode": "2302",
  "Message": "Price must be greater than 0.",
  "Errors": [
    {
      "Code": "2302",
      "Message": "Price must be greater than 0."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0102",
  "Message": "Token has expired. Obtain a new token using the refresh token.",
  "Errors": [
    {
      "Code": "0102",
      "Message": "Token has expired. Obtain a new token using the refresh token."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0110",
  "Message": "You do not have permission for this operation.",
  "Errors": [
    {
      "Code": "0110",
      "Message": "You do not have permission for this operation."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "2000",
  "Message": "Product not found.",
  "Errors": [
    {
      "Code": "2000",
      "Message": "Product not found."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0120",
  "Message": "Daily request limit (10000) exceeded.",
  "Errors": [
    {
      "Code": "0120",
      "Message": "Daily request limit (10000) exceeded."
    }
  ]
}

PATCH

api

products

{productId}

prices

{priceId}

Partially update price

curl --request PATCH \
  --url https://api.noyax.com/api/v1/products/{productId}/prices/{priceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-CompanyID: <x-companyid>' \
  --header 'X-UserID: <x-userid>' \
  --data '
{
  "PriceType": 2,
  "Price": 450,
  "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "IncludesVat": false,
  "Discount": 10,
  "IsDiscountPercentage": true,
  "UnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "StartDate": "2023-11-07T05:31:56Z",
  "EndDate": "2023-11-07T05:31:56Z",
  "CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "CustomerGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "CustomerGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "Description": "<string>"
}
'

using RestSharp;


var options = new RestClientOptions("https://api.noyax.com/api/v1/products/{productId}/prices/{priceId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"PriceType\": 2,\n  \"Price\": 450,\n  \"CurrencyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"IncludesVat\": false,\n  \"Discount\": 10,\n  \"IsDiscountPercentage\": true,\n  \"UnitId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"StartDate\": \"2023-11-07T05:31:56Z\",\n  \"EndDate\": \"2023-11-07T05:31:56Z\",\n  \"CustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"CustomerGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"CustomerGroupDetailId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"Description\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {
    'X-UserID': '<x-userid>',
    'X-CompanyID': '<x-companyid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    PriceType: 2,
    Price: 450,
    CurrencyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    IncludesVat: false,
    Discount: 10,
    IsDiscountPercentage: true,
    UnitId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    StartDate: '2023-11-07T05:31:56Z',
    EndDate: '2023-11-07T05:31:56Z',
    CustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    CustomerGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    CustomerGroupDetailId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    Description: '<string>'
  })
};

fetch('https://api.noyax.com/api/v1/products/{productId}/prices/{priceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.noyax.com/api/v1/products/{productId}/prices/{priceId}"

payload = {
    "PriceType": 2,
    "Price": 450,
    "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "IncludesVat": False,
    "Discount": 10,
    "IsDiscountPercentage": True,
    "UnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Description": "<string>"
}
headers = {
    "X-UserID": "<x-userid>",
    "X-CompanyID": "<x-companyid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "Success": true,
  "ResultCode": "0000",
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ProductId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CurrencyCode": "TRY",
    "UnitName": "<string>",
    "CustomerName": "<string>",
    "CustomerGroupName": "<string>",
    "CustomerGroupDetailName": "<string>",
    "PriceType": 2,
    "Price": 450,
    "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "IncludesVat": false,
    "Discount": 10,
    "IsDiscountPercentage": true,
    "UnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CustomerGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Description": "<string>"
  },
  "Message": "<string>"
}

{
  "Success": false,
  "ResultCode": "2302",
  "Message": "Price must be greater than 0.",
  "Errors": [
    {
      "Code": "2302",
      "Message": "Price must be greater than 0."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0102",
  "Message": "Token has expired. Obtain a new token using the refresh token.",
  "Errors": [
    {
      "Code": "0102",
      "Message": "Token has expired. Obtain a new token using the refresh token."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0110",
  "Message": "You do not have permission for this operation.",
  "Errors": [
    {
      "Code": "0110",
      "Message": "You do not have permission for this operation."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "2000",
  "Message": "Product not found.",
  "Errors": [
    {
      "Code": "2000",
      "Message": "Product not found."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0120",
  "Message": "Daily request limit (10000) exceeded.",
  "Errors": [
    {
      "Code": "0120",
      "Message": "Daily request limit (10000) exceeded."
    }
  ]
}

Send only the fields you want to change; fields you do not send keep their current values. Rules and examples: partial update. Validation runs on the whole merged record: for example, sending only CustomerGroupId without clearing an existing CustomerId returns a scope conflict (2314).

Authorizations

Authorization

string

header

required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID

integer<int32>

required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1

X-CompanyID

integer<int32>

required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1

X-PeriodID

integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

productId

string<uuid>

required

Product ID.

priceId

string<uuid>

required

Price ID.

Body

PriceType

integer<int32>

Required. 1: Purchase, 2: Sales.

Example:

2

Price

number<double>

Required. Must be greater than 0.

Example:

450

CurrencyId

null | string<uuid>

Required. ID of a currency from GET /api/v1/definitions/currencies.

IncludesVat

boolean

Whether Price includes VAT.

Example:

false

Discount

number<double>

Discount amount or percentage, depending on IsDiscountPercentage. Cannot be negative.

Example:

10

IsDiscountPercentage

boolean

Whether Discount is a percentage (0-100) rather than a fixed amount. Defaults to true.

Example:

true

UnitId

null | string<uuid>

Required. Must be one of the product's own units: its main unit (UnitId on the product) or, for products with a second/third unit, one of those.

StartDate

null | string<date-time>

Required. Start of the validity period.

EndDate

null | string<date-time>

Required. End of the validity period. Must be after StartDate.

CustomerId

null | string<uuid>

Scope: applies only to this customer. Cannot be combined with CustomerGroupId or CustomerGroupDetailId. Leave every scope field empty for a general price.

CustomerGroupId

null | string<uuid>

Scope: applies to every customer in this group (from GET /api/v1/customers/groups), unless CustomerGroupDetailId narrows it to one detail. Cannot be combined with CustomerId.

CustomerGroupDetailId

null | string<uuid>

Scope: narrows CustomerGroupId to customers with this group detail. Requires CustomerGroupId to be set.

Description

null | string

Description. At most 255 characters.

Response

Success

boolean

required

Whether the operation succeeded.

Example:

true

ResultCode

string

required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data

object

required

Show child attributes

Message

null | string

Error message when Success is false. Messages of all errors are joined into a single text.

Getting started

Core concepts

Modules

Release notes

Partially update product price

Authorizations

Headers

Path Parameters

Body

Response