Stationäre Händler online
Stadt-Lieferung am selben Tag
Deutschlandweite Lieferung

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:

TypeFieldDeprecation Reason
EventlatitudeReplaced by new field #lat
EventlongitudeReplaced by new field #lng
GrecoweightThis value is deprecated in favor of 'packages.weight'
ProductageRestrictionUse _age_restriction instead, which returns the age as an Integer instead of a String.
TaxonidentifierWill be removed in favor of field `slug`.
UserbillAddressThis field always retuns null and thus will be removed in the future. Use the field billAddress on orders instead.
UsershipAddressThis field always retuns null and thus will be removed in the future. Use the field shipAddress on orders instead.
VendorownerThis field always retuns null and thus will be removed in the future. Use the field representative instead.
VendorpermalinkWill 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:

  • id
  • type
  • payload

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

AttributeTypeDescriptionMandatory
idStringID of productYes

ProductCashbackUpdated

AttributeTypeDescriptionMandatory
idStringID of productYes

ProductUpdated

AttributeTypeDescriptionMandatory
idStringID of product (currently only sent if product has cashback)Yes

ShipmentConfirmed

AttributeTypeDescriptionMandatory
idStringID of shipmentYes

ShipmentRefundCreated

AttributeTypeDescriptionMandatory
idStringID of refundYes

UserAnonymized

AttributeTypeDescriptionMandatory
idStringID of userYes

UserCreated

AttributeTypeDescriptionMandatory
idStringID of userYes

UserDestroyed

AttributeTypeDescriptionMandatory
idStringID of userYes

UserUpdated

AttributeTypeDescriptionMandatory
idStringID of userYes

VariantWithPriceCrossedCreated

AttributeTypeDescriptionMandatory
idStringID of variantYes
productIdStringID of variant's productYes

VariantWithPriceCrossedUpdated

AttributeTypeDescriptionMandatory
idStringID of variantYes
productIdStringID of variant's productYes

VendorCashbackCreated

AttributeTypeDescriptionMandatory
idStringID of vendorYes

VendorCashbackUpdated

AttributeTypeDescriptionMandatory
idStringID of vendorYes

VendorCategoryCreated

AttributeTypeDescriptionMandatory
idStringID of vendor categoryYes

VendorCategoryDestroyed

AttributeTypeDescriptionMandatory
idStringID of vendor categoryYes

VendorCategoryUpdated

AttributeTypeDescriptionMandatory
idStringID of vendor categoryYes

VendorCreated

AttributeTypeDescriptionMandatory
idStringID of vendorYes

VendorDestroyed

AttributeTypeDescriptionMandatory
idStringID of vendorYes

VendorUpdated

AttributeTypeDescriptionMandatory
idStringID of vendorYes