> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.quivo.co/llms.txt > Use this file to discover all available pages before exploring further. # List orders > Get a paginated list of orders that supports query, sorting, and pagination parameters to filter and structure the results. ## OpenAPI ````yaml /openapi.json get /orders openapi: 3.0.1 info: title: Connector version: 80f7edc, 2026-01-23T12:01:00Z description: Enhanced Quivo API documentation with additional descriptions and examples contact: name: Quivo Support email: support@quivo.co url: https://quivo.co license: name: Proprietary url: https://quivo.co/terms termsOfService: https://quivo.co/terms servers: - url: https://api.quivo.co/ description: Production API server for Quivo Connector security: [] tags: - name: addresses description: Manage stored addresses in the seller's address book - name: apiKeyRequests description: Request and manage API keys - name: articles description: Create and manage product articles - name: audits description: Access audit logs and history - name: bundles description: Manage product bundles - name: carriers description: Get carrier information - name: contacts description: Manage contact information - name: countries description: Get country information - name: currencies description: Get currency information - name: customerInquiries description: Manage customer inquiries - name: dashboards description: Access dashboard data - name: files description: Manage file uploads and downloads - name: fulfillmentPlans description: Manage fulfillment plans - name: inbounds description: Manage inbound shipments - name: items description: Monitor and manage inventory items - name: languages description: Get language information - name: notifications description: Manage notifications - name: orders description: Create and manage fulfillment orders - name: ping description: Health check endpoint - name: returnApp description: Manage return applications - name: returnLinks description: Manage return links - name: returns description: Manage returns - name: sellers description: Get seller information - name: shipments description: Book and manage shipments - name: shippingServiceGroups description: Get shipping service groups - name: shopOrders description: Manage shop orders - name: shops description: Manage shops - name: status description: Get system status - name: storedAddresses description: Manage stored addresses - name: subscriptionPackages description: Manage subscription packages - name: subscriptions description: Manage webhook subscriptions - name: track description: Track shipments - name: transports description: Manage transport services - name: users description: Manage users - name: warehouses description: Get warehouse information paths: /orders: get: tags: - orders summary: List orders description: >- Get a paginated list of orders that supports query, sorting, and pagination parameters to filter and structure the results. operationId: orderGet parameters: - name: query in: query schema: type: string description: >- Search query string used to filter results. This field supports specific syntax for filtering across multiple fields. - name: sort in: query schema: type: string description: >- Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc'). - name: page in: query schema: type: integer format: int64 description: >- The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided. - name: searchAfter in: query schema: type: string description: >- 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'. - name: pageSize in: query schema: type: integer format: int64 description: >- The maximum number of items to return per page. Used for both offset and cursor-based pagination. responses: '200': description: >- Returns an array of summarized order details, including key identifiers, status, and shipping information, filtered and sorted according to the request parameters. content: application/json: schema: type: array items: $ref: '#/components/schemas/OrderSummary' '400': description: >- Bad request - the request payload is invalid, missing required fields, or contains invalid data. '401': description: >- Unauthorized - authentication credentials are missing, invalid, or expired. '404': description: >- Not found - the requested resource does not exist or is not accessible. '500': description: Internal server error - an unexpected error occurred on the server. components: schemas: OrderSummary: type: object properties: orderId: type: integer format: int64 description: The unique internal identifier for the order. sellerId: type: integer format: int64 description: >- The unique identifier for the seller account associated with the order. created: type: string format: date-time description: Timestamp when the order record was initially created. lastModified: type: string format: date-time description: Timestamp when the order record was last modified. orderIdentifier: type: string description: >- A unique identifier from the source system (e.g., shop system) to prevent duplicate order creation. orderReference: type: string description: >- An easy-to-read reference number for the order, typically set by the customer or shop. orderStatus: type: string description: >- The current fulfillment status of the order (e.g., 'PENDING', 'PROCESSING', 'COMPLETED'). tags: type: array items: type: string description: Optional list of descriptive tags applied to the order. orderDate: type: string format: date-time description: The date and time when the order was placed by the customer. cancelRequestedAt: type: string format: date-time description: Timestamp if a cancellation request was logged for the order. shipToCountry: type: string description: The ISO 2 country code (e.g., 'DE', 'US') for the delivery address. shipToZip: type: string description: The ZIP code for the delivery address. shipToCompany: type: string description: The company name for the delivery address. shipToName1: type: string description: The first name/line 1 name for the delivery address. shipToName2: type: string description: The second name/line 2 name for the delivery address. shipToAddressIdentifier: type: string description: An optional identifier for the delivery address (e.g., a store ID). shipToAdditionalIdentifiers: type: array items: $ref: '#/components/schemas/OrderAddressAdditionalIdentifier' description: Additional unique identifiers for the shipping address (e.g., GLN). earliestPredatedShipment: type: string format: date description: The earliest allowed date for the order to be shipped. latestPredatedShipment: type: string format: date description: The latest allowed date for the order to be shipped. shipmentTracking: type: array items: $ref: '#/components/schemas/TrackingSummary' description: >- A list of tracking numbers and links associated with shipments for this order. completedAt: type: string format: date-time description: Timestamp when the order was marked as fulfilled/completed. exportedAt: type: string format: date-time description: >- Timestamp when the order was exported to the warehouse management system. shipToEmail: type: string description: The email address for the delivery recipient. billToEmail: type: string description: The email address for the invoice recipient. piiDataRemoved: type: boolean description: >- Indicates if Personally Identifiable Information (PII) has been removed from the order record. totalShipmentWeight: type: number description: The total weight of all shipments associated with the order (in kg). positions: type: array items: $ref: '#/components/schemas/PositionSummary' description: A summary list of the products originally ordered by the customer. fulfillmentOrders: type: array items: $ref: '#/components/schemas/FulfillmentOrderSummary' description: >- Details of how the order was split and planned for physical fulfillment in the warehouse(s). entityErrors: type: array items: $ref: '#/components/schemas/EntityErrorSummary' description: A list of critical errors preventing the fulfillment process. sort: $ref: '#/components/schemas/JsonNode' description: Internal object used for controlling search result ordering. shopId: type: integer format: int64 description: The unique identifier of the source shop system. shopSystem: type: string description: The technical name of the shop system (e.g., 'Shopware', 'Shopify'). shopSystemName: type: string description: The display name of the shop system. customerPurchaseOrderNumber: type: string description: A reference code assigned to the purchase order by the customer. channelId: type: string description: The ID of the sales channel associated with the order. channelName: type: string description: The name of the sales channel associated with the order. customAttributes: type: object additionalProperties: type: string description: >- Arbitrary key-value pairs for storing custom data related to the order. description: >- Provides a high-level summary of an order, including primary identifiers (orderId, orderIdentifier), current status, timestamps, key shipping details (like destination country and ZIP), and a list of included positions and fulfillment details. OrderAddressAdditionalIdentifier: type: object properties: identifier: type: string description: The specific identifier string (e.g., a GLN or store ID). type: type: string description: The type of the identifier (e.g., 'GLN', 'SHOP_SPECIFIC'). description: >- Represents an additional, specialized identifier for an address, such as a GLN or a shop-specific ID, along with its type. TrackingSummary: type: object properties: number: type: string description: The tracking number for the shipment. link: type: string description: The public tracking link URL provided by the carrier. description: >- Provides a summary of a shipment's tracking details, including the tracking number and the corresponding public tracking link. PositionSummary: type: object properties: positionId: type: integer format: int64 description: The unique internal identifier for the order position. positionIdentifier: type: string description: A unique identifier for the position from the source system. name: type: string description: The descriptive name of the ordered product. sku: type: string description: The Stock Keeping Unit (SKU) of the ordered product. customAttributes: type: object additionalProperties: type: string description: >- Arbitrary key-value pairs for storing custom data related to the position. description: >- A summarized view of an individual ordered line item, containing identifiers, the product SKU, its name, and any associated custom attributes. FulfillmentOrderSummary: type: object properties: fulfillmentOrderId: type: integer format: int64 description: The unique identifier for the fulfillmentorder fulfillmentOrderIdentifier: type: string description: >- The unique identifier for the fulfillment order in the warehouse system. fulfillmentStatus: type: string description: >- The current status of the fulfillment order (e.g., 'READY_FOR_PICKING', 'SHIPPED'). positions: type: array items: $ref: '#/components/schemas/FulfillmentOrderPositionSummary' description: >- Details of the items and quantities processed in this fulfillment order. shipments: type: array items: $ref: '#/components/schemas/ShipmentSummary' description: A list of shipments created as a result of this fulfillment order. description: >- Provides an overview of a planned fulfillment operation, detailing its unique identifier, current status in the warehouse, the inventory positions assigned to it, and any resulting shipments. EntityErrorSummary: type: object properties: errorCode: type: string description: >- A machine-readable code identifying the nature of the error (e.g., 'OUT_OF_STOCK'). errorMessage: type: string description: A human-readable message explaining the error in detail. description: >- Describes a high-level error that affects an entity (like an order), providing a specific error code and a human-readable error message. JsonNode: type: object properties: short: type: boolean description: Indicates whether short is enabled or active nodeType: type: string enum: - ARRAY - BINARY - BOOLEAN - MISSING - 'NULL' - NUMBER - OBJECT - POJO - STRING description: The type or category of the node float: type: boolean description: Indicates whether float is enabled or active binary: type: boolean description: Indicates whether binary is enabled or active number: type: boolean description: Number value integralNumber: type: boolean description: Number value boolean: type: boolean description: Indicates whether boolean is enabled or active double: type: boolean description: Indicates whether double is enabled or active long: type: boolean description: Indicates whether long is enabled or active int: type: boolean description: Indicates whether int is enabled or active valueNode: type: boolean description: The value node value containerNode: type: boolean description: Boolean flag indicating container node missingNode: type: boolean description: Boolean flag indicating missing node object: type: boolean description: Indicates whether object is enabled or active pojo: type: boolean description: Indicates whether pojo is enabled or active floatingPointNumber: type: boolean description: Number value bigDecimal: type: boolean description: Boolean flag indicating big decimal bigInteger: type: boolean description: Boolean flag indicating big integer textual: type: boolean description: Indicates whether textual is enabled or active array: type: boolean description: Indicates whether array is enabled or active 'null': type: boolean description: Indicates whether null is enabled or active description: 'The ' FulfillmentOrderPositionSummary: type: object properties: fulfillmentOrderPositionId: type: integer format: int64 description: The unique internal identifier for the fulfillment order position. orderedSku: type: string description: The SKU from the original order before any mapping or bundling. sku: type: string description: >- The final SKU selected for fulfillment, after considering bundles/maps. warehouseSku: type: string description: The SKU as known in the warehouse system. quantity: type: integer format: int32 description: The quantity of the item allocated for fulfillment. lot: type: string description: The lot number of the item allocated. location: type: string description: The warehouse location where the item is stored. customsValue: type: number description: The value of the item used for customs declaration. expirationDate: type: string format: date-time description: The expiration date of the specific product batch used. description: >- Details an individual product position within a fulfillment order, including its allocated quantity, lot, location, and expiration date. ShipmentSummary: type: object properties: shipmentId: type: integer format: int64 description: The unique internal identifier for the shipment. shipmentIdentifier: type: string description: >- The unique reference for the shipment, typically assigned by the system. positions: type: array items: $ref: '#/components/schemas/ShipmentPositionDetail' description: >- The list of items and quantities contained within this specific shipment. description: >- A summary of a particular shipment created for the order, including its unique identifiers and the list of specific items/quantities enclosed. ShipmentPositionDetail: type: object properties: shipmentPositionId: type: integer format: int64 description: The unique internal identifier for the shipment position. sku: type: string description: The SKU used for the shipment position. warehouseSku: type: string description: The SKU as known in the warehouse system. sellerSku: type: string description: The original SKU from the seller. quantity: type: integer format: int32 description: The quantity shipped in this position. lot: type: string description: The lot number of the item shipped. location: type: string description: The storage location where the item was picked from. expirationDate: type: string format: date-time description: The expiration date of the product shipped. serialNumbers: type: array items: type: string description: A list of serial numbers for tracked items. positionIdentifier: type: string description: The unique identifier for the shipment position. description: >- Detailed information about a specific item included within a shipment, including its allocated quantity, lot, location, and serial numbers. ````