Error codes

The HLC API returns structured error codes with descriptive messages to facilitate debugging and error handling. Use these codes to implement user-friendly error messages and automated retry logic.

Error Code Categories

Error codes are prefixed by category:

• SYS: System and authentication errors
• ACC: Account and user management errors
• ORD: Order processing and fulfillment errors
• PMT: Payment and transaction errors
• CAT: Catalog and product errors

Error Code Reference

System Errors

Account Errors

Order Errors

Payment Errors

Catalog Errors

Implementation Example

Client-Side Error Mapping

const errorMessages = {
  SYS0001:
    'Your API key is invalid or has expired. Please check your credentials.',
  ORD0010:
    'Insufficient inventory available. Please reduce quantity or try again later.',
  PMT0001: 'Payment declined. Please try a different payment method.',
  PMT0006: 'Insufficient funds. Please use a different payment method.',
  ORD0003: 'Doorstep delivery is not available for your account.',
}

function getUserMessage(errorCode) {
  return (
    errorMessages[errorCode] ??
    'An unexpected error occurred. Please try again or contact support.'
  )
}

// Usage in error handling
try {
  const response = await fetch(`${apiUrl}/Orders/Create/Fulfillment`, {
    method: 'POST',
    headers: {
      ApiKey: apiKey,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(orderData),
  })

  if (!response.ok) {
    const error = await response.json()
    throw new Error(getUserMessage(error.code))
  }

  const order = await response.json()
} catch (error) {
  console.error('Order creation failed:', error.message)
  // Display error.message to user
}