Store adapter — BrightStores¶

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

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

Required properties¶

The following adapter properties are required for BrightStores stores.

`api_token`¶

Property	`api_token`
Name	BrightStores API Token
Data type	string
Required?	Yes

`subdomain`¶

Property	`subdomain`
Name	BrightStores Subdomain
Data type	string
Example	If the site domain is `"https://mysite.mybrightsites.com"`, the subdomain is `"mysite"`
Required?	Yes

Optional properties¶

The following adapter properties are optional for BrightStores stores.

`order_import_status`¶

Property	`order_import_status`
Name	Order Import Status
Data type	string
Default	`"paid"`

Example¶

Example: create a new BrightStores store

cURL

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 BrightStores Store",
  "platform": "brightsites",
  "adapter": {
    "subdomain": "abc123",
    "api_token": "abc123",
    "order_import_status": "paid"
  }
}
EOF

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