Skip to main content
GET
/
shops
List shops
curl --request GET \
  --url https://api.quivo.co/shops
[
  {
    "endpoint": {},
    "platform": {},
    "sellerId": 123,
    "sort": {
      "short": true,
      "nodeType": "ARRAY",
      "float": true,
      "binary": true,
      "number": true,
      "integralNumber": true,
      "boolean": true,
      "double": true,
      "long": true,
      "int": true,
      "valueNode": true,
      "containerNode": true,
      "missingNode": true,
      "object": true,
      "pojo": true,
      "floatingPointNumber": true,
      "bigDecimal": true,
      "bigInteger": true,
      "textual": true,
      "array": true,
      "null": true
    },
    "deletedAt": "2023-11-07T05:31:56Z",
    "enabled": true,
    "enabledExportFulfillment": true,
    "enabledExportInventory": true,
    "enabledInboundImport": true,
    "enabledInboundExportFulfillment": true,
    "fulfillmentQuantityMode": "INFINITE",
    "language": "<string>",
    "hideEmailFromCarrier": true,
    "warehouseId": 123,
    "orderFilter": {
      "orderedAfter": "2023-11-07T05:31:56Z",
      "referencePattern": {},
      "excludeDeliveryAddressCountries": [
        "AF"
      ],
      "includeDeliveryAddressCountries": [
        "AF"
      ]
    },
    "externallyFulfilledShippingMethodIds": [
      "<string>"
    ],
    "readTariffNumber": true,
    "readCountryOfOrigin": true,
    "readCustomsValue": true,
    "readWeight": true,
    "hideEmailFromOrder": true,
    "orderImportPageSize": 123,
    "pixiOrderPrefix": "<string>",
    "defaultShippingMethod": "<string>",
    "exportInventoryIntervalMinutes": 123,
    "exportInventoryCalculationMode": "<string>",
    "id": 123
  }
]

Query Parameters

query
string

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

sort
string

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

page
integer<int64>

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

searchAfter
string

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'.

pageSize
integer<int64>

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

Response

Returns an array of connected shop integrations with connection status and details.

endpoint
object
required

Response object containing endpoint details

platform
object
required

Response object containing platform details

sellerId
integer<int64>
required

The unique identifier for the seller

sort
object

The

deletedAt
string<date-time>

The deleted at timestamp

enabled
boolean

Indicates whether is enabled

enabledExportFulfillment
boolean

Indicates whether export fulfillment is enabled

enabledExportInventory
boolean

Indicates whether export inventory is enabled

enabledInboundImport
boolean

Indicates whether inbound import is enabled

enabledInboundExportFulfillment
boolean

Indicates whether inbound export fulfillment is enabled

fulfillmentQuantityMode
enum<string>

Quantity or amount

Available options:
INFINITE,
IN_STOCK,
AVAILABLE,
AVAILABLE_SOON
language
string

The language value

hideEmailFromCarrier
boolean

Email address

warehouseId
integer<int64>

The unique identifier for the warehouse

orderFilter
object

Response object containing orderfilter details

externallyFulfilledShippingMethodIds
string[]

The unique identifier for the externallyfulfilledshippingmethods

readTariffNumber
boolean

Number value

readCountryOfOrigin
boolean

Country code or name

readCustomsValue
boolean

The read customs value value

readWeight
boolean

Weight value

hideEmailFromOrder
boolean

Email address

orderImportPageSize
integer<int32>

Order identifier or information

pixiOrderPrefix
string

Order identifier or information

defaultShippingMethod
string

The default shipping method

exportInventoryIntervalMinutes
integer<int32>

The export inventory interval minutes numeric value

exportInventoryCalculationMode
string

The export inventory calculation mode

id
integer<int64>

The unique identifier for the id