SizeCharts
The Size Chart service manages size chart data and template configurations for the Fynd Platform catalog.
Manage the per-application size-to-size mapping table used to render cross-country size comparisons on the storefront.
Operations
PUT
# Update default country comparison config.
GET
# Get default country comparison config.
FDK Method Name: updateDefaultCountryComparisonConfig
Upsert the singleton default country-comparison config. Replaces the sizes[] array wholesale on every call. Idempotent.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
sizes
array of object (DefaultCountryComparisonSizeRow)
Required
Full replacement array. Anything not in this list is removed.
Array of DefaultCountryComparisonSizeRow
priority
integer
| value >= 1
Required
Row sort key. Positive integer, unique within sizes[].
uni
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Config upserted successfully.
DefaultCountryComparisonConfig
_id
string
config_key
string
Singleton sentinel — always 'default_country_comparison'.
sizes
array of object (DefaultCountryComparisonSizeRow)
Array of DefaultCountryComparisonSizeRow
priority
integer
| value >= 1
Row sort key. Positive integer, unique within sizes[].
uni
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
PUT
Response
Update default country comparison config.
updateDefaultCountryComparisonConfig
FDK Method Name: getDefaultCountryComparisonConfig
Fetch the singleton default country-comparison config. Returns null when no config has been created yet.
Parameters
company_id
integer
Required
Unique identifier of the company.
Response
200
Existing config doc, or null when none has been created.
DefaultCountryComparisonConfig
_id
string
config_key
string
Singleton sentinel — always 'default_country_comparison'.
sizes
array of object (DefaultCountryComparisonSizeRow)
Array of DefaultCountryComparisonSizeRow
priority
integer
| value >= 1
Row sort key. Positive integer, unique within sizes[].
uni
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
Get default country comparison config.
getDefaultCountryComparisonConfig
Manage size recommendation opt-out controls and order history retention configuration per category.
Operations
PUT
# Update recommendation settings.
GET
# Get recommendation settings.
GET
# Resolve whether recommendations run for a product.
FDK Method Name: updateRecommendationConfig
Update the singleton recommendation settings. The update is partial — only the fields present in the body change, everything else keeps its stored value — and the document is created on first write. Two of these fields gate the storefront endpoints: `enabled` is a hard kill switch, and `allowlist` restricts which category/brand combinations are served. An empty allowlist means unrestricted.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
enabled
boolean
Master switch.
advance_gate_enabled
boolean
Require brand and universal size mappings on a recommendation.
allowlist
array of object (RecommendationAllowlistEntry)
Replaces the stored allowlist wholesale. Duplicate combinations are collapsed.
Array of RecommendationAllowlistEntry
category_uid
integer
Required
L3 category UID this entry allows.
brand_uid
integer
Nullable
Brand UID this entry is pinned to, or null for every brand in the category.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
fit_attribute_keys
array of string
Replaces the stored keys. Must contain at least one non-empty key.
tips_attribute_key
string
Must be a non-empty string.
order_lookback_months
integer
| value >= 1
Must be a positive integer.
return_window_days
integer
| value >= 0
Must be a non-negative integer.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Settings saved. Returns the whole document after the update.
RecommendationConfig
_id
string
MongoDB ObjectId. Absent until the document is first written.
config_key
string
Always "global" - this is a single-document collection.
enabled
boolean
Master switch. When false nothing is served, whatever the allowlist says.
advance_gate_enabled
boolean
When true a recommendation is withheld unless it carries both the brand and universal size mappings. Defaults to true.
allowlist
array of object (RecommendationAllowlistEntry)
Category/brand combinations recommendations are served for. An empty list is unrestricted, so a fresh install serves everything.
Array of RecommendationAllowlistEntry
category_uid
integer
L3 category UID this entry allows.
brand_uid
integer
Nullable
Brand UID this entry is pinned to, or null for every brand in the category.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
fit_attribute_keys
array of string
Ordered attribute keys the order-history ingest reads a fit type from. The first key present on the payload wins, so order matters.
tips_attribute_key
string
Attribute key the order-history ingest reads the fit tip from.
order_lookback_months
integer
| value >= 1
How many months of order history to consider. Defaults to 2.
return_window_days
integer
| value >= 0
Recent days of orders to ignore, so an order still inside its return window cannot drive a recommendation. Defaults to 7.
created_by
string
Nullable
User ID of the operator who first wrote the settings.
updated_by
string
Nullable
User ID of the operator who last updated the settings.
created_at
string
| date-time
When the settings document was first written.
updated_at
string
| date-time
When the settings document was last updated.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
PUT
Response
Update recommendation settings.
updateRecommendationConfig
FDK Method Name: getRecommendationConfig
Read the singleton recommendation settings. When nothing has been written yet this returns the in-code defaults — recommendations on, advance gate on, empty allowlist — rather than a 404, so callers always get a usable config. The audit fields are absent in that case.
Parameters
company_id
integer
Required
Unique identifier of the company.
Response
200
The stored settings, or the defaults when none are stored.
RecommendationConfig
_id
string
MongoDB ObjectId. Absent until the document is first written.
config_key
string
Always "global" - this is a single-document collection.
enabled
boolean
Master switch. When false nothing is served, whatever the allowlist says.
advance_gate_enabled
boolean
When true a recommendation is withheld unless it carries both the brand and universal size mappings. Defaults to true.
allowlist
array of object (RecommendationAllowlistEntry)
Category/brand combinations recommendations are served for. An empty list is unrestricted, so a fresh install serves everything.
Array of RecommendationAllowlistEntry
category_uid
integer
L3 category UID this entry allows.
brand_uid
integer
Nullable
Brand UID this entry is pinned to, or null for every brand in the category.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
fit_attribute_keys
array of string
Ordered attribute keys the order-history ingest reads a fit type from. The first key present on the payload wins, so order matters.
tips_attribute_key
string
Attribute key the order-history ingest reads the fit tip from.
order_lookback_months
integer
| value >= 1
How many months of order history to consider. Defaults to 2.
return_window_days
integer
| value >= 0
Recent days of orders to ignore, so an order still inside its return window cannot drive a recommendation. Defaults to 7.
created_by
string
Nullable
User ID of the operator who first wrote the settings.
updated_by
string
Nullable
User ID of the operator who last updated the settings.
created_at
string
| date-time
When the settings document was first written.
updated_at
string
| date-time
When the settings document was last updated.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
Get recommendation settings.
getRecommendationConfig
FDK Method Name: resolveRecommendationConfig
Probe the gate for one product without running a recommendation: report whether recommendations would be served for a category/brand pair, and why. Precedence is the master switch first, then the allowlist. The storefront endpoints call this same logic in-process; this route exists so the admin panel can explain the current configuration.
Parameters
company_id
integer
Required
Unique identifier of the company.
category_uid
integer
Category UID to test against the allowlist. Omit to test the master switch alone.
brand_uid
integer
Brand UID to test against the allowlist. Omit to match only the brand-wildcard entries.
Response
200
400
The gate decision for this product.
RecommendationResolution
enabled
boolean
Whether recommendations would be served for this product.
reason
string
Why the gate decided as it did.
- `enabled` - the product passed both checks.
- `master_disabled` - the master switch is off; the allowlist was never consulted.
- `not_allowlisted` - the master switch is on, but this category/brand pair is not allowed.
Enum
config
object (RecommendationConfig)
RecommendationConfig
_id
string
MongoDB ObjectId. Absent until the document is first written.
config_key
string
Always "global" - this is a single-document collection.
enabled
boolean
Master switch. When false nothing is served, whatever the allowlist says.
advance_gate_enabled
boolean
When true a recommendation is withheld unless it carries both the brand and universal size mappings. Defaults to true.
allowlist
array of object (RecommendationAllowlistEntry)
Category/brand combinations recommendations are served for. An empty list is unrestricted, so a fresh install serves everything.
Array of RecommendationAllowlistEntry
category_uid
integer
L3 category UID this entry allows.
brand_uid
integer
Nullable
Brand UID this entry is pinned to, or null for every brand in the category.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
fit_attribute_keys
array of string
Ordered attribute keys the order-history ingest reads a fit type from. The first key present on the payload wins, so order matters.
tips_attribute_key
string
Attribute key the order-history ingest reads the fit tip from.
order_lookback_months
integer
| value >= 1
How many months of order history to consider. Defaults to 2.
return_window_days
integer
| value >= 0
Recent days of orders to ignore, so an order still inside its return window cannot drive a recommendation. Defaults to 7.
created_by
string
Nullable
User ID of the operator who first wrote the settings.
updated_by
string
Nullable
User ID of the operator who last updated the settings.
created_at
string
| date-time
When the settings document was first written.
updated_at
string
| date-time
When the settings document was last updated.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category_uid:
7
brand_uid:
42
Was this section helpful?
GET
Response
Resolve whether recommendations run for a product.
resolveRecommendationConfig
Manage size chart data records including manual entry, bulk upload, bulk delete, and individual record CRUD operations.
Operations
POST
# Create size chart data record.
POST
# Create or update an item-code size chart.
GET
# List size chart data records.
GET
# Get form schema for a category.
GET
# Get measurement type configs for a category.
GET
# Get fit type configs for a category.
GET
# Get attribute configs for a category.
POST
# Download bulk upload template.
GET
# Validate bulk upload template columns.
POST
# Submit bulk upload job.
GET
# List bulk jobs for size chart data.
GET
# Get bulk job error file.
GET
# Get bulk job status.
POST
# Download bulk delete template.
POST
# Submit bulk delete job.
GET
# Get size chart data record.
PATCH
# Update size chart data record.
DEL
# Delete size chart data record.
FDK Method Name: createSizeChartDataManual
Create or upsert a size chart data record via the manual form flow.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
item_code
string
Nullable
Required if brand_slug + category_l3 not provided.
brand_slug
string
Nullable
Required with category_l3 if item_code not provided.
brand_uid
integer
Required
category_l3
string
Nullable
Required with brand_slug if item_code not provided.
category_uid
integer
Required
gender
string
Nullable
Required when item_code is provided.
vendor_code
string
Nullable
measurement_type
string
Required
Enum
fit_type
string
Required
is_active
boolean
tooltip_text
string
Nullable
tooltip_title
string
Nullable
measurement_unit
string
Nullable
size_guide_measurement_unit
string
Nullable
sizes
array of object (SizeEntry)
Required
Array of size entries. Required and must not be empty. Max 500.
Array of SizeEntry
size_name
string
Required
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Size chart record created or updated successfully.
SizeChartDataRow
_id
string
MongoDB ObjectId.
company_id
integer
item_code
string
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
category_l3
string
Nullable
category_uid
integer
Nullable
gender
string
Nullable
vendor_code
string
Nullable
measurement_type
string
fit_type
string
is_active
boolean
Default Value : true
source
string
Enum
current_brand
string
Nullable
tooltip_text
string
Nullable
tooltip_title
string
Nullable
measurement_unit
string
Nullable
size_guide_measurement_unit
string
Nullable
size_header
string
Nullable
category_name
string
Nullable
brand_name
string
Nullable
description
string
Nullable
sizes
array of object (SizeEntry)
Array of SizeEntry
size_name
string
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create size chart data record.
createSizeChartDataManual
FDK Method Name: upsertSizeChartByItemCode
Create or update a size chart scoped to a single item_code. The chart is addressed by company_id + item_code + gender + fit_type + measurement_type, so changing any of those four body fields addresses a different chart. One call carries one size object, which is appended to the chart's sizes array -- or replaces the stored entry of the same size_name -- after which the whole array is re-ordered and re-prioritised using the semantic size ranking. brand_uid and category_uid are resolved from the item_code's product record and cannot be set by the caller. Measurement attributes, the category's measurement type config and the category's fit type config are created on demand.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
item_code
string
Required
Item code the chart belongs to. Must resolve to a product; that product supplies brand_uid and category_uid.
category_slug
string
Required
Category L3 slug, stored on the record as category_l3. Scopes the attribute, measurement type and fit type configs that are looked up and created. Not validated against the catalog.
brand_slug
string
Required
Brand slug, stored as-is. Not validated against the catalog.
measurement_type
string
Required
Measurement type. The display name is also accepted, and casing, spaces and hyphens are normalised, so "Body Measurement" and "body-MEASUREMENT" both resolve to body_measurement.
Enum
fit_type
string
Required
Fit type, from the platform fit type master list (for example regular, slim_fit, oversized). The display name is also accepted and normalised the same way as measurement_type.
gender
string
Required
Gender or segment the chart applies to. Matched case-insensitively against the configured list and stored in canonical casing.
size
object (SizeEntry)
Required
SizeEntry
size_name
string
Required
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
attributes
object
Measurement attribute name to value, merged flat into this one size entry. Keys are normalised to lowercase with spaces and hyphens collapsed to underscores ("Waist Size" becomes waist_size), and an attribute config is created for the category if one does not exist.
meta
object (SizeChartMeta)
SizeChartMeta
vendor_code
string
Nullable
Vendor code the chart belongs to.
current_brand
string
Nullable
Brand the chart is currently attributed to.
tooltip_text
string
Nullable
Body text of the size guide tooltip.
tooltip_title
string
Nullable
Title of the size guide tooltip.
measurement_unit
string
Nullable
Unit the measurements are expressed in.
size_guide_measurement_unit
string
Nullable
Unit shown on the storefront size guide.
size_header
string
Nullable
Heading rendered above the size table.
category_name
string
Nullable
Display name of the category.
brand_name
string
Nullable
Display name of the brand.
vendor_name
string
Nullable
Display name of the vendor.
image_based_size_chart
string
Nullable
Flag indicating the chart is rendered from an image rather than a table.
size_chart_image_url
string
Nullable
CDN URL of the size chart image.
brand_logo_url
string
Nullable
CDN URL of the brand logo shown alongside the chart.
pdp_tooltip_title
string
Nullable
Tooltip title shown on the product detail page.
default_other_country_comparison
string
Nullable
Country key used when comparing against an unlisted country.
description
string
Nullable
Free-text description of the chart.
is_active
boolean
Whether the chart is served on the storefront. Defaults to true on create. The strings "no" and "false" (any casing) are also accepted and coerced to false; any other string coerces to true.
tips
string
Nullable
Measuring tips shown with the chart.
how_to_measure_imageurl_1
string
Nullable
CDN URL of the first how-to-measure illustration.
how_to_measure_imageurl_2
string
Nullable
CDN URL of the second how-to-measure illustration.
show_tool_tip
string
Nullable
Flag controlling whether the tooltip is rendered.
size_chart_tooltip
string
Nullable
Tooltip text specific to the size chart widget.
model_size
string
Nullable
Size worn by the model in the product imagery.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
409
Size chart created or updated successfully.
SizeChartItemCodeUpsertResult
created
boolean
True when this call inserted the chart, false when it updated an existing one.
size_chart
object (SizeChartDataRow)
SizeChartDataRow
_id
string
MongoDB ObjectId.
company_id
integer
item_code
string
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
category_l3
string
Nullable
category_uid
integer
Nullable
gender
string
Nullable
vendor_code
string
Nullable
measurement_type
string
fit_type
string
is_active
boolean
Default Value : true
source
string
Enum
current_brand
string
Nullable
tooltip_text
string
Nullable
tooltip_title
string
Nullable
measurement_unit
string
Nullable
size_guide_measurement_unit
string
Nullable
size_header
string
Nullable
category_name
string
Nullable
brand_name
string
Nullable
description
string
Nullable
sizes
array of object (SizeEntry)
Array of SizeEntry
size_name
string
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_configs
object (SizeChartCreatedConfigs)
SizeChartCreatedConfigs
attributes
array of string
Attribute config names created by this call. Empty when every attribute in the payload already existed for the category.
measurement_type
boolean
Whether a measurement type config was created for the category.
fit_type
boolean
Whether the fit type was added to the category's fit type config.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
ignored_meta_keys
array of string
Keys sent in meta that the data model has no field for. Not an error -- inspect this to catch typos and unsupported fields.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create or update an item-code size chart.
upsertSizeChartByItemCode
FDK Method Name: listSizeChartData
List size chart data records with optional filters (paginated).
Parameters
company_id
integer
Required
Unique identifier of the company.
item_code
string
Filter by item code.
brand_slug
string
Filter by brand slug.
category_l3
string
Filter by category L3 slug.
is_active
boolean
Filter by active status.
page
integer
Page number. Default is 1.
Default Value : 1
limit
integer
Items per page. Default is 10.
Default Value : 10
Response
200
Paginated list of size chart data records.
PaginatedSizeChartDataRows
items
array of object (SizeChartDataRow)
Array of SizeChartDataRow
_id
string
MongoDB ObjectId.
company_id
integer
item_code
string
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
category_l3
string
Nullable
category_uid
integer
Nullable
gender
string
Nullable
vendor_code
string
Nullable
measurement_type
string
fit_type
string
is_active
boolean
Default Value : true
source
string
Enum
current_brand
string
Nullable
tooltip_text
string
Nullable
tooltip_title
string
Nullable
measurement_unit
string
Nullable
size_guide_measurement_unit
string
Nullable
size_header
string
Nullable
category_name
string
Nullable
brand_name
string
Nullable
description
string
Nullable
sizes
array of object (SizeEntry)
Array of SizeEntry
size_name
string
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
integer
Current page number.
total
integer
Total number of matching records.
total_pages
integer
Total number of pages.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
brand_slug:
"only"
category_l3:
"830316017"
is_active:
true
page:
1
limit:
10
Was this section helpful?
GET
Response
List size chart data records.
listSizeChartData
FDK Method Name: getSizeChartDataFormSchema
Return UI-compatible form field metadata for a given category slug.
Parameters
company_id
integer
Required
Unique identifier of the company.
category
string
Required
Category L3 slug (required).
Response
200
400
Form schema sections and fields for the category.
FormSchema
category
string
attributes
array of object (AttributeConfig)
Array of AttributeConfig
_id
string
name
string
Attribute machine name (e.g. "chest").
display_name
string
Human-readable label.
unit
string
Nullable
Unit of measurement (e.g. "cm").
gender
string
Nullable
Gender/segment this attribute config applies to.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
sections
array of object (FormSection)
Array of FormSection
key
string
label
string
fields
array of object (FormField)
Array of FormField
key
string
label
string
type
string
Enum
required
boolean
hint
string
Nullable
options
array of object (FormFieldOption)
Nullable
Array of FormFieldOption
label
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category:
"830316017"
Was this section helpful?
GET
Response
Get form schema for a category.
getSizeChartDataFormSchema
FDK Method Name: getSizeChartDataMeasurementTypeConfigs
List measurement type configs for a given category L3 slug.
Parameters
company_id
integer
Required
Unique identifier of the company.
category
string
Required
Category L3 slug (required).
Response
200
400
Measurement type configs for the category.
Properties
category
string
measurement_types
array of object
Array of Properties
measurement_type
string
priority
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category:
"830316017"
Was this section helpful?
GET
Response
Get measurement type configs for a category.
getSizeChartDataMeasurementTypeConfigs
FDK Method Name: getSizeChartDataFitTypeConfigs
List fit type configs for a given category L3 slug.
Parameters
company_id
integer
Required
Unique identifier of the company.
category
string
Required
Category L3 slug (required).
Response
200
400
Fit type configs for the category.
Properties
category
string
fit_types
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category:
"830316017"
Was this section helpful?
GET
Response
Get fit type configs for a category.
getSizeChartDataFitTypeConfigs
FDK Method Name: getSizeChartDataAttributeConfigs
List attribute configs for a given category L3 slug.
Parameters
company_id
integer
Required
Unique identifier of the company.
category
string
Required
Category L3 slug (required).
gender
string
Required
Gender/segment (required). Matched case-insensitively against the configured gender list - Men, Women, Boys, Girls, Infants, Tech, Home & Kitchen, Toys & Baby Care, Beauty - and echoed back in its canonical casing. Attribute configs are scoped per category and gender, so this is not optional.
Response
200
400
Attribute configs for the category and gender.
Properties
category
string
gender
string
attributes
array of object (AttributeConfig)
Array of AttributeConfig
_id
string
name
string
Attribute machine name (e.g. "chest").
display_name
string
Human-readable label.
unit
string
Nullable
Unit of measurement (e.g. "cm").
gender
string
Nullable
Gender/segment this attribute config applies to.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category:
"830316017"
gender:
"Men"
Was this section helpful?
GET
Response
Get attribute configs for a category.
getSizeChartDataAttributeConfigs
FDK Method Name: downloadSizeChartDataBulkTemplate
Generate and download a sample bulk upload template (xlsx or csv) with dynamic measurement columns for the given category.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
category
string
Required
Category L3 slug.
category_uid
integer
L3 category UID. Required by the size-chart-data bulk template endpoint to resolve measurement and fit-type configs. Not required by the template-configs bulk template endpoint.
format
string
File format. Default is xlsx.
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Template file as binary attachment.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Download bulk upload template.
downloadSizeChartDataBulkTemplate
FDK Method Name: validateSizeChartDataBulkTemplate
Return the expected template columns for a category without generating a file.
Parameters
company_id
integer
Required
Unique identifier of the company.
category
string
Required
Category L3 slug (required).
Response
200
400
Expected template columns for the category.
Properties
data
object
Properties
category
string
columns
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category:
"830316017"
Was this section helpful?
GET
Response
Validate bulk upload template columns.
validateSizeChartDataBulkTemplate
FDK Method Name: submitSizeChartDataBulkUpload
Submit a bulk upload job. The uploaded file is processed asynchronously.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
file_url
string
Required
CDN URL of the uploaded file.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Bulk upload job queued successfully.
BulkJobSubmission
job_id
string
UUID of the created job.
status
string
Enum
message
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Submit bulk upload job.
submitSizeChartDataBulkUpload
FDK Method Name: listSizeChartDataBulkJobs
List bulk upload/delete jobs for the company (paginated, filterable).
Parameters
company_id
integer
Required
Unique identifier of the company.
status
string
Filter by job status. Use "all" for no filter.
Enum
action
string
Filter by action type.
Enum
sort_order
string
Sort order for created_at. Default is desc.
Enum
start_date
string
| date
Filter jobs created on or after this date (ISO 8601).
end_date
string
| date
Filter jobs created on or before this date (ISO 8601).
search
string
Partial or full job_id search.
page
integer
Page number. Default is 1.
Default Value : 1
limit
integer
Items per page. Default 10, max 100.
Default Value : 10
Response
200
Paginated list of bulk jobs.
PaginatedBulkJobs
items
array of object (BulkJob)
Array of BulkJob
_id
string
MongoDB ObjectId.
job_id
string
UUID identifier for this job.
bullmq_job_id
string
Nullable
BullMQ internal job ID.
company_id
integer
action
string
Enum
file_url
string
status
string
Enum
progress
integer
Nullable
Processing progress percentage (0-100).
total
integer
Nullable
Total rows in the file.
success
integer
Nullable
Number of successfully processed rows.
failures
integer
Nullable
Number of failed rows.
errors_truncated
boolean
Nullable
True if error list was truncated due to size limits.
error_file_url
string
Nullable
CDN URL for the error report CSV (set after processing).
error_message
string
Nullable
Top-level error message if the job itself failed.
created_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (BulkJobsPage)
BulkJobsPage
type
string
Always "number".
current
integer
size
integer
has_previous
boolean
has_next
boolean
item_total
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
status:
"all"
action:
"upload"
sort_order:
"desc"
start_date:
"2025-01-01"
end_date:
"2025-12-31"
page:
1
limit:
10
Was this section helpful?
GET
Response
List bulk jobs for size chart data.
listSizeChartDataBulkJobs
FDK Method Name: getSizeChartDataBulkJobErrorFile
Download or redirect to the error report for a bulk job. Returns 302 redirect when the error file has been uploaded to CDN; returns 200 with inline CSV otherwise.
Parameters
company_id
integer
Required
Unique identifier of the company.
job_id
string
Required
UUID of the bulk job.
Response
200
404
Inline CSV error report when CDN URL is not available.
Examples
Parameters
company_id:
1
job_id:
"660e8400-e29b-41d4-a716-446655440007"
Was this section helpful?
GET
Response
Get bulk job error file.
getSizeChartDataBulkJobErrorFile
FDK Method Name: getSizeChartDataBulkJobStatus
Get the status and details of a bulk upload or delete job.
Parameters
company_id
integer
Required
Unique identifier of the company.
job_id
string
Required
UUID of the bulk job.
Response
200
404
Bulk job details.
BulkJob
_id
string
MongoDB ObjectId.
job_id
string
UUID identifier for this job.
bullmq_job_id
string
Nullable
BullMQ internal job ID.
company_id
integer
action
string
Enum
file_url
string
status
string
Enum
progress
integer
Nullable
Processing progress percentage (0-100).
total
integer
Nullable
Total rows in the file.
success
integer
Nullable
Number of successfully processed rows.
failures
integer
Nullable
Number of failed rows.
errors_truncated
boolean
Nullable
True if error list was truncated due to size limits.
error_file_url
string
Nullable
CDN URL for the error report CSV (set after processing).
error_message
string
Nullable
Top-level error message if the job itself failed.
created_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
job_id:
"660e8400-e29b-41d4-a716-446655440002"
Was this section helpful?
GET
Response
Get bulk job status.
getSizeChartDataBulkJobStatus
FDK Method Name: downloadSizeChartDataBulkDeleteTemplate
Generate and download a sample template for bulk deletion (xlsx or csv).
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
format
string
File format. Default is xlsx.
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
Bulk delete template file as binary attachment.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Download bulk delete template.
downloadSizeChartDataBulkDeleteTemplate
FDK Method Name: submitSizeChartDataBulkDelete
Submit a bulk delete job. The uploaded file is processed asynchronously.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
file_url
string
Required
CDN URL of the uploaded file.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Bulk delete job queued successfully.
BulkJobSubmission
job_id
string
UUID of the created job.
status
string
Enum
message
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Submit bulk delete job.
submitSizeChartDataBulkDelete
FDK Method Name: getSizeChartDataRecord
Fetch a single size chart data record by its MongoDB ID.
Parameters
company_id
integer
Required
Unique identifier of the company.
record_id
string
Required
MongoDB _id of the size chart data record.
Response
200
404
Size chart data record.
SizeChartDataRow
_id
string
MongoDB ObjectId.
company_id
integer
item_code
string
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
category_l3
string
Nullable
category_uid
integer
Nullable
gender
string
Nullable
vendor_code
string
Nullable
measurement_type
string
fit_type
string
is_active
boolean
Default Value : true
source
string
Enum
current_brand
string
Nullable
tooltip_text
string
Nullable
tooltip_title
string
Nullable
measurement_unit
string
Nullable
size_guide_measurement_unit
string
Nullable
size_header
string
Nullable
category_name
string
Nullable
brand_name
string
Nullable
description
string
Nullable
sizes
array of object (SizeEntry)
Array of SizeEntry
size_name
string
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
record_id:
"665f1a2b3c4d5e6f7a8b9c0d"
Was this section helpful?
GET
Response
Get size chart data record.
getSizeChartDataRecord
FDK Method Name: updateSizeChartDataRecord
Update fields on an existing size chart data record. Supports replacing the sizes array, or adding/updating/removing a single size entry.
Parameters
company_id
integer
Required
Unique identifier of the company.
record_id
string
Required
MongoDB _id of the size chart data record.
Request body
item_code
string
Nullable
brand_slug
string
Nullable
category_l3
string
Nullable
gender
string
Nullable
vendor_code
string
Nullable
measurement_type
string
Enum
fit_type
string
is_active
boolean
sizes
array of object (SizeEntry)
Full replacement of the sizes array.
Array of SizeEntry
size_name
string
Required
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
add_size
object (SizeEntry)
Append a single size entry.
SizeEntry
size_name
string
Required
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
update_size
object (SizeEntry)
Update an existing size entry matched by size_name.
SizeEntry
size_name
string
Required
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
remove_size
string
oneOf Schema from below
Properties
size_name
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
404
Updated size chart data record.
SizeChartDataRow
_id
string
MongoDB ObjectId.
company_id
integer
item_code
string
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
category_l3
string
Nullable
category_uid
integer
Nullable
gender
string
Nullable
vendor_code
string
Nullable
measurement_type
string
fit_type
string
is_active
boolean
Default Value : true
source
string
Enum
current_brand
string
Nullable
tooltip_text
string
Nullable
tooltip_title
string
Nullable
measurement_unit
string
Nullable
size_guide_measurement_unit
string
Nullable
size_header
string
Nullable
category_name
string
Nullable
brand_name
string
Nullable
description
string
Nullable
sizes
array of object (SizeEntry)
Array of SizeEntry
size_name
string
Name of the size (e.g. "S", "M", "32").
priority
integer
| value >= 1
Display priority (positive integer). Default is 1.
brand_size_attribute
string
Nullable
Brand size value (e.g. "10", "M"). The actual size label as the brand declares it.
brand_size_format
string
Nullable
Format/system the brand_size_attribute is expressed in (e.g. "UK"). Renamed from brand_size_format_attribute in the post-migration schema; the value already names the format so the _attribute suffix was redundant.
universal_size_attribute
string
Nullable
uk
string
Nullable
us
string
Nullable
eu
string
Nullable
aus
string
Nullable
ca
string
Nullable
br
string
Nullable
mx
string
Nullable
tur
string
Nullable
sa
string
Nullable
ae
string
Nullable
default_other_country
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
record_id:
"665f1a2b3c4d5e6f7a8b9c0d"
body:
body
Was this section helpful?
PATCH
Response
Update size chart data record.
updateSizeChartDataRecord
FDK Method Name: deleteSizeChartDataRecord
Delete a size chart data record by its MongoDB ID.
Parameters
company_id
integer
Required
Unique identifier of the company.
record_id
string
Required
MongoDB _id of the size chart data record.
Response
200
404
Record deleted successfully.
Properties
message
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
record_id:
"665f1a2b3c4d5e6f7a8b9c11"
Was this section helpful?
DEL
Response
Delete size chart data record.
deleteSizeChartDataRecord
Manage size chart template configurations including creation, listing, bulk operations, and individual config CRUD.
Operations
POST
# Create template config.
GET
# List template configs.
GET
# Validate template config bulk upload columns.
POST
# Download template config bulk upload template.
PUT
# Bulk update template config status.
DEL
# Bulk delete template configs.
POST
# Submit template config bulk upload job.
GET
# List template config bulk jobs.
GET
# Get template config bulk job error file.
GET
# Get template config bulk job status.
DEL
# Cancel template config bulk job.
GET
# Get template config by ID.
PUT
# Update template config.
DEL
# Delete template config.
FDK Method Name: createSizeChartTemplateConfig
Create a new size chart template configuration.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
category_l3
string
Required
category_uid
integer
Required
brand_slug
string
Nullable
brand_uid
integer
Nullable
gender
string
Required
Gender/segment for this template config. Must be one of the values in the configured GENDER_VALUES list (env-configurable, e.g. "Men", "Women", "Boys", "Girls", "Infants", "Tech", "Home & Kitchen", "Toys & Baby Care", "Beauty"). Participates in the uniqueness key alongside category_l3, brand, vendor_code, and measurement_type.
vendor_code
string
Nullable
measurement_type
string
Required
Enum
is_active
boolean
Default Value : true
size_display
string
Enum
attribute_sequences
array of string
country_sequences
array of string
Ordered list of country/region codes for international size comparison.
brand_sequences
array of string
Ordered list of brand slugs for cross-brand size comparison.
other_attributes
array of string
Catch-all list of unmapped attribute names.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
201
400
409
Template config created successfully.
SizeChartTemplateConfig
_id
string
MongoDB ObjectId.
company_id
integer
category_l3
string
category_uid
integer
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
gender
string
Nullable
Gender/segment this template applies to. Must be one of the values in the configured GENDER_VALUES list (e.g. "Men", "Women", "Boys", "Girls", "Infants", "Tech", "Home & Kitchen", "Toys & Baby Care", "Beauty"). The exact list is environment-configurable, so this is intentionally not an OpenAPI enum.
vendor_code
string
Nullable
measurement_type
string
Enum
is_active
boolean
Default Value : true
size_display
string
Enum
attribute_sequences
array of string
Ordered list of attribute names for this template.
country_sequences
array of string
Ordered list of country/region codes (e.g. in, uk, eu) used for international size comparison display.
brand_sequences
array of string
Ordered list of brand slugs used to render cross-brand size comparison.
other_attributes
array of string
Catch-all list of unmapped attribute names that do not belong to any standard sequence.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create template config.
createSizeChartTemplateConfig
FDK Method Name: listSizeChartTemplateConfigs
List size chart template configurations with optional filters (paginated).
Parameters
company_id
integer
Required
Unique identifier of the company.
category_l3
string
Filter by category L3 slug.
brand_slug
string
Filter by brand slug.
gender
string
Filter by gender/segment value (case-sensitive match against the configured GENDER_VALUES list, e.g. "Men", "Women", "Boys").
measurement_type
string
Filter by measurement type.
Enum
is_active
boolean
Filter by active status.
page
integer
Page number. Default is 1.
Default Value : 1
limit
integer
Items per page. Default is 10.
Default Value : 10
Response
200
Paginated list of template configs.
PaginatedTemplateConfigs
items
array of object (SizeChartTemplateConfig)
Array of SizeChartTemplateConfig
_id
string
MongoDB ObjectId.
company_id
integer
category_l3
string
category_uid
integer
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
gender
string
Nullable
Gender/segment this template applies to. Must be one of the values in the configured GENDER_VALUES list (e.g. "Men", "Women", "Boys", "Girls", "Infants", "Tech", "Home & Kitchen", "Toys & Baby Care", "Beauty"). The exact list is environment-configurable, so this is intentionally not an OpenAPI enum.
vendor_code
string
Nullable
measurement_type
string
Enum
is_active
boolean
Default Value : true
size_display
string
Enum
attribute_sequences
array of string
Ordered list of attribute names for this template.
country_sequences
array of string
Ordered list of country/region codes (e.g. in, uk, eu) used for international size comparison display.
brand_sequences
array of string
Ordered list of brand slugs used to render cross-brand size comparison.
other_attributes
array of string
Catch-all list of unmapped attribute names that do not belong to any standard sequence.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
integer
total
integer
total_pages
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category_l3:
"830316017"
brand_slug:
"only"
gender:
"Men"
measurement_type:
"body_measurement"
is_active:
true
page:
1
limit:
10
Was this section helpful?
GET
Response
List template configs.
listSizeChartTemplateConfigs
FDK Method Name: validateSizeChartTemplateConfigBulkTemplate
Return expected columns and allowed values for a category without generating a file.
Parameters
company_id
integer
Required
Unique identifier of the company.
category
string
Required
Category L3 slug (required).
Response
200
400
Expected template columns and category config.
Properties
data
object
Properties
category
string
columns
array of string
genders
array of string
Allowed gender/segment values (from the configured GENDER_VALUES list). Used by the bulk upload template as the dropdown source for the `gender` column.
measurement_types
array of string
attributes
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
category:
"830316017"
Was this section helpful?
GET
Response
Validate template config bulk upload columns.
validateSizeChartTemplateConfigBulkTemplate
FDK Method Name: downloadSizeChartTemplateConfigBulkTemplate
Generate and download a sample template for bulk template config upload (xlsx or csv) with category-specific measurement types prefilled.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
category
string
Required
Category L3 slug.
category_uid
integer
L3 category UID. Required by the size-chart-data bulk template endpoint to resolve measurement and fit-type configs. Not required by the template-configs bulk template endpoint.
format
string
File format. Default is xlsx.
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Template file as binary attachment.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Download template config bulk upload template.
downloadSizeChartTemplateConfigBulkTemplate
FDK Method Name: bulkUpdateSizeChartTemplateConfigStatus
Bulk activate or deactivate multiple template configs by their IDs.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
ids
array of string
Required
Array of MongoDB _ids.
is_active
boolean
Required
New active status to apply to all listed configs.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Number of modified records.
Properties
modified_count
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
PUT
Response
Bulk update template config status.
bulkUpdateSizeChartTemplateConfigStatus
FDK Method Name: bulkDeleteSizeChartTemplateConfigs
Bulk delete multiple template configs by their IDs.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
ids
array of string
Required
Array of MongoDB _ids.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Number of deleted records.
Properties
deleted_count
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
DEL
Response
Bulk delete template configs.
bulkDeleteSizeChartTemplateConfigs
FDK Method Name: submitSizeChartTemplateConfigBulkUpload
Submit a bulk template config upload job. The file is processed asynchronously.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
file_url
string
Required
CDN URL of the uploaded file.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
202
400
Template config bulk upload job accepted.
BulkJobSubmission
job_id
string
UUID of the created job.
status
string
Enum
message
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Submit template config bulk upload job.
submitSizeChartTemplateConfigBulkUpload
FDK Method Name: listSizeChartTemplateConfigBulkJobs
List template config bulk upload jobs for the company (paginated, filterable).
Parameters
company_id
integer
Required
Unique identifier of the company.
status
string
Filter by job status.
Enum
sort_order
string
Sort order for created_at. Default is desc.
Enum
start_date
string
| date
Filter jobs created on or after this date (ISO 8601).
end_date
string
| date
Filter jobs created on or before this date (ISO 8601).
search
string
Partial or full job_id search.
page
integer
Page number. Default is 1.
Default Value : 1
limit
integer
Items per page. Default 10, max 100.
Default Value : 10
Response
200
Paginated list of template config bulk jobs.
PaginatedBulkJobs
items
array of object (BulkJob)
Array of BulkJob
_id
string
MongoDB ObjectId.
job_id
string
UUID identifier for this job.
bullmq_job_id
string
Nullable
BullMQ internal job ID.
company_id
integer
action
string
Enum
file_url
string
status
string
Enum
progress
integer
Nullable
Processing progress percentage (0-100).
total
integer
Nullable
Total rows in the file.
success
integer
Nullable
Number of successfully processed rows.
failures
integer
Nullable
Number of failed rows.
errors_truncated
boolean
Nullable
True if error list was truncated due to size limits.
error_file_url
string
Nullable
CDN URL for the error report CSV (set after processing).
error_message
string
Nullable
Top-level error message if the job itself failed.
created_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (BulkJobsPage)
BulkJobsPage
type
string
Always "number".
current
integer
size
integer
has_previous
boolean
has_next
boolean
item_total
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
status:
"all"
sort_order:
"desc"
start_date:
"2025-01-01"
end_date:
"2025-12-31"
page:
1
limit:
10
Was this section helpful?
GET
Response
List template config bulk jobs.
listSizeChartTemplateConfigBulkJobs
FDK Method Name: getSizeChartTemplateConfigBulkJobErrorFile
Download or redirect to the error report for a template config bulk job. Returns 302 redirect when the error file has been uploaded to CDN; returns 200 with inline CSV otherwise.
Parameters
company_id
integer
Required
Unique identifier of the company.
job_id
string
Required
UUID of the bulk job.
Response
200
404
Inline CSV error report when CDN URL is not available.
Examples
Parameters
company_id:
1
job_id:
"660e8400-e29b-41d4-a716-446655440008"
Was this section helpful?
GET
Response
Get template config bulk job error file.
getSizeChartTemplateConfigBulkJobErrorFile
FDK Method Name: getSizeChartTemplateConfigBulkJobStatus
Get the status and details of a template config bulk upload job.
Parameters
company_id
integer
Required
Unique identifier of the company.
job_id
string
Required
UUID of the bulk job.
Response
200
404
Template config bulk job details.
BulkJob
_id
string
MongoDB ObjectId.
job_id
string
UUID identifier for this job.
bullmq_job_id
string
Nullable
BullMQ internal job ID.
company_id
integer
action
string
Enum
file_url
string
status
string
Enum
progress
integer
Nullable
Processing progress percentage (0-100).
total
integer
Nullable
Total rows in the file.
success
integer
Nullable
Number of successfully processed rows.
failures
integer
Nullable
Number of failed rows.
errors_truncated
boolean
Nullable
True if error list was truncated due to size limits.
error_file_url
string
Nullable
CDN URL for the error report CSV (set after processing).
error_message
string
Nullable
Top-level error message if the job itself failed.
created_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
job_id:
"660e8400-e29b-41d4-a716-446655440004"
Was this section helpful?
GET
Response
Get template config bulk job status.
getSizeChartTemplateConfigBulkJobStatus
FDK Method Name: cancelSizeChartTemplateConfigBulkJob
Cancel a queued or processing template config bulk upload job.
Parameters
company_id
integer
Required
Unique identifier of the company.
job_id
string
Required
UUID of the bulk job to cancel.
Response
200
400
404
Job cancelled successfully.
Properties
job_id
string
status
string
message
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
job_id:
"660e8400-e29b-41d4-a716-446655440006"
Was this section helpful?
DEL
Response
Cancel template config bulk job.
cancelSizeChartTemplateConfigBulkJob
FDK Method Name: getSizeChartTemplateConfigById
Get a single template config by its MongoDB ID.
Parameters
company_id
integer
Required
Unique identifier of the company.
id
string
Required
MongoDB _id of the template config.
Response
200
404
Template config document.
SizeChartTemplateConfig
_id
string
MongoDB ObjectId.
company_id
integer
category_l3
string
category_uid
integer
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
gender
string
Nullable
Gender/segment this template applies to. Must be one of the values in the configured GENDER_VALUES list (e.g. "Men", "Women", "Boys", "Girls", "Infants", "Tech", "Home & Kitchen", "Toys & Baby Care", "Beauty"). The exact list is environment-configurable, so this is intentionally not an OpenAPI enum.
vendor_code
string
Nullable
measurement_type
string
Enum
is_active
boolean
Default Value : true
size_display
string
Enum
attribute_sequences
array of string
Ordered list of attribute names for this template.
country_sequences
array of string
Ordered list of country/region codes (e.g. in, uk, eu) used for international size comparison display.
brand_sequences
array of string
Ordered list of brand slugs used to render cross-brand size comparison.
other_attributes
array of string
Catch-all list of unmapped attribute names that do not belong to any standard sequence.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
id:
"665f1a2b3c4d5e6f7a8b9c0e"
Was this section helpful?
GET
Response
Get template config by ID.
getSizeChartTemplateConfigById
FDK Method Name: updateSizeChartTemplateConfig
Update fields on an existing template config.
Parameters
company_id
integer
Required
Unique identifier of the company.
id
string
Required
MongoDB _id of the template config.
Request body
category_l3
string
brand_slug
string
Nullable
gender
string
Nullable
Gender/segment. Must be one of the values in the configured GENDER_VALUES list. Env-configurable, so intentionally not an OpenAPI enum.
vendor_code
string
Nullable
measurement_type
string
Enum
is_active
boolean
size_display
string
Enum
attribute_sequences
array of string
country_sequences
array of string
Ordered list of country/region codes for international size comparison.
brand_sequences
array of string
Ordered list of brand slugs for cross-brand size comparison.
other_attributes
array of string
Catch-all list of unmapped attribute names.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
404
Updated template config document.
SizeChartTemplateConfig
_id
string
MongoDB ObjectId.
company_id
integer
category_l3
string
category_uid
integer
Nullable
brand_slug
string
Nullable
brand_uid
integer
Nullable
gender
string
Nullable
Gender/segment this template applies to. Must be one of the values in the configured GENDER_VALUES list (e.g. "Men", "Women", "Boys", "Girls", "Infants", "Tech", "Home & Kitchen", "Toys & Baby Care", "Beauty"). The exact list is environment-configurable, so this is intentionally not an OpenAPI enum.
vendor_code
string
Nullable
measurement_type
string
Enum
is_active
boolean
Default Value : true
size_display
string
Enum
attribute_sequences
array of string
Ordered list of attribute names for this template.
country_sequences
array of string
Ordered list of country/region codes (e.g. in, uk, eu) used for international size comparison display.
brand_sequences
array of string
Ordered list of brand slugs used to render cross-brand size comparison.
other_attributes
array of string
Catch-all list of unmapped attribute names that do not belong to any standard sequence.
created_by
string
Nullable
updated_by
string
Nullable
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
id:
"665f1a2b3c4d5e6f7a8b9c0e"
body:
body
Was this section helpful?
PUT
Response
Update template config.
updateSizeChartTemplateConfig
FDK Method Name: deleteSizeChartTemplateConfig
Delete a template config by its MongoDB ID.
Parameters
company_id
integer
Required
Unique identifier of the company.
id
string
Required
MongoDB _id of the template config.
Response
200
404
Template config deleted successfully.
Properties
message
string
id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
id:
"665f1a2b3c4d5e6f7a8b9c0f"
Was this section helpful?
DEL
Response