API documentation

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

Getting started API reference Store API Finance API Settings API Insights API Wholesale API Resources

Opening hours Ordering schedule Delivery settings

Settings API

Delivery settings

Read and set your fulfilment toggles and, if you deliver yourself, your per-state shipping charges — the same as the dashboard's Delivery settings screen.

Get delivery settings

GET /api/v2.0/third-party/delivery-settings

Signed

Response

{
    "data": {
        "allow_pickup": true,
        "allow_delivery": true,
        "is_self_delivery": true,
        "shipment_charges": [
            {
                "state_id": 1,
                "state": "Najaf",
                "cost": 5000
            },
            {
                "state_id": 2,
                "state": "Karbala",
                "cost": null
            }
        ]
    }
}

Notes

shipment_charges is present only when is_self_delivery is true — a carrier-bound merchant has no per-state grid.
A null cost means the state is unpriced; 0 means free delivery. The two are different.

Update delivery settings

PUT /api/v2.0/third-party/delivery-settings

Signed

Body parameters

Field	Type	Required	Description
`allow_pickup`	boolean	Required	Whether customers may pick up. Both toggles are required together.
`allow_delivery`	boolean	Required	Whether you deliver.
`shipment_charges`	array	Optional	Self-delivery only. Each row is { state_id, cost }. A blank cost leaves that state unpriced; 0 is free.
`shipment_charges.*.state_id`	integer	Optional	A valid Iraqi state id (1–18).
`shipment_charges.*.cost`	integer	Optional	IQD, whole number, 0 or more. Omit to leave the state unpriced.

Notes

Both toggles are required on every update — sending one alone is rejected.
shipment_charges from a merchant that uses a delivery company is rejected with HTTP 422.
States you do not include keep whatever charge they had; nothing is cleared.

Previous Ordering schedule Next Dashboard stats