Search for purchase orders

Search for purchase orders in all stores on tenant. Empty values are ignored. The query field performs a fuzzy search, i.e. looks up words that contain the supplied value. The search is case-insensitive. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", [e-mail], etc ..

post

/tenants/{tenantUid}/purchase-orders/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-timeOptionalDeprecated

Deprecated. Use createdAt.

toDateTimestring · date-timeOptionalDeprecated

Deprecated. Use createdAt.

storeUidsstring[]Optional

Reference to a list of storeUids

organizationUidsstring[]Optional

Reference to a list of organizationUids

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

querystringOptional

productUidsstring[]Optional

hasConfirmedReceivementsbooleanOptional

Responses

200

Example response

post/tenants/{tenantUid}/purchase-orders/search

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

{
  "createdAt": {
    "from": "2026-01-01T00:00:00.000Z",
    "to": "2026-01-01T00:00:00.000Z"
  },
  "orderStatuses": [
    "NEW"
  ],
  "storeUids": [
    "text"
  ],
  "organizationUids": [
    "text"
  ],
  "supplierUid": "text",
  "query": "text",
  "productUids": [
    "text"
  ],
  "hasConfirmedReceivements": true
}

200

Example response

{
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "deliveryAddress": "text",
      "deliveryCity": "text",
      "deliveryCountryCode": "text",
      "deliveryName": "text",
      "deliveryPostalCode": "text",
      "externalId": "text",
      "items": [
        {
          "createdAt": "2026-01-01T00:00:00.000Z",
          "createdBy": "text",
          "expectedDeliveryDate": "2026-01-01",
          "externalId": "text",
          "lastModifiedAt": "2026-01-01T00:00:00.000Z",
          "lastModifiedBy": "text",
          "productUid": "text",
          "productName": "text",
          "productSerialNoRequired": "NO",
          "productSku": "text",
          "purchaseOrderItemUid": "text",
          "quantityOrdered": 1,
          "quantityReceived": 1,
          "quantityReserved": 1,
          "supplierSku": "text",
          "interStoreSalesOrder": {
            "orderUid": "text",
            "orderNumber": "text",
            "orderState": "OPEN",
            "storeUid": "text",
            "storeName": "text",
            "orderItemUid": "text",
            "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"
              }
            }
          },
          "unitPrice": 1,
          "receivementItems": [
            {
              "receivementUid": "text",
              "receivementStatus": "RECEIVED",
              "invoiceApproval": {
                "approvedAt": "2026-01-01T00:00:00.000Z",
                "tenantUserUid": "text",
                "tenantUserDisplayName": "text"
              },
              "createdAt": "2026-01-01T00:00:00.000Z",
              "createdBy": "text",
              "externalId": "text",
              "lastModifiedAt": "2026-01-01T00:00:00.000Z",
              "lastModifiedBy": "text",
              "product": {
                "productUid": "text",
                "name": "text",
                "sku": "text"
              },
              "purchaseOrderItemUid": "text",
              "quantity": 1,
              "unitCost": 1,
              "receivementItemUid": "text",
              "serialnumber": "text",
              "status": "text",
              "note": "text",
              "tenantUserUid": "text",
              "tenantUserDisplayName": "text",
              "reservations": [
                {
                  "orderUid": "text",
                  "orderItemUid": "text",
                  "orderNumber": "text",
                  "quantity": 1,
                  "reservationType": "NONE"
                }
              ]
            }
          ],
          "discountAmount": 1,
          "freightAmount": 1,
          "unitCost": 1,
          "totalLinePrice": 1,
          "localCurrency": {
            "unitPrice": 1,
            "discountAmount": 1,
            "freightAmount": 1,
            "unitCost": 1,
            "totalLinePrice": 1
          },
          "reservations": [
            {
              "orderUid": "text",
              "orderItemUid": "text",
              "orderNumber": "text",
              "quantity": 1,
              "reservationType": "NONE"
            }
          ],
          "note": "text",
          "sortOrder": 1,
          "purchaseOrderItemLinks": [
            {
              "purchaseOrderItemUid": "text",
              "type": "PACKAGE"
            }
          ]
        }
      ],
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedBy": "text",
      "note": "text",
      "purchaseNumber": "text",
      "purchaseOrderUid": "text",
      "status": "NEW",
      "storeUid": "text",
      "storeName": "text",
      "supplierUid": "text",
      "supplierName": "text",
      "discountRate": 1,
      "freight": 1,
      "currency": {
        "code": "text",
        "exchangeRate": 1
      },
      "supplierReferenceNumber": "text",
      "invoiceAddress": {
        "companyName": "text",
        "address": "text",
        "postalCode": "text",
        "city": "text",
        "countryCode": "text",
        "vatNumber": "text",
        "email": "text"
      },
      "reserveAfter": "2026-01-01T00:00:00.000Z",
      "interStoreSalesOrder": {
        "orderUid": "text",
        "orderNumber": "text",
        "orderState": "OPEN",
        "storeUid": "text",
        "storeName": "text"
      },
      "hasConfirmedReceivements": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}