# Deliveries ## Retrieves a paginated list of delivery orders. `DeliveryListDeliveriesResponse Deliveries.ListDeliveries(DeliveryListDeliveriesParams?parameters, CancellationTokencancellationToken = default)` **get** `/api/v2/public/orders/deliveries` Retrieves a paginated list of delivery orders. ### Parameters - `DeliveryListDeliveriesParams parameters` - `string deliveryDate` Filter by delivery date. - `string groupCode` Filter by group code. - `Boolean isSubmitted` Filter by submission status. - `string lastModifiedDate` Filter by last modified date. - `string orderNumber` Filter by order number. - `string pageSize` - `string pageStart` - `string secondaryOrderNumber` Filter by secondary order number. - `string status` Filter by order status. - `string storeNumber` Filter by store number. - `string supplierCode` Filter by supplier code. - `string supplierName` Filter by supplier name. ### Returns - `class DeliveryListDeliveriesResponse:` Generic paginated response wrapper. - `required Int PageSize` Maximum number of items returned per page. - `required Int PageStart` Current page number (1-based). - `required Long TotalCount` Total number of records matching the query across all pages. - `IReadOnlyList? List` Collection of items for the current page. - `required DateTimeOffset DatetimeCreated` - `required DateTimeOffset DatetimeExpected` - `required Long ImportID` - `required Boolean IsDownloaded` - `required DateTimeOffset UpdatedOn` - `string? ExternalReferenceNumber` - `Int? NoOfContainers` - `IReadOnlyList? OrderLines` - `required Int LineNumber` - `required Double Quantity` - `required Double ReceivedQuantity` - `required Int TargetStockPool` - `string? Barcode` - `string? BaseUnit` - `string? CategoryCode` - `string? ContainerBarcode` - `string? CustomerOrderNumber` - `string? CustomerOrderShipmentNumber` - `Int? CustomerOrderShipmentNumberLineNumber` - `string? Description` - `string? GroupCode` - `string? ProductNumber` - `string? PurchaseUnitBarcode` - `string? PurchaseUnitProductNumber` - `Double? PurchaseUnitQuantity` - `Double? RoundedQuantity` - `string? SecondaryOrderNumber` - `string? OrderNumber` - `string? OrderType` - `string? Status` - `string? StoreGln` - `string? StoreNumber` - `string? StoreOrigin` - `string? SupplierCode` - `string? SupplierName` - `string? TracingUrl` - `IReadOnlyDictionary? ListBody` Additional body-level metadata for the list. - `IReadOnlyDictionary>? ListFilters` Active filter criteria applied to the result set, keyed by field name. - `Int? NextPage` Next page number, or null when on the last page. - `Long? PreviousPage` Previous page number, or null when on the first page. - `string? ProjectLastModifiedDate` Last modified date/time of the project. - `string? ScrollID` Opaque scroll identifier for deep-pagination scenarios. - `string? ServerTime` Server UTC date/time when the response was generated. - `string? SortColumn` Column name the results are sorted by. - `string? SortOrder` Sort direction (asc or desc). - `string? TaskLastModifiedDate` Last modified date/time of the task. ### Example ```csharp DeliveryListDeliveriesParams parameters = new(); var response = await client.Deliveries.ListDeliveries(parameters); Console.WriteLine(response); ``` #### Response ```json { "page_size": 0, "page_start": 0, "total_count": 0, "list": [ { "datetime_created": "2019-12-27T18:11:19.117Z", "datetime_expected": "2019-12-27T18:11:19.117Z", "import_id": 0, "is_downloaded": true, "updated_on": "2019-12-27T18:11:19.117Z", "external_reference_number": "external_reference_number", "no_of_containers": 0, "order_lines": [ { "line_number": 0, "quantity": 0, "received_quantity": 0, "target_stock_pool": 0, "barcode": "barcode", "base_unit": "base_unit", "category_code": "category_code", "container_barcode": "container_barcode", "customer_order_number": "customer_order_number", "customer_order_shipment_number": "customer_order_shipment_number", "customer_order_shipment_number_line_number": 0, "description": "description", "group_code": "group_code", "product_number": "product_number", "purchase_unit_barcode": "purchase_unit_barcode", "purchase_unit_product_number": "purchase_unit_product_number", "purchase_unit_quantity": 0, "rounded_quantity": 0, "secondary_order_number": "secondary_order_number" } ], "order_number": "order_number", "order_type": "order_type", "status": "status", "store_gln": "store_gln", "store_number": "store_number", "store_origin": "store_origin", "supplier_code": "supplier_code", "supplier_name": "supplier_name", "tracing_url": "tracing_url" } ], "list_body": { "foo": "bar" }, "list_filters": { "foo": [ "string" ] }, "next_page": 0, "previous_page": 0, "project_last_modified_date": "project_last_modified_date", "scroll_id": "scroll_id", "server_time": "server_time", "sort_column": "sort_column", "sort_order": "sort_order", "task_last_modified_date": "task_last_modified_date" } ``` ## Creates delivery orders for a specific store. `DeliveryCreateStoreDeliveriesResponse Deliveries.CreateStoreDeliveries(DeliveryCreateStoreDeliveriesParamsparameters, CancellationTokencancellationToken = default)` **post** `/api/v2/public/stores/{store_number}/orders/deliveries` Creates delivery orders for a specific store. ### Parameters - `DeliveryCreateStoreDeliveriesParams parameters` - `required string storeNumber` Path param: The store number. - `IReadOnlyList? orders` Body param: The list of delivery orders to create. - `required DateTimeOffset DatetimeExpected` The expected delivery datetime. - `required Int NoOfContainers` The number of containers in the delivery. - `required string OrderNumber` The unique order number. - `required Int OrderType` The order type identifier (e.g. 1 = purchase, 2 = transfer). - `DateTimeOffset? DatetimeCreated` The datetime the order was created. Defaults to UTC now if omitted. - `string? Description` A description of the delivery order. - `IReadOnlyList? OrderLines` The order lines in this delivery. - `required Int LineNumber` The order line number. - `required string ProductNumber` The product number. - `required Double Quantity` The quantity being delivered. - `required Int TargetStockPool` The target stock pool for the delivered goods. - `string? Barcode` The product barcode. - `string? ContainerBarcode` The barcode of the container this line belongs to. - `Int? CustomerOrderLineNumber` The line number on the customer order. - `string? CustomerOrderNumber` The customer order number this line fulfills. - `string? CustomerOrderShipmentNumber` The customer order shipment number. - `Int? CustomerOrderShipmentNumberLineNumber` The line number on the customer order shipment. - `string? Description` A description of the order line. - `Double? OrderedQuantity` The originally ordered quantity. - `string? ProductDescription` A description of the product. - `Double? PurchasePrice` The purchase price per unit. - `string? Reference` An external reference for the order line. - `Int? SecondaryOrderLineNumber` The line number on the secondary order. - `string? SecondaryOrderNumber` A secondary/external order number. - `Int? ReasonCode` The reason code for the delivery. - `string? Reference` An external reference for the delivery order. - `string? StoreOrigin` The origin store number (for inter-store transfers). - `string? SupplierCode` The unique supplier code. - `string? SupplierName` The name of the supplier. - `string? TracingUrl` URL for tracking the delivery shipment. - `Boolean containerOverride` Header param: When true, overrides container validation. ### Returns - `class DeliveryCreateStoreDeliveriesResponse:` Standard success response returned by mutation endpoints. - `required Boolean Success` Indicates whether the operation completed successfully. - `string? Data` Optional data payload returned by the operation. - `string? Message` Human-readable message describing the result. ### Example ```csharp DeliveryCreateStoreDeliveriesParams parameters = new() { StoreNumber = "store_number" }; var response = await client.Deliveries.CreateStoreDeliveries(parameters); Console.WriteLine(response); ``` #### Response ```json { "success": true, "data": "data", "message": "message" } ``` ## Creates delivery orders across multiple stores. `DeliveryCreateMultiStoreDeliveriesResponse Deliveries.CreateMultiStoreDeliveries(DeliveryCreateMultiStoreDeliveriesParams?parameters, CancellationTokencancellationToken = default)` **post** `/api/v2/public/orders/deliveries` Creates delivery orders across multiple stores. ### Parameters - `DeliveryCreateMultiStoreDeliveriesParams parameters` - `IReadOnlyList? orders` Body param: The list of multi-store delivery orders to create. - `required DateTimeOffset DatetimeExpected` The expected delivery datetime. - `required Int NoOfContainers` The number of containers. - `required string OrderNumber` The unique order number. - `required Int OrderType` The order type identifier. - `required string StoreNumber` The target store number. - `required string SupplierName` The name of the supplier. - `DateTimeOffset? DatetimeCreated` The datetime the order was created. - `string? Description` A description of the delivery order. - `IReadOnlyList? OrderLines` The order lines in this delivery. - `required Int LineNumber` The order line number. - `required Double Quantity` The quantity being delivered. - `required Int TargetStockPool` The target stock pool for the delivered goods. - `string? Barcode` The product barcode. - `string? ContainerBarcode` The barcode of the container this line belongs to. - `Int? CustomerOrderLineNumber` The line number on the customer order. - `string? CustomerOrderNumber` The customer order number this line fulfills. - `string? CustomerOrderShipmentNumber` The customer order shipment number. - `Int? CustomerOrderShipmentNumberLineNumber` The line number on the customer order shipment. - `string? Description` A description of the order line. - `string? ProductNumber` The product number. - `Int? SecondaryOrderLineNumber` The line number on the secondary order. - `string? SecondaryOrderNumber` A secondary/external order number. - `Int? ReasonCode` The reason code for the delivery. - `string? SupplierCode` The unique supplier code. - `string? TracingUrl` URL for tracking the delivery shipment. - `Boolean containerOverride` Header param: When true, overrides container validation. ### Returns - `class DeliveryCreateMultiStoreDeliveriesResponse:` Standard success response returned by mutation endpoints. - `required Boolean Success` Indicates whether the operation completed successfully. - `string? Data` Optional data payload returned by the operation. - `string? Message` Human-readable message describing the result. ### Example ```csharp DeliveryCreateMultiStoreDeliveriesParams parameters = new(); var response = await client.Deliveries.CreateMultiStoreDeliveries(parameters); Console.WriteLine(response); ``` #### Response ```json { "success": true, "data": "data", "message": "message" } ```