Info > Info
Commerce APIInfoInfo

Info

Info APIs supply relatively static information that can prove invaluable when building your store. This API encompasses a wide range of data such as countries, currencies, languages, CSV formats, shipping providers, time zones, permissions, and more.

The key advantage of these APIs is their availability without any authorization requirement. This easy access lets you gather necessary information swiftly, aiding in setting up various elements of your store.

Here's what you can do with some of the data:

  • Countries: Helps in setting up shipping and billing addresses.
  • Currencies: Assists in setting up the right currency for different regions of your store.
  • Languages: Allows you to customize your store's language based on user preferences or region.
  • CSV formats: Enables easy data import/export in universally recognized formats.
  • Shipping providers: Helps integrate your store with various shipping providers.
  • Time zones: Assists in displaying time and dates in the correct regional format.
  • Permissions: Useful in setting up roles and defining their capabilities.

The Info APIs equip you with the fundamental building blocks to create a more versatile and user-friendly store environment. They provide the basic details needed for efficient operation and management of your online store.

Endpoints

EndpointDescriptionJSON API
countriesGet all countriesGET:countries.json
infoAllProvincesGet all provinces of all countriesGET:info/all_provinces.json
infoCarrierPackagingGet a list of all carrier packagingGET:info/carrier_packaging.json
infoContentModelsGet built-in content modelsGET:info/content_models.json
infoCountriesGet all countriesGET:info/countries.json
infoCsvFormatGet CSV format infoGET:info/csv_format.json
infoCurrenciesGet all currenciesGET:info/currencies.json
infoCustomItemCreateImitate custom item creationPOST:info/custom_item.json
infoDataFeedsGet info about data feedsGET:info/data_feeds.json
infoHsCodesGet HS code infoGET:info/hs_codes.json
infoLanguagesGet all languagesGET:info/languages.json
infoMccCodesGet a list of all MCC codesGET:info/mcc_codes.json
infoPermissionsGet a list of all permissionsGET:info/permissions.json
infoPlansGet all plansGET:info/plans.json
infoProvincesGet all provincesGET:info/provinces.json
infoRolesGet built-in rolesGET:info/roles.json
infoShippingProvidersGet all shipping providersGET:info/shipping_providers.json
infoTimezonesGet all timezonesGET:info/timezones.json
infoVersionGet backend API versionGET:info/version.json
infoWebhooksGet a list of all webhook event typesGET:info/webhooks.json
provincesGet all provincesGET:provinces.json
taxClassesGet tax classesGET:tax_classes.json

Types

Types
ContentModel
InfoCSVFormat
InfoCarrierPackaging
InfoCountry
InfoCurrency
InfoDataFeeds
InfoHSCode
InfoLanguage
InfoMccCode
InfoPermission
InfoProvince
InfoRole
InfoShippingProvider
InfoTimezone
InfoVersion
InfoWebhook
OrderCustomItem
OrderCustomItemCreate
Plan