API documentation

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

API reference

Product Add-ons

The optional extras a customer can attach to a product — the dashboard's add-ons editor. Managed per product, addressed by the product's SKU.

List a product's add-ons

Every add-on on the product, newest first. Returns name, description, price, quantity, max_quantity, is_active and image_url. Paginated.

GET /api/v2.0/third-party/products/{sku}/addons

Signed

Get one

A single add-on by its numeric id. 404 if the product or add-on is not yours.

GET /api/v2.0/third-party/products/{sku}/addons/{addon}

Signed

Create

POST /api/v2.0/third-party/products/{sku}/addons

Signed

Body parameters

Field	Type	Required	Description
`name`	string	Required	Add-on name.
`description`	string	Optional	Optional, max 1000 chars.
`price`	number	Required	Add-on price.
`quantity`	integer	Required	Available quantity.
`max_quantity`	integer	Required	Max a customer may add per order.
`is_active`	boolean	Optional	Defaults to true.
`image`	file	Optional	Optional image, jpg/jpeg/png/webp, max 5 MB (multipart).

Notes

Send JSON (Content-Type: application/json) when you are not uploading an image, so the body is covered by the signature; use multipart only to include the image.
POST is idempotent — send an Idempotency-Key header.

Update

Partial — send only the fields you are changing. Send remove_image=true to clear the image without uploading a new one.

PUT /api/v2.0/third-party/products/{sku}/addons/{addon}

Signed

Delete

An add-on that appears on an existing order cannot be deleted (HTTP 422) — its order history keeps the reference.

DELETE /api/v2.0/third-party/products/{sku}/addons/{addon}

Signed