Optional Fields - Worldly Developer Docs

When creating or updating a product, you can include the frenchLabelOptionalFields object to provide additional durability and business context. These fields are not required to generate a score, but supplying them can improve its accuracy.

`frenchLabelOptionalFields` properties

Name	Type	Description
`business`	`string (enum)`	Business and Repair Service type. Accepted values: `small-business`, `large-business-with-services`, `large-business-without-services`. Send `null` to clear.
`countrySpinning`	`object<code, name>`	Location of Spinning — the country where spinning occurred. Uses the same country format as other French Eco-Score location fields. Check the location list here. Send `null` to clear.
`numberOfReferences`	`number`	Number of References — the number of references in the brand catalogue. Min: `1`, Max: `999999`. Send `null` to clear.
`price`	`number`	Default Price — product price in euros (EUR). Min: `1`, Max: `1000`. Send `null` to clear.
`upcycled`	`boolean`	Remanufactured — indicates whether the product is remanufactured. Send `null` to clear.

Example

{
  "frenchLabelOptionalFields": {
    "business": "small-business",
    "countrySpinning": {
      "code": "CN",
      "name": "China"
    },
    "numberOfReferences": 100,
    "price": 20,
    "upcycled": true
  }
}

All optional fields are nullable. Send null for any field to clear a previously set value.

Recipes

PIC - Create Product with French Eco-Score Optional Fields