Skip to content

Store adapter — Brandboom

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

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

Required properties

The following adapter properties are required for Brandboom stores.

private_key

Propertyprivate_key
NameAPI Private Key
Data typestring
Required?Yes

public_key

Propertypublic_key
NameAPI Public Key
Data typestring
Required?Yes

showroom_id

Propertyshowroom_id
NameShowroom ID
DescriptionID of Showroom for inventory updates
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for Brandboom stores.

vanity

Propertyvanity
NameShowroom Vanity
DescriptionLimit orders only to the specified Showroom Vanity
Data typestring

Example

Example: create a new Brandboom 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 Brandboom Store",
  "platform": "brand_boom",
  "adapter": {
    "private_key": "abc123",
    "public_key": "abc123",
    "showroom_id": "abc123",
    "vanity": "abc123"
  }
}
EOF

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