> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/product-price/price-lists/partially-update-a-price-list.md).

# Partially update a price list

Updates one or more fields of a price list. Only the fields included in the request body are changed; everything left out keeps its current value.

When `currency` is included and differs from the current one, the list must not contain an extra product price with a different currency.

```json
{"openapi":"3.1.0","info":{"title":"Admin API","version":"1.0.0"},"tags":[{"name":"Price Lists","description":"Administrative endpoints for **price lists** — named, single-currency containers that group extra product prices. A price list does not hold prices itself; the per-product prices that belong to it are managed through `extra_product_price`. Price lists are referenced by customer segments and data sources to decide which prices a shopper sees.\n\n## Core Capabilities\n\n**1. Listing & Filtering**\n* Retrieve a paginated list of price lists.\n* Filter by exact `name` or `code`.\n* Order results with the `sort` parameter.\n\n**2. Full CRUD**\n* Create a price list with a name, a code, and a currency.\n* Retrieve a single price list by its identifier.\n* Fully or partially update a price list.\n* Permanently delete a price list together with the records that depend on it (see **Deleting a Price List**).\n\n## Price List Fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `pk` | integer | The unique identifier of the price list. Read-only. |\n| `name` | string | The display name of the price list. Up to 64 characters, unique across price lists. Required. |\n| `code` | string or `null` | The machine-readable code of the price list. Up to 64 characters, unique across price lists when set. Required. |\n| `currency` | string | The ISO 4217 currency code of every price in the list (see **Currency Codes** under **Product Price**). Required. |\n\n## Currency Consistency\n\nEvery extra product price in a price list must use the price list's currency. The `currency` of an existing price list can only be changed when none of its extra product prices uses a different currency; otherwise the update is rejected with a `400` validation error on the `currency` field. Sending the current currency again is always accepted.\n\n## Deleting a Price List\n\n`DELETE /price_list/{id}/` is a **hard delete**. Removing a price list also permanently removes:\n\n* every extra product price in the list, and the basket items that use those prices;\n* every data source that uses the list, together with its basket items, conversations and messages, shipping options, and landing pages. Products of a removed data source are kept, and their data source is cleared.\n\nThe deletion is rejected with `406` and nothing is removed when:\n\n* a customer segment still uses the price list, or\n* an order item references one of the extra product prices or data sources that would be removed.\n\nReassign or remove the referencing segment first, then repeat the request. A price list whose prices or data sources have been ordered cannot be deleted.\n\n## Filtering & Ordering\n\n| Parameter | Match |\n|-----------|-------|\n| `name` | The price list by its exact, case-sensitive name. |\n| `code` | The price list by its exact, case-sensitive code. |\n\nResults can be ordered with the `sort` parameter; prefix a field with a hyphen for descending order.\n\n## Dynamic Settings & Environment Variables\n\n**Dynamic settings:** No dynamic settings affect these endpoints.\n\n**Environment variables:** No environment variables are read directly by these endpoints."}],"servers":[{"description":"Omnitron Remote Proxy (external access — recommended)","url":"https://{omnitron_url}/api/v1/remote/{channel_id}","variables":{"omnitron_url":{"default":"sandbox.akinon.com","description":"Omnitron server URL (e.g., {omnitron.akinon.com})"},"channel_id":{"default":"1","description":"The channel identifier the remote request is routed through"}}},{"description":"Commerce API Server (internal / direct access only)","url":"https://{commerce_url}/api/v1","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Internal commerce server URL, reachable only from within the Omnitron network"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token credential sent in the Authorization header, in the form: `Token <your-token>`. Requires a staff (admin) account."}},"schemas":{"PriceListPatchRequest":{"type":"object","description":"The body of a price-list partial update request. Only the fields included in the body are changed; every field is optional.","properties":{"name":{"type":"string","maxLength":64,"description":"The display name of the price list. Must be unique."},"code":{"type":["string","null"],"maxLength":64,"description":"The machine-readable code of the price list. Must be unique when set."},"currency":{"allOf":[{"$ref":"#/components/schemas/ProductPriceCurrencyType"}],"description":"The ISO 4217 currency code. Can only change when no extra product price in the list uses a different currency."}}},"ProductPriceCurrencyType":{"type":"string","description":"An ISO 4217 currency code accepted by the product-price endpoints.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd","amd","cfa","lyd"]},"PriceList":{"type":"object","description":"A price list — a named, single-currency container for extra product prices.","properties":{"pk":{"type":"integer","readOnly":true,"description":"The unique identifier of the price list."},"name":{"type":"string","maxLength":64,"description":"The display name of the price list. Unique across price lists."},"code":{"type":["string","null"],"maxLength":64,"description":"The machine-readable code of the price list. Unique across price lists when set."},"currency":{"$ref":"#/components/schemas/ProductPriceCurrencyType"}}},"ValidationError":{"type":"object","description":"Returned when the request contains invalid or missing data. Errors are grouped by the field they apply to: each key is the name of a field from the request and its value is a list of one or more messages describing what is wrong with that field. Messages that do not belong to any single field are grouped under `non_field_errors`.","properties":{"non_field_errors":{"type":"array","description":"Error messages that apply to the request as a whole rather than to a specific field.","items":{"type":"string"}}},"additionalProperties":{"type":"array","description":"The list of error messages for the field named by the key.","items":{"type":"string"}}},"Error":{"type":"object","description":"An error response.","properties":{"detail":{"type":"string","description":"A human-readable description of the error."}},"additionalProperties":true}},"responses":{"PriceListValidationError":{"description":"The request contains invalid or missing data — for example a `name` or `code` that is already used by another price list, an unknown `currency`, a `currency` change while the list contains extra product prices in another currency, or a missing required field. The response names the field the complaint belongs to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"Unauthorized":{"description":"Authentication credentials were not provided or are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The authenticated user does not have administrator privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"PriceListNotFound":{"description":"The requested price list does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/price_list/{id}/":{"patch":{"tags":["Price Lists"],"operationId":"partialUpdatePriceList","summary":"Partially update a price list","description":"Updates one or more fields of a price list. Only the fields included in the request body are changed; everything left out keeps its current value.\n\nWhen `currency` is included and differs from the current one, the list must not contain an extra product price with a different currency.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceListPatchRequest"}}}},"responses":{"200":{"description":"The updated price list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}},"400":{"$ref":"#/components/responses/PriceListValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/PriceListNotFound"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/admin/product-price/price-lists/partially-update-a-price-list.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
