# Deliveries

## List Deliveries

`DeliveryListDeliveriesPageResponse 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.

  - `Int pageSize`

    The number of records per page.

  - `Int pageStart`

    The page number to start from.

  - `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 DeliveryListDeliveriesPageResponse:`

  Generic paginated response wrapper.

  - `required IReadOnlyList<DeliveryListDeliveriesResponse> List`

    Collection of items for the current page.

    - `DateTimeOffset DatetimeCreated`

    - `DateTimeOffset DatetimeExpected`

    - `string? ExternalReferenceNumber`

    - `Long ImportID`

    - `Boolean IsDownloaded`

    - `Int? NoOfContainers`

    - `IReadOnlyList<OrderLine>? OrderLines`

      - `string? Barcode`

      - `string? BaseUnit`

      - `string? CategoryCode`

      - `string? ContainerBarcode`

      - `string? CustomerOrderNumber`

      - `string? CustomerOrderShipmentNumber`

      - `Int? CustomerOrderShipmentNumberLineNumber`

      - `string? Description`

      - `string? GroupCode`

      - `Int LineNumber`

      - `string? ProductNumber`

      - `string? PurchaseUnitBarcode`

      - `string? PurchaseUnitProductNumber`

      - `Double? PurchaseUnitQuantity`

      - `Double Quantity`

      - `Double ReceivedQuantity`

      - `Int TargetStockPool`

    - `string? OrderNumber`

    - `string? OrderType`

    - `string? Status`

    - `string? StoreGln`

    - `string? StoreNumber`

    - `Long? StoreOrigin`

    - `string? SupplierCode`

    - `string? SupplierName`

    - `string? TracingUrl`

    - `DateTimeOffset UpdatedOn`

  - `IReadOnlyDictionary<string, JsonElement>? ListBody`

    Additional body-level metadata for the list.

  - `IReadOnlyDictionary<string, IReadOnlyList<string>>? 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 PageSize`

    Maximum number of items returned per page.

  - `Long PageStart`

    Current page number (1-based).

  - `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.

  - `string? TaskLastModifiedDate`

    Last modified date/time of the task.

  - `Long TotalCount`

    Total number of records matching the query across all pages.

### Example

```csharp
DeliveryListDeliveriesParams parameters = new();

var page = await client.Deliveries.ListDeliveries(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

## Create Store Deliveries

`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<Order>? orders`

    Body param: The list of delivery orders to create.

    - `required Int? NoOfContainers`

      The number of containers in the delivery.

    - `required string OrderNumber`

      The unique order number.

    - `DateTimeOffset? DatetimeCreated`

      The datetime the order was created. Defaults to UTC now if omitted.

    - `DateTimeOffset DatetimeExpected`

      The expected delivery datetime.

    - `string? Description`

      A description of the delivery order.

    - `IReadOnlyList<OrderLine>? OrderLines`

      The order lines in this delivery.

      - `required string ProductNumber`

        The product number.

      - `required Double Quantity`

        The quantity being delivered.

      - `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.

      - `Int LineNumber`

        The order line number.

      - `Double? PurchasePrice`

        The purchase price per unit.

      - `Int? SecondaryOrderLineNumber`

        The line number on the secondary order.

      - `string? SecondaryOrderNumber`

        A secondary/external order number.

      - `Int TargetStockPool`

        The target stock pool for the delivered goods.

    - `Int OrderType`

      The order type identifier (e.g. 1 = purchase, 2 = transfer).

    - `Int? ReasonCode`

      The reason code for the delivery.

    - `Long? 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.

  - `string? Data`

    Optional data payload returned by the operation.

  - `string? Message`

    Human-readable message describing the result.

  - `Boolean Success`

    Indicates whether the operation completed successfully.

### Example

```csharp
DeliveryCreateStoreDeliveriesParams parameters = new()
{
    StoreNumber = "store_number"
};

var response = await client.Deliveries.CreateStoreDeliveries(parameters);

Console.WriteLine(response);
```

## Create Multi Store Deliveries

`DeliveryCreateMultiStoreDeliveriesResponse Deliveries.CreateMultiStoreDeliveries(DeliveryCreateMultiStoreDeliveriesParams?parameters, CancellationTokencancellationToken = default)`

**post** `/api/v2/public/orders/deliveries`

Creates delivery orders across multiple stores.

### Parameters

- `DeliveryCreateMultiStoreDeliveriesParams parameters`

  - `IReadOnlyList<Order>? orders`

    Body param: The list of multi-store delivery orders to create.

    - `required Int? NoOfContainers`

      The number of containers.

    - `required string OrderNumber`

      The unique order number.

    - `required string StoreNumber`

      The target store number.

    - `required string SupplierName`

      The name of the supplier.

    - `DateTimeOffset? DatetimeCreated`

      The datetime the order was created.

    - `DateTimeOffset DatetimeExpected`

      The expected delivery datetime.

    - `string? Description`

      A description of the delivery order.

    - `IReadOnlyList<OrderLine>? OrderLines`

      The order lines in this delivery.

      - `required Double Quantity`

        The quantity being delivered.

      - `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.

      - `Int LineNumber`

        The order line number.

      - `string? ProductNumber`

        The product number.

      - `Int? SecondaryOrderLineNumber`

        The line number on the secondary order.

      - `string? SecondaryOrderNumber`

        A secondary/external order number.

      - `Int TargetStockPool`

        The target stock pool for the delivered goods.

    - `Int OrderType`

      The order type identifier.

    - `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.

  - `string? Data`

    Optional data payload returned by the operation.

  - `string? Message`

    Human-readable message describing the result.

  - `Boolean Success`

    Indicates whether the operation completed successfully.

### Example

```csharp
DeliveryCreateMultiStoreDeliveriesParams parameters = new();

var response = await client.Deliveries.CreateMultiStoreDeliveries(parameters);

Console.WriteLine(response);
```