v6

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

Search for shops

ADD ENDPOINT DESCRIPTION HERE

get/shops

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

endpointEndpointGet required
platformPlatformGet required
sellerIdinteger required
deletedAtstring date-time
enabledboolean
enabledExportFulfillmentboolean
enabledExportInventoryboolean
enabledInboundImportboolean
enabledInboundExportFulfillmentboolean
fulfillmentQuantityMode'INFINITE' | 'IN_STOCK' | 'AVAILABLE' | 'AVAILABLE_SOON'
languagestring
hideEmailFromCarrierboolean
warehouseIdinteger
externallyFulfilledShippingMethodIdsstring[]
readTariffNumberboolean
readCountryOfOriginboolean
readCustomsValueboolean
readWeightboolean
hideEmailFromOrderboolean
orderImportPageSizeinteger
pixiOrderPrefixstring
defaultShippingMethodstring
exportInventoryIntervalMinutesinteger
exportInventoryCalculationModestring
idinteger