Store adapter — TradeGecko¶
The adapter
object contains properties for connecting to the TradeGecko API.
Parent object: a store with property "platform" : "trade_gecko"
Required properties¶
The following adapter
properties are required for TradeGecko stores.
privileged_access_token
¶
Property | privileged_access_token |
---|---|
Name | TradeGecko Privileged Access Token |
Data type | string |
Required? | Yes |
Optional properties¶
The following adapter
properties are optional for TradeGecko stores.
location_name
¶
Property | location_name |
---|---|
Name | Inventory Location Name |
Description | Track inventory to the specified location |
Data type | string |
Default | "location_1" |
stock_location_ids
¶
Property | stock_location_ids |
---|---|
Name | Import Stock Locations |
Description | Import orders only from the specified Stock Locations |
Data type | array of strings |
Example | [ "location_1", "location_2" ] |
Example¶
Example: create a new TradeGecko 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 TradeGecko Store",
"platform": "trade_gecko",
"adapter": {
"privileged_access_token": "abc123",
"location_name": "abc123",
"stock_location_ids": [ "location_1", "location_2" ]
}
}
EOF
For details about this request type, see: Create a new store.