Store adapter — Spree Commerce¶
The adapter
object contains properties for connecting to the Spree Commerce API.
Parent object: a store with property "platform" : "spreecommerce"
Required properties¶
The following adapter
properties are required for Spree Commerce stores.
token
¶
Property | token |
---|---|
Name | Spree Commerce API Token |
Data type | string |
Required? | Yes |
url
¶
Property | url |
---|---|
Name | Spree Commerce Store URL |
Data type | string |
Requirements | must be valid |
Required? | Yes |
Optional properties¶
The following adapter
properties are optional for Spree Commerce stores.
stock_location_id
¶
Property | stock_location_id |
---|---|
Name | Stock Location ID |
Data type | string |
Example¶
Example: create a new Spree Commerce 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 Spree Commerce Store",
"platform": "spreecommerce",
"adapter": {
"url": "https://www.example.com",
"token": "abc123",
"stock_location_id": "abc123"
}
}
EOF
For details about this request type, see: Create a new store.