Skip to content
platform

API reference

Customers

Services for full management of customer registration data, their addresses and groups.

Customer Management

  • GET Find Customer by Document /v1/customer/document/:document

    Finds a customer in your store by document and returns the complete record, with addresses and price links.

  • POST Create New Customer /v1/customer

    Registers a customer in your store, with the address and, optionally, the customer type, group and price tag links. The customer created can already access the store with the username and password provided.

  • PUT Update Customer Registration Data /v1/customer/:document

    Updates the record of a customer of your store. It is a partial update: send only the fields you want to change.

  • PUT Activate or Deactivate Customer /customer/updateStatus/:document/:active

    Activates or deactivates a customer of your store. An inactive customer cannot access the store or complete a purchase.

Addresses

  • GET List Customer Addresses /customer/addresses/:document

    Lists the addresses of a customer in your store.

  • POST Add Address to Customer /customer/:document/address

    Adds an address to the record of one of your store's customers.

  • DELETE Remove Customer Address /customer/:document/address/:addressId

    Removes an address from the record of a customer of your store.

  • DELETE Remove All Customer Addresses /deleteAllCustomerAddress/:document

    Removes all addresses of a customer in your store at once.

Customer Groups

  • GET List Customer Groups /customer/group/byGroup

    Queries your store's customer groups by name or by external id.

  • POST Create Customer Group /customer/group

    Creates a customer group in your store. The group defines which document type it applies to and which delivery and payment methods are restricted for those in it.

  • DELETE Delete Customer Group /customer/group

    Deletes a customer group from your store. The customers who were in the group remain registered — what is removed is the group and the links to it.

  • PUT Link Customer to a Group /customer/:document/priceType/:customerGroupId

    Links a price type to the customer. It is what makes the customer start receiving that type's price table.

  • DELETE Unlink Customer from a Group /customer/:document/priceType/:customerGroupId

    Undoes the link between a customer and a price type. The customer stops receiving the price table of that type.

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.