Store adapter — Volusion¶
The adapter object contains properties for connecting to the Volusion API.
Parent object: a store with property "platform" : "volusion"
Required properties¶
The following adapter properties are required for Volusion stores.
password¶
| Property | password |
|---|---|
| Name | Integration Password |
| Data type | string |
| Required? | Yes |
store_url¶
| Property | store_url |
|---|---|
| Name | Volusion Store URL |
| Data type | string |
| Requirements | must be valid |
| Example | "http://www.example.com" |
| Required? | Yes |
username¶
| Property | username |
|---|---|
| Name | Integration Username/Email |
| Data type | string |
| Required? | Yes |
Optional properties¶
The following adapter properties are optional for Volusion stores.
exclude_customer_email¶
| Property | exclude_customer_email |
|---|---|
| Name | Exclude Customer Email |
| Description | Exclude customer email from order information |
| Data type | boolean |
| Default | false |
status_value¶
| Property | status_value |
|---|---|
| Name | Order Status |
| Description | Import orders only with this status |
| Data type | string |
| Accepted values |
|
Example¶
Example: create a new Volusion 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 Volusion Store",
"platform": "volusion",
"adapter": {
"store_url": "http://example.com",
"username": "abc123",
"password": "abc123",
"exclude_customer_email": false,
"status_value": "Processing"
}
}
EOF
For details about this request type, see: Create a new store.
