GraphQL-Api

Das Modul bietet eine GraphQL-Schnittstelle, um Konfigurationsdaten für das Modul zu ermitteln und z.B. für PWA-Magento-Shops auszugeben. Des Weiteren bietet es noch einen Api-Funktion um dediziert zu Prüfen, ob ein Land für die Lieferung freigegeben ist.

Modulkonfiguration

Mit folgendem Request kann die Modulkonfiguration store-spezifisch abgefragt werden:

Request:

https://www.domain.tld/graphql

Query:

query {
    getShippableCountryConfigComplete (
        storeCode: "default"
    ) {
        generalRestrictedCountries
        validationErrorMessage
        enabledInCustomerSection
        showRegions
        regionRequiredCountries
        defaultStoreCountry
        zipCodeOptionalCountries
        restrictedCountries
        moduleEnabled
        customerShareOption
        forceRatesValidation
        shippableCountries {
            value
            label
            is_region_visible
            is_region_required
            is_zipcode_optional
        }
    }
}

Response:

{
    "data": {
        "getShippableCountryConfigComplete": {
            "generalRestrictedCountries": [],
            "validationErrorMessage": "The selected shipping address is not allowed for this country mandate. Please choose a different address or change to the corresponding delivery country.",
            "enabledInCustomerSection": false,
            "showRegions": true,
            "regionRequiredCountries": [
                "AL",
                "AR",
                "AU",
                "BG",
                "BO",
                "BR",
                "BY",
                "CA",
                "CH",
                "CL",
                "CN",
                "CO",
                "DK",
                "EC",
                "EE",
                "ES",
                "GR",
                "GY",
                "HR",
                "IN",
                "IS",
                "IT",
                "LT",
                "LV",
                "MX",
                "PE",
                "PL",
                "PT",
                "PY",
                "RO",
                "SE",
                "SR",
                "US",
                "UY",
                "VE"
            ],
            "defaultStoreCountry": "US",
            "zipCodeOptionalCountries": [
                "HK",
                "IE",
                "MO",
                "PA",
                "GB"
            ],
            "restrictedCountries": [],
            "moduleEnabled": false,
            "customerShareOption": "per website",
            "forceRatesValidation": false,
            "shippableCountries": []
        }
    }
}

Länderfreigabe für Lieferungen

Mit folgendem Request kann die Länderfreigabe für die Lieferung anhand des Ländercodes abgefragt werden: