Validate terminal basket

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.enjovia.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Enjovia API MCP server": {
    "url": "https://docs.enjovia.com/mcp"
  }
}

POST /terminal/basket/validate

Bearer auth

Validates and calculates pricing for a terminal basket. Returns the basket with calculated prices, taxes, and discounts. With draft: true the basket is stored as a draft (is_valid: false): per-product shipping may be omitted (shipping that is present is still validated in full) and stock reservations are not touched. Stock is only reserved on a full (non-draft) validate. Requires process_offline_payments, process_card_payments, or process_test_orders permission Setting stock_override: true additionally requires manage_account or manage_catalogue permission.

Headers

Store-Subdomain string Required

Store subdomain for store-specific operations

application/json

Body Required

store_eni string Required

Store ENI (Entity Number Identifier)
customer_id string Required

Customer identifier

Maximum length is 191.
draft boolean

Store the basket as a draft (is_valid: false) — per-product shipping may be omitted and stock reservations are not touched
stock_override boolean

Bypass stock validation and allow overselling. Requires manage_account or manage_catalogue permission
data object Required
Hide data attributes Show data attributes object
- products array[object] Required
  Hide products attributes Show products attributes object
  
  id string(uuid) Required
  
  Product UUID
  
  eni string Required
  
  Product ENI
  
  image_url string Required
  
  Product image URL
  
  message string | null
  
  Gift message
  
  Maximum length is 191.
  
  recipient_name string | null
  
  Recipient name for voucher
  
  Maximum length is 60.
  
  from_name string | null
  
  Sender name for voucher
  
  Maximum length is 60.
  
  monetary_value integer
  
  Value for monetary products
  
  Minimum value is 0, maximum value is 99999999.
  
  category_id string(uuid)
  
  Category UUID (required with category_eni)
  
  category_eni string
  
  Category ENI (required with category_id)
  
  variant_id string(uuid) | null
  
  Product variant UUID
  
  addons array[object]
  
  Hide addons attributes Show addons attributes object
  
  id string(uuid) Required
  
  Addon UUID
  
  eni string Required
  
  Addon ENI
  
  staff_discount object
  
  Hide staff_discount attribute Show staff_discount attribute object
  
  discount_value integer
  
  Staff discount amount
  
  Minimum value is 0, maximum value is 99999999.
  
  shipping object | null
  
  Required on a full validate; may be omitted per line when draft is true
  
  Hide shipping attributes Show shipping attributes object | null
  
  type string Required
  
  Delivery type
  
  Values are email, post, or collect.
  
  email string(email)
  
  Required if type is email
  
  packaging_option_id string(uuid)
  
  Required for post/collect
  
  delivery_method_id string(uuid)
  
  Required if type is post
  
  delivery_address object
  
  Required if type is post
  
  collection_point_id string(uuid)
  
  For collect type
  
  staff_discount object
  
  Hide staff_discount attribute Show staff_discount attribute object
  
  discount_value integer
  
  Minimum value is 0, maximum value is 99999999.
  
  staff_discount object
  
  Hide staff_discount attribute Show staff_discount attribute object
  
  discount_value integer
  
  Staff discount amount
  
  Minimum value is 0, maximum value is 99999999.
- marketing_consent boolean
  
  Customer marketing consent
- promotion object
  Hide promotion attributes Show promotion attributes object
  
  id string(uuid)
  
  Promotion UUID
  
  eni string
  
  Promotion ENI
  
  code string
  
  Promotion code

Responses

200 application/json

Validated basket with calculated prices
Hide response attribute Show response attribute object
- basket object
  
  Hide basket attributes Show basket attributes object
  
  id string(uuid)
  
  Basket UUID
  
  customer_id string
  
  Customer identifier
  
  data object
  
  Basket data with calculated prices, taxes, discounts
403

Forbidden - storefront users cannot access
422 application/json

Validation error. Basket limit errors additionally expose a stable code (basket.max_products, basket.max_addons, basket.addon_max_allowed) and its params so clients can interpolate the limits into their own copy.
Hide response attributes Show response attributes object
- message string
  
  Human-readable error message
- code string
  
  Stable error code (basket limit errors only)
- params object
  
  Values for the coded error (e.g. limit, name)
- errors object
  
  Error messages keyed by field

POST /terminal/basket/validate

curl \
 --request POST 'https://api.asia.enjovia.app/terminal/basket/validate' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "Store-Subdomain: string" \
 --data '{
  "store_eni": "STORE-2024-001",
  "customer_id": "customer-123456",
  "data": {
    "products": [
      {
        "id": "987e6543-e21b-12d3-a456-426614174000",
        "eni": "PROD-2024-001",
        "image_url": "https://example.com/product.jpg",
        "message": "Happy Birthday!",
        "recipient_name": "John Doe",
        "from_name": "Jane Smith",
        "monetary_value": 5000,
        "shipping": {
          "type": "email",
          "email": "john.doe@example.com"
        }
      },
      {
        "id": "abc12345-e89b-12d3-a456-426614174001",
        "eni": "PROD-2024-002",
        "image_url": "https://example.com/product2.jpg",
        "variant_id": "def45678-e89b-12d3-a456-426614174002",
        "addons": [
          {
            "id": "789abcde-e89b-12d3-a456-426614174003",
            "eni": "ADDON-001"
          }
        ],
        "shipping": {
          "type": "post",
          "packaging_option_id": "123e4567-e89b-12d3-a456-426614174004",
          "delivery_method_id": "456e7890-e89b-12d3-a456-426614174005",
          "delivery_address": {
            "name": "John Doe",
            "address_line_1": "123 Main St",
            "city": "New York",
            "state": "NY",
            "postal_code": "10001",
            "country": "US"
          }
        }
      }
    ],
    "marketing_consent": true,
    "promotion": {
      "id": "bcd23456-e89b-12d3-a456-426614174006",
      "eni": "PROMO-001",
      "code": "SUMMER20"
    }
  }
}'

Request example

{
  "store_eni": "STORE-2024-001",
  "customer_id": "customer-123456",
  "data": {
    "products": [
      {
        "id": "987e6543-e21b-12d3-a456-426614174000",
        "eni": "PROD-2024-001",
        "image_url": "https://example.com/product.jpg",
        "message": "Happy Birthday!",
        "recipient_name": "John Doe",
        "from_name": "Jane Smith",
        "monetary_value": 5000,
        "shipping": {
          "type": "email",
          "email": "john.doe@example.com"
        }
      },
      {
        "id": "abc12345-e89b-12d3-a456-426614174001",
        "eni": "PROD-2024-002",
        "image_url": "https://example.com/product2.jpg",
        "variant_id": "def45678-e89b-12d3-a456-426614174002",
        "addons": [
          {
            "id": "789abcde-e89b-12d3-a456-426614174003",
            "eni": "ADDON-001"
          }
        ],
        "shipping": {
          "type": "post",
          "packaging_option_id": "123e4567-e89b-12d3-a456-426614174004",
          "delivery_method_id": "456e7890-e89b-12d3-a456-426614174005",
          "delivery_address": {
            "name": "John Doe",
            "address_line_1": "123 Main St",
            "city": "New York",
            "state": "NY",
            "postal_code": "10001",
            "country": "US"
          }
        }
      }
    ],
    "marketing_consent": true,
    "promotion": {
      "id": "bcd23456-e89b-12d3-a456-426614174006",
      "eni": "PROMO-001",
      "code": "SUMMER20"
    }
  }
}

Response examples (200)

{
  "basket": {
    "id": "string",
    "customer_id": "string",
    "data": {}
  }
}

Response examples (422)

{
  "message": "A basket can have a maximum of 20 products",
  "code": "basket.max_products",
  "params": {
    "limit": 20
  },
  "errors": {
    "basket": [
      "A basket can have a maximum of 20 products"
    ]
  }
}