Substitute Products API

Manage "substitute product" relationships between products — retrieve, create, update, and delete

Base URL

https://{tenant}.logzi.com/api/product_replace/

Every request returns a JSON response. On success result.code == 1, on failure result.code == 0. The substitute products API manages relationships between a product group and substitute/alternative products — product_group_id identifies the parent product group, product_id identifies the substitute product.

GET /api/product_replace/get

Retrieve a single substitute product record by ID.

Query parameters

ParameterTypeRequiredDescription
idintSubstitute product record ID

Example request

GET /api/product_replace/get?id=1
X-API-KEY: {your_api_key}
GET /api/product_replace/list

Paginated list of substitute product relationships.

Query parameters

ParameterTypeRequiredDescription
list_countintMaximum number of records to return
list_offsetintPagination offset (default: 0)
list_conditionobjectFilter conditions object — e.g. {"product_group_id": 5} or {"product_id": 12}

Available list_condition filters

FilterTypeDescription
product_group_idintFilter by parent product group ID
product_idintRetrieve all relationships for a given product

Example request

GET /api/product_replace/list?list_offset=0&list_count=100&list_condition={"product_group_id":5}
X-API-KEY: {your_api_key}
POST /api/product_replace/save

Create or update a substitute product relationship. If data.id is 0 or missing, a new record is created.

POST fields — data object

FieldTypeRequiredDescription
idintRecord ID (0 = create new)
product_idintSubstitute product ID
product_group_idintParent product group ID

Example request

POST /api/product_replace/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 0, "product_id": 42, "product_group_id": 5 } }
POST /api/product_replace/delete

Delete a substitute product relationship by ID (soft delete).

POST fields

FieldTypeRequiredDescription
idintID of the relationship to delete

Example request

POST /api/product_replace/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "id": 1 }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!