GraphQL
Utilizing this API, a variety of data, such as data on products, vendors, and
shipments, can be retrieved. GraphQL is used as the query language; thus giving
clients the possibility to request exactly what they need and nothing else. As a
bonus, the API can be explored using the interactive GraphQL Playground, which also
contains a comprehensive and always up-to-date documentation.
Credentials
To get access to the GraphQL API, please request your credentials at info@atalanda.com.
Deprecations
These fields are deprecated and will be removed in the foreseeable future:
Type | Field | Deprecation Reason |
---|
Event | latitude | Replaced by new field #lat |
Event | longitude | Replaced by new field #lng |
Greco | weight | This value is deprecated in favor of 'packages.weight' |
Product | ageRestriction | Use _age_restriction instead, which returns the age as an Integer instead of a String. |
Taxon | identifier | Will be removed in favor of field `slug`. |
User | billAddress | This field always retuns null and thus will be removed in the future. Use the field billAddress on orders instead. |
User | shipAddress | This field always retuns null and thus will be removed in the future. Use the field shipAddress on orders instead. |
Vendor | owner | This field always retuns null and thus will be removed in the future. Use the field representative instead. |
Vendor | permalink | Will be removed in favor of field `slug`. |
Playground
The GraphQL API can be tested in the atalanda GraphQL Playground. For authorization, you have to click on HTTP HEADERS in the lower left corner and insert the following line, using the token that you've
received as part of your credentials:
{ "Authorization": "Bearer insert_your_token" }
In the playground, the documentation can be found on the right-hand side.

Example Queries
Retrieve Product Details
Query
query {
products(first: 3) {
nodes {
id
name {
de
}
permalink
}
}
}
Example Result
{
"data": {
"products": {
"nodes": [
{
"id": "gwpLrWzBU3",
"name": {
"de": "Halskette aus Glasperlen "
},
"permalink": "halskette-aus-glasperlen-1"
},
{
"id": "Dngjv2Yeh2",
"name": {
"de": "Armband aus Holz"
},
"permalink": "armband-aus-holz"
}
]
}
}
}
Event System
To subscribe to our event system, please email us at info@atalanda.com.
Structure
All events have the following structure:
{
"Type" : "Notification",
"MessageId" : "XXX",
"TopicArn" : "arn:aws:sns:eu-central-1:XXX:events",
"Message" : "{\"id\":\"XXX\",\"type\":\"XXX\",\"payload\":{...}}",
"Timestamp" : "2019-01-01T00:00:00.000Z",
"SignatureVersion" : "1",
"Signature" : "XXX",
"SigningCertURL" : "https://sns.eu-central-1.amazonaws.com/xxx",
"UnsubscribeURL" : "https://sns.eu-central-1.amazonaws.com/xxx"
}
The "Message" attribute always contains the following attributes:
Message
id
Hash ID of the event
type
Type of event. Possible values are:
- ProductCashbackCreated
- ProductCashbackUpdated
- ProductUpdated
- ShipmentConfirmed
- ShipmentRefundCreated
- UserAnonymized
- UserCreated
- UserDestroyed
- UserUpdated
- VariantWithPriceCrossedCreated
- VariantWithPriceCrossedUpdated
- VendorCashbackCreated
- VendorCashbackUpdated
- VendorCategoryCreated
- VendorCategoryDestroyed
- VendorCategoryUpdated
- VendorCreated
- VendorDestroyed
- VendorUpdated
payload
Contains further information and references to the object that triggered the event.
The structure of this attribute depends on the type.
The following is a list of structures per type:
ProductCashbackCreated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of product | Yes |
ProductCashbackUpdated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of product | Yes |
ProductUpdated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of product (currently only sent if product has cashback) | Yes |
ShipmentConfirmed
Attribute | Type | Description | Mandatory |
---|
id | String | ID of shipment | Yes |
ShipmentRefundCreated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of refund | Yes |
UserAnonymized
Attribute | Type | Description | Mandatory |
---|
id | String | ID of user | Yes |
UserCreated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of user | Yes |
UserDestroyed
Attribute | Type | Description | Mandatory |
---|
id | String | ID of user | Yes |
UserUpdated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of user | Yes |
VariantWithPriceCrossedCreated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of variant | Yes |
productId | String | ID of variant's product | Yes |
VariantWithPriceCrossedUpdated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of variant | Yes |
productId | String | ID of variant's product | Yes |
VendorCashbackCreated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor | Yes |
VendorCashbackUpdated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor | Yes |
VendorCategoryCreated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor category | Yes |
VendorCategoryDestroyed
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor category | Yes |
VendorCategoryUpdated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor category | Yes |
VendorCreated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor | Yes |
VendorDestroyed
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor | Yes |
VendorUpdated
Attribute | Type | Description | Mandatory |
---|
id | String | ID of vendor | Yes |