API reference
Contracts
Endpoints to manage fixed-price contracts for customers or customer groups.
Store Management
-
Creates a price contract: the special price table that the store applies to a set of customers during a period. Creation stores the contract header — validity, scope and application filters. Customers and products are added afterwards, through Add Customers to Contract and Add Products to Contract.
-
Updates part of a contract header: status, validity period, scope and application filters. It is a partial update — send only the fields you want to change, and at least one of them.
-
Lists the price contracts of your store, from newest to oldest, with pagination.
-
Adds customers to a contract, by the document of each one. The customers start receiving the contract prices.
-
Removes customers from a contract, by each one's document. The customers stop receiving the contract prices.
-
Adds products to the contract with the price of each one, or updates the price of those already in it. Each product is processed independently: the result of each one comes in the status field of the response.
-
Removes products from the contract. The products go back to being sold at the store's list price.
Head Office Management
-
Allows a head office account to create a price contract in one of its branches. Creation saves the contract header — validity period, scope and application filters. Customers and products are added afterward, through Add Customers to Branch Contract and Add Products to Branch Contract.
-
Allows a head office account to update part of the header of a contract of one of its branches: status, validity period, coverage and application filters. It is a partial update — send only the fields you want to change, and at least one of them.
-
Allows a head office account to list the price contracts of one of its branches, from newest to oldest, with pagination.
-
Allows a head office account to add customers to a contract of one of its branches, by the document of each one. The customers start receiving the contract prices.
- DELETE Remove Customers from Branch Contract
/pricing/contract/:contractId/customers/store/:partnerIdAllows a head office account to remove customers from a contract of one of its branches, by each one's document. The customers stop receiving the contract prices.
-
Allows a head office account to add products to the contract of one of its branches with the price of each, or update the price of those already in it. Each product is processed independently: the result for each one comes in the status field of the response.
-
Allows a head office account to remove products from the contract of one of its branches. The products go back to being sold at the branch's list price.
Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.