Skip to content

Store adapter — Brightpearl

The adapter object contains properties for connecting to the Brightpearl API.

Parent object: a store with property "platform" : "brightpearl"

Required properties

The following adapter properties are required for Brightpearl stores.

account_id

Propertyaccount_id
NameBrightpearl Account ID
Data typestring
Required?Yes

datacenter_code

Propertydatacenter_code
NameDatacenter Code
DescriptionAccount region location
Data typestring
Accepted values
  • "use" — for EST / CST Timezone
  • "usw" — for PST / MST Timezone
  • "eu1" — for GMT / CET Timezone
  • "eu2" — for EU Secure Timezone
Required?Yes

email

Propertyemail
NameBrightpearl API User Email
Data typestring
Required?Yes

password

Propertypassword
NameBrightpearl API User Password
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for Brightpearl stores.

inventory_update_price_list

Propertyinventory_update_price_list
NameInventory Update Price List
Data typestring

warehouse_name

Propertywarehouse_name
NameWarehouse Name
DescriptionLimit to a specific warehouse
Data typestring

Example

Example: create a new Brightpearl store
curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your Brightpearl Store",
  "platform": "brightpearl",
  "adapter": {
    "account_id": "abc123",
    "datacenter_code": "usw",
    "email": "abc123",
    "password": "abc123",
    "inventory_update_price_list": "abc123",
    "warehouse_name": "abc123"
  }
}
EOF

For details about this request type, see: Create a new store.