> ## 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 inbound shipments > List inbound shipments or inbound deliveries. ## OpenAPI ````yaml /openapi.json get /inbounds 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: /inbounds: get: tags: - inbounds summary: List inbound shipments description: List inbound shipments or inbound deliveries. operationId: searchGetInbounds 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 inbound shipment summaries with key identifiers and status information. content: application/json: schema: type: array items: $ref: '#/components/schemas/InboundSummary' '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: InboundSummary: required: - deliverySlipNumber - estimatedArrivalTime - sellerId - shipFrom - warehouseId type: object properties: sellerId: type: integer description: Seller ID. format: int64 warehouseId: type: integer description: >- Warehouse ID.
A list of warehouse identifiers and names can be obtained by executing GET /warehouses format: int64 shipFrom: $ref: '#/components/schemas/AddressDetail' estimatedArrivalTime: type: string description: Estimated date of arrival format: date-time deliverySlipNumber: type: string description: Delivery slip number customAttributes: type: object additionalProperties: type: string description: Optional custom attributes of this inbound. example: '{"attr1":"val1"}' movementReferenceNumber: maxLength: 1024 minLength: 0 type: string description: >- Optional movement reference number. Unique identifier assigned to customs declarations within the UK and EU id: type: integer format: int64 description: The unique identifier for the id created: type: string format: date-time description: Timestamp when the item was created completedAt: type: string format: date-time description: The completed at timestamp cancelledAt: type: string format: date-time description: The cancelled at timestamp inboundIdentifier: type: string description: The unique identifier for the inboundentifier sort: $ref: '#/components/schemas/JsonNode' trackingLink: type: string description: Tracking information or tracking enabled status trackingNumber: type: string description: Tracking information or tracking enabled status carrier: type: string description: Carrier identifier or information createdByLogsta: type: boolean description: Timestamp when the item was created inboundStatus: type: string enum: - PENDING - CREATED - PROCESSING - COMPLETED - CANCELLED description: The current status of the inbound tags: type: array items: type: string description: Tags or labels inboundPositions: type: array items: $ref: '#/components/schemas/InboundPositionSummary' description: Array of inbound position inboundShipments: type: array items: $ref: '#/components/schemas/InboundShipmentSummary' description: Shipment identifier or information deliveryInfo: $ref: '#/components/schemas/InboundDeliveryInfoDetail' description: >- Summarized inbound shipment information for list views. Contains essential inbound identifiers, warehouse, and status information. AddressDetail: type: object properties: name1: type: string description: The name of the item name2: type: string description: The name of the item company: type: string description: Company name address1: type: string description: Address information address2: type: string description: Address information address3: type: string description: Address information zip: type: string description: ZIP or postal code city: type: string description: City name state: type: string description: State or province country: type: string description: Country code or name phone: type: string description: Phone number email: type: string description: Email address description: Detailed address information 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 ' InboundPositionSummary: type: object properties: inboundPositionId: type: integer format: int64 description: The unique identifier for the inboundposition sku: type: string description: Stock Keeping Unit (SKU) identifier warehouseSku: type: string description: Stock Keeping Unit (SKU) identifier articleIdentifier: type: string description: The unique identifier for the articleentifier quantity: type: integer format: int32 description: Quantity or amount customAttributes: type: object additionalProperties: type: string description: Custom attributes or data description: Summary information for inboundposition InboundShipmentSummary: type: object properties: inboundShipmentIdentifier: type: string description: The unique identifier for the inboundshipmententifier arrivedAt: type: string format: date-time description: The arrived at timestamp inboundShipmentPositions: type: array items: $ref: '#/components/schemas/InboundShipmentPositionSummary' description: Shipment identifier or information totalGrossWeight: type: number description: Weight value description: Summary information for inboundshipment InboundDeliveryInfoDetail: required: - cargoType - quantity type: object properties: cargoType: type: string description: Cargo type. enum: - CARTON - PALLET - CONTAINER quantity: minimum: 1 type: integer description: Cargo quantity. format: int32 description: Detailed information for inbounddeliveryinfo InboundShipmentPositionSummary: type: object properties: quantity: type: integer format: int32 description: Quantity or amount warehouseSku: type: string description: Stock Keeping Unit (SKU) identifier lot: type: string description: The lot value positionIdentifier: type: string description: The unique identifier for the positionentifier location: type: string description: The location value expirationDate: type: string format: date description: The expiration date date description: Summary information for inboundshipmentposition ````