API Documentation >> API 2.0 Main >> Entities >> Article

Article Entity

{
    article: {
        idArticle:                          // Article ID
        idProduct:                          // Product ID
        language: {                         // Language entity
            idLanguage:                     // Language ID
            languageName:                   // Language's name in English
        }
        comments:                           // Comments
        price:                              // Price of the article (uses buyer/seller price if applicable, otherwise in EUR)
        idCurrency:                         // Currency ID
        currencyCode:                       // ISO 4217 Currency Code
        prices: [                           // Prices in all supported currencies; only applicable if viewer is neither buyer nor seller
            {
                price:
                idCurrency:
                currencyCode:
            }
        ]
        count:                              // Count (see notes)
        inShoppingCart:                     // Flag, if that article is currently in a shopping cart
        product: {                          // Short Product entity
            enName:                         // English name
            locName:                        // Localized name (according to the language of the article)
            image:                          // deprecated; always empty string; is available on the standalone Product entity 
            idExpansion:                    // Expansion ID
            expansion:                      // expansion name in English, if applicable
            abbreviation:                   // expansion abbreviation
            nr:                             // Number of single within the expansion, if applicable
            expIcon:                        // index to the expansion's icon, if applicable
            rarity:                         // product's rarity if applicable
        }
        seller: {}                          // Seller's user entity
        lastEdited:                         // Date, the article was last updated
        onSale:                             // If the article is on sale, only applicable if viewer is the seller
        condition:                          // Product's condition, if applicable
        isFoil:                             // Foil flag, if applicable
        isReverseHolo:                      // Reverse Holo flag, of applicable
        isSigned:                           // Signed flag, if applicable
        isAltered:                          // Altered flag, if applicable
        isPlayset (DEPRECATED):             // Playset flag, if applicable - As of 11.11.2024 we no longer support playsets, isPlayset will appear on articles before this date for archival reasons.
        isFirstEd:                          // First edition flag, if applicable
        links: {}                           // HATEOAS links
    }
}

For the details of the seller's entity, see User entity.

The short product entity is only returned for widget and 3rd party apps.

The count key represents has different semantics depending on the request the entity was the response to:

• the amount of available articles, taking into account:
  • same seller
  • same price
  • same condition, if applicable
  • same additional properties (isFoil, isSigned, isAltered, isFirstEd)
• the amount of that article in the shopping cart (as part of a reservation)
• the amount of that articel in an order

The lastEdited key is only returned for Stock Management requests.

The condition key is only returned for single cards.

The following additional properties are only returned for specific games:

• isFoil for Magic, Pokémon (deprecated) singles
• isSigned for Magic, Yu-Gi-Oh!, Pokémon singles
• isPlayset for Magic, Pokémon singles - (DEPRECATED) As of 11.11.2024 we no longer support playsets, isPlayset will appear on articles before this date for archival reasons.
• isAltered for Magic, Pokémon, Yu-Gi-Oh! singles
• isFirstEd for Yu-Gi-Oh!, Pokémon singles
• isReverseHolo for Pokémon singles

For the links, see HATEOAS Links

Example Entities

{
    article: [
        {
            idArticle: 142158699
            idProduct: 266361
            language: {
                idLanguage: 1
                languageName: "English"
            }
            comments: ""
            price: 0.02
            idCurrency: 1,
            currencyCode: "EUR",
            count: 3
            inShoppingCart: false
            seller: {
                idUser: 9999
                username: "Maxi"
                registrationDate: "2011-04-04T21:23:24+0200"
                isCommercial: 0
                isSeller: true
                name: {
                    firstName: Max
                }
                address: {
                    country: "D"
                }
                phone: ""
                email: ""
                vat: ""
                riskGroup: 0
                reputation: 1
                shipsFast: 1
                sellCount: 254
                soldItems: 3321
                avgShippingTime: 5
                onVacation: false
            }
            condition: "NM"
            isFoil: false
            isSigned: false
            isAltered: false
            links: {}
        }
    ]
    
}