SizeCharts

The Size Chart service manages size chart data and template configurations for the Fynd Platform catalog.

Recommendation Configuration

Manage size recommendation opt-out controls and order history retention configuration per category.

Operations

POST

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/disable

# Disable recommendation for a category.

GET

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/disabled

# List categories with recommendation disabled.

POST

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/enable

# Re-enable recommendation for a category.

PUT

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/order-history-retention

# Set order history retention period.

GET

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/order-history-retention

# Get order history retention period.

POST

Disable recommendation for a category.

FDK Method Name: disableRecommendation

Disable size recommendations for a category (opt-out). Idempotent — calling it multiple times for the same category_uid is safe.

Requires company/size-chart/write access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

Request body

category_uid

integer

Required

L3 category UID for which to disable recommendations.

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Response

200

400

Recommendation disabled (or already disabled) for the category.

RecommendationConfig

_id

string

MongoDB ObjectId.

category_uid

integer

L3 category UID for which recommendations are disabled.

category

string

Nullable

Category L3 slug.

recommendation_disabled

boolean

Always true when this document exists.

created_by

string

Nullable

User ID of the operator who created this opt-out.

updated_by

string

Nullable

User ID of the operator who last updated this opt-out.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/disable

Response

GET

List categories with recommendation disabled.

FDK Method Name: listDisabledRecommendations

List all categories for which size recommendations have been disabled. Supports pagination and optional search by category slug.

Requires company/size-chart/read access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

page

integer

Page number. Default is 1.

Default Value : 1

limit

integer

Items per page. Default is 20.

Default Value : 20

string

Search by category slug (partial match, case-insensitive).

Response

200

Paginated list of categories with recommendations disabled.

PaginatedRecommendationConfigs

items

array of object (RecommendationConfig)

Array of RecommendationConfig

_id

string

MongoDB ObjectId.

category_uid

integer

L3 category UID for which recommendations are disabled.

category

string

Nullable

Category L3 slug.

recommendation_disabled

boolean

Always true when this document exists.

created_by

string

Nullable

User ID of the operator who created this opt-out.

updated_by

string

Nullable

User ID of the operator who last updated this opt-out.

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 opt-out 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:

page:

limit:

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/disabled

Response

POST

Re-enable recommendation for a category.

FDK Method Name: enableRecommendation

Re-enable size recommendations for a category by removing the opt-out record. Absence of a record means enabled (the default state). Idempotent.

Requires company/size-chart/write access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

Request body

category_uid

integer

Required

L3 category UID for which to re-enable recommendations.

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Response

200

400

Recommendation enabled (or was already enabled) for the category.

RecommendationEnabledResult

message

string

Human-readable confirmation. Either "Recommendation enabled successfully" or "Recommendation is already enabled for this category".

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/enable

Response

PUT

Set order history retention period.

FDK Method Name: setOrderHistoryRetention

Set the order history retention period in months. The cron job uses this value to determine how far back to keep order history when running the cleanup process. Must be a positive integer (minimum 1 month). Idempotent — subsequent calls update the existing config document.

Requires company/size-chart/write access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

Request body

retention_months

integer

| value >= 1

Required

Number of months to retain order history. Orders older than this period are removed by the cleanup cron.

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Response

200

400

Retention period saved successfully.

CronConfigData

_id

string

Nullable

MongoDB ObjectId. Null when the config has not been set yet.

config_key

string

Unique configuration key (e.g. "order_history_retention_months").

value

integer

Nullable

Configuration value. Integer months for retention config. Null if not set.

created_by

string

Nullable

User ID of the operator who created this config.

updated_by

string

Nullable

User ID of the operator who last updated this config.

created_at

string

| date-time

Nullable

updated_at

string

| date-time

Nullable

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

body:

body

Was this section helpful?

PUT

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/order-history-retention

Response

GET

Get order history retention period.

FDK Method Name: getOrderHistoryRetention

