Get Order Variables

Retrieve payment and shipping method lists

GET /orders/variables

Get Order Variables

cURL

curl --request GET \
  --url https://www.xn--dkkango-n2a.com/api/integrations/orders/variables \
  --header 'Access-Token: <api-key>'

200

{
  "status": true,
  "data": {
    "paymentMethod": [
      {
        "key": "<string>",
        "name": "<string>"
      }
    ],
    "shippingMethod": [
      {
        "key": "<string>",
        "name": "<string>"
      }
    ]
  }
}

Overview

Returns the available payment methods and shipping methods used in the system.

Headers

Access-Token · string · required

Your API access token

Response

status · boolean

true if successful

data · object

Object containing payment and shipping method arrays

Show Response Structure

paymentMethod · array

Available payment methods

Show Payment Method Object

key · string

Payment method key (e.g., “CASH”, “CREDIT_CARD”)

name · string

Display name (e.g., “Nakit”, “Kredi Kartı”)

shippingMethod · array

Available shipping methods

Show Shipping Method Object

key · string

Shipping method key (e.g., “delivery”, “pickup”)

name · string

Display name (e.g., “Teslimat”, “Gel Al”)

Examples

cURL

curl -X GET https://www.xn--dkkango-n2a.com/api/integrations/orders/variables \
  -H 'Access-Token: your-access-token'

Success Response (200)

{
  "status": true,
  "data": {
    "paymentMethod": [
      {
        "key": "CASH",
        "name": "Nakit"
      },
      {
        "key": "CREDIT_CARD",
        "name": "Kredi Kartı"
      },
      {
        "key": "DEBIT_CARD",
        "name": "Banka Kartı"
      }
    ],
    "shippingMethod": [
      {
        "key": "delivery",
        "name": "Teslimat"
      },
      {
        "key": "pickup",
        "name": "Gel Al"
      }
    ]
  }
}

Error Response (401)

{
  "status": false,
  "error": "yetkisiz erişim"
}

Use Cases

Initialize POS

Fetch and cache variables when POS starts.

async function initializePOS() {
  const variables = await getOrderVariables();
  
  // Store in local cache
  localStorage.setItem('paymentMethods', 
    JSON.stringify(variables.paymentMethod));
  localStorage.setItem('shippingMethods', 
    JSON.stringify(variables.shippingMethod));
  
  console.log('POS initialized with order variables');
}

Display Order Details

Map payment/shipping keys to display names.

function formatOrderDetails(order) {
  const paymentMethods = getPaymentMethods();
  const shippingMethods = getShippingMethods();
  
  const paymentName = paymentMethods.find(
    p => p.key === order.payment_type
  )?.name || order.payment_type;
  
  const shippingName = shippingMethods.find(
    s => s.key === order.shipping_method
  )?.name || order.shipping_method;
  
  return {
    ...order,
    paymentMethodName: paymentName,
    shippingMethodName: shippingName
  };
}

Build Filters

Create dropdown filters in POS interface.

async function buildOrderFilters() {
  const variables = await getOrderVariables();
  
  // Payment filter
  const paymentFilter = variables.paymentMethod.map(pm => ({
    value: pm.key,
    label: pm.name
  }));
  
  // Shipping filter
  const shippingFilter = variables.shippingMethod.map(sm => ({
    value: sm.key,
    label: sm.name
  }));
  
  renderFilters(paymentFilter, shippingFilter);
}

Validation

Validate incoming order data.

function validateOrderVariables(order) {
  const variables = getCachedVariables();
  
  const validPayment = variables.paymentMethod.some(
    p => p.key === order.payment_type
  );
  
  const validShipping = variables.shippingMethod.some(
    s => s.key === order.shipping_method
  );
  
  if (!validPayment || !validShipping) {
    throw new Error('Invalid payment or shipping method');
  }
}

Caching Strategy

These values rarely change. Cache them locally to avoid unnecessary API calls.

class VariablesCache {
  constructor() {
    this.cache = null;
    this.lastFetch = null;
    this.cacheDuration = 24 * 60 * 60 * 1000; // 24 hours
  }
  
  async getVariables() {
    const now = Date.now();
    
    // Return cached if recent
    if (this.cache && (now - this.lastFetch) < this.cacheDuration) {
      return this.cache;
    }
    
    // Fetch fresh
    const response = await fetch('/orders/variables');
    this.cache = await response.json();
    this.lastFetch = now;
    
    return this.cache;
  }
  
  invalidate() {
    this.cache = null;
    this.lastFetch = null;
  }
}

Payment Methods

Key	Name	Description
CASH	Nakit	Cash payment on delivery
CREDIT_CARD	Kredi Kartı	Credit card (pre-paid)
DEBIT_CARD	Banka Kartı	Debit card (pre-paid)

Shipping Methods

Key	Name	Description
delivery	Teslimat	Home/office delivery
pickup	Gel Al	Customer pickup from restaurant

Related Endpoints

Get Current Orders

Orders use these payment/shipping methods

Get Cancel Reasons

Another variables endpoint