Store adapter — TrueCommerce¶
The adapter
object contains properties for connecting to the TrueCommerce API.
Parent object: a store with property "platform" : "true_commerce"
Required properties¶
The following adapter
properties are required for TrueCommerce stores.
connection_string
¶
Property | connection_string |
---|---|
Name | FTP Connection String |
Data type | string |
Example | "ftp://user:pass@host:port" |
Required? | Yes |
Optional properties¶
The following adapter
properties are optional for TrueCommerce stores.
receiver_id
¶
Property | receiver_id |
---|---|
Name | Receiver ID |
Data type | string |
Example¶
Example: create a new TrueCommerce 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 TrueCommerce Store",
"platform": "true_commerce",
"adapter": {
"connection_string": "ftp://user@pass@host:21",
"receiver_id": "abc123"
}
}
EOF
For details about this request type, see: Create a new store.