Skip to content

Store adapter — Adobe Business Catalyst

The adapter object contains properties for connecting to the Adobe Business Catalyst API.

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

Required properties

The following adapter properties are required for Adobe Business Catalyst stores.

password

Propertypassword
NameAPI User Password
Data typestring
Required?Yes

secure_domain

Propertysecure_domain
NameAPI Secure Domain
Data typestring
RequirementsMust be valid URL
Required?Yes

site_id

Propertysite_id
NameUnique Site ID
Data typestring
Required?Yes

username

Propertyusername
NameAPI User Email Address
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for Adobe Business Catalyst stores.

tracking_crm_field_name

Propertytracking_crm_field_name
NameTracking Number Field Name
DescriptionCustom field used for the shipment tracking number
Data typestring

Example

Example: create a new Adobe Business Catalyst 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 Business Catalyst Store",
  "platform": "business_catalyst",
  "adapter": {
    "secure_domain": "https://www.example.com",
    "site_id": "abc123",
    "username": "abc123",
    "password": "abc123",
    "tracking_crm_field_name": "abc123"
  }
}
EOF

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