Search for deliveries

Search for order deliveries.

fromDateTime and toDateTime can be set to null. If both fields have value null, only order deliveries with no deliveryDate is fetched.

post

/tenants/{tenantUid}/deliveries/search

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Body

fromDateTimestring · date-time · nullableOptional

toDateTimestring · date-time · nullableOptional

storeUidsstring[]Required

querystringOptional

Responses

200

Example response

application/json

post/tenants/{tenantUid}/deliveries/search

POST /v2/tenants/{tenantUid}/deliveries/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "fromDateTime": "2026-01-01T00:00:00.000Z",
  "toDateTime": "2026-01-01T00:00:00.000Z",
  "deliveryStates": [
    "NOT_DELIVERED"
  ],
  "storeUids": [
    "text"
  ],
  "query": "text",
  "deliveryProviders": [
    {
      "uid": "text",
      "deliveryProviderMethodUids": [
        "text"
      ]
    }
  ],
  "orderSettleStates": [
    "NOT_STARTED"
  ],
  "orderOrderStates": [
    "OPEN"
  ]
}

200

Example response

{
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "deliveryUid": "text",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "signature": "text",
      "note": "text",
      "deliveryAddress": {
        "address": "text",
        "city": "text",
        "companyName": "text",
        "countryCode": "text",
        "email": "text",
        "mobile": "text",
        "firstname": "text",
        "lastname": "text",
        "postalCode": "text",
        "displayName": "text",
        "customerAddressUid": "text"
      },
      "deliveryState": "NOT_DELIVERED",
      "deliveryDate": "2026-01-01",
      "externalDeliveryReference": "text",
      "trackingNumber": "text",
      "deliveryProviderUid": "text",
      "deliveryProviderMethodUid": "text",
      "items": [
        {
          "deliveryItemUid": "text",
          "quantityDelivered": 1,
          "serialnumber": "text",
          "sku": "text",
          "warehouseUid": "text",
          "warehouseName": "text",
          "tenantUserUid": "text",
          "tenantUserDisplayName": "text"
        }
      ],
      "order": {
        "orderUid": "text",
        "orderNumber": "text",
        "settleState": "NOT_STARTED",
        "voucherNumber": "text",
        "storeUid": "text",
        "storeName": "text",
        "orderItems": [
          {
            "actions": [
              {
                "comment": "text",
                "createdAt": "2026-01-01T00:00:00.000Z",
                "createdBy": "text",
                "handlingActionUid": "text",
                "handlingActionName": "text",
                "handlingDescription": "text",
                "handlingUid": "text",
                "handlingName": "text",
                "lastModifiedAt": "2026-01-01T00:00:00.000Z",
                "lastModifiedBy": "text",
                "orderHandlingActionUid": "text"
              }
            ],
            "allowedActions": [
              "QUANTITY_SOLD"
            ],
            "createdAt": "2026-01-01T00:00:00.000Z",
            "discountReasonCode": "text",
            "externalId": "text",
            "externalOrderLinks": [
              {
                "orderId": "text",
                "orderNumber": "text",
                "orderItemId": "text",
                "system": "text",
                "type": "CREDIT"
              }
            ],
            "itemCost": 1,
            "itemDiscountAmount": 1,
            "itemDiscountPercentage": 1,
            "itemGrossProfitAmount": 1,
            "itemGrossProfitPercentage": 1,
            "itemPrice": 1,
            "itemVatAmount": 1,
            "lastModifiedAt": "2026-01-01T00:00:00.000Z",
            "ledgerNumber": "text",
            "name": "text",
            "note": "text",
            "orderItemReference": "text",
            "orderItemUid": "text",
            "orderLinks": [
              {
                "orderUid": "text",
                "orderItemUid": "text",
                "orderNumber": "text",
                "storeUid": "text",
                "type": "CREDIT"
              }
            ],
            "originalItemPrice": 1,
            "productUid": "text",
            "productType": "STOCK",
            "properties": [
              {
                "uid": "text",
                "key": "text",
                "value": "text"
              }
            ],
            "quantityCredited": 1,
            "quantityDelivered": 1,
            "quantityOrdered": 1,
            "quantityReserved": 1,
            "returnReasonCode": "text",
            "returnReference": "text",
            "serialnumber": "text",
            "sku": "text",
            "sortOrder": 1,
            "tenantUserDisplayName": "text",
            "tenantUserUid": "text",
            "totalCost": 1,
            "totalDiscountAmount": 1,
            "totalGrossProfitAmount": 1,
            "totalPrice": 1,
            "totalVatAmount": 1,
            "vatCodeUid": "text",
            "warehouseUid": "text",
            "warehouseName": "text",
            "internalInfo": "text",
            "productProperties": [
              {
                "productPropertyUid": "text",
                "propertyName": "text",
                "propertyOptionName": "text",
                "propertyType": "TEXT",
                "propertyText": "text",
                "propertyUid": "text",
                "propertyOptionUid": "text",
                "required": true
              }
            ],
            "coverImage": {
              "productMediaUid": "text",
              "mainUrl": "text",
              "thumbnailUrl": "text"
            },
            "deliveryUid": "text",
            "compensationReasonCode": "text",
            "orderReceiptUid": "text",
            "allowDelivery": "YES",
            "allowDeliveryFromDate": "2026-01-01T00:00:00.000Z",
            "reservationType": "NONE",
            "reservationDetails": {
              "warehouse": {
                "warehouseName": "text"
              },
              "purchaseOrder": {
                "purchaseOrderUid": "text",
                "purchaseOrderItemUid": "text",
                "expectedDeliveryDate": "2026-01-01T00:00:00.000Z",
                "purchaseOrderNumber": "text",
                "quantityOrdered": 1,
                "externalId": "text"
              },
              "receivement": {
                "receivementUid": "text",
                "receivementItemUid": "text",
                "expectedArrival": "2026-01-01T00:00:00.000Z",
                "expectedDispatch": "2026-01-01T00:00:00.000Z",
                "quantity": 1,
                "supplierOrderReference": "text",
                "receivedAt": "2026-01-01T00:00:00.000Z"
              },
              "interStorePurchaseOrder": {
                "storeUid": "text",
                "storeName": "text",
                "purchaseOrderUid": "text",
                "purchaseOrderNumber": "text",
                "purchaseOrderItemUid": "text"
              },
              "interStorePurchaseOrderReceivement": {
                "receivementUid": "text",
                "receivementItemUid": "text",
                "expectedArrival": "2026-01-01T00:00:00.000Z",
                "expectedDispatch": "2026-01-01T00:00:00.000Z",
                "quantity": 1,
                "supplierOrderReference": "text",
                "receivedAt": "2026-01-01T00:00:00.000Z"
              }
            },
            "interStoreOrderReservationQuantity": 1,
            "gtins": [
              {
                "gtin": "text",
                "primary": true,
                "type": "text"
              }
            ],
            "usesVatMarginScheme": true
          }
        ]
      },
      "timeslot": {
        "deliveryProviderMethodTimeslotUid": "text",
        "name": "text"
      }
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}