Find Customers | NaviPartner | NP Retail API Documentation

1 import requests 2 3 url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./customer/" 4 5 querystring = {"pageSize":"50","customerNo":"CUST-10001","email":"jane.doe@acme.com"} 6 7 headers = {"Authorization": "Bearer <apiKey>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "morePages": true, 3 "nextPageKey": "c29tZSBiYXNlNjQgc3RyaW5n", 4 "nextPageURL": "https://api.npretail.app/tenant/env/company/customer?pageKey=c29tZSBiYXNlNjQgc3RyaW5n&lastRowVersion=12345678901234567890", 5 "data": [ 6 { 7 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 8 "no": "CUST-10001", 9 "name": "Acme Corporation", 10 "address": "123 Main Street", 11 "postCode": "10001", 12 "city": "New York", 13 "address2": "Suite 400", 14 "county": "New York", 15 "countryCode": "US", 16 "contact": "Jane Doe", 17 "email": "jane.doe@acme.com", 18 "phone": "+1-555-123-4567", 19 "mobilePhone": "+1-555-987-6543", 20 "ean": "1234567890123", 21 "vatRegistrationNo": "US123456789", 22 "rowVersion": "12345678901234567890" 23 }, 24 { 25 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 26 "no": "CUST-10001", 27 "name": "Acme Corporation", 28 "address": "123 Main Street", 29 "postCode": "10001", 30 "city": "New York", 31 "address2": "Suite 400", 32 "county": "New York", 33 "countryCode": "US", 34 "contact": "Jane Doe", 35 "email": "jane.doe@acme.com", 36 "phone": "+1-555-123-4567", 37 "mobilePhone": "+1-555-987-6543", 38 "ean": "1234567890123", 39 "vatRegistrationNo": "US123456789", 40 "rowVersion": "12345678901234567890" 41 } 42 ] 43 }

Get a list of customers with pagination

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Query Parameters

customerNostringOptional

Filter customers by customer number

emailstringOptional

Filter customers by email address

pageSizeintegerOptional

pageKeystringOptional

lastRowVersionstringOptional

syncbooleanOptional

Response

This endpoint returns an object.

morePagesboolean

nextPageKeystring

nextPageURLstring

datalist of objects

Authentication

Path Parameters

Headers

Query Parameters

Response