API documentation

Everything you need to integrate with the Gini v2 Third-Party API.

Store API

Branches

Create and manage your physical store branches, matching the dashboard's branches screen.

List branches

Your branches, newest first. Returns name, email, phone, business_phone, state, state_label, address, geo, is_active. Paginated.

GET /api/v2.0/third-party/branches

Signed

Get one

A single record by its numeric id. 404 if it is not yours.

GET /api/v2.0/third-party/branches/{branch}

Signed

Create

POST /api/v2.0/third-party/branches

Signed

Body parameters

Field	Type	Required	Description
`name`	string	Required	Branch name.
`email`	string	Required	Unique across all branches.
`phone`	string	Required	Iraqi number; unique across all branches (normalised).
`business_phone`	string	Required	Iraqi number; unique across all branches (normalised).
`state`	integer	Required	Delivery-network state id.
`nearest_function_point`	string	Required	Address / nearest landmark, max 500 chars.
`latitude`	number	Required	-90 to 90.
`longitude`	number	Required	-180 to 180.
`is_active`	boolean	Optional	Defaults to true.

Notes

Send the body as JSON (Content-Type: application/json) so every field is covered by the signature — a form-encoded body is signed as empty.
Phones are stored in normalised Iraqi form; a non-Iraqi number is rejected with HTTP 422.
state_label is resolved from the delivery network's state list — you send only the state id.
The branch's own login password is generated server-side and never returned.
POST /branches is idempotent — send an Idempotency-Key header.

Update

Partial — send only the fields you are changing. 404 if it is not yours.

PUT /api/v2.0/third-party/branches/{branch}

Signed

Delete

DELETE /api/v2.0/third-party/branches/{branch}

Signed