Sellers

class ab.api.endpoints.sellers.SellersEndpoint(client)[source]

Operations on sellers (Catalog API).

Parameters:: client (HttpClient)

create(*, data)[source]

POST /Seller.

Parameters:: data (AddSellerRequest | dict) – Seller creation payload with name and display_id. Accepts an AddSellerRequest instance or a dict.
Return type:: SellerDto

Request model: AddSellerRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/sellers/create.html Request model: AddSellerRequest Response model: SellerDto

list(*, id=None, name=None, customer_display_id=None, is_active=None, page_size=25, page_number=1)[source]

List sellers with optional filters.

Parameters:

id (int | None) – Filter by seller ID.
name (str | None) – Filter by seller name.
customer_display_id (int | None) – Filter by customer display ID.
is_active (bool | None) – Filter by active status.
page_size (int) – Number of items per page.
page_number (int) – Page number (1-based).

Returns:

Paginated seller results.

Return type:

PaginatedList[SellerExpandedDto]

get(seller_id)[source]

Retrieve a single seller by ID.

Parameters:: seller_id (int) – Seller identifier.
Returns:: Seller details with catalog associations.
Return type:: SellerExpandedDto

Docs: https://ab-sdk.readthedocs.io/en/latest/api/sellers/get.html Response model: SellerExpandedDto

update(seller_id, *, data)[source]

PUT /Seller/{id}.

Parameters:

seller_id (int) – Seller identifier.
data (UpdateSellerRequest | dict) – Seller update payload with name and display_id. Accepts an UpdateSellerRequest instance or a dict.

Return type:

SellerDto

Request model: UpdateSellerRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/sellers/update.html Request model: UpdateSellerRequest Response model: SellerDto

delete(seller_id)[source]

Delete a seller.

Parameters:: seller_id (int) – Seller identifier.
Return type:: None

Docs: https://ab-sdk.readthedocs.io/en/latest/api/sellers/delete.html

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.sellers.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

Methods

create

POST /Seller — Create a new seller.

from ab import ABConnectAPI

api = ABConnectAPI(env="staging")
api.sellers.create({"name": "New Seller"})

list

GET /Seller — List sellers with optional filters (paginated).

Returns: PaginatedList[SellerExpandedDto]

# List all sellers
sellers = api.sellers.list(page_number=1, page_size=25)

# Filter by active status
sellers = api.sellers.list(is_active=True)

get

GET /Seller/{id} — Get a seller by ID.

Returns: SellerExpandedDto

seller = api.sellers.get(1)
print(seller.name)

update

PUT /Seller/{id} — Update a seller.

api.sellers.update(1, {"name": "Updated Seller"})

delete

DELETE /Seller/{id} — Delete a seller.

api.sellers.delete(1)