Get the current order history retention period. Returns the config document, or { config_key, value: null } when not yet configured.

Requires company/size-chart/read access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

Response

200

Current retention configuration (or default stub if not set).

CronConfigData

_id

string

Nullable

MongoDB ObjectId. Null when the config has not been set yet.

config_key

string

Unique configuration key (e.g. "order_history_retention_months").

value

integer

Nullable

Configuration value. Integer months for retention config. Null if not set.

created_by

string

Nullable

User ID of the operator who created this config.

updated_by

string

Nullable

User ID of the operator who last updated this config.

created_at

string

| date-time

Nullable

updated_at

string

| date-time

Nullable

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/recommendation-configs/order-history-retention

Response

Size Chart Data Management

Manage size chart data records including manual entry, bulk upload, bulk delete, and individual record CRUD operations.

Operations

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/manual

# Create size chart data record.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data

# List size chart data records.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/form-schema

# Get form schema for a category.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/measurement-type-configs

# Get measurement type configs for a category.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/fit-type-configs

# Get fit type configs for a category.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/attribute-configs

# Get attribute configs for a category.

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/template

# Download bulk upload template.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/validate-template

# Validate bulk upload template columns.

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/upload

# Submit bulk upload job.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/jobs

# List bulk jobs for size chart data.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/jobs/{job_id}/error-file

# Get bulk job error file.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/jobs/{job_id}

# Get bulk job status.

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/delete/template

# Download bulk delete template.

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/delete/upload

# Submit bulk delete job.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/{record_id}

# Get size chart data record.

PATCH

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/{record_id}

# Update size chart data record.

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/{record_id}

# Delete size chart data record.

POST

Create size chart data record.

FDK Method Name: createSizeChartDataManual

Create or upsert a size chart data record via the manual form flow.

Requires company/size-chart/write access scope.

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/manual

Response

GET

List size chart data records.

FDK Method Name: listSizeChartData

List size chart data records with optional filters (paginated).

Requires company/size-chart/read access scope.

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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:

brand_slug:

"only"

category_l3:

"830316017"

is_active:

true

page:

limit:

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data

Response

GET

Get form schema for a category.

FDK Method Name: getSizeChartDataFormSchema

Return UI-compatible form field metadata for a given category slug.

Requires company/size-chart/read access scope.

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").

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:

category:

"830316017"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/form-schema

Response

GET

Get measurement type configs for a category.

FDK Method Name: getSizeChartDataMeasurementTypeConfigs

List measurement type configs for a given category L3 slug.

Requires company/size-chart/read access scope.

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:

category:

"830316017"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/measurement-type-configs

Response

GET

Get fit type configs for a category.

FDK Method Name: getSizeChartDataFitTypeConfigs

List fit type configs for a given category L3 slug.

Requires company/size-chart/read access scope.

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:

category:

"830316017"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/fit-type-configs

Response

GET

Get attribute configs for a category.

FDK Method Name: getSizeChartDataAttributeConfigs

List attribute configs for a given category L3 slug.

Requires company/size-chart/read access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

category

string

Required

Category L3 slug (required).

Response

200

400

Attribute configs for the category.

Properties

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").

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:

category:

"830316017"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/attribute-configs

Response

POST

Download bulk upload template.

FDK Method Name: downloadSizeChartDataBulkTemplate

Generate and download a sample bulk upload template (xlsx or csv) with dynamic measurement columns for the given category.

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/template

Response

GET

Validate bulk upload template columns.

FDK Method Name: validateSizeChartDataBulkTemplate

Return the expected template columns for a category without generating a file.

Requires company/size-chart/read access scope.

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:

category:

"830316017"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/validate-template

Response

POST

Submit bulk upload job.

FDK Method Name: submitSizeChartDataBulkUpload

Submit a bulk upload job. The uploaded file is processed asynchronously.

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/upload

Response

GET

List bulk jobs for size chart data.

