# Deliveries ## List Deliveries **get** `/api/v2/public/orders/deliveries` Retrieves a paginated list of delivery orders. ### Query Parameters - `delivery_date: optional string` Filter by delivery date. - `group_code: optional string` Filter by group code. - `is_submitted: optional boolean` Filter by submission status. - `last_modified_date: optional string` Filter by last modified date. - `order_number: optional string` Filter by order number. - `page_size: optional number` The number of records per page. - `page_start: optional number` The page number to start from. - `status: optional string` Filter by order status. - `store_number: optional string` Filter by store number. - `supplier_code: optional string` Filter by supplier code. - `supplier_name: optional string` Filter by supplier name. ### Returns - `list: array of object { datetime_created, datetime_expected, external_reference_number, 14 more }` Collection of items for the current page. - `datetime_created: optional string` - `datetime_expected: optional string` - `external_reference_number: optional string` - `import_id: optional number` - `is_downloaded: optional boolean` - `no_of_containers: optional number` - `order_lines: optional array of object { barcode, base_unit, category_code, 14 more }` - `barcode: optional string` - `base_unit: optional string` - `category_code: optional string` - `container_barcode: optional string` - `customer_order_number: optional string` - `customer_order_shipment_number: optional string` - `customer_order_shipment_number_line_number: optional number` - `description: optional string` - `group_code: optional string` - `line_number: optional number` - `product_number: optional string` - `purchase_unit_barcode: optional string` - `purchase_unit_product_number: optional string` - `purchase_unit_quantity: optional number` - `quantity: optional number` - `received_quantity: optional number` - `target_stock_pool: optional number` - `order_number: optional string` - `order_type: optional string` - `status: optional string` - `store_gln: optional string` - `store_number: optional string` - `store_origin: optional number` - `supplier_code: optional string` - `supplier_name: optional string` - `tracing_url: optional string` - `updated_on: optional string` - `list_body: optional map[unknown]` Additional body-level metadata for the list. - `list_filters: optional map[array of string]` Active filter criteria applied to the result set, keyed by field name. - `next_page: optional number` Next page number, or null when on the last page. - `page_size: optional number` Maximum number of items returned per page. - `page_start: optional number` Current page number (1-based). - `previous_page: optional number` Previous page number, or null when on the first page. - `project_last_modified_date: optional string` Last modified date/time of the project. - `scroll_id: optional string` Opaque scroll identifier for deep-pagination scenarios. - `server_time: optional string` Server UTC date/time when the response was generated. - `sort_column: optional string` Column name the results are sorted by. - `sort_order: optional string` Sort direction. - `task_last_modified_date: optional string` Last modified date/time of the task. - `total_count: optional number` Total number of records matching the query across all pages. ### Example ```http curl https://api.colleqtive.net/api/v2/public/orders/deliveries \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` ## Create Store Deliveries **post** `/api/v2/public/stores/{store_number}/orders/deliveries` Creates delivery orders for a specific store. ### Path Parameters - `store_number: string` ### Header Parameters - `container_override: optional boolean` ### Body Parameters - `orders: optional array of object { no_of_containers, order_number, datetime_created, 9 more }` The list of delivery orders to create. - `no_of_containers: number` The number of containers in the delivery. - `order_number: string` The unique order number. - `datetime_created: optional string` The datetime the order was created. Defaults to UTC now if omitted. - `datetime_expected: optional string` The expected delivery datetime. - `description: optional string` A description of the delivery order. - `order_lines: optional array of object { product_number, quantity, barcode, 11 more }` The order lines in this delivery. - `product_number: string` The product number. - `quantity: number` The quantity being delivered. - `barcode: optional string` The product barcode. - `container_barcode: optional string` The barcode of the container this line belongs to. - `customer_order_line_number: optional number` The line number on the customer order. - `customer_order_number: optional string` The customer order number this line fulfills. - `customer_order_shipment_number: optional string` The customer order shipment number. - `customer_order_shipment_number_line_number: optional number` The line number on the customer order shipment. - `description: optional string` A description of the order line. - `line_number: optional number` The order line number. - `purchase_price: optional number` The purchase price per unit. - `secondary_order_line_number: optional number` The line number on the secondary order. - `secondary_order_number: optional string` A secondary/external order number. - `target_stock_pool: optional number` The target stock pool for the delivered goods. - `order_type: optional number` The order type identifier (e.g. 1 = purchase, 2 = transfer). - `reason_code: optional number` The reason code for the delivery. - `store_origin: optional number` The origin store number (for inter-store transfers). - `supplier_code: optional string` The unique supplier code. - `supplier_name: optional string` The name of the supplier. - `tracing_url: optional string` URL for tracking the delivery shipment. ### Returns - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. - `success: optional boolean` Indicates whether the operation completed successfully. ### Example ```http curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/orders/deliveries \ -X POST \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` ## Create Multi Store Deliveries **post** `/api/v2/public/orders/deliveries` Creates delivery orders across multiple stores. ### Header Parameters - `container_override: optional boolean` ### Body Parameters - `orders: optional array of object { no_of_containers, order_number, store_number, 9 more }` The list of multi-store delivery orders to create. - `no_of_containers: number` The number of containers. - `order_number: string` The unique order number. - `store_number: string` The target store number. - `supplier_name: string` The name of the supplier. - `datetime_created: optional string` The datetime the order was created. - `datetime_expected: optional string` The expected delivery datetime. - `description: optional string` A description of the delivery order. - `order_lines: optional array of object { quantity, barcode, container_barcode, 10 more }` The order lines in this delivery. - `quantity: number` The quantity being delivered. - `barcode: optional string` The product barcode. - `container_barcode: optional string` The barcode of the container this line belongs to. - `customer_order_line_number: optional number` The line number on the customer order. - `customer_order_number: optional string` The customer order number this line fulfills. - `customer_order_shipment_number: optional string` The customer order shipment number. - `customer_order_shipment_number_line_number: optional number` The line number on the customer order shipment. - `description: optional string` A description of the order line. - `line_number: optional number` The order line number. - `product_number: optional string` The product number. - `secondary_order_line_number: optional number` The line number on the secondary order. - `secondary_order_number: optional string` A secondary/external order number. - `target_stock_pool: optional number` The target stock pool for the delivered goods. - `order_type: optional number` The order type identifier. - `reason_code: optional number` The reason code for the delivery. - `supplier_code: optional string` The unique supplier code. - `tracing_url: optional string` URL for tracking the delivery shipment. ### Returns - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. - `success: optional boolean` Indicates whether the operation completed successfully. ### Example ```http curl https://api.colleqtive.net/api/v2/public/orders/deliveries \ -X POST \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ```