Solid Commerce Docs
PUT/v1/inventory/rules/periods/{id}

PUT /v1/inventory/rules/periods/{id}

Scopes: inventory:seasonal_factors:write

Requires scope: inventory:seasonal_factors:write.

Parameters

NameInTypeRequiredDescription
idpathinteger<int32>yes

Request body

FieldTypeRequiredDescription
namestringno
start_datestringno
end_datestringno
factor_valuenumber<double>no
period_typestringno

Response (200)

FieldTypeRequiredDescription
idinteger<int32>no
namestringno
start_datestringno
end_datestringno
factor_valuenumber<double>no
period_typestringno

Examples

import { SolidCommerceClient } from '@solidcommerce/sdk';

const client = new SolidCommerceClient({
  apiKey: process.env.SOLIDCOMMERCE_API_KEY!,
});

const { data, error } = await client.raw.PUT('/v1/inventory/rules/periods/{id}', {
  // params: { path: { id: '...' }, query: { limit: 25 } },
  // body: { /* request body */ },
});

if (error) throw error;
console.log(data);