# Deliveries ## List Deliveries `deliveries.list_deliveries(DeliveryListDeliveriesParams**kwargs) -> SyncCursorPage[DeliveryListDeliveriesResponse]` **get** `/api/v2/public/orders/deliveries` Retrieves a paginated list of delivery orders. ### Parameters - `delivery_date: Optional[str]` Filter by delivery date. - `group_code: Optional[str]` Filter by group code. - `is_submitted: Optional[bool]` Filter by submission status. - `last_modified_date: Optional[str]` Filter by last modified date. - `order_number: Optional[str]` Filter by order number. - `page_size: Optional[int]` The number of records per page. - `page_start: Optional[int]` The page number to start from. - `status: Optional[str]` Filter by order status. - `store_number: Optional[str]` Filter by store number. - `supplier_code: Optional[str]` Filter by supplier code. - `supplier_name: Optional[str]` Filter by supplier name. ### Returns - `class DeliveryListDeliveriesResponse: …` - `datetime_created: Optional[datetime]` - `datetime_expected: Optional[datetime]` - `external_reference_number: Optional[str]` - `import_id: Optional[int]` - `is_downloaded: Optional[bool]` - `no_of_containers: Optional[int]` - `order_lines: Optional[List[OrderLine]]` - `barcode: Optional[str]` - `base_unit: Optional[str]` - `category_code: Optional[str]` - `container_barcode: Optional[str]` - `customer_order_number: Optional[str]` - `customer_order_shipment_number: Optional[str]` - `customer_order_shipment_number_line_number: Optional[int]` - `description: Optional[str]` - `group_code: Optional[str]` - `line_number: Optional[int]` - `product_number: Optional[str]` - `purchase_unit_barcode: Optional[str]` - `purchase_unit_product_number: Optional[str]` - `purchase_unit_quantity: Optional[float]` - `quantity: Optional[float]` - `received_quantity: Optional[float]` - `target_stock_pool: Optional[int]` - `order_number: Optional[str]` - `order_type: Optional[str]` - `status: Optional[str]` - `store_gln: Optional[str]` - `store_number: Optional[str]` - `store_origin: Optional[int]` - `supplier_code: Optional[str]` - `supplier_name: Optional[str]` - `tracing_url: Optional[str]` - `updated_on: Optional[datetime]` ### Example ```python import os from colleqtive_sdk import Colleqtive client = Colleqtive( bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"), # This is the default and can be omitted ) page = client.deliveries.list_deliveries() page = page.list[0] print(page.import_id) ``` ## Create Store Deliveries `deliveries.create_store_deliveries(strstore_number, DeliveryCreateStoreDeliveriesParams**kwargs) -> DeliveryCreateStoreDeliveriesResponse` **post** `/api/v2/public/stores/{store_number}/orders/deliveries` Creates delivery orders for a specific store. ### Parameters - `store_number: str` - `orders: Optional[Iterable[Order]]` The list of delivery orders to create. - `no_of_containers: Optional[int]` The number of containers in the delivery. - `order_number: str` The unique order number. - `datetime_created: Optional[Union[str, datetime, null]]` The datetime the order was created. Defaults to UTC now if omitted. - `datetime_expected: Optional[Union[str, datetime]]` The expected delivery datetime. - `description: Optional[str]` A description of the delivery order. - `order_lines: Optional[Iterable[OrderOrderLine]]` The order lines in this delivery. - `product_number: str` The product number. - `quantity: float` The quantity being delivered. - `barcode: Optional[str]` The product barcode. - `container_barcode: Optional[str]` The barcode of the container this line belongs to. - `customer_order_line_number: Optional[int]` The line number on the customer order. - `customer_order_number: Optional[str]` The customer order number this line fulfills. - `customer_order_shipment_number: Optional[str]` The customer order shipment number. - `customer_order_shipment_number_line_number: Optional[int]` The line number on the customer order shipment. - `description: Optional[str]` A description of the order line. - `line_number: Optional[int]` The order line number. - `purchase_price: Optional[float]` The purchase price per unit. - `secondary_order_line_number: Optional[int]` The line number on the secondary order. - `secondary_order_number: Optional[str]` A secondary/external order number. - `target_stock_pool: Optional[int]` The target stock pool for the delivered goods. - `order_type: Optional[int]` The order type identifier (e.g. 1 = purchase, 2 = transfer). - `reason_code: Optional[int]` The reason code for the delivery. - `store_origin: Optional[int]` The origin store number (for inter-store transfers). - `supplier_code: Optional[str]` The unique supplier code. - `supplier_name: Optional[str]` The name of the supplier. - `tracing_url: Optional[str]` URL for tracking the delivery shipment. - `container_override: Optional[bool]` ### Returns - `class DeliveryCreateStoreDeliveriesResponse: …` Standard success response returned by mutation endpoints. - `data: Optional[str]` Optional data payload returned by the operation. - `message: Optional[str]` Human-readable message describing the result. - `success: Optional[bool]` Indicates whether the operation completed successfully. ### Example ```python import os from colleqtive_sdk import Colleqtive client = Colleqtive( bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"), # This is the default and can be omitted ) response = client.deliveries.create_store_deliveries( store_number="store_number", ) print(response.data) ``` ## Create Multi Store Deliveries `deliveries.create_multi_store_deliveries(DeliveryCreateMultiStoreDeliveriesParams**kwargs) -> DeliveryCreateMultiStoreDeliveriesResponse` **post** `/api/v2/public/orders/deliveries` Creates delivery orders across multiple stores. ### Parameters - `orders: Optional[Iterable[Order]]` The list of multi-store delivery orders to create. - `no_of_containers: Optional[int]` The number of containers. - `order_number: str` The unique order number. - `store_number: str` The target store number. - `supplier_name: str` The name of the supplier. - `datetime_created: Optional[Union[str, datetime, null]]` The datetime the order was created. - `datetime_expected: Optional[Union[str, datetime]]` The expected delivery datetime. - `description: Optional[str]` A description of the delivery order. - `order_lines: Optional[Iterable[OrderOrderLine]]` The order lines in this delivery. - `quantity: float` The quantity being delivered. - `barcode: Optional[str]` The product barcode. - `container_barcode: Optional[str]` The barcode of the container this line belongs to. - `customer_order_line_number: Optional[int]` The line number on the customer order. - `customer_order_number: Optional[str]` The customer order number this line fulfills. - `customer_order_shipment_number: Optional[str]` The customer order shipment number. - `customer_order_shipment_number_line_number: Optional[int]` The line number on the customer order shipment. - `description: Optional[str]` A description of the order line. - `line_number: Optional[int]` The order line number. - `product_number: Optional[str]` The product number. - `secondary_order_line_number: Optional[int]` The line number on the secondary order. - `secondary_order_number: Optional[str]` A secondary/external order number. - `target_stock_pool: Optional[int]` The target stock pool for the delivered goods. - `order_type: Optional[int]` The order type identifier. - `reason_code: Optional[int]` The reason code for the delivery. - `supplier_code: Optional[str]` The unique supplier code. - `tracing_url: Optional[str]` URL for tracking the delivery shipment. - `container_override: Optional[bool]` ### Returns - `class DeliveryCreateMultiStoreDeliveriesResponse: …` Standard success response returned by mutation endpoints. - `data: Optional[str]` Optional data payload returned by the operation. - `message: Optional[str]` Human-readable message describing the result. - `success: Optional[bool]` Indicates whether the operation completed successfully. ### Example ```python import os from colleqtive_sdk import Colleqtive client = Colleqtive( bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"), # This is the default and can be omitted ) response = client.deliveries.create_multi_store_deliveries() print(response.data) ```