---
title: "POST /api/v1.0/{appId}/fulfillment/configuration/states"
method: POST
path: "/api/v1.0/{appId}/fulfillment/configuration/states"
tags: ["FulfillmentStateConfiguration"]
---

# POST /api/v1.0/{appId}/fulfillment/configuration/states

`POST /api/v1.0/{appId}/fulfillment/configuration/states`

## Request

- Base URL: `https://api.flipdish.co`
- URL: `https://api.flipdish.co/api/v1.0/{appId}/fulfillment/configuration/states`
- Auth: OAuth 2 (implicit, authorization URL `https://api.flipdish.co/identity/connect/authorize`, scopes: `api`)

## Path parameters

- `appId` string, required

## Request body

- CreateFulfillmentStatesConfiguration: Create fulfillment states configuration
  - `StoreIds` integer[]: Stores id's
  - `StoreSelectorType` 'None' | 'Single' | 'Multiple': Store Selector Type
  - `States` FulfillmentStatusConfigurationItem[]: Settings
    - `StatusId` string: Status Id (no whitespaces)
    - `StatusName` string: Status name
    - `Enabled` boolean: Is status enabled
    - `DisplayName` string: The short status string that is displayed to users in apps, portal. If empty then Order Status Name is displayed instead
    - `Icon` string: Icon/Image that represents that status visual
    - `PublicDescription` string: A string which could be used in notification templates with a placeholder (SMS, email, push, web page with status)
    - `Internal` boolean: Is internal state (internal states not shown to customers)
    - `NextStatuses` string[]: list of statuses that this status can move to (can be back or forth)
    - `DefaultNextStatus` NextStatusWithOrderType[]: The default next status (on a dropdown or quick button on terminal or portal)
      - `OrderType` 'All' | 'Delivery' | 'Collection' | 'DineIn': Order type
      - `NextStatus` string: Next status id
    - `ChangeType` 'Manual' | 'Automated' | 'Integrated': How will state change (manually or automated, including timed)
    - `IncludeInReports` boolean: Include in reports
    - `IsCustom` boolean: Is custom state. If not, then it's a system state
    - `OrderTypes` string[]: If empty then applies to all ordertypes, otherwise a list of order types this state applies to
    - `Communication` boolean: Whether state should fire off a notification to the customer
    - `Image` string: Image (image filename, relative, not absolute URL)
  - `AutomaticTransitionsEnabled` boolean, nullable: Enable automatic transitions
  - `Name` string: Name

## Response `200`

OK

- RestApiResultFulfillmentStatesConfiguration: Rest api result
  - `Data` FulfillmentStatesConfiguration, required: Fulfillment States Configuration
    - `States` FulfillmentStatusConfigurationItem[]: States
      - `StatusId` string: Status Id (no whitespaces)
      - `StatusName` string: Status name
      - `Enabled` boolean: Is status enabled
      - `DisplayName` string: The short status string that is displayed to users in apps, portal. If empty then Order Status Name is displayed instead
      - `Icon` string: Icon/Image that represents that status visual
      - `PublicDescription` string: A string which could be used in notification templates with a placeholder (SMS, email, push, web page with status)
      - `Internal` boolean: Is internal state (internal states not shown to customers)
      - `NextStatuses` string[]: list of statuses that this status can move to (can be back or forth)
      - `DefaultNextStatus` NextStatusWithOrderType[]: The default next status (on a dropdown or quick button on terminal or portal)
        - `OrderType` 'All' | 'Delivery' | 'Collection' | 'DineIn': Order type
        - `NextStatus` string: Next status id
      - `ChangeType` 'Manual' | 'Automated' | 'Integrated': How will state change (manually or automated, including timed)
      - `IncludeInReports` boolean: Include in reports
      - `IsCustom` boolean: Is custom state. If not, then it's a system state
      - `OrderTypes` string[]: If empty then applies to all ordertypes, otherwise a list of order types this state applies to
      - `Communication` boolean: Whether state should fire off a notification to the customer
      - `Image` string: Image (image filename, relative, not absolute URL)
    - `AutomaticTransitionsEnabled` boolean, nullable: Enable automatic transitions
    - `AppId` string: AppId
    - `ConfigurationUid` string: Configuration Uid
    - `StoreSelectorType` 'None' | 'Single' | 'Multiple': Store Selector Type
    - `StoreIds` integer[]: Store Ids
    - `Name` string: Name

## Other responses

- `400`: BadRequest
- `401`: Authentication has been denied for this request.
- `403`: Successful authentication, but authorization has been denied for this request.
- `404`: NotFound

---

[API](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/revisions/4d8c2b9e1c13?raw)