- Utilities
-
Accounting
- Accounting Period
- Accounting Period Lock
- All transaction statement
- Contact balance
- Currency
- Customer Payment
- Exchange Rate
- Journal
- Journal Entry
- Nominal Code
- Payment Method
- Purchase Credit
- Purchase Invoice
- Purchase Payment
- Purchase Payment Total
- Sale Payment Total
- Sales Credit
- Sales Invoice
- Sales Receipt
- Sales Receipt (deprecated)
- Supplier Payment
- Tax Code
- Contact
- Integration
-
Order
- Custom Field Metadata
- Landed Cost Estimate
- Order
- Order Acknowledgement
- Custom Field
- Order Note
- Order Row
- Order Shipping Status
- Order Status
- Order Status Update
- Order Stock Status
- Order Type
- Purchase Credit Close
- Purchase Order Close
- Sales Credit
- Sales Credit Close
- Sales Order
- Sales Order Close
- Sales Order Row
- Pricing
-
Product
- Brand
- Brightpearl Category
- Channel
- Channel brand
- Collection
- Discount contact usage
- Discount total usage
- Option
- Option Value
- Price List
- Product Primary Supplier
- Product
- Product Bundle
- Product Custom Field
- Custom Field Metadata
- Custom Field
- Product Group
- Product Identity
- Product option value
- Product Price
- Product Supplier
- Product Type
- Product Type Option Association
- Season
-
Warehouse
- Asset Value Correction
- Bundle Availability
- Default Location
- Drop-Ship Note
- Drop-Ship Note Event
- External Transfer
- Fulfilment Source
- Order fulfilment status
- Goods-In Note Correction
- Goods-In Note
- Goods Movement
- Goods-Out Note
- Goods-Out Note Event
- Internal Transfer
- Location
- Pick
- Product Availability
- Quarantine Location
- Quarantine Release
- Reservation
- Reservation Row
- Reservations
- Shipping Method
- Stock Correction
- Stock Transfer
- Warehouse
- Warehouse Defaults
- Zone
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/contact-service/contact/{ID-SET}
Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
The contact OPTIONS message allows you to programmatically request a set of URIs you need to call if you would like to retrieve a large set of contacts.
The method takes an optional ID set of contact IDs. If you do not specify an ID set then you are requesting all contacts.
This method exists as we limit the number of contacts you can request using the GET message to ease the load on our servers. The limit for one request is currently set to 200 contacts.
A typical scenario is that your Brightpearl account contains 20,000 contacts and you would like to request them all. You would make a call to the /contact/ URI using OPTIONS. The response of the request will be a series of URIs. You will need to perform a Contact GET on each of these to retrieve all your contacts.
Example 1
Request URI
/contact/
Response
{
"response": {
"getUris": [
"/contact/1-4,200-209,250-435",
"/contact/436-500"
]
}
}
Example 2
Request URI
/contact/250-500
Response
{
"response": {
"getUris": [
"/contact/250-449",
"/contact/450-500"
]
}
}