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.
API Documentation
- 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
Region
Overview 
Represents a collection of countries to which an item ships.
Fields
| Field | Visibility Level | Permission Scope | Type | Description |
|---|---|---|---|---|
region_id |
public |
none | int |
The numeric ID of this region. |
region_name |
public |
none | string |
The name of the region. |
is_dead |
public |
none | boolean |
The eligibilty of this region to be used |
Associations
This resource has no associations.
Methods
findAllRegion
| Method Name | findAllRegion |
|---|---|
| Synopsis | Finds all Region. |
| HTTP Method | GET |
| URI | /regions |
| Parameters | none |
| Requires OAuth | N |
| Permission Scope | none |
getRegion
| Method Name | getRegion |
||||||||
|---|---|---|---|---|---|---|---|---|---|
| Synopsis | Retrieves a Region by id. | ||||||||
| HTTP Method | GET |
||||||||
| URI | /regions/:region_id |
||||||||
| Parameters |
|
||||||||
| Requires OAuth | N |
||||||||
| Permission Scope | none |
findEligibleRegions
| Method Name | findEligibleRegions |
|---|---|
| Synopsis | |
| HTTP Method | GET |
| URI | /regions/eligible |
| Parameters | none |
| Requires OAuth | N |
| Permission Scope | none |