Skip to content

Store adapter — Magento

The adapter object contains properties for connecting to the Magento API.

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

Required properties

The following adapter properties are required for Magento stores.

api_key

Propertyapi_key
NameMagento API Key
Data typestring
Required?Yes

store_url

Propertystore_url
NameMagento Store URL
Data typestring
Requirementsmust be valid
Example"http://mystore.com"
Required?Yes

user_name

Propertyuser_name
NameMagento Web Service User Name
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for Magento stores.

store_view_code

Propertystore_view_code
NameStore View Code
DescriptionFor multi-store installations. Only orders from the given store will be imported
Data typestring

Example

Example: create a new Magento 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 Magento Store",
  "platform": "magento",
  "adapter": {
    "api_key": "abc123",
    "store_url": "http://example.com",
    "user_name": "abc123",
    "store_view_code": "abc123"
  }
}
EOF

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