Brightmarket Sync Guide

SDK sync

Built-in entity sync: adapter rows to Brightmarket API writes.

The SDK sync layer reads from your adapter, applies field maps and value maps from src/constants.py (mappers_from_constants), and calls writers.

Field map reference: Field maps.

Typical client wiring in src/sync_registry.py:

from brightmarket_data_sync.sync import build_default_commands, mappers_from_constants
commands = build_default_commands(mappers_from_constants(constants))

Optional adapter helper

get_pagos_by_ticket(from_date, to_date) — dict of ticket id → payment method external ids (used by ticket sync).

ClientMappers

Organization-specific lookup tables and field maps used by SDK sync.

class ClientMappers(sex_mapping: Dict[str, str] = <factory>, department_to_name: Dict[Any, str] = <factory>, department_name_to_state_id: Dict[str, int] = <factory>, country_mapping: Dict[Any, int] = <factory>, client_level_mapping: Dict[str, int] = <factory>, movement_type_mapping: Dict[str, str] = <factory>, country_id_for_resolved_state: Optional[int] = None, store_only_contact_validation: bool = False, sku_create_categories: bool = False, sku_category_separator: Optional[str] = None, client_fields: Optional[Any] = None, sku_fields: Optional[Any] = None, ticket_fields: Optional[Any] = None, payment_method_fields: Optional[Any] = None, reward_fields: Optional[Any] = None, points_movement_fields: Optional[Any] = None, points_expiration_fields: Optional[Any] = None, promotion_fields: Optional[Any] = None, stock_adjustment_fields: Optional[Any] = None) -> None

mappers_from_constants

def mappers_from_constants(constants)

No documentation.

build_default_commands

def build_default_commands(mappers=...)

No documentation.

sync_clients

def sync_clients(adapter, api, mappers=..., from_date=..., to_date=...)

No documentation.

sync_clients_created_from_rows

def sync_clients_created_from_rows(rows, api, mappers=...)

No documentation.

sync_skus

def sync_skus(adapter, api, mappers=..., from_date=..., to_date=...)

No documentation.

sync_tickets

def sync_tickets(adapter, api, mappers=..., from_date=..., to_date=..., use_file=..., generate_only=..., output_dir=...)

No documentation.

sync_payment_methods

def sync_payment_methods(adapter, api, mappers=...)

No documentation.

sync_promotions

def sync_promotions(adapter, api, mappers=..., from_date=..., to_date=...)

No documentation.

sync_rewards

def sync_rewards(adapter, api, mappers=..., from_date=..., to_date=..., output_dir=...)

No documentation.

sync_points_movements

def sync_points_movements(adapter, api, mappers=..., from_date=..., to_date=...)

No documentation.

sync_stock_adjustments

def sync_stock_adjustments(adapter, api, mappers=..., branch_office_id=...)

No documentation.

sync_stock_adjustments_from_rows

def sync_stock_adjustments_from_rows(rows, api, mappers=...)

No documentation.

On this page