Skip to main content
Branches
Important: Branch records have a dependency on shops. The system validates the shop_id field against existing shops in the database. You should upload shop records before uploading branch records to ensure proper data validation.

Authentication Required

This endpoint requires API key authentication via Bearer token in the Authorization header.

About the Data API

This endpoint is part of the Cobi Data API (/v1/data/:type), which provides a consistent interface for uploading different types of structured data.

Request Body

array
required
An array of branch records (up to 5000)

Response

The API returns a JSON response with the following fields:

Error Codes

Example

Best Practices

  1. Upload Order: Upload shops before branches to ensure shop_id references exist
  2. Batch Size: Upload up to 5000 records at a time for optimal performance
  3. Data Validation: Ensure all required fields are present and properly formatted
  4. Error Handling: Implement proper error handling for failed requests
  5. Rate Limiting: Be mindful of API rate limits
Need help? Contact our support team at [email protected]