README

A Laravel package for interacting with the Omeda API.

Requirements

• PHP 8.3+
• Laravel 11 or 12

Installation

composer require fmasites/omeda

Configuration

Add the following to your .env file:

OMEDA_APP_ID=
OMEDA_BASE_API_URL=
OMEDA_BRAND=
OMEDA_CLIENT=
OMEDA_CLIENT_BASE_API_URL=
OMEDA_INPUT_ID=

Usage

OmedaApi

use FMASites\Omeda\OmedaApi;

$api = new OmedaApi();

You can also inject custom base URLs directly, which is useful in tests:

$api = new OmedaApi(baseApiUrl: 'https://...', clientBaseApiUrl: 'https://...');

Available methods

// Brand
$api->brandComprehensiveLookup();             // Cached for 8 hours

// Customer
$api->customerComprehensiveLookup($id);
$api->customerLookupByEmail($email);

// Orders & Transactions
$api->storeCustomerAndOrder($data);
$api->transactionLookup($transactionId);
$api->runProcessor($transactionIds);          // Utility API

// Postal
$api->postalInfoLookup($zipCode);             // Utility API

// Email
$api->emailOptinQueue($email, $deploymentTypeId, $options);

GET methods return array|false — false indicates a non-successful response (404, 300, etc.). POST methods return an Illuminate\Http\Client\Response instance.

DataAdapter

Utilities for transforming brand comprehensive lookup data:

use FMASites\Omeda\DataAdapter;

// Filter demographics down to specific type IDs
DataAdapter::filterByDemographicTypes($brandData, [1, 2, 3]);

// Simplify the full brand lookup response to a smaller structure
DataAdapter::simplifyBrandComprehensiveLookupData($brandData);

// Remove specific demographic value options by ID
DataAdapter::removeDemographicValueOptionsById($brandData, [10, 11]);

// Simplify a products array
DataAdapter::simplifyProductData($products);

Enums

The package includes enums for common Omeda constants:

Testing

composer install
./vendor/bin/phpunit