Customer Management
This chapter provides a comprehensive guide to managing customers within the OCS.io. It covers various aspects of customer management, including creating, updating, and retrieving customer information. The following sub-chapters are included:
The CreateCustomer API allows for the creation of new customers within the system. This API provides the necessary functionality to set up customer details and initial configurations.
The CreateSubscriptionOnCustomer API covers the management of subscriptions related to customers. This includes recording, updating, and retrieving subscription details to maintain accurate records.
The UpdateCustomerExternalId API allows for the modification of a customer’s external ID. This API provides the necessary functionality to update the external identifier used for customer management.
The UpdateCustomerCustomName API covers the management of custom names associated with customers. This includes updating the custom name to reflect changes in customer details.
The UpdateCustomerCustomAttributes API enables the modification of custom attributes for a customer. Custom attributes are implemented as key-value pairs, and the system must provide the full set of key-value pairs in the request.
The UpdateCustomerSegment API allows for updating the segment of a customer. This attribute is used for categorizing customers and is crucial for subsequent processes.
The UpdateCustomerState API provides access to the historical data of a customer. This includes past transactions, changes in customer status, and other relevant historical information.
The ReadCustomer API allows for retrieving detailed information about a customer using their unique identifier. This API is essential for accessing customer data for management and reporting purposes.
Each sub-chapter provides detailed information on the respective API, including usage examples, parameters, and expected responses. This guide aims to equip developers with the knowledge and tools necessary to effectively manage customers within the OCS.io.