FDK Method Name: listSizeChartDataBulkJobs

List bulk upload/delete jobs for the company (paginated, filterable).

Requires company/size-chart/read access scope.

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).

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:

status:

"all"

action:

"upload"

sort_order:

"desc"

start_date:

"2025-01-01"

end_date:

"2025-12-31"

page:

limit:

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/jobs

Response

GET

Get bulk job error file.

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.

Requires company/size-chart/read access scope.

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:

job_id:

"660e8400-e29b-41d4-a716-446655440007"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/jobs/{job_id}/error-file

Response

GET

Get bulk job status.

FDK Method Name: getSizeChartDataBulkJobStatus

Get the status and details of a bulk upload or delete job.

Requires company/size-chart/read access scope.

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:

job_id:

"660e8400-e29b-41d4-a716-446655440002"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/jobs/{job_id}

Response

POST

Download bulk delete template.

FDK Method Name: downloadSizeChartDataBulkDeleteTemplate

Generate and download a sample template for bulk deletion (xlsx or csv).

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/delete/template

Response

POST

Submit bulk delete job.

FDK Method Name: submitSizeChartDataBulkDelete

Submit a bulk delete job. The uploaded file is processed asynchronously.

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/bulk/delete/upload

Response

GET

Get size chart data record.

FDK Method Name: getSizeChartDataRecord

Fetch a single size chart data record by its MongoDB ID.

Requires company/size-chart/read access scope.

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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:

record_id:

"665f1a2b3c4d5e6f7a8b9c0d"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/{record_id}

Response

PATCH

Update size chart data record.

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.

Requires company/size-chart/write access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

record_id

string

Required

MongoDB _id of the size chart data record.

body

object (SizeChartDataUpdateBody)

Required

SizeChartDataUpdateBody

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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.

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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_format_attribute

string

Nullable

universal_size_attribute

string

Nullable

string

Nullable

string

Nullable

string

Nullable

aus

string

Nullable

string

Nullable

string

Nullable

string

Nullable

tur

string

Nullable

string

Nullable

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:

record_id:

"665f1a2b3c4d5e6f7a8b9c0d"

body:

body

Was this section helpful?

PATCH

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/{record_id}

Response

DEL

Delete size chart data record.

FDK Method Name: deleteSizeChartDataRecord

Delete a size chart data record by its MongoDB ID.

Requires company/size-chart/write access scope.

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:

record_id:

"665f1a2b3c4d5e6f7a8b9c11"

Was this section helpful?

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-data/{record_id}

Response

Size Chart Template Config Management

Manage size chart template configurations including creation, listing, bulk operations, and individual config CRUD.

Operations

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs

# Create template config.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs

# List template configs.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/validate-template

# Validate template config bulk upload columns.

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/template

# Download template config bulk upload template.

PUT

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/status

# Bulk update template config status.

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/delete

# Bulk delete template configs.

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/upload

# Submit template config bulk upload job.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs

# List template config bulk jobs.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs/{job_id}/error-file

# Get template config bulk job error file.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs/{job_id}

# Get template config bulk job status.

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs/{job_id}

# Cancel template config bulk job.

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/{id}

# Get template config by ID.

PUT

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/{id}

# Update template config.

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/{id}

# Delete template config.

POST

Create template config.

FDK Method Name: createSizeChartTemplateConfig

Create a new size chart template configuration.

Requires company/size-chart/write access scope.

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

vendor_code

string

Nullable

measurement_type

string

Required

Enum

is_active

boolean

Default Value : true

size_display

string

Enum

attribute_sequences

array of string

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

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.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs

Response

GET

List template configs.

FDK Method Name: listSizeChartTemplateConfigs

List size chart template configurations with optional filters (paginated).

Requires company/size-chart/read access scope.

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.

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

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.

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:

category_l3:

"830316017"

brand_slug:

"only"

measurement_type:

"body"

is_active:

true

