added
New Endpoints for Customer Data Management
3 months ago by Lidia Perov
Release Date: November 11, 2024
What’s New?
-
New GET and POST Endpoints Introduced:
-
GET Endpoint:
/api/p/v{version}/customers
: Retrieves detailed customer profiles, including contact information and associated data, byid
orcompanyNumber
.
Example Request:
GET /api/p/v{version}/customers?id=12345 //or //GET /api/p/v{version}/customers?companyNumber=12345
-
POST Endpoint:
/api/p/v{version}/customers/search
: Supports advanced filtered searches for customer records by status, or date range. Includes pagination for optimized data access.
Example Request:
POST /api/p/v{version}/customers/search { "page": 0, "pageSize": 100, "statuses": [ "Active" ], "createdDateRange": { // "start": "2024-11-08T19:38:34.529Z", // "end": "2024-11-08T19:38:34.529Z" } }
-
Purpose
- Provides flexibility for retrieving and searching customer data.
- Enables streamlined workflows for integration, automation, and reporting.