Store API — client.sell.stores¶
Version 1 · base path /sell/stores/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_store_categories ¶
get_store_categories(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_stores_models.GetStoreCategoriesResponseType
get_store_categories(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_store_categories(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_stores_models.GetStoreCategoriesResponseType | httpx.Response
This method is used to retrieve the category hierarchy for an eBay user's store. Note: Three levels of store categories are supported.
add_store_category ¶
add_store_category(*, body: AddStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
add_store_category(*, body: AddStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
add_store_category(*, body: AddStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method is used to add a single new custom category to a user's eBay store through an asynchronous request. A successful call returns the getStoreTask URI in the Location response header. Call getStoreTask (or getStoreTasks ) method to retrieve the status of the add category operation. Note: Three levels of store categories are supported.
rename_store_category ¶
rename_store_category(category_id: str, *, body: RenameStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
rename_store_category(category_id: str, *, body: RenameStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
rename_store_category(category_id: str, *, body: RenameStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method is used to rename the single category of a user's eBay store through a synchronous request.
delete_store_category ¶
delete_store_category(category_id: str, *, body: DeleteStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_store_category(category_id: str, *, body: DeleteStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_store_category(category_id: str, *, body: DeleteStoreCategoryRequestType | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method is used to delete one custom category of a user's eBay store through an asynchronous request. A successful call returns the getStoreTask URI in the Location response header. Call getStoreTask (or getStoreTasks ) method to retrieve the status of the delete category operation.
get_store ¶
get_store(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_stores_models.GetStoreResponseType
get_store(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_store(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_stores_models.GetStoreResponseType | httpx.Response
This method is used to retrieve information for an eBay user's store such as store name, store URL, and description.
get_store_task ¶
get_store_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_stores_models.GetStoreTaskResponseType
get_store_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_store_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_stores_models.GetStoreTaskResponseType | httpx.Response
This method retrieves the current status of a recent store operation. The unique identifier of the task is passed in as a path parameter.
get_store_tasks ¶
get_store_tasks(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_stores_models.GetStoreTasksResponseType
get_store_tasks(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_store_tasks(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_stores_models.GetStoreTasksResponseType | httpx.Response
This method retrieves the status of all async store tasks for a store. Every task is set as FAILED or COMPLETED once it's execution time reaches 24 hours.
move_store_category ¶
move_store_category(*, body: MoveStoreCategoryRequestType, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
move_store_category(*, body: MoveStoreCategoryRequestType, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
move_store_category(*, body: MoveStoreCategoryRequestType, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method is used to move an existing user's eBay store custom category through an asynchronous request. A successful call returns the getStoreTask URI in the Location response header. The user calls getStoreTask to retrieve the status of the move category operation.
Models¶
AddStoreCategoryRequestType ¶
Bases: EbayModel
category_name
class-attribute
instance-attribute
¶
category_name = Field(None, alias='categoryName', description='The seller-specified name of the custom category. Max Length: 35')
destination_parent_category_id
class-attribute
instance-attribute
¶
destination_parent_category_id = Field(None, alias='destinationParentCategoryId', description="This field is used to specify the parent category to which the new category belongs. To specify the new category as a top-level category, set the value of this field to -999, or just omit this field, as the default value is -999. The getStoreCategories method can be used to retrieve store category IDs. Default: ROOT category ID (-999) if it's null.")
listing_destination_category_id
class-attribute
instance-attribute
¶
listing_destination_category_id = Field(None, alias='listingDestinationCategoryId', description='If the store category specified as the destinationParentCategoryId is a leaf category with active listings, those listings are moved to the store category identified through this listingDestinationCategoryId . If this field is omitted, the new store category being added under the parent category inherits those listings. The getStoreCategories method can be used to retrieve store category IDs.')
DeleteStoreCategoryRequestType ¶
Bases: EbayModel
listing_destination_category_id
class-attribute
instance-attribute
¶
listing_destination_category_id = Field(None, alias='listingDestinationCategoryId', description="This field is only needed if the category to be deleted or any of its children categories have one or more active listings. The operation will fail otherwise. All active listings in or under the category to be deleted will be moved to the store category specified in this field. The getStoreCategories method can be used to retrieve store category IDs. Default: OTHER category ID (1) if it's null.")
ErrorParameter ¶
MoveStoreCategoryRequestType ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description="The unique identifier of an eBay Store's custom category. eBay auto-generates this identifier when a seller establishes a custom store category. This category ID should not be confused with an eBay category ID. This is the category that is moved.")
destination_parent_category_id
class-attribute
instance-attribute
¶
destination_parent_category_id = Field(None, alias='destinationParentCategoryId', description='The new parent category of the category to be moved is specified in this field. If the category is being moved to level 1 category, set this value to -999 .')
listing_destination_category_id
class-attribute
instance-attribute
¶
listing_destination_category_id = Field(None, alias='listingDestinationCategoryId', description='This field is only needed if the category to be moved is a leaf category with listings, but a category that becomes a non-leaf category after the move. The listings of the category to be moved are moved to the category specified in this field.')
RenameStoreCategoryRequestType ¶
Bases: EbayModel
category_name
class-attribute
instance-attribute
¶
category_name = Field(None, alias='categoryName', description='The seller-specified name of the custom category. This is the new name of the category specified through path parameter. Max Length: 35')
StoreCategoryType ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description="Unique identifier of an eBay Store's custom category. eBay auto-generates this identifier when a seller establishes a custom store category. This category ID should not be confused with an eBay category ID.")
category_name
class-attribute
instance-attribute
¶
category_name = Field(None, alias='categoryName', description='The seller-specified name of the custom category.')
children_categories
class-attribute
instance-attribute
¶
children_categories = Field(None, alias='childrenCategories', description='This array is returned to show second and third-level store categories. eBay Stores support up to three category levels.')
level
class-attribute
instance-attribute
¶
level = Field(None, description='The level indicates the category level of the category tree. Note: Three levels of store categories are supported. All categories belonging to the same parent should have the same level.')
order
class-attribute
instance-attribute
¶
order = Field(None, description='The order in which the custom store category appears in the list of store categories when the eBay store is visited.')
StoreLogoType ¶
Bases: EbayModel
url
class-attribute
instance-attribute
¶
url = Field(None, description="The URL of the seller's store logo.")
StoreTaskStatusEnum ¶
StoreTaskTypeEnum ¶
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
GetStoreCategoriesResponseType ¶
Bases: EbayModel
store_categories
class-attribute
instance-attribute
¶
store_categories = Field(None, alias='storeCategories', description='An array of top-level categories defined for the eBay store. A childrenCategories array is used for second and third-level categories, if defined for the store.')
GetStoreResponseType ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The seller-provided description of the eBay Store. Max length: 300')
last_opened_time
class-attribute
instance-attribute
¶
last_opened_time = Field(None, alias='lastOpenedTime', description='Indicates the time the store was last opened or reopened.')
logo
class-attribute
instance-attribute
¶
logo = Field(None, description='This container provides information about a Store logo.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the eBay Store. The name is shown at the top of the Store page. Max length: 35')
url
class-attribute
instance-attribute
¶
url = Field(None, description="The complete URL of the user's store.")
url_path
class-attribute
instance-attribute
¶
url_path = Field(None, alias='urlPath', description='The relative URL path of the Store. Max length: 58')
StoreTaskType ¶
Bases: EbayModel
id
class-attribute
instance-attribute
¶
id = Field(None, description='The unique identifier of an eBay Store task.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='This field provides a textual description on the status of the task, and could help user troubleshoot any issues if there is an issue with eBay creating the task.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The enumeration value here indicates the processing status of the task. See the StoreTaskStatusEnum type for more information on supported status values.')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The enumeration value indicates the task type.')