> 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/order/block-an-order.md).

# Block an order

Places a block on an order, with a free text reason. An order blocked with type DELIVER\_OUT must not be handed out to the customer - use this when the customer cannot be trusted to receive the goods, for instance because an invoice is unpaid or the credit limit is spent.

An order carries at most one blocking of each type. Blocking a type the order is already blocked with answers 409 - the blocking is already there, and its reason is changed with PUT rather than by blocking again.

Required permissions: ORDER\_BLOCKING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Order","description":"Order"}],"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"}},"responses":{"OrderBlockingResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBlockingResponseSchema"}}}}},"schemas":{"OrderBlockingResponseSchema":{"title":"OrderBlockingResponseSchema","description":"A block placed on the order, stopping one kind of work on it until it is removed.","allOf":[{"required":["orderBlockingUid","type","description"],"properties":{"orderBlockingUid":{"$ref":"#/components/schemas/UID"},"type":{"$ref":"#/components/schemas/OrderBlockingTypeENUM"},"description":{"type":"string","description":"Free text explaining why the order is blocked, shown to whoever is stopped by it. Empty when no reason was given."}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}],"type":"object"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"OrderBlockingTypeENUM":{"title":"OrderBlockingTypeENUM","enum":["DELIVER_OUT"],"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| DELIVER_OUT | The order must not be handed out to the customer|","type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}},"requestBodies":{"OrderBlockingCreateRequest":{"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/OrderBlockingTypeENUM"},"description":{"type":"string","description":"Free text explaining why the order is blocked, shown to whoever is stopped by it."}}}}},"description":"Blocks the order. An order carries at most one blocking of each type, so blocking a type the order is already blocked with answers 409."}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/blockings":{"post":{"summary":"Block an order","tags":["Order"],"responses":{"201":{"$ref":"#/components/responses/OrderBlockingResponse"},"409":{"description":"The order is already blocked with this type. Change the reason on the existing blocking with PUT instead."}},"operationId":"post-orders-blockings","description":"Places a block on an order, with a free text reason. An order blocked with type DELIVER_OUT must not be handed out to the customer - use this when the customer cannot be trusted to receive the goods, for instance because an invoice is unpaid or the credit limit is spent.\n\nAn order carries at most one blocking of each type. Blocking a type the order is already blocked with answers 409 - the blocking is already there, and its reason is changed with PUT rather than by blocking again.\n\nRequired permissions: ORDER_BLOCKING","requestBody":{"$ref":"#/components/requestBodies/OrderBlockingCreateRequest"}}}}}
```


---

# 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/order/block-an-order.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.