page:

limit:

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs

Response

GET

Validate template config bulk upload columns.

FDK Method Name: validateSizeChartTemplateConfigBulkTemplate

Return expected columns and allowed values for a category without generating a file.

Requires company/size-chart/read access scope.

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

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:

category:

"830316017"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/validate-template

Response

POST

Download template config bulk upload template.

FDK Method Name: downloadSizeChartTemplateConfigBulkTemplate

Generate and download a sample template for bulk template config upload (xlsx or csv) with category-specific measurement types prefilled.

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/template

Response

PUT

Bulk update template config status.

FDK Method Name: bulkUpdateSizeChartTemplateConfigStatus

Bulk activate or deactivate multiple template configs by their IDs.

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

PUT

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/status

Response

DEL

Bulk delete template configs.

FDK Method Name: bulkDeleteSizeChartTemplateConfigs

Bulk delete multiple template configs by their IDs.

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/delete

Response

POST

Submit template config bulk upload job.

FDK Method Name: submitSizeChartTemplateConfigBulkUpload

Submit a bulk template config upload job. The file is processed asynchronously.

Requires company/size-chart/write access scope.

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:

body:

body

Was this section helpful?

POST

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/upload

Response

GET

List template config bulk jobs.

FDK Method Name: listSizeChartTemplateConfigBulkJobs

List template config bulk upload jobs for the company (paginated, filterable).

Requires company/size-chart/read access scope.

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).

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:

status:

"all"

sort_order:

"desc"

start_date:

"2025-01-01"

end_date:

"2025-12-31"

page:

limit:

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs

Response

GET

Get template config bulk job error file.

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.

Requires company/size-chart/read access scope.

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:

job_id:

"660e8400-e29b-41d4-a716-446655440008"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs/{job_id}/error-file

Response

GET

Get template config bulk job status.

FDK Method Name: getSizeChartTemplateConfigBulkJobStatus

Get the status and details of a template config bulk upload job.

Requires company/size-chart/read access scope.

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:

job_id:

"660e8400-e29b-41d4-a716-446655440004"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs/{job_id}

Response

DEL

Cancel template config bulk job.

FDK Method Name: cancelSizeChartTemplateConfigBulkJob

Cancel a queued or processing template config bulk upload job.

Requires company/size-chart/write access scope.

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:

job_id:

"660e8400-e29b-41d4-a716-446655440006"

Was this section helpful?

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/bulk/jobs/{job_id}

Response

GET

Get template config by ID.

FDK Method Name: getSizeChartTemplateConfigById

Get a single template config by its MongoDB ID.

Requires company/size-chart/read access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

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

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.

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:

id:

"665f1a2b3c4d5e6f7a8b9c0e"

Was this section helpful?

GET

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/{id}

Response

PUT

Update template config.

FDK Method Name: updateSizeChartTemplateConfig

Update fields on an existing template config.

Requires company/size-chart/write access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

string

Required

MongoDB _id of the template config.

Request body

category_l3

string

brand_slug

string

Nullable

vendor_code

string

Nullable

measurement_type

string

Enum

is_active

boolean

size_display

string

Enum

attribute_sequences

array of string

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

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.

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:

id:

"665f1a2b3c4d5e6f7a8b9c0e"

body:

body

Was this section helpful?

PUT

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/{id}

Response

DEL

Delete template config.

FDK Method Name: deleteSizeChartTemplateConfig

Delete a template config by its MongoDB ID.

Requires company/size-chart/write access scope.

Parameters

company_id

integer

Required

Unique identifier of the company.

string

Required

MongoDB _id of the template config.

Response

200

404

Template config 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:

id:

"665f1a2b3c4d5e6f7a8b9c0f"

Was this section helpful?

DEL

/service/platform/size-chart/v1.0/company/{company_id}/size-chart-template-configs/{id}

Response

« Get Localities by Name Prefix

Get default marketplace theme. »