v6

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-09153208467.0 KB
sellers

Search for sellers

ADD ENDPOINT DESCRIPTION HERE

get/sellers

Query parameters

querystring

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

sortstring

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

pageinteger

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

searchAfterstring

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

pageSizeinteger

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

successful operation

namestring
usesWarehouseSkuboolean
warehouseIdinteger
companyNamestring

Company name. <br>Necessary for VAT Registration Number

sendToEmailstring required

E-Mail address to send invoices.

sellerServicesstring[]
pixiSellerIdentifierstring

SellerIdentifier used in Pixi <br>Necessary for Pixi sellers

pixiArticlePrefixstring

ArticlePrefix used for Pixi articles <br>Necessary for Pixi sellers

pixiManualOrderPrefixstring

OrderPrefix used for Pixi orders created manually <br>Necessary for Pixi sellers

allowInboundOverReceivingboolean

Optional value indicating if seller can over receive more than announced during inbounds. <br>Default value is true.

allowReturnOverReceivingboolean

Optional value indicating if seller can receive more than announced during returns. <br>Default value is true.

lottableIdRequiredboolean

Optional value indicating if seller requires to replace lot no. with lottable ID.<br>Default value is false.

idinteger
identifierstring
status'ACTIVE' | 'BLOCKED' | 'TERMINATED' | 'NEW' | 'PENDING'