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
ShopSection
Overview
A section within a user's shop.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
shop_section_id |
public |
none | int |
The numeric ID of the shop section. |
title |
public |
none | string |
The title of the section. |
rank |
public |
none | int |
Display order. |
user_id |
public |
none | int |
The ID of the user who owns this shop section. |
active_listing_count |
public |
none | int |
The number of active listings currently in the section. |
Associations
Association | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
Shop |
public |
none |
|
The shop to which this section belongs. |
Listings |
public |
none |
|
An array of listings in this section. |
Translations |
public |
none |
|
An array of translations for this ShopSection. |
Methods
findAllShopSections
Method Name | findAllShopSections |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a set of ShopSection objects associated to a Shop. | ||||||||
HTTP Method | GET |
||||||||
URI | /shops/:shop_id/sections |
||||||||
Parameters |
|
||||||||
Requires OAuth | N |
||||||||
Permission Scope | none |
createShopSection
Method Name | createShopSection |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Creates a new ShopSection. | ||||||||||||||||
HTTP Method | POST |
||||||||||||||||
URI | /shops/:shop_id/sections |
||||||||||||||||
Parameters |
|
||||||||||||||||
Requires OAuth | Y |
||||||||||||||||
Permission Scope |
|
getShopSection
Method Name | getShopSection |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a ShopSection by id and shop_id | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /shops/:shop_id/sections/:shop_section_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | N |
||||||||||||
Permission Scope | none |
updateShopSection
Method Name | updateShopSection |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Updates a ShopSection with the given id. | ||||||||||||||||||||
HTTP Method | PUT |
||||||||||||||||||||
URI | /shops/:shop_id/sections/:shop_section_id |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||
Permission Scope |
|
deleteShopSection
Method Name | deleteShopSection |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Deletes the ShopSection with the given id. | ||||||||||||
HTTP Method | DELETE |
||||||||||||
URI | /shops/:shop_id/sections/:shop_section_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|