The Item Variant Settings object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

do_not_update_variants boolean

Default: false

allow_rename_attribute_value boolean

Default: false

allow_different_uom boolean

Default: false

The Item Variant Settings object 
{
  "id": "item-variant-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "do_not_update_variants": false,
  "allow_rename_attribute_value": false,
  "allow_different_uom": false
}
GET /api/stock/item-variant-settings

Retrieve item variant settings

Retrieves the current item variant settings. This is a singleton resource.

Returns

Returns the item variant settings object.

GET /api/stock/item-variant-settings 
curl https://api.overplane.dev/api/stock/item-variant-settings \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "item-variant-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "do_not_update_variants": false,
  "allow_rename_attribute_value": false,
  "allow_different_uom": false
}
PATCH /api/stock/item-variant-settings/{id}

Update a item variant settings

Updates the specified item variant settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the item variant settings to update.

Body parameters

do_not_update_variants boolean

Default: false

allow_rename_attribute_value boolean

Default: false

allow_different_uom boolean

Default: false

Returns

Returns the updated item variant settings object.

PATCH /api/stock/item-variant-settings/{id} 
curl https://api.overplane.dev/api/stock/item-variant-settings/item-variant-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"do_not_update_variants":false,"allow_rename_attribute_value":false}'
Response 
{
  "id": "item-variant-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "do_not_update_variants": false,
  "allow_rename_attribute_value": false,
  "allow_different_uom": false
}

Line items

Child objects that belong to this item variant settings. These are accessed via the parent's ID.

Variant Field

Attributes

idx integer
item_variant_settings_id string required
field_name string required

Endpoints

GET /api/stock/variant-field?parent_id={id}
POST /api/stock/variant-field
PATCH /api/stock/variant-field/{id}
DELETE /api/stock/variant-field/{id}
POST /api/stock/variant-field/reorder
Variant Field object 
{
  "id": "variant-field_abc123",
  "idx": 1,
  "item_variant_settings_id": "item_variant_settings_id_example",
  "field_name": "field_name_example"
}