Flavours API
OrderType

Update Order Type

PUT
/api/v2/orders/types/{typeKey}

Update a catalog order type's canonical name/image.

Authorization

default
AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Path Parameters

typeKey*string

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Request Body

application/json

name_en?|

Canonical order type name (English). Must not be greater than 255 characters.

name_ar?|

Canonical order type name (Arabic). Must not be greater than 255 characters.

image_url?|

Canonical uploaded image URL (custom image). Use icon_id instead to pick a catalog icon. Must be a valid URL.

icon_id?|

Canonical icon reference into the shared icon catalog (GET /v2/icons). Must match an existing stored value.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://api.flavours.sa/dev/api/v2/orders/types/eius" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Order type updated successfully."
  },
  "data": {
    "key": "UPDATE_REGISTRY",
    "market_id": null,
    "name_en": "Updated Registry Name",
    "name_ar": "تحديث السجل",
    "image_url": null,
    "created_at": 1787446697381,
    "updated_at": 1787446697383,
    "icon_id": "8254803d-1404-4a64-8dfb-01fbda0c487e"
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

List Order Types GET

List the shared order type catalog, flagged with whether the caller market has adopted each entry.

Create Order Type Config POST

Adopt an existing order type or mint a new one for the caller market. A target=PRODUCT config may carry a products[] batch of per-product charge overrides (sync/replace, keyed by modifier_id).