Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
Country
Overview
Represents a geographical country and its location.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
country_id |
public |
none | int |
The country's numeric ID. |
iso_country_code |
public |
none | string |
The two-letter country code according to ISO 3166-1-alpha-2.
|
world_bank_country_code |
public |
none | string |
The three-letter country code according to the World Bank. |
name |
public |
none | string |
The country's plain-English name. |
slug |
public |
none | string |
The country's plain-English name slugified; suitable for interpolation into a url. |
lat |
public |
none | float |
The country's latitude. |
lon |
public |
none | float |
The country's longitude. |
Associations
This resource has no associations.
Methods
findAllCountry
Method Name | findAllCountry |
---|---|
Synopsis | Finds all Country. |
HTTP Method | GET |
URI | /countries |
Parameters | none |
Requires OAuth | N |
Permission Scope | none |
getCountry
Method Name | getCountry |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a Country by id. | ||||||||
HTTP Method | GET |
||||||||
URI | /countries/:country_id |
||||||||
Parameters |
|
||||||||
Requires OAuth | N |
||||||||
Permission Scope | none |
findByIsoCode
Method Name | findByIsoCode |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get the country info for the given ISO code. | ||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||
URI | /countries/iso/:iso_code |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||
Permission Scope | none |