Skip to content

Create brand product

Request

Add any additional information relating to a specific product analysis. This information is specific to you as a client. When using Fairly Made for tracaebility, sending this information is mandatory.

Bodyapplication/jsonrequired
uniqueIdentifierstring, [ 1 .. 255 ] charactersrequired

Makes each brand product record unique in our systems. Build it from the ref, colorCode, collection and purchaseOrder of the related purchased item (create purchased item). Follow the global uniqueIdentifier rules in the API introduction: use prefix BP and underscores between segments—recommended shape BP_<ref>_<colorCode>_<collection>_<purchaseOrder> (e.g. BP_REF-001_DEFAULT_C01_PO-001).

manufacturedProductIdstring, (uuid)

System UUID of the manufactured product this brand product row is linked to. At most one product link among manufacturedProductId, manufacturedProductUniqueIdentifier, purchasedItemId, and purchasedItemUniqueIdentifier. Use when only a supplier address was provided for the manufactured product and no purchase transaction exists yet.

manufacturedProductUniqueIdentifierstring

Client uniqueIdentifier of the manufactured product. Mutually exclusive with other product link fields.

purchasedItemIdstring, (uuid)

System UUID of the purchased item (transaction). Mutually exclusive with other product link fields. Use when a purchase transaction exists for the manufactured product you own.

purchasedItemUniqueIdentifierstring

Client uniqueIdentifier of the purchased item. Mutually exclusive with other product link fields.

refstring

Optional internal reference for the brand product.

colorCodestring

Unique color reference/name of the product.

collectionstring

Collection or season name of the product.

productNamestring

Name of the product in your own system.

packagingIdsArray of strings, (uuid)

System UUIDs of the associated packagings. Mutually exclusive with packagingUniqueIdentifiers — send one or the other, not both. Each element is a UUID (v4 format).

packagingUniqueIdentifiersArray of strings

Client uniqueIdentifiers of the associated packagings (same values as on POST /packagings). Mutually exclusive with packagingIds — send one or the other, not both.

gtinsArray of strings

List of Global Trade Item Numbers (GTIN) and/or European Article Numbers (EAN).

marketSegmentstring

Market segment taxonomy.

Enum:"Menswear""Womenswear""Kidswear""Babywear""Lingerie"
productPricenumber

Product price in euro.

ecoModulationstring

Eco-modulation taxonomy. Values.

Enum:"ECOLOGIC ASL - CRITERIA 1 + 2""ECOLOGIC ASL - CRITERIA 1 + 2 + 3""ECOLOGIC ASL - CRITERIA 1 + 3""ECOLOGIC ASL - CRITERIA 1 - SPARE PARTS AVAILABILITY >10 YEARS""ECOLOGIC ASL - CRITERIA 2 + 3""ECOLOGIC ASL - CRITERIA 2 - SPARE PARTS TIME > 7 DAYS""ECOLOGIC ASL - CRITERIA 3 - INTEGRATION OF RECYCLED MATERIALS > 40%.""NONE""REFASHION TLC - ECO-MODULATION 1 - DURABILITY""REFASHION TLC - ECO-MODULATION 2 - ENVIRONMENTAL LABELS"
producedQuantitynumber

Quantity produced for this specific product.

weightnumber

Weight of the product in grams.

warehouseobject(Warehouse)required

Information about the destination warehouse for brand product data. Provide either a warehouse supplier (supplierId or supplierUniqueIdentifier) or an address with country — not both in the same object.

curl -i -X POST \
  https://api.fairlymade.com/v3/brand-products \
  -H 'Content-Type: application/json' \
  -d '{
    "uniqueIdentifier": "BP_REF-001_DEFAULT_C01_PO-001",
    "ref": "REF-001",
    "colorCode": "DEFAULT",
    "collection": "C01",
    "packagingIds": [
      "c8568d90-0609-4ff6-b76f-5bf14051af43"
    ],
    "warehouse": {
      "address": {
        "country": "FR"
      }
    }
  }'

Responses

Brand product added successfully. The response echoes the product's uniqueIdentifier, its hasCommunicationPackage flag and its links (QR-code and web). links are returned only when the communication pack is active; a product without the pack returns links: { qrCode: null, web: null }.

Bodyapplication/json
brandProductIdstring, (uuid)required

Identifier of the created brand product record. UUID v4 format.

uniqueIdentifierstring

Your brand product uniqueIdentifier, echoed from the request.

hasCommunicationPackagebooleanrequired

Whether the product's communication pack is active. Governs whether links are returned.

linksobject(BrandProductLinks)required

The product's QR-code and web links. Both are returned only when the product's communication pack is active (hasCommunicationPackage: true); otherwise both are null. This rule is identical across the whole brand-products resource — the create response, the update responses and the list. Each URL points at the environment serving the request (production, sandbox).

Response
{
  "brandProductId": "3bfbff7e-c942-4df7-9c16-21ba51a4b549",
  "uniqueIdentifier": "BP_REF-123_Black_Spring2026_PO-2026-03",
  "hasCommunicationPackage": true,
  "links": {
    "qrCode": "https://links.fairlymade.com/49cb7b8f-a4a5-4f6e-bda6-b1441a56d992",
    "web": "https://links.fairlymade.com/71159d67-f38b-4a9c-9ede-b7f7d81ce968"
  }
}