Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference
  2. Directory

Countries

PreviousDirectoryNextCurrency

directory Country Information Acquirer V1Get Countries Info Get

get

Get all countries and regions information for the store.

Responses
200
OK
application/json
Responseobject
500
Internal Server Error
application/json
get
GET /V1/directory/countries HTTP/1.1
Host: {{baseurl}}
Accept: */*
[
  {
    "id": "voluptate fugi",
    "two_letter_abbreviation": "aute",
    "three_letter_abbreviation": "exercitation do",
    "full_name_locale": "ex ",
    "full_name_english": "proident velit nostrud aute",
    "available_regions": [
      {
        "id": "in in non qui ipsum",
        "code": "voluptate ",
        "name": "ut",
        "extension_attributes": {}
      },
      {
        "id": "sed in dolor do ",
        "code": "labore velit",
        "name": "commodo",
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {}
  },
  {
    "id": "incididunt officia in eu",
    "two_letter_abbreviation": "qui ipsum esse est nulla",
    "three_letter_abbreviation": "nulla",
    "full_name_locale": "fugiat enim mollit laboris",
    "full_name_english": "consequat non",
    "available_regions": [
      {
        "id": "reprehenderit tempor",
        "code": "laboris",
        "name": "esse cillum in et labore",
        "extension_attributes": {}
      },
      {
        "id": "n",
        "code": "anim sit fugiat minim",
        "name": "nisi consequat id",
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {}
  }
]

directory Country Information Acquirer V1Get Country Info Get

get

Get country and region information for the store.

Path parameters
countryIdstringRequired

(Required)

Example: <string>
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
500
Internal Server Error
application/json
get
GET /V1/directory/countries/{countryId} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "id": "sit esse par",
  "two_letter_abbreviation": "magna irure in officia",
  "three_letter_abbreviation": "officia aliquip do",
  "full_name_locale": "et commodo",
  "full_name_english": "minim Excepteur",
  "available_regions": [
    {
      "id": "Duis",
      "code": "cillum in aliquip",
      "name": "aliqua ullamco",
      "extension_attributes": {}
    },
    {
      "id": "culpa deserunt irure",
      "code": "ex Duis dol",
      "name": "ipsum quis pariatur",
      "extension_attributes": {}
    }
  ],
  "extension_attributes": {}
}
  • GETdirectory Country Information Acquirer V1Get Countries Info Get
  • GETdirectory Country Information Acquirer V1Get Country Info Get