> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/receivement/receivements-search.md).

# Receivements search

Get a list of receivements in a time window of created or received date, optionally filtered on status, organization, store and warehouse.

Set accept header to application/vnd.openxmlformats-officedocument.spreadsheetml.sheet to get response as an excel file.

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Receivement","description":"Receivement"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"}},"schemas":{"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"},"ReceivementResponseSchema":{"title":"ReceivementResponseSchema","type":"object","required":["createdAt","createdBy","externalId","items","lastModifiedAt","lastModifiedBy","packingList","receivementUid","status","expectedArrival","expectedDispatch","supplierOrderReference","receivedAt","receivedBy","purchaseOrder","supplier","store","organization","warehouse","invoiceApproval"],"properties":{"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"externalId":{"description":"External reference to receivment","type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ReceivementItemResponseSchema"}},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"packingList":{"type":"string"},"purchaseOrderUid":{"$ref":"#/components/schemas/DeprecatedUID"},"receivementUid":{"$ref":"#/components/schemas/UID"},"status":{"$ref":"#/components/schemas/ReceivementStatusENUM"},"warehouseUid":{"$ref":"#/components/schemas/DeprecatedUID"},"expectedArrival":{"type":"string","format":"date-time","description":"ETA"},"expectedDispatch":{"type":"string","format":"date-time","description":"ETD"},"supplierOrderReference":{"type":"string"},"receivedAt":{"type":"string","format":"date-time","nullable":true},"receivedBy":{"$ref":"#/components/schemas/ReceivementReceivedBySchema"},"purchaseOrder":{"$ref":"#/components/schemas/PurchaseOrderRefResponseSchema"},"supplier":{"$ref":"#/components/schemas/SupplierNameResponseSchema"},"store":{"$ref":"#/components/schemas/StoreNameResponseSchema"},"organization":{"$ref":"#/components/schemas/OrganizationNameResponseSchema"},"warehouse":{"$ref":"#/components/schemas/WarehouseNameResponseSchema"},"invoiceApproval":{"$ref":"#/components/schemas/ReceivementInvoiceApprovalSchema"}}},"ReceivementItemResponseSchema":{"title":"ReceivementItemResponseSchema","type":"object","required":["createdAt","createdBy","externalId","lastModifiedAt","lastModifiedBy","product","purchaseOrderItemUid","quantity","receivementItemUid","status","note","tenantUserUid","tenantUserDisplayName","reservations"],"properties":{"createdAt":{"format":"date-time","type":"string"},"createdBy":{"type":"string"},"externalId":{"description":"External reference to receivement line","type":"string"},"lastModifiedAt":{"format":"date-time","type":"string"},"lastModifiedBy":{"type":"string"},"product":{"$ref":"#/components/schemas/ReceivementItemProductResponseSchema"},"purchaseOrderItemUid":{"$ref":"#/components/schemas/UID"},"quantity":{"type":"integer"},"unitPrice":{"type":"integer","deprecated":true,"description":"Deprecated: Use unitcost instead"},"unitCost":{"type":"integer"},"receivementItemUid":{"$ref":"#/components/schemas/UID"},"serialnumber":{"type":"string"},"status":{"type":"string"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/OptionalUID"},"tenantUserDisplayName":{"type":"string","description":"The display name of the user that made the receivement"},"reservations":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemReservationSchema"}}}},"ReceivementItemProductResponseSchema":{"title":"ReceivementItemProductResponseSchema","type":"object","required":["productUid","name","sku"],"properties":{"productUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"sku":{"type":"string"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"OrderItemReservationSchema":{"title":"OrderItemReservationSchema","type":"object","required":["orderUid","orderItemUid","orderNumber","quantity","reservationType"],"properties":{"orderUid":{"$ref":"#/components/schemas/UID"},"orderItemUid":{"$ref":"#/components/schemas/UID"},"orderNumber":{"type":"string"},"quantity":{"type":"integer"},"reservationType":{"$ref":"#/components/schemas/SalesReservationTypeENUM"}}},"SalesReservationTypeENUM":{"title":"SalesReservationTypeENUM","type":"string","enum":["NONE","WAREHOUSE","PURCHASEORDER","REQUEST_PURCHASEORDER","PURCHASEORDER_CONFIRMED"],"description":""},"DeprecatedUID":{"title":"DeprecatedUID","type":"string","pattern":"^[A-Za-z0-9-_]+","deprecated":true},"ReceivementStatusENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| RECEIVED | Received|\n| PENDING | Put aside, not finished|\n| UPDATING | Updating in progress|\n| CONFIRMED | Confirmed |","enum":["RECEIVED","PENDING","UPDATING","CONFIRMED"],"title":"ReceivementStatusENUM","type":"string"},"ReceivementReceivedBySchema":{"title":"ReceivementReceivedBySchema","type":"object","nullable":true,"description":"Who received the goods. Null when the receivement is not yet received.","required":["tenantUserUid","tenantUserDisplayName"],"properties":{"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"}}},"PurchaseOrderRefResponseSchema":{"title":"PurchaseOrderRefResponseSchema","type":"object","required":["purchaseOrderUid","purchaseNumber","externalId"],"properties":{"purchaseOrderUid":{"$ref":"#/components/schemas/UID"},"purchaseNumber":{"type":"string"},"externalId":{"type":"string","description":"External reference to the purchase order."}}},"SupplierNameResponseSchema":{"title":"SupplierNameResponseSchema","type":"object","required":["supplierUid","name"],"properties":{"supplierUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"}}},"StoreNameResponseSchema":{"title":"StoreNameResponseSchema","type":"object","required":["storeUid","name"],"properties":{"storeUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"}}},"OrganizationNameResponseSchema":{"title":"OrganizationNameResponseSchema","type":"object","required":["organizationUid","name"],"properties":{"organizationUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"}}},"WarehouseNameResponseSchema":{"title":"WarehouseNameResponseSchema","type":"object","required":["warehouseUid","name"],"properties":{"warehouseUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"}}},"ReceivementInvoiceApprovalSchema":{"title":"ReceivementInvoiceApprovalSchema","type":"object","nullable":true,"description":"Invoice-approval (fakturagodkjent) state. Null when the receivement is not invoice-approved.","required":["approvedAt","tenantUserUid","tenantUserDisplayName"],"properties":{"approvedAt":{"type":"string","format":"date-time"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"}}},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"},"DateTimeRangeSchema":{"title":"DateTimeRangeSchema","type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}},"responses":{"ReceivementListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ReceivementResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}},"description":"Example response"}},"requestBodies":{"ReceivementSearchRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"$ref":"#/components/schemas/DateTimeRangeSchema"},"receivedAt":{"$ref":"#/components/schemas/DateTimeRangeSchema"},"status":{"type":"array","items":{"$ref":"#/components/schemas/ReceivementStatusENUM"}},"organizationUids":{"type":"array","items":{"$ref":"#/components/schemas/UID"}},"storeUids":{"type":"array","items":{"$ref":"#/components/schemas/UID"}},"warehouseUids":{"type":"array","items":{"$ref":"#/components/schemas/UID"}},"supplierUids":{"type":"array","description":"Filter receivements via the linked purchase order's supplier.","items":{"$ref":"#/components/schemas/UID"}},"hasReservations":{"type":"boolean","description":"Match receivements where any item has an OrderItemReservation."},"invoiceApproved":{"type":"boolean","description":"Filter by invoice-approved (fakturagodkjent) state. Set false to return only receivements that are NOT invoice-approved."},"search":{"type":"string","description":"Free-text ILIKE across receivement.externalId, receivement.packingList, receivement.supplierOrderReference, and the linked purchase order's purchaseNumber and externalId."}}}}}}}},"paths":{"/tenants/{tenantUid}/receivements/search":{"post":{"summary":"Receivements search","tags":["Receivement"],"operationId":"receivements-search","description":"Get a list of receivements in a time window of created or received date, \noptionally filtered on status, organization, store and warehouse.\n\nSet accept header to application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\nto get response as an excel file.","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/ReceivementListResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ReceivementSearchRequest"}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/receivement/receivements-search.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.