Skip to main content
Important: The branch model has a dependency on the shop model. The shop_id field must reference an existing shop in the system. It’s recommended to upload shop data before uploading branch data.

Schema

Field Descriptions

Required Fields

Optional Fields

Example

Best Practices

  1. UUID Format: Use valid UUID v4 format for branch_id and shop_id
  2. Data Dependencies: Ensure shop_id references an existing shop
  3. Region Codes: Use ISO 3166-1 alpha-2 country codes (e.g., “CA” for Canada, “US” for United States)
  4. Coordinates: When providing latitude and longitude, ensure they are valid geographic coordinates
  5. Data Consistency: Ensure consistent data across all branch records
Need help? Contact our support team at [email protected]