{"items":[{"type":"link","label":"Fairly Made API","link":"/swagger-fairlymadeapi-v3","routeSlug":"/swagger-fairlymadeapi-v3","content":{"contentType":"overview","meta":{"name":"Fairly Made API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"swagger-FairlyMadeAPI-v3.json","url":"/_bundle/swagger-FairlyMadeAPI-v3.json?download"},{"kind":"download","label":"swagger-FairlyMadeAPI-v3.yaml","url":"/_bundle/swagger-FairlyMadeAPI-v3.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fairly Made API (3.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Fairly Made API describes endpoints for creating and retrieving supply‑chain entities such as suppliers, manufactured materials, manufactured components, manufactured products and purchased items."},"children":[]}]}]}]}],"sectionId":"/swagger-fairlymadeapi-v3"}],"sectionId":"/swagger-fairlymadeapi-v3"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/uniqueidentifier"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" convention"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is your item's unique key in the Fairly Made system. It defines the granularity of analysis you want Fairly Made to perform: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = one analysis"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For create payloads that include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", start the value with a short "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource prefix"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then add your own reference segments separated by underscores ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") instead of spaces or concatenated camelCase where practical."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use one of these prefixes depending on the entity: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supplier), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (material), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (component), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (packaging), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (manufactured product), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (purchased item), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (file), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (brand product). Each endpoint’s schema describes how to compose the segments after the prefix for that resource."},"children":[]}]}]}]}],"sectionId":"/swagger-fairlymadeapi-v3/section/uniqueidentifier"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/entity-references-(id-vs-unique-identifier)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity references (id vs unique identifier)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a schema exposes both a UUID field ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a client reference field ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*UniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), send "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of them — not both, not neither. Violations return HTTP "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*ReferenceConflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*ReferenceRequired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*BothIdAndUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner (supplier)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — on manufactured materials, components, and products: provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead — not both owner and address. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchased items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for the buyer, send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). For the seller, send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the purchased entity (material, component, or product), send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. If you run traceability collection with Fairly Made, every purchased item needs at least a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so supplier data collection can be launched; if your analysis granularity is not at purchase-order level, use a representative PO for the panel covered by that granularity. If you are unable to provide a PO at all, you can set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_SPECIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Links made only through used items ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.) instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not taken into account for the analysis."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — include at most one product reference: exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the warehouse supplier, send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For packaging, send either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packagingIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packagingUniqueIdentifiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not both."},"children":[]}]}]}]}],"sectionId":"/swagger-fairlymadeapi-v3/section/entity-references-(id-vs-unique-identifier)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/manufactured-items-and-their-purchased-items"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manufactured items and their purchased items"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you run traceability collection with Fairly Made, each manufactured item must be created as a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pair"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the manufactured item "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" its corresponding purchased item. For a given item (manufactured material, manufactured component, or manufactured product), first create the manufactured item, then create the matching purchased item ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that references it and carries a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Without this pair, supplier data collection cannot be launched for that item. If you handle traceability yourself, the purchased item stays optional."},"children":[]}]}]}]}],"sectionId":"/swagger-fairlymadeapi-v3/section/manufactured-items-and-their-purchased-items"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate with a Bearer access token ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Your registry context is resolved from the token."},"children":[]}]}]}]}],"sectionId":"/swagger-fairlymadeapi-v3/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two environments are available — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — each with its own base URL (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" above). The documented paths and request/response schemas are identical; only the host changes. Use Sandbox for integration tests, Production for live data."},"children":[]}]}]}]}],"sectionId":"/swagger-fairlymadeapi-v3/section/environments"}]}]}},{"type":"link","label":"uniqueIdentifier","link":"/swagger-fairlymadeapi-v3/section/uniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/section/uniqueidentifier","content":null},{"type":"link","label":"Entity references (id vs unique identifier)","link":"/swagger-fairlymadeapi-v3/section/entity-references-(id-vs-unique-identifier)","routeSlug":"/swagger-fairlymadeapi-v3/section/entity-references-(id-vs-unique-identifier)","content":null},{"type":"link","label":"Manufactured items and their purchased items","link":"/swagger-fairlymadeapi-v3/section/manufactured-items-and-their-purchased-items","routeSlug":"/swagger-fairlymadeapi-v3/section/manufactured-items-and-their-purchased-items","content":null},{"type":"link","label":"Authentication","link":"/swagger-fairlymadeapi-v3/section/authentication","routeSlug":"/swagger-fairlymadeapi-v3/section/authentication","content":null},{"type":"link","label":"Environments","link":"/swagger-fairlymadeapi-v3/section/environments","routeSlug":"/swagger-fairlymadeapi-v3/section/environments","content":null},{"type":"separator","label":"1. Create","content":null},{"type":"group","label":"Post items","link":"/swagger-fairlymadeapi-v3/post-data","routeSlug":"/swagger-fairlymadeapi-v3/post-data","items":[{"type":"link","label":"Key rules","link":"/swagger-fairlymadeapi-v3/post-data/key-rules","routeSlug":"/swagger-fairlymadeapi-v3/post-data/key-rules","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Key rules"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"post-data/key-rules"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your item's unique key in the Fairly Made system. It defines the granularity of analysis you want Fairly Made to perform: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = one analysis"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Format: resource prefix ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") followed by your own segments separated by underscores ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). See the API introduction for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id vs unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — when a field has both a UUID ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a client reference ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*UniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), send "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not both and not neither."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner (supplier)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — on manufactured materials, components, and products: send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — not both owner and address."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One item = one supplier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a created item (manufactured material, component, manufactured product, or packaging) maps to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one supplier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the traceability steps tied to that supplier. If what you consider a single item involves "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple suppliers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", create "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"separate items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — one per supplier."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Supplier data collection","link":"/swagger-fairlymadeapi-v3/post-data/supplier-data-collection","routeSlug":"/swagger-fairlymadeapi-v3/post-data/supplier-data-collection","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Supplier data collection"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"post-data/supplier-data-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supplier data collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section applies "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only if you ask Fairly Made to collect traceability data from your suppliers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a process we call "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier data collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you handle traceability yourself, the fields below stay optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When supplier data collection is active, Fairly Made needs enough information to contact each supplier and attach their data to the right analysis."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"siteEmails"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one valid contact email ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"siteEmails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is required on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /suppliers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for every supplier that will be contacted (warehouses excluded). Without it, Fairly Made can't reach the site to launch collection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating purchased items ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required references"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for the buyer, send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (buyer is required; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). For the seller, send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (seller is required). For the purchased entity, send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Full field details are in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — at least one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required per purchased item so collection can be launched. If your analysis granularity isn't at purchase-order level, provide a representative PO for the panel covered by that granularity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link items through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only links made via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count for the analysis. Links made only through used items ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.) are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" taken into account."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Creation order","link":"/swagger-fairlymadeapi-v3/post-data/creation-order","routeSlug":"/swagger-fairlymadeapi-v3/post-data/creation-order","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Creation order"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"post-data/creation-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Follow the supply chain creation order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppliers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packaging "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manufactured material "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(optional)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3.a) Manufactured material purchased items — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory if you run traceability collection with Fairly Made."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Optional otherwise."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manufactured component"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4.a) Manufactured component purchased items — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory if you run traceability collection with Fairly Made."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Optional otherwise."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manufactured products"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5.a) Manufactured product purchased items — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory if you run traceability collection with Fairly Made."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Optional otherwise."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate a traceability tree, you must create a brand product."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Create supplier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/post-data/paths/~1suppliers/post","routeSlug":"/swagger-fairlymadeapi-v3/post-data/paths/~1suppliers/post","metadata":{"seo":{"title":"Create supplier","description":"Use this endpoint to send us the Suppliers data needed for the analysis."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create supplier","isWebhook":false,"pointer":"/paths/~1suppliers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create supplier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to send us the Suppliers data needed for the analysis."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Within Fairly Made data model, supplier data covers all the stakeholders involved in your product lifecycle — from manufacturers and fabric mills to agents, wholesalers, and warehouses. This includes any entity that transforms, handles, or stores your materials and products throughout the supply chain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each supplier site in our system requires a unique identifier — this can be your internal code or reference for that specific site."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key rule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If any supplier details differ, create a separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is especially important for supplier groups with multiple locations, as each site needs its own reference since operations and capabilities may vary. You have the option to declare the parent company name at site creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During the Supplier Data Collection phase (if applicable), suppliers (excluding warehouses) will be contacted to update, modify and enrich their information directly with us, based on the details you have provided. In that case, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"siteEmails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (at least one email) on each supplier so Fairly Made can contact them and launch supplier data collection."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Supplier","exampleIds":["paths/~1suppliers/post/requestBody/content/application~1json/examples/minimal","paths/~1suppliers/post/requestBody/content/application~1json/examples/minimalIfFairlyMadeSDC","paths/~1suppliers/post/requestBody/content/application~1json/examples/full"]}},"schemaId":"components/schemas/Supplier","exampleIds":["paths/~1suppliers/post/requestBody/content/application~1json/examples/minimal","paths/~1suppliers/post/requestBody/content/application~1json/examples/minimalIfFairlyMadeSDC","paths/~1suppliers/post/requestBody/content/application~1json/examples/full"],"pointer":"/paths/~1suppliers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/suppliers","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Supplier","exampleIds":["paths/~1suppliers/post/requestBody/content/application~1json/examples/minimal","paths/~1suppliers/post/requestBody/content/application~1json/examples/minimalIfFairlyMadeSDC","paths/~1suppliers/post/requestBody/content/application~1json/examples/full"]}},"responseCodes":["201","400","401","409"],"pointer":"/suppliers","href":"post-data/paths/~1suppliers/post","summary":"Create supplier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/Supplier","exampleIds":["paths/~1suppliers/post/requestBody/content/application~1json/examples/minimal","paths/~1suppliers/post/requestBody/content/application~1json/examples/minimalIfFairlyMadeSDC","paths/~1suppliers/post/requestBody/content/application~1json/examples/full"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Supplier","exampleIds":["paths/~1suppliers/post/requestBody/content/application~1json/examples/minimal","paths/~1suppliers/post/requestBody/content/application~1json/examples/minimalIfFairlyMadeSDC","paths/~1suppliers/post/requestBody/content/application~1json/examples/full"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Supplier created successfully. Returns the full supplier record.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SupplierCreated","exampleIds":["paths/~1suppliers/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/SupplierCreated","exampleIds":["paths/~1suppliers/post/responses/201/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error (schema / Zod) or business rule failure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation issues use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: ValidationError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Known supplier business rules use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RegistrySupplier_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/validationError","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidCountry","paths/~1suppliers/post/responses/400/content/application~1json/examples/emptyCity","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidEmail","paths/~1suppliers/post/responses/400/content/application~1json/examples/unknownCertification"]}},"schemaId":"schema_15","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/validationError","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidCountry","paths/~1suppliers/post/responses/400/content/application~1json/examples/emptyCity","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidEmail","paths/~1suppliers/post/responses/400/content/application~1json/examples/unknownCertification"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized – token missing, malformed, expired, or not recognized."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A supplier with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exists for your customer."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegistrySupplierBusinessError","exampleIds":["paths/~1suppliers/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/RegistrySupplierBusinessError","exampleIds":["paths/~1suppliers/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1suppliers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SupplierCreated","exampleIds":["paths/~1suppliers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SupplierCreated","exampleIds":["paths/~1suppliers/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_15","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/validationError","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidCountry","paths/~1suppliers/post/responses/400/content/application~1json/examples/emptyCity","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidEmail","paths/~1suppliers/post/responses/400/content/application~1json/examples/unknownCertification"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/validationError","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidCountry","paths/~1suppliers/post/responses/400/content/application~1json/examples/emptyCity","paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidEmail","paths/~1suppliers/post/responses/400/content/application~1json/examples/unknownCertification"]}}},{"code":"401"},{"code":"409","schemaId":"components/schemas/RegistrySupplierBusinessError","exampleIds":["paths/~1suppliers/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegistrySupplierBusinessError","exampleIds":["paths/~1suppliers/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-data/paths/~1suppliers/post"}],"panels":[]}]},"httpPath":"/suppliers"},{"label":"Create manufactured material *","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/post-data/paths/~1manufactured-materials/post","routeSlug":"/swagger-fairlymadeapi-v3/post-data/paths/~1manufactured-materials/post","metadata":{"seo":{"title":"Create manufactured material *","description":"Optional endpoint. Calling this endpoint is optional. If you use it, create a manufactured material and optionally define processing steps; you must include either the owner (ownerKind, ownerId) or the processing step address, but not both."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create manufactured material *","isWebhook":false,"pointer":"/paths/~1manufactured-materials/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create manufactured material *","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional endpoint."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Calling this endpoint is optional. If you use it, create a manufactured material and optionally define processing steps; you must include either the owner (ownerKind, ownerId) or the processing step address, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When you send them, provide both as a single taxonomy pair at the root of the object (not a list). Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1uPK74A-i0_TgF-7S6ldtYVgVEenLLbBT/edit?gid=1517342635#gid=1517342635"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made Material Selector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to pick the allowed attribute for that name (Step 1 = material, Step 2 = attributes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Traceability collection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link purchased inputs for Fairly Made supplier data collection, reference them via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (each purchased item must include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Links made only through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" taken into account for that analysis."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Material","exampleIds":["paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonWithProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherWithProcessingAddress"]}},"schemaId":"components/schemas/Material","exampleIds":["paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonWithProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherWithProcessingAddress"],"pointer":"/paths/~1manufactured-materials/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manufactured-materials","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Material","exampleIds":["paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonWithProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherWithProcessingAddress"]}},"responseCodes":["201","400","401","403","409","422"],"pointer":"/manufactured-materials","href":"post-data/paths/~1manufactured-materials/post","summary":"Create manufactured material *"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/Material","exampleIds":["paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonWithProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherWithProcessingAddress"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Material","exampleIds":["paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonWithProcessingAddress","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherOwnedBySupplier","paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherWithProcessingAddress"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Material created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request – Validation error (missing or invalid field)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialName","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialAttribute","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialNameAttributeCombination","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialName","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialAttribute","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialNameAttributeCombination","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized – Missing, invalid or expired token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden – Insufficient permissions."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/403/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict – Material with this uniqueIdentifier already exists. The response includes the Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing material in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response when that material was created)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity – Referenced resource does not exist (e.g. ownerId, materialId, purchasedItemId)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/materialIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/materialIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"]}],"pointer":"/paths/~1manufactured-materials/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialName","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialAttribute","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialNameAttributeCombination","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialName","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialAttribute","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialNameAttributeCombination","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/materialIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/materialIdNotFound","paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-data/paths/~1manufactured-materials/post"}],"panels":[]}]},"httpPath":"/manufactured-materials"},{"label":"Create manufactured component","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/post-data/paths/~1manufactured-components/post","routeSlug":"/swagger-fairlymadeapi-v3/post-data/paths/~1manufactured-components/post","metadata":{"seo":{"title":"Create manufactured component","description":"Component data covers all the individual elements that make up your products — from main fabrics and linings to hardware like zippers, buttons, outsoles, and uppers. Each component is made of one or multiple composition lines; each line combines a raw material name and a raw material attribute (same taxonomies and pairing rules as on Material with rawMaterialName and rawMaterialAttribute), plus a percentage and optional origin and certification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create manufactured component","isWebhook":false,"pointer":"/paths/~1manufactured-components/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create manufactured component","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Component data covers all the individual elements that make up your products — from main fabrics and linings to hardware like zippers, buttons, outsoles, and uppers. Each component is made of one or multiple composition lines; each line combines a raw material name and a raw material attribute (same taxonomies and pairing rules as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Material"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), plus a percentage and optional origin and certification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each component needs a unique identifier representing specific characteristics including composition, usageCategory, and supplier (owner or address)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key rule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If any component characteristics differ, create a separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must include either the owner (ownerKind, ownerId) or the processing step address, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawMaterial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1uPK74A-i0_TgF-7S6ldtYVgVEenLLbBT/edit?gid=1517342635#gid=1517342635"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made Material Selector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to pick the allowed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Step 1 = material, Step 2 = attributes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Traceability collection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link purchased inputs for Fairly Made supplier data collection, reference them via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (each purchased item must include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Links made only through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" taken into account for that analysis."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Component","exampleIds":["paths/~1manufactured-components/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricWithProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperWithProcessingAddress"]}},"schemaId":"components/schemas/Component","exampleIds":["paths/~1manufactured-components/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricWithProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperWithProcessingAddress"],"pointer":"/paths/~1manufactured-components/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manufactured-components","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Component","exampleIds":["paths/~1manufactured-components/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricWithProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperWithProcessingAddress"]}},"responseCodes":["201","400","401","403","409","422"],"pointer":"/manufactured-components","href":"post-data/paths/~1manufactured-components/post","summary":"Create manufactured component"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/Component","exampleIds":["paths/~1manufactured-components/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricWithProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperWithProcessingAddress"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Component","exampleIds":["paths/~1manufactured-components/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricWithProcessingAddress","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperOwnedBySupplier","paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperWithProcessingAddress"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Component created. Return Component ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_17"}},"schemaId":"schema_17"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request – Validation error (missing or invalid field)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositions","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositionRawAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialName","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialNameAttributeCombination","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidComposition","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/compositionPercentageSumNot100","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositions","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositionRawAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialName","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialNameAttributeCombination","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidComposition","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/compositionPercentageSumNot100","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized – Missing, invalid or expired token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden – Insufficient permissions."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/403/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict – Component with this uniqueIdentifier already exists. The response includes the Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"componentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing component in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].componentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response when that component was created)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity – Referenced resource does not exist (e.g. ownerId, purchasedItemId, componentId, materialId)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/materialIdNotFound"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/materialIdNotFound"]}],"pointer":"/paths/~1manufactured-components/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_17","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_17"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositions","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositionRawAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialName","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialNameAttributeCombination","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidComposition","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/compositionPercentageSumNot100","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositions","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositionRawAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialName","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialAttribute","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialNameAttributeCombination","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidComposition","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/compositionPercentageSumNot100","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-components/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/materialIdNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-components/post/responses/422/content/application~1json/examples/materialIdNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-data/paths/~1manufactured-components/post"}],"panels":[]}]},"httpPath":"/manufactured-components"},{"label":"Create packaging *","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/post-data/paths/~1packagings/post","routeSlug":"/swagger-fairlymadeapi-v3/post-data/paths/~1packagings/post","metadata":{"seo":{"title":"Create packaging *","description":"Optional endpoint. Calling this endpoint is optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create packaging *","isWebhook":false,"pointer":"/paths/~1packagings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create packaging *","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional endpoint."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Calling this endpoint is optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packaging data includes all containers, bags, boxes, and wrapping materials that accompany your products and are delivered to the end consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This information is essential for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AGEC compliance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the French environmental regulation requiring brands to report on the packaging they place on the market."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://filieres-rep.ademe.fr/observatoire-reemploi-reutilisation/declaration-reemploi-emballages-professionnels"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visit the official declaration page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Packaging","exampleIds":["paths/~1packagings/post/requestBody/content/application~1json/examples/minimal","paths/~1packagings/post/requestBody/content/application~1json/examples/shoeBox"]}},"schemaId":"components/schemas/Packaging","exampleIds":["paths/~1packagings/post/requestBody/content/application~1json/examples/minimal","paths/~1packagings/post/requestBody/content/application~1json/examples/shoeBox"],"pointer":"/paths/~1packagings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/packagings","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Packaging","exampleIds":["paths/~1packagings/post/requestBody/content/application~1json/examples/minimal","paths/~1packagings/post/requestBody/content/application~1json/examples/shoeBox"]}},"responseCodes":["201","400","401","403","409","422"],"pointer":"/packagings","href":"post-data/paths/~1packagings/post","summary":"Create packaging *"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/Packaging","exampleIds":["paths/~1packagings/post/requestBody/content/application~1json/examples/minimal","paths/~1packagings/post/requestBody/content/application~1json/examples/shoeBox"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Packaging","exampleIds":["paths/~1packagings/post/requestBody/content/application~1json/examples/minimal","paths/~1packagings/post/requestBody/content/application~1json/examples/shoeBox"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Packaging created. Returns Packaging ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request – Validation error (missing or invalid field)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1packagings/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1packagings/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1packagings/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1packagings/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized – Missing, invalid or expired token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden – Insufficient permissions."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/403/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict – Packaging with this uniqueIdentifier already exists. The response includes the Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packagingId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing packaging in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].packagingId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response when that packaging was created)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity – Referenced resource does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1packagings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1packagings/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1packagings/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1packagings/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1packagings/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1packagings/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-data/paths/~1packagings/post"}],"panels":[]}]},"httpPath":"/packagings"},{"label":"Create manufactured product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/post-data/paths/~1manufactured-products/post","routeSlug":"/swagger-fairlymadeapi-v3/post-data/paths/~1manufactured-products/post","metadata":{"seo":{"title":"Create manufactured product","description":"Use this endpoint to create the product that your manufacturer has sold to you. This is different from your own brand product data, which you send via POST /brand-products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create manufactured product","isWebhook":false,"pointer":"/paths/~1manufactured-products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create manufactured product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to create the product that your manufacturer has sold to you. This is different from your own brand product data, which you send via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Traceability collection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link purchased inputs for Fairly Made supplier data collection, reference them via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (each purchased item must include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Links made only through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" taken into account for that analysis."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product","exampleIds":["paths/~1manufactured-products/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/fromManufacturedProductOnly","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtWithProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesWithProcessingAddress"]}},"schemaId":"components/schemas/Product","exampleIds":["paths/~1manufactured-products/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/fromManufacturedProductOnly","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtWithProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesWithProcessingAddress"],"pointer":"/paths/~1manufactured-products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manufactured-products","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Product","exampleIds":["paths/~1manufactured-products/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/fromManufacturedProductOnly","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtWithProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesWithProcessingAddress"]}},"responseCodes":["201","400","401","403","409","422"],"pointer":"/manufactured-products","href":"post-data/paths/~1manufactured-products/post","summary":"Create manufactured product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/Product","exampleIds":["paths/~1manufactured-products/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/fromManufacturedProductOnly","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtWithProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesWithProcessingAddress"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product","exampleIds":["paths/~1manufactured-products/post/requestBody/content/application~1json/examples/ownedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/withProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/fromManufacturedProductOnly","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtWithProcessingAddress","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesOwnedBySupplier","paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesWithProcessingAddress"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Manufactured product created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request – Validation error (missing or invalid field)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized – Missing, invalid or expired token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden – Insufficient permissions."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/403/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict – Manufactured product with this uniqueIdentifier already exists. The response includes the Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing manufactured product in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response when that manufactured product was created)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity – Referenced resource does not exist (e.g. ownerId, purchasedItemId, componentId, productId)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/productIdNotFound"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/productIdNotFound"]}],"pointer":"/paths/~1manufactured-products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/bothOwnerAndAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidOwnerKind","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsageCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidAddressCountry","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidCategory","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidStepProcess","paths/~1manufactured-products/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/productIdNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products/post/responses/422/content/application~1json/examples/ownerIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/componentIdNotFound","paths/~1manufactured-products/post/responses/422/content/application~1json/examples/productIdNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-data/paths/~1manufactured-products/post"}],"panels":[]}]},"httpPath":"/manufactured-products"},{"label":"Create purchased item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/post-data/paths/~1purchased-items/post","routeSlug":"/swagger-fairlymadeapi-v3/post-data/paths/~1purchased-items/post","metadata":{"seo":{"title":"Create purchased item","description":"Creating a purchased item is mandatory when doing traceability with Fairly Made, for each item you want Fairly Made to analyse. This endpoint creates a record representing an item purchased between buyers and sellers, with optional transport and quantity details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create purchased item","isWebhook":false,"pointer":"/paths/~1purchased-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create purchased item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a purchased item is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mandatory when doing traceability with Fairly Made"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for each item you want Fairly Made to analyse. This endpoint creates a record representing an item purchased between buyers and sellers, with optional transport and quantity details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required references:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (buyer is required), exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (seller is required), and exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (purchased entity is required). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you run traceability collection with Fairly Made, you must provide at least a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each purchased item: without that link, Fairly Made cannot launch supplier data collection. If your chosen analysis granularity is not at purchase-order level, provide a representative PO for the panel covered by that granularity. If you are unable to provide a PO at all, you can set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_SPECIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Links made only through used items ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.) instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" taken into account for the analysis."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with at least one entry, each entry must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchasedItem","exampleIds":["paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingId","paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingUniqueIdentifier","paths/~1purchased-items/post/requestBody/content/application~1json/examples/full"]}},"schemaId":"components/schemas/PurchasedItem","exampleIds":["paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingId","paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingUniqueIdentifier","paths/~1purchased-items/post/requestBody/content/application~1json/examples/full"],"pointer":"/paths/~1purchased-items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/purchased-items","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchasedItem","exampleIds":["paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingId","paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingUniqueIdentifier","paths/~1purchased-items/post/requestBody/content/application~1json/examples/full"]}},"responseCodes":["201","400","401","403","409","422"],"pointer":"/purchased-items","href":"post-data/paths/~1purchased-items/post","summary":"Create purchased item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/PurchasedItem","exampleIds":["paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingId","paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingUniqueIdentifier","paths/~1purchased-items/post/requestBody/content/application~1json/examples/full"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchasedItem","exampleIds":["paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingId","paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingUniqueIdentifier","paths/~1purchased-items/post/requestBody/content/application~1json/examples/full"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Purchased item created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request – Validation error (missing or invalid field)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidBuyerKind","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidTransportType","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidPurchasedQuantityUnit","paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingCertificationNameWhenCertificationsPresent"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidBuyerKind","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidTransportType","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidPurchasedQuantityUnit","paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingCertificationNameWhenCertificationsPresent"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized – Missing, invalid or expired token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden – Insufficient permissions."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/403/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict – Purchased item with this uniqueIdentifier already exists. The response includes the Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing purchased item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response when that purchased item was created)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity – Referenced resource does not exist (e.g. buyerId, sellerId, itemId)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/422/content/application~1json/examples/buyerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/sellerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/itemIdNotFound"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/422/content/application~1json/examples/buyerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/sellerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/itemIdNotFound"]}],"pointer":"/paths/~1purchased-items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidBuyerKind","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidTransportType","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidPurchasedQuantityUnit","paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingCertificationNameWhenCertificationsPresent"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidBuyerKind","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUsagePercentage","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidTransportType","paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidPurchasedQuantityUnit","paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingCertificationNameWhenCertificationsPresent"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/422/content/application~1json/examples/buyerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/sellerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/itemIdNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items/post/responses/422/content/application~1json/examples/buyerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/sellerIdNotFound","paths/~1purchased-items/post/responses/422/content/application~1json/examples/itemIdNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-data/paths/~1purchased-items/post"}],"panels":[]}]},"httpPath":"/purchased-items"},{"label":"Create brand product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/post-data/paths/~1brand-products/post","routeSlug":"/swagger-fairlymadeapi-v3/post-data/paths/~1brand-products/post","metadata":{"seo":{"title":"Create brand product","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create brand product","isWebhook":false,"pointer":"/paths/~1brand-products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create brand product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrandProductInformation","exampleIds":["paths/~1brand-products/post/requestBody/content/application~1json/examples/minimal","paths/~1brand-products/post/requestBody/content/application~1json/examples/full","paths/~1brand-products/post/requestBody/content/application~1json/examples/teeShirt","paths/~1brand-products/post/requestBody/content/application~1json/examples/shoe"]}},"schemaId":"components/schemas/BrandProductInformation","exampleIds":["paths/~1brand-products/post/requestBody/content/application~1json/examples/minimal","paths/~1brand-products/post/requestBody/content/application~1json/examples/full","paths/~1brand-products/post/requestBody/content/application~1json/examples/teeShirt","paths/~1brand-products/post/requestBody/content/application~1json/examples/shoe"],"pointer":"/paths/~1brand-products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/brand-products","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BrandProductInformation","exampleIds":["paths/~1brand-products/post/requestBody/content/application~1json/examples/minimal","paths/~1brand-products/post/requestBody/content/application~1json/examples/full","paths/~1brand-products/post/requestBody/content/application~1json/examples/teeShirt","paths/~1brand-products/post/requestBody/content/application~1json/examples/shoe"]}},"responseCodes":["201","400","401","403","409","422"],"pointer":"/brand-products","href":"post-data/paths/~1brand-products/post","summary":"Create brand product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/BrandProductInformation","exampleIds":["paths/~1brand-products/post/requestBody/content/application~1json/examples/minimal","paths/~1brand-products/post/requestBody/content/application~1json/examples/full","paths/~1brand-products/post/requestBody/content/application~1json/examples/teeShirt","paths/~1brand-products/post/requestBody/content/application~1json/examples/shoe"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrandProductInformation","exampleIds":["paths/~1brand-products/post/requestBody/content/application~1json/examples/minimal","paths/~1brand-products/post/requestBody/content/application~1json/examples/full","paths/~1brand-products/post/requestBody/content/application~1json/examples/teeShirt","paths/~1brand-products/post/requestBody/content/application~1json/examples/shoe"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand product added successfully. The response echoes the product's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasCommunicationPackage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (QR-code and web). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned only when the communication pack is active; a product without the pack returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links: { qrCode: null, web: null }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductCreatedResponse","exampleIds":["paths/~1brand-products/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/BrandProductCreatedResponse","exampleIds":["paths/~1brand-products/post/responses/201/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request – Validation error (missing or invalid field)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1brand-products/post/responses/400/content/application~1json/examples/neitherManufacturedProductNorPurchasedItem","paths/~1brand-products/post/responses/400/content/application~1json/examples/warehouseIncomplete","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidWarehouseAddressCountry","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidMarketSegment","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidEcoModulation","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidGtins"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1brand-products/post/responses/400/content/application~1json/examples/neitherManufacturedProductNorPurchasedItem","paths/~1brand-products/post/responses/400/content/application~1json/examples/warehouseIncomplete","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidWarehouseAddressCountry","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidMarketSegment","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidEcoModulation","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidGtins"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized – Missing, invalid or expired token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden – Insufficient permissions."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/403/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict – Brand product with this uniqueIdentifier already exists. The response includes the Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing brand product in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response when that record was created)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity – Referenced resource does not exist (e.g. manufacturedProductId, purchasedItemId, packagingIds, warehouse.supplierId)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/422/content/application~1json/examples/manufacturedProductIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/packagingIdsNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/warehouseSupplierIdNotFound"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/422/content/application~1json/examples/manufacturedProductIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/packagingIdsNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/warehouseSupplierIdNotFound"]}],"pointer":"/paths/~1brand-products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/BrandProductCreatedResponse","exampleIds":["paths/~1brand-products/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductCreatedResponse","exampleIds":["paths/~1brand-products/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1brand-products/post/responses/400/content/application~1json/examples/neitherManufacturedProductNorPurchasedItem","paths/~1brand-products/post/responses/400/content/application~1json/examples/warehouseIncomplete","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidWarehouseAddressCountry","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidMarketSegment","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidEcoModulation","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidGtins"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/400/content/application~1json/examples/missingRequiredField","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidUuid","paths/~1brand-products/post/responses/400/content/application~1json/examples/neitherManufacturedProductNorPurchasedItem","paths/~1brand-products/post/responses/400/content/application~1json/examples/warehouseIncomplete","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidWarehouseAddressCountry","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidMarketSegment","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidEcoModulation","paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidGtins"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/422/content/application~1json/examples/manufacturedProductIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/packagingIdsNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/warehouseSupplierIdNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/post/responses/422/content/application~1json/examples/manufacturedProductIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/packagingIdsNotFound","paths/~1brand-products/post/responses/422/content/application~1json/examples/warehouseSupplierIdNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-data/paths/~1brand-products/post"}],"panels":[]}]},"httpPath":"/brand-products"}],"content":{"contentType":"group","meta":{"name":"post-data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post items","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/suppliers","summary":"Create supplier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-data/paths/~1suppliers/post","deprecated":false},{"title":"/manufactured-materials","summary":"Create manufactured material *","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-data/paths/~1manufactured-materials/post","deprecated":false},{"title":"/manufactured-components","summary":"Create manufactured component","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-data/paths/~1manufactured-components/post","deprecated":false},{"title":"/packagings","summary":"Create packaging *","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-data/paths/~1packagings/post","deprecated":false},{"title":"/manufactured-products","summary":"Create manufactured product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-data/paths/~1manufactured-products/post","deprecated":false},{"title":"/purchased-items","summary":"Create purchased item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-data/paths/~1purchased-items/post","deprecated":false},{"title":"/brand-products","summary":"Create brand product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-data/paths/~1brand-products/post","deprecated":false}]}]}]}]}},{"type":"separator","label":"2. Modify","content":null},{"type":"group","label":"Brand products","link":"/swagger-fairlymadeapi-v3/update-brand-products","routeSlug":"/swagger-fairlymadeapi-v3/update-brand-products","items":[{"label":"Call by unique identifier","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-brand-products/patchbrandproductbyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/update-brand-products/patchbrandproductbyuniqueidentifier","metadata":{"seo":{"title":"Call by unique identifier","description":"Call by: uniqueIdentifier — your internal reference (same value as on POST /brand-products)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBrandProductByUniqueIdentifier","name":"Call by unique identifier","isWebhook":false,"pointer":"/paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal reference (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update with the same body and rules as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /brand-products/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product belongs to another client, the response is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BrandProductNotFoundByUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — existence is not revealed (contrast with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the id exists but is out of scope)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side effects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" introducing a product link on update may trigger traceability or legacy migration. Failures return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without rollback — the record is kept; retry the request."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your resource "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"pointer":"/paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/brand-products/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/brand-products/by-unique-identifier/{uniqueIdentifier}","href":"update-brand-products/patchbrandproductbyuniqueidentifier","openApiOperationId":"patchBrandProductByUniqueIdentifier","summary":"Call by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated brand product record (full DTO).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerReadModel"}},"schemaId":"components/schemas/BrandProductCustomerReadModel"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid payload, empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or business rules not satisfied."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or product belongs to another client."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Referenced resource missing, not declared, inactive supplier, or side-effect failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BrandProductCustomerReadModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerReadModel"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-brand-products/patchbrandproductbyuniqueidentifier"}],"panels":[]}]},"httpPath":"/brand-products/by-unique-identifier/{uniqueIdentifier}"},{"label":"Call by id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-brand-products/patchbrandproductbyid","routeSlug":"/swagger-fairlymadeapi-v3/update-brand-products/patchbrandproductbyid","metadata":{"seo":{"title":"Call by id","description":"Call by: id — the Fairly Made brand product id (UUID v4) from the 201 response of POST /brand-products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBrandProductById","name":"Call by id","isWebhook":false,"pointer":"/paths/~1brand-products~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made brand product id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a brand product that belongs to your organisation. Use Customer API credentials; your registry scope is resolved from the access token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only include fields you want to change. Omitted fields stay as they are. When you send an array (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a nested object (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warehouse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the value "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replaces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the previous one in full. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (it is set at creation only; sending it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exists but belongs to another client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BrandProductOwnershipViolation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Contrast with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in that case."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side effects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" introducing a product link on update may trigger traceability or legacy migration. Failures return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without rollback — the record is kept; retry the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error responses for PATCH inventory endpoints use a dedicated JSON shape ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), not the same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints that return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made resource id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1brand-products~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/relinkMp"]}},"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/relinkMp"],"pointer":"/paths/~1brand-products~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/brand-products/{id}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/relinkMp"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/brand-products/{id}","href":"update-brand-products/patchbrandproductbyid","openApiOperationId":"patchBrandProductById","summary":"Call by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/relinkMp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerPatchBody","exampleIds":["paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/relinkMp"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated brand product record.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerReadModel"}},"schemaId":"components/schemas/BrandProductCustomerReadModel"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid payload, unknown fields (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must not be sent), or business rules not satisfied after applying the update."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/400/content/application~1json/examples/uniqueIdentifierNotAllowed"]}},"schemaId":"components/schemas/CustomerInventoryValidationError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/400/content/application~1json/examples/uniqueIdentifierNotAllowed"]},{"code":"401","description":"Missing or invalid access token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"The product exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Unknown brand product id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"A referenced id is missing, not in your scope, or points to an inactive supplier.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1brand-products~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BrandProductCustomerReadModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductCustomerReadModel"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/400/content/application~1json/examples/uniqueIdentifierNotAllowed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/400/content/application~1json/examples/uniqueIdentifierNotAllowed"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1brand-products~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-brand-products/patchbrandproductbyid"}],"panels":[]}]},"httpPath":"/brand-products/{id}"}],"content":{"contentType":"group","meta":{"name":"update-brand-products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brand products","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of a brand product. Two equivalent lookups — pick the one matching the identifier you have:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A brand product can be updated at any time."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unlike the other entities, a brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always taken into account — including after traceability collection has started."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/brand-products/by-unique-identifier/{uniqueIdentifier}","summary":"Call by unique identifier","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-brand-products/patchbrandproductbyuniqueidentifier","deprecated":false},{"title":"/brand-products/{id}","summary":"Call by id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-brand-products/patchbrandproductbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Manufactured products","link":"/swagger-fairlymadeapi-v3/update-manufactured-products","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-products","items":[{"label":"Call by unique identifier","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-manufactured-products/patchmanufacturedproductbyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-products/patchmanufacturedproductbyuniqueidentifier","metadata":{"seo":{"title":"Call by unique identifier","description":"Call by: uniqueIdentifier — your internal reference from POST /manufactured-products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchManufacturedProductByUniqueIdentifier","name":"Call by unique identifier","isWebhook":false,"pointer":"/paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal reference from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update with the same body and rules as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product belongs to another client → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ManufacturedProductNotFoundByUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your resource "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"pointer":"/paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/manufactured-products/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/manufactured-products/by-unique-identifier/{uniqueIdentifier}","href":"update-manufactured-products/patchmanufacturedproductbyuniqueidentifier","openApiOperationId":"patchManufacturedProductByUniqueIdentifier","summary":"Call by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated manufactured product record (full DTO).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerAggregate"}},"schemaId":"components/schemas/ManufacturedProductCustomerAggregate"},{"code":"400","description":"Invalid payload or business rules not satisfied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or product belongs to another client."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Referenced resource missing, not declared, or supplier inactive.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManufacturedProductCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-manufactured-products/patchmanufacturedproductbyuniqueidentifier"}],"panels":[]}]},"httpPath":"/manufactured-products/by-unique-identifier/{uniqueIdentifier}"},{"label":"Call by id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-manufactured-products/patchmanufacturedproductbyid","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-products/patchmanufacturedproductbyid","metadata":{"seo":{"title":"Call by id","description":"Call by: id — the Fairly Made manufactured product id (UUID v4) from the 201 response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchManufacturedProductById","name":"Call by id","isWebhook":false,"pointer":"/paths/~1manufactured-products~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made manufactured product id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a manufactured product that belongs to your organisation (registry scope from the access token)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only include fields you want to change. Omitted fields stay as they are. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sending it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"steps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replaced in full"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sent. Validation rules are checked against the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resulting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource after your changes are applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product exists but belongs to another client → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ManufacturedProductOwnershipViolation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made resource id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1manufactured-products~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/categoryOnly"]}},"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/categoryOnly"],"pointer":"/paths/~1manufactured-products~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/manufactured-products/{id}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/categoryOnly"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/manufactured-products/{id}","href":"update-manufactured-products/patchmanufacturedproductbyid","openApiOperationId":"patchManufacturedProductById","summary":"Call by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/categoryOnly"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerPatchBody","exampleIds":["paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/noOp","paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/categoryOnly"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated manufactured product record (full DTO).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerAggregate"}},"schemaId":"components/schemas/ManufacturedProductCustomerAggregate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid payload, unknown fields (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must not be sent), or business rules not satisfied for the updated product."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing or invalid access token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"The resource exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"404","description":"Unknown manufactured product id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"422","description":"A referenced id is missing, not in your scope, or not usable (e.g. inactive supplier).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1manufactured-products~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManufacturedProductCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedProductCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-manufactured-products/patchmanufacturedproductbyid"}],"panels":[]}]},"httpPath":"/manufactured-products/{id}"}],"content":{"contentType":"group","meta":{"name":"update-manufactured-products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manufactured products","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of a manufactured product. Two equivalent lookups:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates are locked once traceability collection starts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you run traceability collection (SDC) with Fairly Made, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on this entity is taken into account only until the collection is launched for its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Collection can be launched only once per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — after that launch, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calls on this entity are no longer taken into account. (Brand products are the exception: they can be updated at any time.)"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/manufactured-products/by-unique-identifier/{uniqueIdentifier}","summary":"Call by unique identifier","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-manufactured-products/patchmanufacturedproductbyuniqueidentifier","deprecated":false},{"title":"/manufactured-products/{id}","summary":"Call by id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-manufactured-products/patchmanufacturedproductbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Manufactured components","link":"/swagger-fairlymadeapi-v3/update-manufactured-components","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-components","items":[{"label":"Call by unique identifier","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-manufactured-components/patchmanufacturedcomponentbyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-components/patchmanufacturedcomponentbyuniqueidentifier","metadata":{"seo":{"title":"Call by unique identifier","description":"Call by: uniqueIdentifier — your internal reference from POST /manufactured-components."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchManufacturedComponentByUniqueIdentifier","name":"Call by unique identifier","isWebhook":false,"pointer":"/paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal reference from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-components"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update with the same body and rules as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the component belongs to another client → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ManufacturedComponentNotFoundByUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your resource "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"pointer":"/paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/manufactured-components/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/manufactured-components/by-unique-identifier/{uniqueIdentifier}","href":"update-manufactured-components/patchmanufacturedcomponentbyuniqueidentifier","openApiOperationId":"patchManufacturedComponentByUniqueIdentifier","summary":"Call by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated manufactured component record (full DTO).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerAggregate"}},"schemaId":"components/schemas/ManufacturedComponentCustomerAggregate"},{"code":"400","description":"Invalid payload or business rules not satisfied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or component belongs to another client."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Referenced resource missing, not declared, or supplier inactive.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManufacturedComponentCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-manufactured-components/patchmanufacturedcomponentbyuniqueidentifier"}],"panels":[]}]},"httpPath":"/manufactured-components/by-unique-identifier/{uniqueIdentifier}"},{"label":"Call by id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-manufactured-components/patchmanufacturedcomponentbyid","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-components/patchmanufacturedcomponentbyid","metadata":{"seo":{"title":"Call by id","description":"Call by: id — the Fairly Made component id (UUID v4) from the 201 response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchManufacturedComponentById","name":"Call by id","isWebhook":false,"pointer":"/paths/~1manufactured-components~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made component id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a manufactured component (registry scope from the access token)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only include fields you want to change. Omitted fields stay as they are. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sending it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the array "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replaces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the previous list and must contain at least one line; percentages must sum to 100%."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the component exists but belongs to another client → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ManufacturedComponentOwnershipViolation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made resource id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1manufactured-components~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody"}},"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody","pointer":"/paths/~1manufactured-components~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/manufactured-components/{id}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/manufactured-components/{id}","href":"update-manufactured-components/patchmanufacturedcomponentbyid","openApiOperationId":"patchManufacturedComponentById","summary":"Call by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerPatchBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated component; response body is the full component record.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerAggregate"}},"schemaId":"components/schemas/ManufacturedComponentCustomerAggregate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid payload, unknown fields (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must not be sent), or business rules not satisfied for the updated component."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing or invalid access token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"The resource exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"404","description":"Unknown manufactured component id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"422","description":"A referenced id is missing, not in your scope, or not usable (e.g. inactive supplier).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1manufactured-components~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManufacturedComponentCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedComponentCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-manufactured-components/patchmanufacturedcomponentbyid"}],"panels":[]}]},"httpPath":"/manufactured-components/{id}"}],"content":{"contentType":"group","meta":{"name":"update-manufactured-components"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manufactured components","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of a manufactured component. Two equivalent lookups:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates are locked once traceability collection starts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you run traceability collection (SDC) with Fairly Made, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on this entity is taken into account only until the collection is launched for its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Collection can be launched only once per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — after that launch, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calls on this entity are no longer taken into account. (Brand products are the exception: they can be updated at any time.)"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/manufactured-components/by-unique-identifier/{uniqueIdentifier}","summary":"Call by unique identifier","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-manufactured-components/patchmanufacturedcomponentbyuniqueidentifier","deprecated":false},{"title":"/manufactured-components/{id}","summary":"Call by id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-manufactured-components/patchmanufacturedcomponentbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Manufactured materials","link":"/swagger-fairlymadeapi-v3/update-manufactured-materials","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-materials","items":[{"label":"Call by unique identifier","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-manufactured-materials/patchmanufacturedmaterialbyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-materials/patchmanufacturedmaterialbyuniqueidentifier","metadata":{"seo":{"title":"Call by unique identifier","description":"Call by: uniqueIdentifier — your internal reference from POST /manufactured-materials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchManufacturedMaterialByUniqueIdentifier","name":"Call by unique identifier","isWebhook":false,"pointer":"/paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal reference from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-materials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update with the same body and rules as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the material belongs to another client → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ManufacturedMaterialNotFoundByUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your resource "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"pointer":"/paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/manufactured-materials/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/manufactured-materials/by-unique-identifier/{uniqueIdentifier}","href":"update-manufactured-materials/patchmanufacturedmaterialbyuniqueidentifier","openApiOperationId":"patchManufacturedMaterialByUniqueIdentifier","summary":"Call by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated manufactured material record (full DTO).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate"}},"schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate"},{"code":"400","description":"Invalid payload or business rules not satisfied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or material belongs to another client."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Referenced resource missing, not declared, or supplier inactive.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-manufactured-materials/patchmanufacturedmaterialbyuniqueidentifier"}],"panels":[]}]},"httpPath":"/manufactured-materials/by-unique-identifier/{uniqueIdentifier}"},{"label":"Call by id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-manufactured-materials/patchmanufacturedmaterialbyid","routeSlug":"/swagger-fairlymadeapi-v3/update-manufactured-materials/patchmanufacturedmaterialbyid","metadata":{"seo":{"title":"Call by id","description":"Call by: id — the Fairly Made material id (UUID v4) from the 201 response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchManufacturedMaterialById","name":"Call by id","isWebhook":false,"pointer":"/paths/~1manufactured-materials~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made material id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a manufactured material (registry scope from the access token)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only include fields you want to change. Omitted fields stay as they are. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sending it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you change the raw material, send "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or send neither. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are replaced in full when sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the material exists but belongs to another client → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ManufacturedMaterialOwnershipViolation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made resource id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1manufactured-materials~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody"}},"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody","pointer":"/paths/~1manufactured-materials~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/manufactured-materials/{id}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/manufactured-materials/{id}","href":"update-manufactured-materials/patchmanufacturedmaterialbyid","openApiOperationId":"patchManufacturedMaterialById","summary":"Call by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerPatchBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated material; response body is the full material record.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate"}},"schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid payload, unknown fields (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must not be sent), or business rules not satisfied for the updated material."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing or invalid access token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"The resource exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"404","description":"Unknown manufactured material id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"422","description":"A referenced id is missing, not in your scope, or not usable (e.g. inactive supplier).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1manufactured-materials~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManufacturedMaterialCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-manufactured-materials/patchmanufacturedmaterialbyid"}],"panels":[]}]},"httpPath":"/manufactured-materials/{id}"}],"content":{"contentType":"group","meta":{"name":"update-manufactured-materials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manufactured materials","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of a manufactured material. Two equivalent lookups:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates are locked once traceability collection starts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you run traceability collection (SDC) with Fairly Made, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on this entity is taken into account only until the collection is launched for its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Collection can be launched only once per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — after that launch, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calls on this entity are no longer taken into account. (Brand products are the exception: they can be updated at any time.)"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/manufactured-materials/by-unique-identifier/{uniqueIdentifier}","summary":"Call by unique identifier","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-manufactured-materials/patchmanufacturedmaterialbyuniqueidentifier","deprecated":false},{"title":"/manufactured-materials/{id}","summary":"Call by id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-manufactured-materials/patchmanufacturedmaterialbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Purchased items","link":"/swagger-fairlymadeapi-v3/update-purchased-items","routeSlug":"/swagger-fairlymadeapi-v3/update-purchased-items","items":[{"label":"Call by unique identifier","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-purchased-items/patchpurchaseditembyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/update-purchased-items/patchpurchaseditembyuniqueidentifier","metadata":{"seo":{"title":"Call by unique identifier","description":"Call by: uniqueIdentifier — your internal reference from POST /purchased-items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPurchasedItemByUniqueIdentifier","name":"Call by unique identifier","isWebhook":false,"pointer":"/paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal reference from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update with the same body and rules as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerKind"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and buyer/seller identity fields "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the item belongs to another client → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PurchasedItemNotFoundByUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your resource "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerPatchBody"}},"schemaId":"components/schemas/PurchasedItemCustomerPatchBody","pointer":"/paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/purchased-items/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerPatchBody"}},"responseCodes":["200","400","401","404","422"],"pointer":"/purchased-items/by-unique-identifier/{uniqueIdentifier}","href":"update-purchased-items/patchpurchaseditembyuniqueidentifier","openApiOperationId":"patchPurchasedItemByUniqueIdentifier","summary":"Call by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/PurchasedItemCustomerPatchBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerPatchBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated purchased item record (full DTO).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerAggregate"}},"schemaId":"components/schemas/PurchasedItemCustomerAggregate"},{"code":"400","description":"Invalid payload or business rules not satisfied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or item belongs to another client."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Referenced item, supplier, or file missing or inconsistent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchasedItemCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","exampleIds":["paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-purchased-items/patchpurchaseditembyuniqueidentifier"}],"panels":[]}]},"httpPath":"/purchased-items/by-unique-identifier/{uniqueIdentifier}"},{"label":"Call by id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/update-purchased-items/patchpurchaseditembyid","routeSlug":"/swagger-fairlymadeapi-v3/update-purchased-items/patchpurchaseditembyid","metadata":{"seo":{"title":"Call by id","description":"Call by: id — the Fairly Made purchased item id (UUID v4) from the 201 response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPurchasedItemById","name":"Call by id","isWebhook":false,"pointer":"/paths/~1purchased-items~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made purchased item id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a purchased item that belongs to your organisation (registry scope from the access token)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only include fields you want to change. Omitted fields stay as they are. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be included"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sending it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (product, component, or material) is fixed at creation and cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"buyer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seller"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are also fixed at creation and cannot be changed on update — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not part of the update body (sending any of them returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When present, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the previous values in full."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchased items:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a resource belonging to another client returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PurchasedItem_NotFound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), not "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — unlike other inventory entities on "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made resource id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1purchased-items~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerPatchBody"}},"schemaId":"components/schemas/PurchasedItemCustomerPatchBody","pointer":"/paths/~1purchased-items~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/purchased-items/{id}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerPatchBody"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/purchased-items/{id}","href":"update-purchased-items/patchpurchaseditembyid","openApiOperationId":"patchPurchasedItemById","summary":"Call by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"schemaId":"components/schemas/PurchasedItemCustomerPatchBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerPatchBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated purchased item; response body is the full item record.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerAggregate"}},"schemaId":"components/schemas/PurchasedItemCustomerAggregate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid payload, unknown fields (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must not be sent), or business rules not satisfied for the updated purchased item."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}},"schemaId":"components/schemas/CustomerInventoryValidationError"},{"code":"401","description":"Missing or invalid access token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"The resource exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"404","description":"Unknown purchased item id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}},"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"},{"code":"422","description":"A referenced supplier, item, or file is missing, out of scope, inactive, or inconsistent with the item type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}},"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}],"pointer":"/paths/~1purchased-items~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchasedItemCustomerAggregate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasedItemCustomerAggregate"}}},{"code":"400","schemaId":"components/schemas/CustomerInventoryValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryValidationError"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"404","schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryForbiddenOrNotFoundError"}}},{"code":"422","schemaId":"components/schemas/CustomerInventoryUnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerInventoryUnprocessableError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/update-purchased-items/patchpurchaseditembyid"}],"panels":[]}]},"httpPath":"/purchased-items/{id}"}],"content":{"contentType":"group","meta":{"name":"update-purchased-items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Purchased items","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of a purchased item. Two equivalent lookups:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates are locked once traceability collection starts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you run traceability collection (SDC) with Fairly Made, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on this entity is taken into account only until the collection is launched for its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Collection can be launched only once per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — after that launch, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calls on this entity are no longer taken into account. (Brand products are the exception: they can be updated at any time.)"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/purchased-items/by-unique-identifier/{uniqueIdentifier}","summary":"Call by unique identifier","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-purchased-items/patchpurchaseditembyuniqueidentifier","deprecated":false},{"title":"/purchased-items/{id}","summary":"Call by id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/update-purchased-items/patchpurchaseditembyid","deprecated":false}]}]}]}]}},{"type":"separator","label":"3. Retrieve","content":null},{"type":"group","label":"Brand products with links — all products (list)","link":"/swagger-fairlymadeapi-v3/list-brand-products","routeSlug":"/swagger-fairlymadeapi-v3/list-brand-products","items":[{"label":"List brand products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/list-brand-products/listbrandproducts","routeSlug":"/swagger-fairlymadeapi-v3/list-brand-products/listbrandproducts","metadata":{"seo":{"title":"List brand products","description":"Returns, in one paginated call, all your brand products — selected with the same filters and sorts as the My Products page of the Fairly Made portal — and, for the products whose communication pack is active, the product's QR-code and web links."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBrandProducts","name":"List brand products","isWebhook":false,"pointer":"/paths/~1brand-products/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List brand products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns, in one paginated call, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your brand products — selected with the same filters and sorts as the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"My Products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page of the Fairly Made portal — and, for the products whose communication pack is active, the product's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QR-code and web links"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All results are scoped to the brand the token belongs to; there is no way to read another brand's data, and a product that is not yours is simply absent from the result set (no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the endpoint to retrieve your products' QR-code and web links in bulk"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — one call returns the links for every product whose communication pack is active. See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section below for the exact behavior."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freshness — a product appears in this list up to 20 minutes after it is created or updated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This list is served from an analytics store refreshed "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 20 minutes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". So a product just created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or changed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") appears on this list only at the next refresh — treat the 20 minutes as an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upper bound"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses return the affected product immediately, so do not poll this list for a just-written product; for a full catalogue sync, schedule it (hourly, nightly) rather than triggering it right after a write."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because the list and the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"My Products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page read the same store, a given filter returns the same products and the same total in both."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"list-brand-products/listbrandproducts/request/filtering-and-sorting","deepLinkHash":"/list-brand-products/listbrandproducts#list-brand-products/listbrandproducts/request/filtering-and-sorting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering and sorting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint accepts the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same filters and sorts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List declared French environmental cost"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /declared-french-environmental-cost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — same field list, encoding→filter mapping and operator/validation rules. See that endpoint for the exhaustive reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are optional query parameters; combination rule is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OR within a field, AND across fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An unknown parameter returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (strict schema)."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shape"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syntax"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — case-insensitive over name, id, ref and collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search=shirt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeat the key, or a single value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCategories=SHIRT&productCategories=DRESS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[op]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"op"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ∈ "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"neq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[min]="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[max]="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight[gte]=100"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[start]="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[end]="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (range, open bounds allowed)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceabilityStartDate[start]=2026-01-01"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isProductInAGECScope=true"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most useful filters for this route:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — repeatable (UUID)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marketSegment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — read at the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level on this route."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceabilityStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"theoreticalTraceabilityEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the supplier-collection business dates (launch date and deadline). When no deadline was set, the end defaults to launch + 70 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — one supplier per request (UUID); returns the products associated with that supplier."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy=<field>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy=asc|desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); the sortable keys are those of the declared-FEC endpoint. Filtering and sorting are allowed on fields the response does not return. Pagination is stable: the sort always adds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a tie-breaker, so consecutive pages do not overlap. Text sorts ignore case, and values starting with a digit come after the others; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values always sort last, in both directions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL-length caveat:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" large repeated id lists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") can hit the ~8 KB URL limit — filter more narrowly, or page."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"list-brand-products/listbrandproducts/request/links","deepLinkHash":"/list-brand-products/listbrandproducts#list-brand-products/listbrandproducts/request/links"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a product whose communication pack is active ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasCommunicationPackage: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links.qrCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links.web"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carry the product's stable, printable hub URLs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for whichever link the product does not have yet). For a product without the pack ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasCommunicationPackage: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), links are withheld as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links: { qrCode: null, web: null }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". So within one page, some products carry links and others do not — the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasCommunicationPackage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag tells you which case you are in. A product keeps its links even if the brand later stops the pack on other products; the decision is per product. Activating the pack becomes visible here at the next refresh (up to 20 minutes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same links rule applies everywhere on the resource"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this list and the create ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") / update ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") responses all withhold "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a product without the communication pack."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links are environment-specific:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the URL points at the environment serving the request (production, sandbox), not always the production domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"list-brand-products/listbrandproducts/request/response-field-notes","deepLinkHash":"/list-brand-products/listbrandproducts#list-brand-products/listbrandproducts/request/response-field-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response field notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as a list of plain strings. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always present (see above). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"producedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the amount only, without a unit."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero-based index of the first row to return. Default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">= 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of rows to return per page. Default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"> 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", max "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"search","in":"query","schemaId":"schema_25","description":"Free-text search over product name, id, reference and collection."},{"name":"sortBy","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort by (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Accepts the sortable keys of the List declared French environmental cost endpoint. Sorting is allowed on fields the response does not return."},"children":[]}]}]}]},{"name":"orderBy","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values always sort last, in both directions."},"children":[]}]}]}]},{"name":"brandProductId","in":"query","schemaId":"schema_28","description":"Fairly Made product id (UUID v4). Repeatable to narrow to several products; pass a single id to target one product.\n"},{"name":"brandProductUniqueIdentifier","in":"query","schemaId":"schema_29","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Repeatable; pass a single value to target one product by client reference."},"children":[]}]}]}]}],"pointer":"/paths/~1brand-products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/brand-products","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_23"},{"name":"limit","in":"query","required":false,"schemaId":"schema_24"},{"name":"search","in":"query","required":false,"schemaId":"schema_25"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_26"},{"name":"orderBy","in":"query","required":false,"schemaId":"schema_27"},{"name":"brandProductId","in":"query","required":false,"schemaId":"schema_28","style":"form","explode":true},{"name":"brandProductUniqueIdentifier","in":"query","required":false,"schemaId":"schema_29","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","502"],"pointer":"/brand-products","href":"list-brand-products/listbrandproducts","openApiOperationId":"listBrandProducts","summary":"List brand products"},"definitionSamples":[{"lang":"Shell","label":"First page, most recent first","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n  \"https://api.fairlymade.com/v3/brand-products?sortBy=createdAt&orderBy=desc&limit=20\"\n"},{"lang":"Shell","label":"One collection, by client reference","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n  \"https://api.fairlymade.com/v3/brand-products?collections=25W&collections=26W\"\n"},{"lang":"Shell","label":"Two specific products, second page","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n  \"https://api.fairlymade.com/v3/brand-products?brandProductId=0d4a1c9e-1a2b-4c3d-8e4f-5a6b7c8d9e0f&brandProductId=7f21b0aa-1111-2222-3333-444455556666&offset=20&limit=20\"\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginated list of your brand products. A valid request with no match returns 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data: []"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total: 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". There is no 404 or 403 — a product that does not exist or does not belong to your brand is simply absent from the result set."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductListResponse","exampleIds":["paths/~1brand-products/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BrandProductListResponse","exampleIds":["paths/~1brand-products/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALIDATION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): unknown filter or sort key, wrong value type, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" above 100 or a negative "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a numeric field with both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[op]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[min]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[max]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a numeric range with only one bound; a date field with both the exact form and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[start]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[end]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; or an unknown numeric operator (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight[between]=…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Missing or invalid bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/401/content/application~1json/example"]},{"code":"502","description":"Upstream data store unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1brand-products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BrandProductListResponse","exampleIds":["paths/~1brand-products/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrandProductListResponse","exampleIds":["paths/~1brand-products/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/401/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1brand-products/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/list-brand-products/listbrandproducts"}],"panels":[]}]},"httpPath":"/brand-products"}],"content":{"contentType":"group","meta":{"name":"list-brand-products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brand products with links — all products (list)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List, filter, sort and paginate "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your brand products in a single call. Same filters and sorts as the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"My products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page of the portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve your products' links in bulk."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For every product whose communication pack is active, the response carries the product's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QR-code and web links"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — so this is the endpoint to use to pull all your QR-code and web links at once."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/brand-products","summary":"List brand products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/list-brand-products/listbrandproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Declared FEC — all products (list)","link":"/swagger-fairlymadeapi-v3/list-declared-fec","routeSlug":"/swagger-fairlymadeapi-v3/list-declared-fec","items":[{"label":"List declared French environmental cost","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/list-declared-fec/listdeclaredfrenchenvironmentalcost","routeSlug":"/swagger-fairlymadeapi-v3/list-declared-fec/listdeclaredfrenchenvironmentalcost","metadata":{"seo":{"title":"List declared French environmental cost","description":"Returns, in one paginated call, the declared French environmental cost (FEC — affichage environnemental / Ecobalyse) across your products, with the same filters and sorts as the My Products page of the Fairly Made portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDeclaredFrenchEnvironmentalCost","name":"List declared French environmental cost","isWebhook":false,"pointer":"/paths/~1declared-french-environmental-cost/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List declared French environmental cost","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns, in one paginated call, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"declared French environmental cost"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (FEC — "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"affichage environnemental"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / Ecobalyse) across your products, with the same filters and sorts as the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"My Products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page of the Fairly Made portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the collection counterpart to the single-product read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /declared-french-environmental-cost/{brandProductId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freshness — a product appears in this list up to 20 minutes after it is created or updated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This list is served from an analytics store refreshed "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 20 minutes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", whereas the single-product endpoints are served from the live store and answer instantly. So a product just created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or changed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is visible on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /declared-french-environmental-cost/{brandProductId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" immediately, but on this list only at the next refresh. This is expected behavior — treat the 20 minutes as an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upper bound"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For a just-written product, verify with the single-product read (authoritative immediately) rather than polling this list; for a full catalogue sync, schedule it (hourly, nightly) rather than triggering it right after a write."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because the list and the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"My Products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page read the same store, a given filter returns the same products and the same total in both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a Customer API bearer token ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). All results are scoped to the brand the token belongs to; there is no way to read another brand's data."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list returns every matching product, declared or not."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A product without a declaration returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"governmentPlatformPublicationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the boolean flag as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no declaration record exists at all). To retrieve "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only declared products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isFrenchEnvironmentalCostPublishedToGovernmentPlatform=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Published values are the snapshot submitted at declaration time — they can differ from a freshly recalculated score."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"list-declared-fec/listdeclaredfrenchenvironmentalcost/request/filtering","deepLinkHash":"/list-declared-fec/listdeclaredfrenchenvironmentalcost#list-declared-fec/listdeclaredfrenchenvironmentalcost/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are optional query parameters. Combination rule: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OR within a field, AND across fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — repeating a parameter widens that filter, adding another parameter narrows the result. The operator syntax depends only on the field's type. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" box below lists the pagination/sort controls and the id filters; the table here is the full filter reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shape"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query encoding"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (matches product name / id / reference / collection)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search=<text>"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search=zipped"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text any-of"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"componentCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCertifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecoModulation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marketSegment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productPublicName{FR,IT,EN,ES}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declaredProductSupplier{Ref,Name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declaredComponentsSuppliers{Ref,Name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frenchEnvironmentalCostCustomerSettingsEditedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeat the param, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[]=a&field[]=b"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections=25W&collections=26W"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean any-of"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isProductInAGECScope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isProductAGECCompliant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isProductConcernedByFrenchMethodology"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isFrenchEnvironmentalCostPublishedToGovernmentPlatform"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeat the param; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isFrenchEnvironmentalCostPublishedToGovernmentPlatform=true"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID any-of"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Fairly Made product ids), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (products associated to these suppliers; capped list size)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeat with UUID values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId=<uuid>&brandProductId=<uuid>"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric comparison"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" below"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[op]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"op"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ∈ "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"neq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publishedFrenchEnvironmentalCost[gte]=200"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric range"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[min]=…&field[max]=…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (both bounds required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight[min]=100&weight[max]=500"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date is"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" below"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field=<ISO 8601 date>"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"governmentPlatformPublicationDate=2026-01-01"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date between"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[start]=…&field[end]=…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (open bound allowed: either one alone)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"governmentPlatformPublicationDate[start]=2026-01-01&governmentPlatformPublicationDate[end]=2026-03-01"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One shape at a time per field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a numeric field takes either a comparison or a range (never both); a date field takes either an exact value or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[start]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[end]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range (never both)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Composition / quantities: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"producedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"microplasticsPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recycledMaterialsPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Durability / service: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjustedServiceDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bonusMalusServiceDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"durabilityCoefficient"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deadstock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"microfibers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outOfEuropeExport"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promotionToRepairIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rangeOfProductsIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceServiceDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scores / price: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lcaScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pefSingleScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceabilityScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". FEC: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastCalculatedFrenchEnvironmentalCost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastCalculatedFrenchEnvironmentalCostPer100grams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publishedFrenchEnvironmentalCost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publishedFrenchEnvironmentalCostPer100grams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". LCA impact indicators — each exists as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"…FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"…PEF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"climateChangeFR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"climateChangePEF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acidification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"climateChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eutrophicationFreshwater"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eutrophicationMarine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eutrophicationTerrestrial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecotoxicityFreshwater"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"particulateMatter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"humanToxicityNonCancer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"humanToxicityCancer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ionisingRadiationHumanHealth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"landUse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waterUse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ozoneDepletion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"photochemicalOzoneFormationHumanHealth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceUseFossils"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceUseMineralsAndMetals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — plus FR-only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"climateChangeFossilFR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"climateChangeBiogenicFR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"climateChangeLandUseFR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"governmentPlatformPublicationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agecClaimsAndComplianceCalculatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastCalculatedFrenchEnvironmentalCostComputationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frenchEnvironmentalCostCustomerSettingsEditedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastLCAUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceabilityStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"theoreticalTraceabilityEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"list-declared-fec/listdeclaredfrenchenvironmentalcost/request/sorting","deepLinkHash":"/list-declared-fec/listdeclaredfrenchenvironmentalcost#list-declared-fec/listdeclaredfrenchenvironmentalcost/request/sorting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy=<field>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy=asc|desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values always sort "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in both directions; text keys sort case-insensitively. Sorting and filtering are allowed on fields the response does not return (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy=productScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" works even though the score is not in the payload). Sortable keys include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus every text, numeric and date field listed under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero-based index of the first row to return. Default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">= 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of rows to return per page. Default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"> 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", max "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"search","in":"query","schemaId":"schema_25","description":"Free-text search over product name, id, reference and collection."},{"name":"sortBy","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort by (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Accepts any sortable key — see the Sorting section in the description. Sorting is allowed on fields the response does not return."},"children":[]}]}]}]},{"name":"orderBy","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values always sort last, in both directions."},"children":[]}]}]}]},{"name":"brandProductId","in":"query","schemaId":"schema_28","description":"Fairly Made product id (UUID v4). Repeatable to narrow to several products; pass a single id to target one product.\n"},{"name":"brandProductUniqueIdentifier","in":"query","schemaId":"schema_29","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Repeatable; pass a single value to target one product by client reference."},"children":[]}]}]}]}],"pointer":"/paths/~1declared-french-environmental-cost/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/declared-french-environmental-cost","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_23"},{"name":"limit","in":"query","required":false,"schemaId":"schema_24"},{"name":"search","in":"query","required":false,"schemaId":"schema_25"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_26"},{"name":"orderBy","in":"query","required":false,"schemaId":"schema_27"},{"name":"brandProductId","in":"query","required":false,"schemaId":"schema_28","style":"form","explode":true},{"name":"brandProductUniqueIdentifier","in":"query","required":false,"schemaId":"schema_29","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","502"],"pointer":"/declared-french-environmental-cost","href":"list-declared-fec/listdeclaredfrenchenvironmentalcost","openApiOperationId":"listDeclaredFrenchEnvironmentalCost","summary":"List declared French environmental cost"},"definitionSamples":[{"lang":"Shell","label":"Declared products, most recently published first","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n  \"https://api.fairlymade.com/v3/declared-french-environmental-cost?isFrenchEnvironmentalCostPublishedToGovernmentPlatform=true&sortBy=governmentPlatformPublicationDate&orderBy=desc&limit=20\"\n"},{"lang":"Shell","label":"Collections + cost >= 200, sorted","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n  \"https://api.fairlymade.com/v3/declared-french-environmental-cost?collections=25W&collections=26W&publishedFrenchEnvironmentalCost[gte]=200&sortBy=publishedFrenchEnvironmentalCost&orderBy=desc\"\n"},{"lang":"Shell","label":"Published in Q1 2026, weight 100-500 g","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n  \"https://api.fairlymade.com/v3/declared-french-environmental-cost?governmentPlatformPublicationDate[start]=2026-01-01&governmentPlatformPublicationDate[end]=2026-03-31&weight[min]=100&weight[max]=500\"\n"},{"lang":"Shell","label":"Two specific products, second page","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n  \"https://api.fairlymade.com/v3/declared-french-environmental-cost?brandProductId=0d4a1c9e-1a2b-4c3d-8e4f-5a6b7c8d9e0f&brandProductId=7f21b0aa-1111-2222-3333-444455556666&offset=20&limit=20\"\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginated list of products with their declared FEC. A valid request with no match returns 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data: []"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total: 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". There is no 404 or 403 — a product that does not exist or does not belong to your brand is simply absent from the result set."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostListResponse","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostListResponse","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALIDATION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): unknown filter/sort key, wrong value type, out-of-range "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a numeric field with both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[op]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[min]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[max]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a numeric range with only one bound; a date field with both the exact form and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[start]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[end]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; or an unknown numeric operator (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight[between]=…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownKey","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/numberOperatorConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/incompleteNumberRange","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/dateFormConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownOperator"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownKey","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/numberOperatorConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/incompleteNumberRange","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/dateFormConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownOperator"]},{"code":"401","description":"Missing or invalid bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/401/content/application~1json/example"]},{"code":"502","description":"Upstream data store unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1declared-french-environmental-cost/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostListResponse","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostListResponse","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownKey","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/numberOperatorConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/incompleteNumberRange","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/dateFormConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownOperator"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownKey","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/numberOperatorConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/incompleteNumberRange","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/dateFormConflict","paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownOperator"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/401/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1declared-french-environmental-cost/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/list-declared-fec/listdeclaredfrenchenvironmentalcost"}],"panels":[]}]},"httpPath":"/declared-french-environmental-cost"}],"content":{"contentType":"group","meta":{"name":"list-declared-fec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Declared FEC — all products (list)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List, filter, sort and paginate the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"declared"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" French Environmental Cost (FEC) for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your brand products in a single call — the bulk equivalent of the single-product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /declared-french-environmental-cost/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints. Same data, filters and sorts as the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"My products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page of the portal."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/declared-french-environmental-cost","summary":"List declared French environmental cost","prefix":{"name":"get","color":"get"},"badges":[],"link":"/list-declared-fec/listdeclaredfrenchenvironmentalcost","deprecated":false}]}]}]}]}},{"type":"group","label":"Deprecated","link":"/swagger-fairlymadeapi-v3/deprecated-retrieve","routeSlug":"/swagger-fairlymadeapi-v3/deprecated-retrieve","items":[{"label":"Calculated FEC — by unique identifier","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbyuniqueidentifier","metadata":{"seo":{"title":"Calculated FEC — by unique identifier","description":"Call by: uniqueIdentifier — your internal brand product reference (same value as on POST /brand-products)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCalculatedFrenchEnvironmentalCostByUniqueIdentifier","name":"Calculated FEC — by unique identifier","deprecated":true,"isWebhook":false,"pointer":"/paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculated FEC — by unique identifier","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal brand product reference (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" French Environmental Cost (FEC / "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coût Environnemental Calculé"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for the matching brand product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a Customer API bearer token. Your registry customer scope is resolved from the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not validated as a UUID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — any non-empty URL-encoded string is accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error responses use a dedicated JSON shape: machine-readable codes are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calculated-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","422","502"],"pointer":"/calculated-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}","href":"deprecated-retrieve/getcalculatedfrenchenvironmentalcostbyuniqueidentifier","openApiOperationId":"getCalculatedFrenchEnvironmentalCostByUniqueIdentifier","summary":"Calculated FEC — by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Calculated FEC available for this brand product.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or bearer token registry context."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}},"schemaId":"components/schemas/AnalysisReadError"},{"code":"404","description":"No brand product matches the identifier, or calculated FEC is not available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"]},{"code":"422","description":"Registry customer unknown, or lookup by unique identifier failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"]},{"code":"502","description":"Unexpected upstream failure while resolving the brand product or FEC calculation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}}},{"code":"401","schemaId":"components/schemas/AnalysisReadError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}}},{"code":"404","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}}},{"code":"422","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"]}}},{"code":"502","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbyuniqueidentifier"}],"panels":[]}]},"httpPath":"/calculated-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}"},{"label":"Calculated FEC — by brand product id","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbybrandproductid","routeSlug":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbybrandproductid","metadata":{"seo":{"title":"Calculated FEC — by brand product id","description":"Call by: brandProductId — the Fairly Made brand product id (UUID v4) from the 201 response of POST /brand-products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCalculatedFrenchEnvironmentalCostByBrandProductId","name":"Calculated FEC — by brand product id","deprecated":true,"isWebhook":false,"pointer":"/paths/~1calculated-french-environmental-cost~1{brandProductId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculated FEC — by brand product id","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made brand product id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" French Environmental Cost (FEC / "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coût Environnemental Calculé"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for the matching brand product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a Customer API bearer token. Your registry customer scope is resolved from the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error responses use a dedicated JSON shape: machine-readable codes are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"brandProductId","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand product id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1calculated-french-environmental-cost~1{brandProductId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calculated-french-environmental-cost/{brandProductId}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"brandProductId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","502"],"pointer":"/calculated-french-environmental-cost/{brandProductId}","href":"deprecated-retrieve/getcalculatedfrenchenvironmentalcostbybrandproductid","openApiOperationId":"getCalculatedFrenchEnvironmentalCostByBrandProductId","summary":"Calculated FEC — by brand product id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Calculated FEC available for this brand product.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel"}},"schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or bearer token registry context."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}},"schemaId":"components/schemas/AnalysisReadError"},{"code":"403","description":"The brand product exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Unknown brand product id, or product exists but calculated FEC is not available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"]},{"code":"422","description":"Bearer token registry customer is syntactically valid but unknown.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"]},{"code":"502","description":"Unexpected upstream failure while resolving the brand product or FEC calculation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel"}}},{"code":"400","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}}},{"code":"401","schemaId":"components/schemas/AnalysisReadError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}}},{"code":"403","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}}},{"code":"422","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbybrandproductid"}],"panels":[]}]},"httpPath":"/calculated-french-environmental-cost/{brandProductId}"},{"label":"LCA — by unique identifier","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getlifecycleassessmentbyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getlifecycleassessmentbyuniqueidentifier","metadata":{"seo":{"title":"LCA — by unique identifier","description":"Call by: uniqueIdentifier — your internal brand product reference (same value as on POST /brand-products)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLifeCycleAssessmentByUniqueIdentifier","name":"LCA — by unique identifier","deprecated":true,"isWebhook":false,"pointer":"/paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LCA — by unique identifier","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal brand product reference (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the life cycle assessment (LCA) results for the matching brand product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes French regulatory indicators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lcaFR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and PEF indicators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lcaPEF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", 17 impact categories including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pefSingleScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a Customer API bearer token. Your registry customer scope is resolved from the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not validated as a UUID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — any non-empty URL-encoded string is accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error responses use a dedicated JSON shape: machine-readable codes are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lifecycle-assessment/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","422","502"],"pointer":"/lifecycle-assessment/by-unique-identifier/{uniqueIdentifier}","href":"deprecated-retrieve/getlifecycleassessmentbyuniqueidentifier","openApiOperationId":"getLifeCycleAssessmentByUniqueIdentifier","summary":"LCA — by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"LCA results available for this brand product.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LifeCycleAssessmentReadModel","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/LifeCycleAssessmentReadModel","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or bearer token registry context."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}},"schemaId":"components/schemas/AnalysisReadError"},{"code":"404","description":"No brand product matches the identifier, or LCA is not available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/lcaNotAvailable"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/lcaNotAvailable"]},{"code":"422","description":"Registry customer unknown, or lookup by unique identifier failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"]},{"code":"502","description":"Unexpected upstream failure while resolving the brand product or LCA results.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LifeCycleAssessmentReadModel","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LifeCycleAssessmentReadModel","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}}},{"code":"401","schemaId":"components/schemas/AnalysisReadError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}}},{"code":"404","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/lcaNotAvailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/lcaNotAvailable"]}}},{"code":"422","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound","paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"]}}},{"code":"502","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-retrieve/getlifecycleassessmentbyuniqueidentifier"}],"panels":[]}]},"httpPath":"/lifecycle-assessment/by-unique-identifier/{uniqueIdentifier}"},{"label":"LCA — by brand product id","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getlifecycleassessmentbybrandproductid","routeSlug":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getlifecycleassessmentbybrandproductid","metadata":{"seo":{"title":"LCA — by brand product id","description":"Call by: brandProductId — the Fairly Made brand product id (UUID v4) from the 201 response of POST /brand-products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLifeCycleAssessmentByBrandProductId","name":"LCA — by brand product id","deprecated":true,"isWebhook":false,"pointer":"/paths/~1lifecycle-assessment~1{brandProductId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LCA — by brand product id","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made brand product id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the life cycle assessment (LCA) results for the matching brand product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes French regulatory indicators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lcaFR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and PEF indicators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lcaPEF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", 17 impact categories including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pefSingleScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a Customer API bearer token. Your registry customer scope is resolved from the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error responses use a dedicated JSON shape: machine-readable codes are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"brandProductId","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand product id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1lifecycle-assessment~1{brandProductId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lifecycle-assessment/{brandProductId}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"brandProductId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","502"],"pointer":"/lifecycle-assessment/{brandProductId}","href":"deprecated-retrieve/getlifecycleassessmentbybrandproductid","openApiOperationId":"getLifeCycleAssessmentByBrandProductId","summary":"LCA — by brand product id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"LCA results available for this brand product.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LifeCycleAssessmentReadModel"}},"schemaId":"components/schemas/LifeCycleAssessmentReadModel"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or bearer token registry context."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}},"schemaId":"components/schemas/AnalysisReadError"},{"code":"403","description":"The brand product exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Unknown brand product id, or product exists but LCA is not available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/lcaNotAvailable"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/lcaNotAvailable"]},{"code":"422","description":"Bearer token registry customer is syntactically valid but unknown.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/422/content/application~1json/example"]},{"code":"502","description":"Unexpected upstream failure while resolving the brand product or LCA results.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1lifecycle-assessment~1{brandProductId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LifeCycleAssessmentReadModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LifeCycleAssessmentReadModel"}}},{"code":"400","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}}},{"code":"401","schemaId":"components/schemas/AnalysisReadError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}}},{"code":"403","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/lcaNotAvailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/lcaNotAvailable"]}}},{"code":"422","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/422/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1lifecycle-assessment~1{brandProductId}/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-retrieve/getlifecycleassessmentbybrandproductid"}],"panels":[]}]},"httpPath":"/lifecycle-assessment/{brandProductId}"},{"label":"Declared FEC — by unique identifier","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbyuniqueidentifier","routeSlug":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbyuniqueidentifier","metadata":{"seo":{"title":"Declared FEC — by unique identifier","description":"Call by: uniqueIdentifier — your internal brand product reference (same value as on POST /brand-products)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeclaredFrenchEnvironmentalCostByUniqueIdentifier","name":"Declared FEC — by unique identifier","deprecated":true,"isWebhook":false,"pointer":"/paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Declared FEC — by unique identifier","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your internal brand product reference (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"declared"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" French Environmental Cost (FEC) published for the matching brand product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the customer-facing declared FEC (government platform publication), distinct from the calculated FEC returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /calculated-french-environmental-cost/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a Customer API bearer token. Your registry customer scope is resolved from the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not validated as a UUID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — any non-empty URL-encoded string is accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error responses use a dedicated JSON shape: machine-readable codes are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueIdentifier","in":"path","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Any non-empty URL-encoded string is accepted; it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated as a UUID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/declared-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"uniqueIdentifier","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","502"],"pointer":"/declared-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}","href":"deprecated-retrieve/getdeclaredfrenchenvironmentalcostbyuniqueidentifier","openApiOperationId":"getDeclaredFrenchEnvironmentalCostByUniqueIdentifier","summary":"Declared FEC — by unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Declared FEC available for this brand product.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or bearer token registry context."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}},"schemaId":"components/schemas/AnalysisReadError"},{"code":"403","description":"The brand product exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"No brand product matches the identifier, or declared FEC is not published.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"]},{"code":"422","description":"Registry customer unknown.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/example"]},{"code":"502","description":"Unexpected upstream failure (legacy Declare-FEC service).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}}},{"code":"401","schemaId":"components/schemas/AnalysisReadError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}}},{"code":"403","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}}},{"code":"422","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbyuniqueidentifier"}],"panels":[]}]},"httpPath":"/declared-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}"},{"label":"Declared FEC — by brand product id","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbybrandproductid","routeSlug":"/swagger-fairlymadeapi-v3/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbybrandproductid","metadata":{"seo":{"title":"Declared FEC — by brand product id","description":"Call by: brandProductId — the Fairly Made brand product id (UUID v4) from the 201 response of POST /brand-products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeclaredFrenchEnvironmentalCostByBrandProductId","name":"Declared FEC — by brand product id","deprecated":true,"isWebhook":false,"pointer":"/paths/~1declared-french-environmental-cost~1{brandProductId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Declared FEC — by brand product id","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call by:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made brand product id (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"declared"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" French Environmental Cost (FEC) published for the matching brand product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the customer-facing declared FEC (government platform publication), distinct from the calculated FEC returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /calculated-french-environmental-cost/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a Customer API bearer token. Your registry customer scope is resolved from the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error responses use a dedicated JSON shape: machine-readable codes are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"brandProductId","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand product id (UUID v4). Use the id from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1declared-french-environmental-cost~1{brandProductId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/declared-french-environmental-cost/{brandProductId}","servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"parameters":{"path":[{"name":"brandProductId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","502"],"pointer":"/declared-french-environmental-cost/{brandProductId}","href":"deprecated-retrieve/getdeclaredfrenchenvironmentalcostbybrandproductid","openApiOperationId":"getDeclaredFrenchEnvironmentalCostByBrandProductId","summary":"Declared FEC — by brand product id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","description":"Mock server","isMockServer":true},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Declared FEC available for this brand product.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel"}},"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or bearer token registry context."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]},{"code":"401","description":"Missing, invalid, or expired bearer token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}},"schemaId":"components/schemas/AnalysisReadError"},{"code":"403","description":"The brand product exists but does not belong to your organisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Unknown brand product id, or product exists but declared FEC is not published.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"]},{"code":"422","description":"Bearer token registry customer is syntactically valid but unknown.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"]},{"code":"502","description":"Unexpected upstream failure (legacy Declare-FEC service).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"]}],"pointer":"/paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel"}}},{"code":"400","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"]}}},{"code":"401","schemaId":"components/schemas/AnalysisReadError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError"}}},{"code":"403","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound","paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"]}}},{"code":"422","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnalysisReadError","exampleIds":["paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbybrandproductid"}],"panels":[]}]},"httpPath":"/declared-french-environmental-cost/{brandProductId}"}],"content":{"contentType":"group","meta":{"name":"deprecated-retrieve"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These single-product endpoints are deprecated and will be removed in a future version — avoid building new integrations on them."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use instead"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" French Environmental Cost ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coût Environnemental Calculé"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /calculated-french-environmental-cost/..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will be replaced by a list endpoint"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Life Cycle Assessment (LCA) results"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /lifecycle-assessment/..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will be replaced by a list endpoint"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declared"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" French Environmental Cost, published on the government platform"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /declared-french-environmental-cost/{brandProductId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/by-unique-identifier/..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.api.fairlymade.com/swagger-fairlymadeapi-v3/list-declared-fec"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declared FEC — all products (list)"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each data type has two equivalent lookups:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By unique identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By brand product id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the Fairly Made "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID v4) from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/calculated-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}","summary":"Calculated FEC — by unique identifier","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbyuniqueidentifier","deprecated":true},{"title":"/calculated-french-environmental-cost/{brandProductId}","summary":"Calculated FEC — by brand product id","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-retrieve/getcalculatedfrenchenvironmentalcostbybrandproductid","deprecated":true},{"title":"/lifecycle-assessment/by-unique-identifier/{uniqueIdentifier}","summary":"LCA — by unique identifier","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-retrieve/getlifecycleassessmentbyuniqueidentifier","deprecated":true},{"title":"/lifecycle-assessment/{brandProductId}","summary":"LCA — by brand product id","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-retrieve/getlifecycleassessmentbybrandproductid","deprecated":true},{"title":"/declared-french-environmental-cost/by-unique-identifier/{uniqueIdentifier}","summary":"Declared FEC — by unique identifier","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbyuniqueidentifier","deprecated":true},{"title":"/declared-french-environmental-cost/{brandProductId}","summary":"Declared FEC — by brand product id","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-retrieve/getdeclaredfrenchenvironmentalcostbybrandproductid","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ErrorDetail":{"id":"components/schemas/ErrorDetail","kind":"json-schema","title":"ErrorDetail","data":{"type":"object","description":"A single validation or error detail.","properties":{"field":{"type":"string","description":"JSON path or name of the field concerned (e.g. uniqueIdentifier, siteAddress.country)."},"reason":{"type":"string","description":"Short reason or message for this detail."},"supplierId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On supplier "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (duplicate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), identifier of the existing supplier—same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response. UUID v4 format."},"children":[]}]}]}]},"materialId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On material "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifier of the existing material—same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-materials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". UUID v4 format."},"children":[]}]}]}]},"componentId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On component "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifier of the existing component—same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"componentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-components"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". UUID v4 format."},"children":[]}]}]}]},"packagingId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On packaging "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifier of the existing packaging—same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response. UUID v4 format."},"children":[]}]}]}]},"manufacturedProductId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On manufactured product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifier of the existing product—same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". UUID v4 format."},"children":[]}]}]}]},"purchasedItemId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On purchased item "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifier of the existing purchased item—same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /purchased-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". UUID v4 format."},"children":[]}]}]}]},"brandProductId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifier of the existing brand product record—same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response. UUID v4 format."},"children":[]}]}]}]}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","description":"Standard error response body for 4xx responses.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code (e.g. VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, CONFLICT)."},"children":[]}]}]}]},"message":{"type":"string","description":"Human-readable error message."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional list of field-level errors (e.g. for validation). For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" due to an existing resource, the relevant detail includes the resource identifier property matching the endpoint (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brandProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","description":"Postal address of an entity.","required":["country"],"properties":{"country":{"type":"string","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two‑letter ISO country code. Taxonomy – COUNTRY"},"children":[]}]}]}],"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"city":{"type":"string"},"postalCode":{"type":"string"},"street":{"type":"string"}}}},"components/schemas/MaterialStep":{"id":"components/schemas/MaterialStep","kind":"json-schema","title":"MaterialStep","data":{"type":"object","description":"Processing step for a material. Taxonomy.","properties":{"process":{"type":"string","description":"Material processing step taxonomy. The API accepts the full process taxonomy on any entity; the values listed here are those expected for this entity type.","enum":["BREEDING","CAPTURE","CARDING","COMBING","DYEING","HARVESTING","LEATHER_PRESERVATION","MINING","POLYMER_SYNTHESIS","PREPARATION","PRE_TREATMENT","RAW_MATERIAL","RECYCLING_CHEMICAL","RECYCLING_MECHANICAL","RECYCLING_WOOD","TRADING"]}}}},"components/schemas/ComponentStep":{"id":"components/schemas/ComponentStep","kind":"json-schema","title":"ComponentStep","data":{"type":"object","description":"Processing step for a component or packaging. Taxonomy.","properties":{"process":{"type":"string","description":"Component/packaging processing step taxonomy. The API accepts the full process taxonomy on any entity; the values listed here are those expected for this entity type.","enum":["ACID_WASHING","ANILINE","ANODIC_OXIDATION","ANTI_MICROBIAL","ANTI_PILLING","ANTI_STATIC","BEAM_HOUSE","BLEACHING","BONDING","BRAIDING","BRUSHING","BURN_OUT","CALENDARING_EMBOSSING_DEBOSSING","CARDING","CHEMICAL_PLISSING","COATING","COMBING","CROCHET","CUTTING","DYEING","EASY_CARE","ELECTROPLATING","EMBOSSING","EMBROIDERY","ENZYME_WASHING","EXTRUSION","FADING","FLAME_RETARDANT_RESISTANCE","FLOCKING","FOAM_FORMATION","FULLING","GALVANIZATION","GLASS_FORMATION","GLAZING","GLAZING_CIRE","HEAT_PRESSING_PLISSING","HOT_DIPPING","INJECTION","KNITTING","LACE_FABRICATION","LAMINATION","LASERING","LEATHER_BUFFING","LEATHER_FINISHING","LEATHER_PRESERVATION","MACHINING","MANUFACTURING","MECHANICAL_LEATHER","METAL_REFINEMENT","METAL_SHAPING","MOIRE","MOISTURE_WICKING","MOTH_PROOF","NAPPING","NW_PROCESSING","PADDING","PAINTING","PLASTIC_SHAPING","PLEATING","PLISSING_BY_STITCHING","PLUCKING","POLISHING","POLYMER_SYNTHESIS","POWDER_COATING","PP_SPRAY_OXIDIZING_AGENT","PRE_TREATMENT","PRINTING","QUALITY_CHECK","QUILTING","REVIVING","SANDING","SANDWASHING_BLASTING","SANFORIZATION","SHEARING","SILICONE_COATING","SLAUGHTERING","SOFTENING","SOIL_REALEASE","SOIL_REPELLENT","SOLE_VULCANISATION","SPINNING","SPLITTING","STITCHING","STOCKFITTING","STONEWASHING","SUEDING","TANNING","THERMOREGULATION","TINTING_OVERDYEING","TRADING","TREATMENT_SCOURING","TUFTING","TURNING","UV_PROTECTION","VACUUM_DEPOSIT","VARNISHING","WARPING","WASHING","WATERPROOF","WATER_REPELANT","WATER_RESISTANT","WEAVING","WEIGHTING_FOR_SILK","WET_END","WRAPPING","WRINKLE_RESISTANCE"]}}}},"components/schemas/ProductStep":{"id":"components/schemas/ProductStep","kind":"json-schema","title":"ProductStep","data":{"type":"object","description":"Processing step for a product. Taxonomy.","properties":{"process":{"type":"string","description":"Product processing step taxonomy. The API accepts the full process taxonomy on any entity; the values listed here are those expected for this entity type.","enum":["ACID_WASHING","ANTI_MICROBIAL","ANTI_PILLING","ASSEMBLY","BLEACHING","BONDING","DYEING","EMBOSSING","EMBROIDERY","FADING","FINISHING","FLOCKING","IRONING","LABELLING","LASERING","LASTING","MANUFACTURING","MOIRE","PACKING","PRINTING","PRODUCT_KNITTING","QUALITY_CHECK","SANDING","SANDWASHING_BLASTING","SOFTENING","STITCHING","TINTING_OVERDYEING","TRADING","WAREHOUSE","WASHING"]}}}},"components/schemas/Composition":{"id":"components/schemas/Composition","kind":"json-schema","title":"Composition","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One composition line for a component. The raw material name and attribute must form an allowed pair from the official taxonomy (same rules as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Material"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Use the Fairly Made Material Selector to pick "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawMaterial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same tool as for materials). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1uPK74A-i0_TgF-7S6ldtYVgVEenLLbBT/edit?gid=1517342635#gid=1517342635"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made Material Selector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["compositionRawMaterial","compositionRawAttribute","compositionPercentage"],"properties":{"compositionRawMaterial":{"$ref":"#/components/schemas/RawMaterialName"},"compositionRawAttribute":{"$ref":"#/components/schemas/RawMaterialAttribute"},"compositionPercentage":{"type":"number","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of this raw material (total composition must sum to 100%)."},"children":[]}]}]}]},"compositionOrigin":{"type":"string","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two‑letter ISO country code. Taxonomy – COUNTRY"},"children":[]}]}]}],"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"compositionCertifications":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON array of certification codes for this composition line (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"GOTS\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"GOTS\", \"OCS\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Each element must be one of the enum values exactly as written."},"children":[]}]}]}],"items":{"type":"string","enum":["ABELUSI WOOL","AGRICULTURE BIOLOGIQUE","ALGODAO BRASILEIRO RESPONSAVEL","ALPACA MARK - BLEND MARK","ALPACA MARK - GOLD","ALPACA MARK - SILVER","ANIMAL WELFARE APPROVED","AUTHENTICO","BCI","BIORE COTTON","BIORE TEXTILE","BLUE ANGEL","BLUESIGN PRODUCT","BMP CERTIFIED COTTON","C2C BRONZE","C2C GOLD","C2C PLATINUM","C2C SILVER","CARBON FREE CERTIFIED","CARBON NEUTRAL","CCS","CERTIFICATION OF RAW MATERIAL TRACEABILITY","CERTIFIED RAW MATERIALS","CLEANER COTTON","CMIA ORGANIC","DEMETER","DOWNPASS","ECO PASSPORT BY OEKO-TEX","ERTS","EU ECOLABEL","EU ORGANIC FARMING","EUROPEAN FLAX","FAIR TRADE USA CERTIFIED","FAIRMINED","FAIRTRADE COTTON MARK","FAIRTRADE COTTON PROGRAM","FAIRTRADE MARK","FAIRTRADE SOURCED INGREDIENT MARK","FAIRTRADE TEXTILE PRODUCTION MARK","FIELD TO MARKET","FSC","FURMARK","GOOD EARTH COTTON®","GOODWEAVE","GOTS","GOTS TC","GREEN DENIM","GRS","ICEC - ECO-LEATHER UNI 11427","ICEC - LEATHER FROM ITALY - UNI EN 16484","INTERBEV","ISCC","ISCC PLUS","IWS","IWTO","LEATHER STANDARD BY OEKO-TEX","MADE IN GREEN BY OEKOTEX LEVEL 1","MADE IN GREEN BY OEKOTEX LEVEL 2","MADE IN GREEN BY OEKOTEX LEVEL 3","MASTER OF LINEN","MATERIALS MATTER STANDARD","MULESING FREE","NA FARM RAISED","NA WILD FUR","NATIVA","NATURLEDER","NATURTEXTIL","NATURTEXTIL BEST","NEWMERINO","NORDIC SWAN ECOLABEL","OABA A","OABA B","OABA C","OABA D","OABA E","OCS","OK BIOBASED","OK BIODEGRADABLE","ORIGINE FRANCE GARANTIE","OTHER","PEFC","PEFC RECYCLED","RAS","RAWIP","RCS","RDS","REEL","REGENAGRI","REMADE IN ITALY","REPREVE","RGMP","RMS","ROC GOLD","ROC SILVER","RRSS","RSPCA","RWS","SAOBC","SFA","SOIL ASSOCIATION ORGANIC","SOUTH AFRICAN OSTRICH BUSINESS CHAMBER","SRCP","STANDARD 100 BY OEKOTEX","SUSTAINABLE CAPE WOOL STANDARD","SUSTAINABLE FIBRE ALLIANCE","SUSTAINABLE FORESTRY INITIATIVE","SUSTAINAWOOL","SWAKARA","THE GOOD CASHMERE STANDARD","TRACEABLE DOWN STANDARD","US COTTON TRUST PROTOCOL","USDA CERTIFIED BIOBASED","WELFUR","WOOL INTEGRITY","WOOLMARK","ZQ WOOL","ZQRX PROGRAM"]}}}}},"components/schemas/Transport":{"id":"components/schemas/Transport","kind":"json-schema","title":"Transport","data":{"type":"object","required":["name","usagePercentage"],"properties":{"name":{"type":"string","description":"Transport type taxonomy. Values.","enum":["BARGE","BOAT","CAR","PLANE","TRAIN","TRUCK","VAN"]},"usagePercentage":{"type":"number","description":"The percentage of this transport mode used within this transaction."}}}},"components/schemas/Quantity":{"id":"components/schemas/Quantity","kind":"json-schema","title":"Quantity","data":{"type":"object","properties":{"value":{"type":"number","description":"Quantity of the purchased item declared in the purchase order."},"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit taxonomy. Values. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references a product, the only allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIECES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["GRAMS","KILOGRAMS","METERS","PIECES","SQUARE FOOT","SQUARE METERS"]}}}},"components/schemas/SupplierCertification":{"id":"components/schemas/SupplierCertification","kind":"json-schema","title":"SupplierCertification","data":{"type":"object","required":["certificationName"],"properties":{"certificationName":{"type":"string","description":"Use one of the enum values exactly as written. The list covers certifications relevant for a supplier certification scope.","enum":["4SUSTAINABILITY CHEM ADVANCED","4SUSTAINABILITY CHEM BASIC","4SUSTAINABILITY CHEM EXCELLENCE","4SUSTAINABILITY CYCLE ADVANCED","4SUSTAINABILITY CYCLE BASIC","4SUSTAINABILITY MATERIALS ADVANCED","4SUSTAINABILITY MATERIALS BASIC","4SUSTAINABILITY MATERIALS EXCELLENCE","4SUSTAINABILITY PEOPLE ADVANCED","4SUSTAINABILITY PEOPLE BASIC","4SUSTAINABILITY PLANET ADVANCED","4SUSTAINABILITY PLANET BASIC","4SUSTAINABILITY TRACE ADVANCED","4SUSTAINABILITY TRACE BASIC","AGREMENT ATELIER CHANTIER INSERTION","AGREMENT ENTREPRISE ADAPTÉE","AGREMENT ENTREPRISE INSERTION","AGREMENT ESAT","ASC","B CORPORATION","BCI MEMBERSHIP","BEPI ADVANCED","BEPI BASIC","BEPI GOOD","BLUESIGN SYSTEM PARTNER","BSCI GRADE A","BSCI GRADE B","BSCI GRADE C","BSCI GRADE D","BSCI GRADE E","CANOPYSTYLE AUDIT","CAREGORA","CONTROL UNION FAIR CHOICE","COPPER MARK","CVFR","DETOX TO ZERO BY OEKO-TEX","ELEVATE RESPONSIBLE SOURCING ASSESSMENT","ENTREPRISE DU PATRIMOINE VIVANT","FAIR FOR LIFE","FAIR WEAR FOUNDATION","FAIRTRADE FIBRE CROPS STANDARD - CONTRACT PRODUCTION ORGANIZATION","FAIRTRADE FIBRE CROPS STANDARD - SMALL PRODUCER ORGANIZATION","FAIRTRADE FIBRE CROPS STANDARD - TRADER","FAIRTRADE TEXTILE STANDARD - TRADER","FAITRADE CLIMATE STANDARD","FAITRADE CLIMATE STANDARD - TRADER","GREEN TO WEAR BY INDITEX GRADE A","GREEN TO WEAR BY INDITEX GRADE B","GREEN TO WEAR BY INDITEX GRADE C","GREEN TO WEAR BY INDITEX GRADE D","GREENSCREEN FOR SAFER CHEMICALS","HIGG","ICCAW","ICFA","ICS GRADE A","ICS GRADE B","ICS GRADE C","ICS GRADE D","ICS GRADE E","IFOAM","ILO","IRMA 50","ISO 14001","ISO 26000","ISO 45001","ISO 50001","ISO 9001","ISO/TS 34700","LBMA","LWG","LWG COMMISSIONING MANUFACTURER - BRONZE","LWG COMMISSIONING MANUFACTURER - GOLD","LWG COMMISSIONING MANUFACTURER - SILVER","LWG LEATHER MANUFACTURER - BRONZE","LWG LEATHER MANUFACTURER - GOLD","LWG LEATHER MANUFACTURER - SILVER","LWG SUBCONTRACTOR","LWG TRADER","OEKO-TEX® ECO PASSPORT","OEKO-TEX® ORGANIC COTTON","QIMA ETHICAL AUDIT REPORT","REACH","REGENEVATE","RESPONSIBLE REPTILE SOURCING STANDARD","RESPONSIBLE SOURCING STANDARD","RJC CODE OF PRACTICES","SA8000","SA8000 STANDARD GRADE 1","SA8000 STANDARD GRADE 2","SA8000 STANDARD GRADE 3","SA8000 STANDARD GRADE 4","SA8000 STANDARD GRADE 5","SLCP","SMETA 2-PILLAR","SMETA 4-PILLAR","STEP BY OEKOTEX","SUPPLIER QUALIFICATION PROGRAM","SWISS BETTER GOLD LEVEL 1","SWISS BETTER GOLD LEVEL 2","SWISS BETTER GOLD LEVEL 3","TESSILE E SALUTE","THINK GREEN INITIATIVE","TISSU FRANCE TERRE TEXTILE","UNI PDR 125:2022","USDA ORGANIC","VERIFIED_GRAPHENE_PRODUCER","WETHICA","WFTO","WRAP","WRAP GOLD","WRAP PLATINUM","WRAP SILVER","Welfare Quality® Assessement protocol","ZDHC CMS","ZDHC LEVEL 0","ZDHC LEVEL 1","ZDHC LEVEL 2","ZDHC LEVEL 3","ZDHC WMS"]}}}},"components/schemas/PurchasedItemUsage":{"id":"components/schemas/PurchasedItemUsage","kind":"json-schema","title":"PurchasedItemUsage","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage of a purchased item within a manufactured item. The purchased item can be of any type — a purchased material, component or product; the relevant types depend on the parent item. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"purchasedItemId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the purchased item. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchasedItemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the purchased item. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usageCategory":{"type":"string","description":"Defines the functional purpose of that component within a specific item configuration or transaction.","enum":["BACKINGS/COUNTERS","BEADS","BELT LOOPS","BIAS STRIPS","BRA CLIPS","BUCKLES","BUTTINETTES","BUTTONS","CHAIN","CLAMPING TABS","COLARS","CORD STOPERS","ELASTICS","EMBROIDERIES","EMBROIDERY BASE","EMBROIDERY YARN","EYELETS","FABRICS KNITTED","FABRICS WOVEN","FOAM","FRAME GUARDS","FURS","HANDLES","HEELS","HOOK_LOOP","INORGANIC_FIBER","INSOLES","JACRONS","LABELLINGS","LACES","LACES/CORDS","LEATHER PIECE","LININGS","LOCKS","MAGNETS","MAIN COMPONENT (EMBROIDERY)","MAIN COMPONENT (FUR)","MAIN COMPONENT (LEATHER)","MAIN COMPONENT (NON WOVEN)","MAIN FABRIC (KNITTED)","MAIN FABRIC (WOVEN)","MARQUISETTES","METAL ACCESSORIES","MIDSOLES","NATURAL_RUBBER","NETS/TROUSER SEATS","NON WOVEN","ORE","OUTSOLES","PADDINGS","PADDINGS BRA","PATIN","PIPING","PLASTIC ACCESSORIES","PLASTIC_GRANULES","POCKETING FABRIC","RECYCLED_FIBER","RECYCLED_ORE","RECYCLED_PLASTIC_GRANULES","RECYCLED_TANNED_HIDE","RECYCLED_WOOD","RIBBED EDGES","RIBBON","RINGS & CHIVES","RUBBER","RUBBER BANDS","SEWING THREADS","SHANKS","SHOULDER PADS","SHOULDER STRAPS","SMALL METAL PARTS","SMALL PLASTIC PARTS","SNAP HOOKS","STIFFENERS","STRAIGHT GRAINS","STRASS","STRETCHERS","STUFFINGS","SUSPENDERS","TAPES","TEXTILE ACCESSORIES","THERMOFUSINGS","TOE PUFFS","TOP LIFT","TULLES","UPPERS","VEGETAL_FIBER","VEGETAL_MATERIAL","WIRES","WOOD","YARNS","ZIP SLIDER","ZIP TAPE","ZIP TEETH","ZIPS"]},"usagePercentage":{"type":"number","description":"Percentage usage of this purchased item within the parent entity. Sum of purchased items and used items must equal 100."}}}},"components/schemas/UsedProduct":{"id":"components/schemas/UsedProduct","kind":"json-schema","title":"UsedProduct","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to a manufactured product used as an input. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"productId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the manufactured product. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"productUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the manufactured product. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usagePercentage":{"type":"number"}}}},"components/schemas/UsedComponent":{"id":"components/schemas/UsedComponent","kind":"json-schema","title":"UsedComponent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to a manufactured component used as an input. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"componentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"componentUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["usageCategory"],"properties":{"componentId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the manufactured component. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"componentUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"componentUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the manufactured component. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"componentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usageCategory":{"type":"string","description":"Defines the functional purpose of that component within a specific item configuration or transaction.","enum":["BACKINGS/COUNTERS","BEADS","BELT LOOPS","BIAS STRIPS","BRA CLIPS","BUCKLES","BUTTINETTES","BUTTONS","CHAIN","CLAMPING TABS","COLARS","CORD STOPERS","ELASTICS","EMBROIDERIES","EMBROIDERY BASE","EMBROIDERY YARN","EYELETS","FABRICS KNITTED","FABRICS WOVEN","FOAM","FRAME GUARDS","FURS","HANDLES","HEELS","HOOK_LOOP","INORGANIC_FIBER","INSOLES","JACRONS","LABELLINGS","LACES","LACES/CORDS","LEATHER PIECE","LININGS","LOCKS","MAGNETS","MAIN COMPONENT (EMBROIDERY)","MAIN COMPONENT (FUR)","MAIN COMPONENT (LEATHER)","MAIN COMPONENT (NON WOVEN)","MAIN FABRIC (KNITTED)","MAIN FABRIC (WOVEN)","MARQUISETTES","METAL ACCESSORIES","MIDSOLES","NATURAL_RUBBER","NETS/TROUSER SEATS","NON WOVEN","ORE","OUTSOLES","PADDINGS","PADDINGS BRA","PATIN","PIPING","PLASTIC ACCESSORIES","PLASTIC_GRANULES","POCKETING FABRIC","RECYCLED_FIBER","RECYCLED_ORE","RECYCLED_PLASTIC_GRANULES","RECYCLED_TANNED_HIDE","RECYCLED_WOOD","RIBBED EDGES","RIBBON","RINGS & CHIVES","RUBBER","RUBBER BANDS","SEWING THREADS","SHANKS","SHOULDER PADS","SHOULDER STRAPS","SMALL METAL PARTS","SMALL PLASTIC PARTS","SNAP HOOKS","STIFFENERS","STRAIGHT GRAINS","STRASS","STRETCHERS","STUFFINGS","SUSPENDERS","TAPES","TEXTILE ACCESSORIES","THERMOFUSINGS","TOE PUFFS","TOP LIFT","TULLES","UPPERS","VEGETAL_FIBER","VEGETAL_MATERIAL","WIRES","WOOD","YARNS","ZIP SLIDER","ZIP TAPE","ZIP TEETH","ZIPS"]},"usagePercentage":{"type":"number"}}}},"components/schemas/MaterialPurchasedItem":{"id":"components/schemas/MaterialPurchasedItem","kind":"json-schema","title":"MaterialPurchasedItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use of a purchased material within a material. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"purchasedItemId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the purchased item (must reference a material purchase). Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchasedItemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the purchased item. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usagePercentage":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage usage of this purchased material (total not more than 100%)."},"children":[]}]}]}]}}}},"components/schemas/UsedMaterial":{"id":"components/schemas/UsedMaterial","kind":"json-schema","title":"UsedMaterial","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raw materials used to create another material or component. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"materialId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the input material. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"materialUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the input material. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usagePercentage":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage usage of the input material (total not more than 100%)."},"children":[]}]}]}]}}}},"components/schemas/Certification":{"id":"components/schemas/Certification","kind":"json-schema","title":"Certification","data":{"type":"object","required":["certificationName"],"properties":{"certificationName":{"type":"string"}}}},"components/schemas/PublicApiValidationError":{"id":"components/schemas/PublicApiValidationError","kind":"json-schema","title":"PublicApiValidationError","data":{"type":"object","description":"Standard validation error envelope for public API v3 create endpoints (Zod).","required":["type","details"],"properties":{"type":{"type":"string","enum":["ValidationError"]},"details":{"type":"object","additionalProperties":true,"description":"Field-level validation details (Zod-shaped object)."}}}},"components/schemas/RegistrySupplierBusinessError":{"id":"components/schemas/RegistrySupplierBusinessError","kind":"json-schema","title":"RegistrySupplierBusinessError","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business rule error envelope for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /suppliers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","details"],"properties":{"type":{"type":"string","enum":["RegistrySupplier_AlreadyExists","RegistrySupplier_CountryShouldBeValid","RegistrySupplier_SiteAddress_CityShouldNotBeEmpty"]},"details":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structured context for the business error (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingSupplierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}}},"components/schemas/SupplierCertificationCreated":{"id":"components/schemas/SupplierCertificationCreated","kind":"json-schema","title":"SupplierCertificationCreated","data":{"type":"object","required":["certificationName"],"properties":{"certificationName":{"type":"string","description":"Certification name as stored on the supplier site."}}}},"components/schemas/SupplierCreated":{"id":"components/schemas/SupplierCreated","kind":"json-schema","title":"SupplierCreated","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supplier record returned on successful creation ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":["supplierId","uniqueIdentifier","siteAddress"],"properties":{"supplierId":{"type":"string","format":"uuid","description":"System-generated identifier of the created supplier. UUID v4 format."},"uniqueIdentifier":{"type":"string","description":"Client-side identifier sent in the request."},"parentCompanyName":{"type":"string","nullable":true,"description":"Parent company / group name, when provided."},"siteName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Site name. Falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not sent in the request."},"children":[]}]}]}]},"siteEmails":{"type":"array","items":{"type":"string","format":"email"},"nullable":true,"description":"Site contact emails, when provided."},"siteAddress":{"$ref":"#/components/schemas/Address"},"siteCertifications":{"type":"array","items":{"$ref":"#/components/schemas/SupplierCertificationCreated"},"description":"Certifications stored on the supplier site (without file attachment for now)."}}}},"components/schemas/Supplier":{"id":"components/schemas/Supplier","kind":"json-schema","title":"Supplier","data":{"type":"object","required":["uniqueIdentifier","siteAddress"],"properties":{"uniqueIdentifier":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your internal identifier for this supplier site. Required and must be unique within your customer registry (duplicate → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 RegistrySupplier_AlreadyExists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"parentCompanyName":{"type":"string","description":"Optional parent company / group name."},"siteName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Site name of the supplier. Mandatory if you run traceability collection with Fairly Made. When omitted, the created supplier uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as its site name."},"children":[]}]}]}]},"siteEmails":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Site contact emails. Optional for a plain create, but "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (at least one) if you run Fairly Made supplier data collection (SDC) — without it, Fairly Made cannot contact the supplier (excluding warehouses) to launch data collection. Each entry must be a valid email."},"children":[]}]}]}]},"siteAddress":{"allOf":[{"$ref":"#/components/schemas/Address"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mandatory inside the object; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postalCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional."},"children":[]}]}]}]}]},"siteCertifications":{"type":"array","items":{"$ref":"#/components/schemas/SupplierCertification"},"description":"Optional list of certifications for this supplier site. May be omitted or empty."}}}},"components/schemas/RawMaterialAttribute":{"id":"components/schemas/RawMaterialAttribute","kind":"json-schema","title":"RawMaterialAttribute","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raw material attribute taxonomy. Values are only valid in combination with a given raw material name; each material name accepts only the attributes defined in the official material–attribute pairs. To choose the correct attribute for a given material name, use the Fairly Made Material Selector (Google Sheets): Step 1 — select the material; Step 2 — lists the attributes you may use with that name. Then send the exact enum value from this schema. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1uPK74A-i0_TgF-7S6ldtYVgVEenLLbBT/edit?gid=1517342635#gid=1517342635"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made Material Selector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BIO_BASED","CHROME_FREE","CONVENTIONAL","FARMED","MIXED_TANNING","ORGANIC","RECYCLED","REGENERATIVE","VEGETABLE","WILD"]}},"components/schemas/RawMaterialName":{"id":"components/schemas/RawMaterialName","kind":"json-schema","title":"RawMaterialName","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raw material name taxonomy (from official material–attribute pairs; each name must be combined with a valid attribute for that material). Use the Fairly Made Material Selector spreadsheet to see which attributes are allowed for each name (Step 1 = material, Step 2 = allowed attributes), then align with the enums here. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1uPK74A-i0_TgF-7S6ldtYVgVEenLLbBT/edit?gid=1517342635#gid=1517342635"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made Material Selector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ABACÁ","ACETAL","ACETATE","ACRYLIC","ACRYLIC RESIN","ACRYLONITRILE BUTADIENE RUBBER","ACRYLONITRILE BUTADIENE STYRENE","ALCANTARA","ALGINATE","ALLIGATOR LEATHER","ALLIGATOR MISSISSIPPIENSIS LEATHER","ALPACA WOOL","ALUMINIUM","ANANAS FIBER","ANGORA WOOL","ANTELOPE FUR","ARAMID","ARTIFICIAL LEATHER","ASH","ASTRAKAN_FUR","AYOUS","BABY ALPACA WOOL","BAMBOO FIBER","BAMBOO VISCOSE","BEAR FUR","BEAVER FUR","BEECH","BENBERG™","BIOBASED POLYESTER SOLOTEX®","BIRCH","BIRLA EXCEL™","BIRLA MODAL™","BIRLA VISCOSE™","BONE","BOVINE LEATHER","BOVINE SHEARLING","BOVINE SPLIT","BRASS","BROMOBUTYL RUBBER","BRONZE","BUFFALO LEATHER","BUFFALO_BONE","BUFFALO_SUEDE","BULL LEATHER","BULL_SUEDE","BY-CAST LEATHER","CAIMAN_CAIMAN_CROCODILUS","CAIMAN_CAIMAN_YACARE_LEATHER","CALF LEATHER","CALF SHEARLING","CAMEL HAIRS","CANE","CAPRINE LEATHER","CAPRINE SHEARLING","CAPRINE SPLIT","CAPYBARA_FUR","CARBON FIBER","CASHMERE","CEDAR","CELLOPHANE","CELLULOSE WADDING","CELLULOSE_DIACETATE","CHAMOIS LEATHER","CHECKERED_KEELBACK","CHERRYWOOD","CHINCHILLA FUR","CHLOROFIBRE","CHROME","CHRYSOCALE","CIRCULOSE®","COBRA LEATHER","COCK_FEATHER","COCONUT FIBER","COD LEATHER","CONVENTIONAL PYTHON RETICULATUS LEATHER","COPPER","CORAL","CORIAN®","CORK","COTTON","COW LEATHER","COW SPLIT","COW_BONE","COYOTE FUR","COYPU FUR","CROCODILE - CROCODYLUS NILOTICUS LEATHER","CROCODILE - CROCODYLUS POSORUS LEATHER","CROCODILE-CROCODYLUS_SIAMENSIS","CRYSTAL","CUPRO","CURLY LAMB FUR","CYCORA®","DEER LEATHER","DOUSSIE","DOWN_FEATHER","DRALON®","DUCK DOWN","EBONY","ECONYL®","ECOVERO®","EEL LEATHER","ELASTANE","ELASTANE ROICA™","ELASTODIENE","ELASTOLEFINE","ELASTOMULTIESTER","ELK LEATHER","ENKA®","EPOXY","ERMINE FUR","ETHYLENE GLYCOL POLYTEREPHTALATE","ETHYLENE VINYL ACETATE","EUCALYPTUS","EXPANDED POLYTETRAFLUOROETHYLENE","FEATHER","FIBRANNE","FIR","FISH LEATHER","FISHER FUR","FLAX","FLUOROCARBON","FLUOROFIBRE","FOX FUR","FOX HAIRS","FROG LEATHER","FUR","GALALITH","GALUCHAT LEATHER","GLASS","GLASS WOOL","GOAT WOOL","GOAT_SUEDE","GOLD","GOOSE DOWN","GOOSE_FEATHER","GRAPHENE","GUANACO WOOL","HAGFISH_LEATHER","HAMSTER FUR","HEMP","HENEQUEN","HI-SOLIDS POLYURETHANE","HIGH-DENSITY POLYETHYLENE","HORN","HORNBEAM","HORSE LEATHER","HORSEHAIR","INGEO™","IRACA","IROKO","IRON","ISOBUTYLENE ISOPRENE RUBBER","ISOREL","JIRECELL","JUTE","KANGAROO LEATHER","KAPOK","KARAKUL_FUR","KARUNG_LEATHER","KENAF","KEVLAR","KID MOHAIR","KID_LEATHER","KID_SHEARLING","KID_SPLIT","KID_SUEDE","LAMB LEATHER","LARCH","LEAD","LEMUR FUR","LEOPARD FUR","LINDEN","LIVAECO BY BIRLA CELLULOSE™","LIZARD LEATHER","LLAMA","LOTUS","LOW DENSITY POLYETHYLENE","LUREX®","LYCRA","LYNX FUR","LYOCELL","LYOCELL SEACELL™","MAGNESIUM","MAGNET","MAGUEY","MAHOGANY","MAILLECHORT","MANGANESE","MANILA","MAPLE","MERANTI","MERINO WOOL","METALLIZED POLYAMIDE","METALLIZED POLYESTER","MICROTENCEL","MILK CASEIN","MINK FUR","MIRUM","MIXED DOWN","MODACRYLIC","MODAL","MOHAIR","MONEL","MOTHER OF PEARL","MUSKRAT FUR","MWOOL®","NAIA_RENEW","NAIA™","NATIVA_CASHMERE","NATIVA_COTTON","NATIVA_WOOL","NATURAL RUBBER","NEODYMIUM","NEOPRENE®","NETTLE","NEWLIFE™","NICKEL","NICLAFOR","NIPOL®","NIVAFLEX","NUTRIA_FUR","NYLON","OAK","OJO","OKOUME","OPOSSUM_FUR","ORANGE FIBER®","ORYLAG_FUR","OSTRICH LEATHER","OSTRICH_FEATHER","OTHER","OTHER_METALS","OTTER FUR","OVIN SPLIT","OVINE SHEARLING","PALLADIUM","PALM FIBER","PANTHUNA® LEATHER","PAPER-CARDBOARD","PEACOCK_FEATHER","PEAFOWL_FEATHER","PEAR_TREE","PEKAN_FUR","PERCH LEATHER","PHEASANT_FEATHER","PIG HAIRS","PIG LEATHER","PIG_SPLIT","PIMA COTTON","PINE","PLATINUM","POLYALLYL_DIGLYCOL_CARBONATE","POLYAMIDE","POLYBUTYLENE TEREPHTHALATE","POLYCARBAMIDE","POLYCARBONATE","POLYCYCLOHEXYLENEDIMETHYLENE_TEREPHTHALATE_GLYCOL","POLYCYCLOHEXYLENEDIMETHYLENE_TEREPHTHALATE_MODIFIED_ACID","POLYESTER","POLYESTER RESIN","POLYETHERSULFONE","POLYETHER_ETHER_KETONE","POLYETHYLENE","POLYETHYLENE TEREPHTHALATE","POLYETHYLENE_FURANOATE","POLYETHYLENE_TEREPHTHALATE_GLYCOL","POLYIMIDE","POLYLACTIC ACID","POLYMETHYL METHACRYLATE","POLYOXYMETHYLENE","POLYPROPYLENE","POLYPROPYLENE_TEREPHTHALATE","POLYSTYRENE","POLYURETHANE","POLYVINYL CHLORIDE","POPLAR","PRESSED_WOOD","PYTHON MOLURUS BIVITTATUS LEATHER","PYTHON RETICULATUS LEATHER","PYTHON-SHORT_TAILED_PYTHON_CURTUS","PYTHON_BRONGERSMAI_LEATHER","Q-NOVA®","QIVIUT WOOL","RABBIT FUR","RABBIT HAIRS","RABBIT LEATHER","RACCOON FUR","RAFFIA","RAMIE","RAT_SNAKE_LEATHER","RAYON","REED","REFIBRA®","REPREVE®","REPTILE LEATHER","REVIWOOL®","RHODIUM","ROSEWOOD","RUTHENIUM","SALMON LEATHER","SAPELE","SCOTCH_BROOM","SEAQUAL®","SEA_SNAKE_LEATHER","SHARK - CARCHARHINUS AMBLYRHYNCHOS","SHARK - SQUALUS ACANTHIAS","SHEARLING","SHEEP LEATHER","SHEEP WOOL","SHELL","SHETLAND WOOL","SILICONE","SILK","SILVER","SIPO","SISAL","SKUNK FUR","SNAKE LEATHER","SORONA®","SOYBEAN","SPANDEX®","SPRINGBOK_LEATHER","SPRUCE","SQUIRREL FUR","STAINLESS STEEL","STEEL","STERLING_SILVER","STINGRAY LEATHER","STRAW","STYRENE_BUTADIENE_RUBBER","SUEDE","SUGARCANE RESIN","SUPERFINE ALPACA WOOL","SUPERKID MOHAIR","SWAKARA_FUR","SYCOMORE","SYNDERME","SYNTHETIC LEATHER","SYNTHETIC RUBBER","SYNTHETIC_RESIN","TACTEL®","TANTALUM","TASAR_SILK","TEAK","TEFLON®","TEGUS - TUPINAMBIS LEATHER","TENCEL™ LYOCELL","TENCEL™ MODAL","THERMOPLASTIC POLYURETHANE","THERMOPLASTIC_ELASTOMER","THERMOPLASTIC_RUBBER","TILAPIA LEATHER","TIN","TITANIUM","TRIACETATE","TRIVINYL","TUNGSTEN","TURKEY_FEATHER","TWARON®","VARANUS LEATHER","VEAL SPLIT","VEAL_LEATHER","VEGEA™","VEGETABLE WASTE","VEGETAL IVORY - COROZO","VICUNA WOOL","VINYLAL","VIPER_LEATHER","VIRGIN WOOL","VISCOSE","WALNUT","WATER-BASED POLYURETHANE","WEASEL FUR","WICKER","WOLF FUR","WOLFISH LEATHER","WOOD","YAK WOOL","ZAMAK","ZIBELINE FUR","ZINC","ZINC_PLATED_IRON","ZIRCONIUM"]}},"components/schemas/Material":{"id":"components/schemas/Material","kind":"json-schema","title":"Material","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manufactured material (optional entity). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional fields at the root of the object (not an array); when both are provided they must form an official taxonomy pair. When you send one of these fields, send the other as well. Allowed values are the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enum"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lists on the shared schemas "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RawMaterialName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RawMaterialAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same taxonomies as for component "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawMaterial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1uPK74A-i0_TgF-7S6ldtYVgVEenLLbBT/edit?gid=1517342635#gid=1517342635"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made Material Selector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Step 1 = material, Step 2 = allowed attributes)."},"children":[]}]}]}],"required":["uniqueIdentifier"],"properties":{"uniqueIdentifier":{"type":"string","minLength":15,"maxLength":255,"description":"This identifier will make each material unique in our systems."},"ownerKind":{"type":"string","enum":["SUPPLIER"]},"ownerId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the material supplier. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead — not both owner and address."},"children":[]}]}]}]},"ownerUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the material supplier. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"allOf":[{"$ref":"#/components/schemas/Address"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not know the supplier of the item, you have the option to only fill an address. Provide either an owner ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or this address, but not both. Accessible only for clients that do not run traceability collection with Fairly Made."},"children":[]}]}]}]}]},"rawMaterialName":{"$ref":"#/components/schemas/RawMaterialName"},"rawMaterialAttribute":{"$ref":"#/components/schemas/RawMaterialAttribute"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/MaterialStep","description":"Processing steps applied to the material."}},"purchasedItems":{"type":"array","items":{"$ref":"#/components/schemas/MaterialPurchasedItem"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchased material inputs to produce this material. Each item represents a purchased material and its contribution percentage. Only applicable when the entity is linked with an owner ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); not used when providing a processing step address. Sum of purchased items and used items usagePercentage must equal 100."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Fairly Made traceability / supplier data collection, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (each related purchased item must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Links made only through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not taken into account for that analysis."},"children":[]}]}]}]},"usedMaterials":{"type":"array","items":{"$ref":"#/components/schemas/UsedMaterial"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Materials used as inputs for this material along with their usage percentage. Not taken into account for Fairly Made supplier data collection — use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]}}}},"components/schemas/Packaging":{"id":"components/schemas/Packaging","kind":"json-schema","title":"Packaging","data":{"type":"object","required":["uniqueIdentifier","channel","compostability","ecoModulation","hazardousSubstances","percentageRecycled","possibilityReUse","recyclability","type"],"properties":{"uniqueIdentifier":{"type":"string","minLength":1,"maxLength":70,"description":"Should be unique in FM system. Alphanumeric."},"channel":{"type":"string","description":"The distribution channel where the packaging is used. Taxonomy to be respected.","enum":["BOTH","E-COMMERCE","FACTORY_TO_CONSUMER","STORE"]},"compostability":{"type":"string","description":"Compostability of the packaging. Taxonomy to be respected.","enum":["N/A","NO - 0","YES - COMPOSTABLE"]},"ecoModulation":{"type":"string","description":"Eco-modulation linked to this packaging. Taxonomy to be respected.","enum":["BONUS -4% OFF-PACK - AWARENESS CAMPAIGN MEDIA","BONUS -8% REDUCTION AT SOURCE - REDUCTION OF THE NUMBER OF UNITS","BONUS -8% REDUCTION AT SOURCE - REDUCTION OF WEIGHT","BONUS -8% REDUCTION AT SOURCE - REFILLABLE RECYCLED CONTAINER","MALUS +10% - RIGID PE/PP BOTTLE DENSITY < 1","MALUS +10% - RIGID PET BOTTLE DENSITY < 1 AND DENSITY >1","MALUS +100% - ARMED PAPER/CARDBOARD","MALUS +100% - GLASS OTHER THA SODA LIME","MALUS +100% - GLASS WITH SODA LIME WITH INFUSIBLE ELEMENT","MALUS +100% - OPAQUE PET BOTTLE MINERAL FILLER > 4%","MALUS +100% - PVC BOTTLE","MALUS +100% - RIGID PLASTIC BOTTLE PET/PE/PP ASSOCIATED WITH ALUMINUM/PVC/SILICONE DENSITY >1","MALUS +50% - GLASS WITH A NON-MAGNETIC STEEL CLOSURE SYSTEM","MALUS +50% - PAPER/CARDBOARD CONTAINING PRINTING MINERAL OILS","MALUS +50% - PET BOTTLE CONTAINING GLASS BEADS","MALUS +50% - RIGID PLASTIC CONTAINING CARBON BLACK","NONE","PENALTY +X% OF THE WEIGHT - MARKING/SIGN LEADS CONFUSION ABOUT THE ACT OF SORTING","REWARD -X% OF THE WEIGHT - COMPOSITION > 10 % POST CONSUMER RECYCLED PLASTIC"]},"hazardousSubstances":{"type":"object","required":["status"],"description":"Presence of hazardous substances in the packaging.","properties":{"status":{"type":"string","description":"Status of hazardous substances. Taxonomy to be respected.","enum":["YES","NO","UNKNOWN"]},"value":{"type":"string","description":"You can pinpoint the exact hazardous substance."}}},"percentageRecycled":{"type":"number","minimum":0,"maximum":100,"description":"Percentage of recycled material present in the packaging."},"possibilityReUse":{"type":"string","description":"Possibility of re-use of the packaging. Taxonomy to be respected.","enum":["N/A","NO - 0","YES - REFILLABLE","YES - REUSABLE"]},"recyclability":{"type":"string","description":"Recyclability of the packaging. Taxonomy to be respected.","enum":["N/A","NO - 0","YES - FULLY RECYCLING","YES - FULLY RECYCLING + RECYCLABLE IN THE SAME TYPE OF PACKAGING","YES - MOSTLY RECYCLING"]},"type":{"type":"string","description":"Type of packaging. Taxonomy to be respected.","enum":["BOX","CARDBOARD_SHEET","CASE","CRYSTAL_POCKET","DELIVERY BOX","DOYPACK","DUST BAG/POUCH","ENVELOPE","FILLER","GARMENT_BAG","HANGER","HANGTAG_PAPER","HANGTAG_PLASTIC","NONE","OTHER","OUTER_PACK_","PAPER_ENVELOPE","PERFUME_BOTTLE","POLYBAG","PRINTED PAPER","SHOE BOX","SHOPPING BAG","SHRINK_FILM","SILK PAPER","STICKER","STRIPES","TOTE BAG","WOOD_PALLET"]}}}},"components/schemas/Component":{"id":"components/schemas/Component","kind":"json-schema","title":"Component","data":{"type":"object","required":["uniqueIdentifier","category","compositions"],"properties":{"uniqueIdentifier":{"type":"string","minLength":15,"maxLength":255,"description":"This identifier will make each component unique in our systems."},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the functional purpose of that component, you can reuse the value that you would use for the usedComponents[].usageCategory or purchasedItems[].usageCategory fields."},"children":[]}]}]}],"enum":["BACKINGS/COUNTERS","BEADS","BELT LOOPS","BIAS STRIPS","BRA CLIPS","BUCKLES","BUTTINETTES","BUTTONS","CHAIN","CLAMPING TABS","COLARS","CORD STOPERS","ELASTICS","EMBROIDERIES","EMBROIDERY BASE","EMBROIDERY YARN","EYELETS","FABRICS KNITTED","FABRICS WOVEN","FOAM","FRAME GUARDS","FURS","HANDLES","HEELS","HOOK_LOOP","INORGANIC_FIBER","INSOLES","JACRONS","LABELLINGS","LACES","LACES/CORDS","LEATHER PIECE","LININGS","LOCKS","MAGNETS","MAIN COMPONENT (EMBROIDERY)","MAIN COMPONENT (FUR)","MAIN COMPONENT (LEATHER)","MAIN COMPONENT (NON WOVEN)","MAIN FABRIC (KNITTED)","MAIN FABRIC (WOVEN)","MARQUISETTES","METAL ACCESSORIES","MIDSOLES","NATURAL_RUBBER","NETS/TROUSER SEATS","NON WOVEN","ORE","OUTSOLES","PADDINGS","PADDINGS BRA","PATIN","PIPING","PLASTIC ACCESSORIES","PLASTIC_GRANULES","POCKETING FABRIC","RECYCLED_FIBER","RECYCLED_ORE","RECYCLED_PLASTIC_GRANULES","RECYCLED_TANNED_HIDE","RECYCLED_WOOD","RIBBED EDGES","RIBBON","RINGS & CHIVES","RUBBER","RUBBER BANDS","SEWING THREADS","SHANKS","SHOULDER PADS","SHOULDER STRAPS","SMALL METAL PARTS","SMALL PLASTIC PARTS","SNAP HOOKS","STIFFENERS","STRAIGHT GRAINS","STRASS","STRETCHERS","STUFFINGS","SUSPENDERS","TAPES","TEXTILE ACCESSORIES","THERMOFUSINGS","TOE PUFFS","TOP LIFT","TULLES","UPPERS","VEGETAL_FIBER","VEGETAL_MATERIAL","WIRES","WOOD","YARNS","ZIP SLIDER","ZIP TAPE","ZIP TEETH","ZIPS"]},"reference":{"type":"string","description":"Your supplier's code or reference for this component. This will be the name of the form your supplier receives during Supplier Data Collection (if applicable), helping them identify the specific component."},"ownerKind":{"type":"string","enum":["SUPPLIER"]},"ownerId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the component supplier. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead — not both owner and address."},"children":[]}]}]}]},"ownerUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the component supplier. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"allOf":[{"$ref":"#/components/schemas/Address"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not know the supplier of the item, you have the option to only fill an address. Provide either an owner ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or this address, but not both. Accessible only for clients that do not run traceability collection with Fairly Made."},"children":[]}]}]}]}]},"compositions":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Composition"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Composition details; each entry must use an official raw material name–attribute pair; the sum of percentages must equal 100% and lines must be unique. When the same raw material (name + attribute) has multiple origins and/or certifications, you must create multiple entries in the array (one per origin and/or certification). Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1uPK74A-i0_TgF-7S6ldtYVgVEenLLbBT/edit?gid=1517342635#gid=1517342635"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made Material Selector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to choose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compositionRawMaterial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ComponentStep","description":"Processing steps for the component. Taxonomy"}},"purchasedItems":{"type":"array","items":{"$ref":"#/components/schemas/PurchasedItemUsage"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchased items used to produce this component (can be purchased component or purchased material). If the purchased item is a component, usageCategory is mandatory. Only applicable when the entity is linked with an owner ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); not used when providing a processing step address. Sum of purchased items and used items usagePercentage must equal 100."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Fairly Made traceability / supplier data collection, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (each related purchased item must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Links made only through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedMaterials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not taken into account for that analysis."},"children":[]}]}]}]},"usedComponents":{"type":"array","items":{"$ref":"#/components/schemas/UsedComponent"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Components used as inputs for this component along with their usage percentage. Not taken into account for Fairly Made supplier data collection — use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},"usedMaterials":{"type":"array","items":{"$ref":"#/components/schemas/UsedMaterial"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Materials used as inputs for this component along with their usage percentage. Not taken into account for Fairly Made supplier data collection — use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]}}}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","required":["uniqueIdentifier","category"],"properties":{"uniqueIdentifier":{"type":"string","description":"This identifier will make each product unique in our systems."},"ownerKind":{"type":"string","enum":["SUPPLIER"]},"ownerId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the manufacturing supplier. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead — not both owner and address."},"children":[]}]}]}]},"ownerUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the manufacturing supplier. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"allOf":[{"$ref":"#/components/schemas/Address"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not know the supplier of the item, you have the option to only fill an address. Provide either an owner ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or this address, but not both. Accessible only for clients that do not run traceability collection with Fairly Made."},"children":[]}]}]}]}]},"category":{"type":"string","description":"Product category taxonomy. Values.","enum":["ACCESSORIES","APRONS","BACKPACKS","BATHROBES","BATH_MATS","BATH_TOWELS","BEACH_BAGS","BEACH_TOWELS","BEANIES","BELTS","BIBS","BIBS & BRACES","BIKINIS","BLANKETS_PLAIDS","BLAZERS & SUITS","BLOUSES","BODYSUITS","BRAS","CAPE","CAPS","CARDIGANS","CHAIR_SOFA_COVERS","COMPONENTS","CURTAINS","CUSHIONS","CUSHION_COVERS","DENIM PANTS","DENIM_JACKETS","DOWN JACKETS","DRESSES","DUVETS","DUVET_COVERS","FASHION BOOTS","FLIP FLOPS","FORMAL COATS","FORMAL SHOES","FOUTA","GLOVES","HAIR ACCESSORIES","HATS","HEELS (CLOSED)","HEELS (OPENED)","HOME TEXTILES","HOMEWEARS","HOODIES","JACKETS & WORKVESTS","JEWELRY","JUMPSUITS & BOILERS","KITCHEN_POTHOLDER_GLOVES","LEGGINGS","MATTRESS_PROTECTORS","NAPKINS","ONE PIECES","OTHER BAGS","PANTS","PAREOS","PERFUMES","PILLOWCASES","POLOS","PONCHO","PROTECTIVE BOOTS","PROTECTIVE SHOES","PULLOVERS","PURSES","PUSHCHAIR_SEAT_FABRIC","RASHGUARDS","RUG","SANDALS","SCARVES & TIES","SHEETS","SHIRT-DRESSES","SHIRTS","SHORTS","SKIRTS","SLIPPERS","SNEAKERS","SOCKS","STOCKINGS & TIGHTS","SWEATSHIRTS","SWIMMING TRUNKS","TABLECLOTHS","TANK TOPS","TEA_TOWELS","TEDDY","TOPS","TOTE BAGS","TRENCH","TSHIRTS","UNDERWEARS","WAISTCOATS","WALLETS & CARD CARRIERS","WASH_GLOVES","WATCH","YOGA_MAT","ZIPPED COATS","ZIPPED POUCHES"]},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProductStep","description":"Processing steps for the product."}},"purchasedItems":{"type":"array","items":{"$ref":"#/components/schemas/PurchasedItemUsage"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchased items used in this product. If the purchased item is a component, usageCategory is mandatory. Only applicable when the entity is linked with an owner ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); not used when providing a processing step address. Sum of purchased items and used items usagePercentage must equal 100."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Fairly Made traceability / supplier data collection, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (each related purchased item must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Links made only through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not taken into account for that analysis."},"children":[]}]}]}]},"usedProducts":{"type":"array","items":{"$ref":"#/components/schemas/UsedProduct"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other manufactured products used as inputs. Counts toward the same 100% total as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sum of all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usagePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must equal 100). Not taken into account for Fairly Made supplier data collection — use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},"usedComponents":{"type":"array","items":{"$ref":"#/components/schemas/UsedComponent"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Components used as inputs for this product. Not taken into account for Fairly Made supplier data collection — use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]}}}},"components/schemas/PurchasedItem":{"id":"components/schemas/PurchasedItem","kind":"json-schema","title":"PurchasedItem","data":{"type":"object","required":["uniqueIdentifier","buyerKind","purchaseOrder"],"properties":{"uniqueIdentifier":{"type":"string","description":"This identifier will make each purchased item unique in our systems."},"buyerKind":{"type":"string","enum":["CUSTOMER","SUPPLIER"],"description":"The type of buyer (customer -yourself- or supplier) for this item."},"buyerId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the buyer. Required as exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not both, not neither)."},"children":[]}]}]}]},"buyerUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer supplier. Required as exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sellerId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the supplier that sold the item. Required as exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not both, not neither)."},"children":[]}]}]}]},"sellerUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the seller supplier. Required as exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchaseOrder":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order number for this transaction. Required. If you run traceability collection with Fairly Made, this link is needed so Fairly Made can launch supplier data collection. If your analysis granularity is not at purchase-order level, use a representative PO for the panel covered by that granularity. If you are unable to provide a PO at all, you can set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_SPECIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchaseOrderDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the transaction. Calendar date only, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (RFC 3339 full-date / ISO 8601), e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"transports":{"type":"array","description":"The transportation mode used for this transaction.","items":{"$ref":"#/components/schemas/Transport"}},"purchasedQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purchased quantity for this transaction. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references a product, the only allowed unit is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIECES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/Quantity"}]},"certifications":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. If the array is present and contains at least one object, each object must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","required":["certificationName"],"properties":{"certificationName":{"type":"string","description":"Use one of the enum values exactly as written. The list covers certifications relevant whether the purchased item is a product, a component, or a material.","enum":["ABELUSI WOOL","AGRICULTURE BIOLOGIQUE","ALGODAO BRASILEIRO RESPONSAVEL","ALPACA MARK - BLEND MARK","ALPACA MARK - GOLD","ALPACA MARK - SILVER","ANIMAL WELFARE APPROVED","AUTHENTICO","BCI","BIOKREIS","BIORE COTTON","BIORE TEXTILE","BLUE ANGEL","BLUESIGN PRODUCT","BMP CERTIFIED COTTON","C2C BRONZE","C2C GOLD","C2C PLATINUM","C2C SILVER","CARBON FREE CERTIFIED","CARBON NEUTRAL","CCS","CERTIFICATION OF RAW MATERIAL TRACEABILITY","CERTIFIED ANIMAL FIBERS","CERTIFIED RAW MATERIALS","CLEANER COTTON","CMIA ORGANIC","DEMETER","DOWNPASS","ECO PASSPORT BY OEKO-TEX","ERTS","EU ECOLABEL","EU ORGANIC FARMING","EUROPEAN FLAX","FAIR TRADE USA CERTIFIED","FAIRMINED","FAIRTRADE COTTON MARK","FAIRTRADE COTTON PROGRAM","FAIRTRADE MARK","FAIRTRADE SOURCED INGREDIENT MARK","FAIRTRADE TEXTILE PRODUCTION MARK","FSC","FSC 100%","FURMARK","GOOD EARTH COTTON®","GOODWEAVE","GOTS","GOTS TC","GREEN PRODUCT","GRS","ICEC - ECO-LEATHER UNI 11427","ICEC - LEATHER FROM ITALY - UNI EN 16484","ICEC - MADE IN ITALY","ICEC - TS PM 414","INTERBEV","ISCC","ISCC PLUS","IWTO","LEATHER STANDARD BY OEKO-TEX","MADE IN GREEN BY OEKOTEX LEVEL 1","MADE IN GREEN BY OEKOTEX LEVEL 2","MADE IN GREEN BY OEKOTEX LEVEL 3","MANAGED FOREST FIBERS","MASTER OF LINEN","MATERIALS MATTER STANDARD","MSC","MULESING FREE","NA FARM RAISED","NA WILD FUR","NATIVA","NATURLEDER","NATURTEXTIL","NATURTEXTIL BEST","NEWMERINO","NORDIC SWAN ECOLABEL","OABA A","OABA B","OABA C","OABA D","OABA E","OCS","OK BIOBASED","OK BIODEGRADABLE","ORGANIC FIBERS","ORIGINE FRANCE GARANTIE","OTHER","PEFC","PEFC RECYCLED","PETA - CRUELTY FREE","PETA - CRUELTY FREE & VEGAN","RAS","RAWIP","RCS","RDS","RECYCLED FIBERS","RECYCLED FSC","REEL","REGENAGRI","REMADE IN ITALY","REPREVE","RGMP","RMS","ROC GOLD","ROC SILVER","RRSS","RSPCA","RWS","SAOBC","SFA","SOIL ASSOCIATION ORGANIC","SOUTH AFRICAN OSTRICH BUSINESS CHAMBER","SRCP","STANDARD 100 BY OEKOTEX","SUSTAINABLE CAPE WOOL STANDARD","SUSTAINABLE FIBRE ALLIANCE","SUSTAINABLE FORESTRY INITIATIVE","SUSTAINAWOOL","SWAKARA","THE GOOD CASHMERE STANDARD","TRACEABLE DOWN STANDARD","US COTTON TRUST PROTOCOL","USDA CERTIFIED BIOBASED","V-LABEL","WELFUR","WOOL INTEGRITY","WOOLMARK","ZQ WOOL","ZQRX PROGRAM"]}}}},"itemId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the purchased entity (manufactured product, component, or material). Required as exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not both, not neither)."},"children":[]}]}]}]},"itemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the purchased entity (manufactured product, component, or material). Required as exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/CustomerInventoryValidationError":{"id":"components/schemas/CustomerInventoryValidationError","kind":"json-schema","title":"CustomerInventoryValidationError","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned with HTTP 400 when the request is not valid: unknown JSON properties (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must not be sent on PATCH), invalid formats, or business rules that fail after applying your update. The shape differs from legacy endpoints that return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","message","field"],"properties":{"type":{"type":"string","description":"Machine-readable error identifier for this failure (stable string for client-side handling)."},"message":{"type":"string","description":"Human-readable explanation."},"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON path of the field the error relates to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warehouse.supplierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}}},"components/schemas/CustomerInventoryForbiddenOrNotFoundError":{"id":"components/schemas/CustomerInventoryForbiddenOrNotFoundError","kind":"json-schema","title":"CustomerInventoryForbiddenOrNotFoundError","data":{"type":"object","description":"Returned with HTTP 403 or 404 when the id is not accessible for your organisation.","required":["reason","message","field"],"properties":{"reason":{"type":"string","description":"Machine-readable reason for the failure (stable string for client-side handling)."},"message":{"type":"string"},"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON path or parameter name associated with the error (often "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for path issues)."},"children":[]}]}]}]},"extra":{"type":"object","additionalProperties":true,"description":"Optional structured context (for example related ids)."}}}},"components/schemas/CustomerInventoryUnprocessableError":{"id":"components/schemas/CustomerInventoryUnprocessableError","kind":"json-schema","title":"CustomerInventoryUnprocessableError","data":{"type":"object","description":"Returned with HTTP 422 when a reference cannot be resolved, is outside your registry scope, points to an inactive supplier, or another consistency check fails.\n","required":["type","message","field"],"properties":{"type":{"type":"string","description":"Machine-readable error identifier for this failure (stable string for client-side handling)."},"message":{"type":"string"},"field":{"type":"string"},"extra":{"type":"object","additionalProperties":true,"description":"Optional structured context returned with the error."}}}},"components/schemas/BrandProductCustomerPatchBody":{"id":"components/schemas/BrandProductCustomerPatchBody","kind":"json-schema","title":"BrandProductCustomerPatchBody","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /brand-products/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every field is optional; only send properties you want to change. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not part of this schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — omit it (sending it returns HTTP 400). Do not send both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the same request (same rule applies to their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*UniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variants — at most one product link). Allowed values for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marketSegment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecoModulation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" follow the same taxonomies as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless your integration guide states otherwise."},"children":[]}]}]}],"properties":{"manufacturedProductId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID link to a manufactured product. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"manufacturedProductUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link to a manufactured product. Mutually exclusive with other product link fields."},"children":[]}]}]}]},"purchasedItemId":{"type":"string","format":"uuid","description":"System UUID link to a purchased item. Mutually exclusive with other product link fields."},"purchasedItemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link to a purchased item. Mutually exclusive with other product link fields."},"children":[]}]}]}]},"ref":{"type":"string"},"colorCode":{"type":"string"},"collection":{"type":"string"},"productName":{"type":"string","nullable":true},"packagingIds":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUIDs of the associated packagings. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packagingUniqueIdentifiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Replaces the previous list in full when sent."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"}},"packagingUniqueIdentifiers":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s of the associated packagings. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packagingIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Replaces the previous list in full when sent."},"children":[]}]}]}],"items":{"type":"string"}},"gtins":{"type":"array","items":{"type":"string"}},"marketSegment":{"type":"string","nullable":true},"productPrice":{"type":"number","nullable":true},"ecoModulation":{"type":"string"},"producedQuantity":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"warehouse":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warehouse: provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a postal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — not both supplier reference and address in the same object. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear the warehouse on the brand product."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/Warehouse"}]}}}},"components/schemas/BrandProductCustomerReadModel":{"id":"components/schemas/BrandProductCustomerReadModel","kind":"json-schema","title":"BrandProductCustomerReadModel","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand product as returned after a successful "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /brand-products/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /brand-products/by-unique-identifier/{uniqueIdentifier}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","description":"Your customer id."},"uniqueIdentifier":{"type":"string","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigned at creation; returned for reference only — not accepted in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request bodies."},"children":[]}]}]}]},"collection":{"type":"string"},"category":{"type":"string"},"colorCode":{"type":"string"},"marketSegment":{"type":"string","nullable":true},"ecoModulation":{"type":"string","nullable":true},"ref":{"type":"string"},"productName":{"type":"string","nullable":true,"description":"Commercial or internal product name on your side."},"manufacturedProductId":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the linked manufactured product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchasedItemId":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the linked purchased item, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"productPrice":{"type":"number","nullable":true},"weight":{"type":"number","nullable":true},"producedQuantity":{"type":"number","nullable":true},"warehouse":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Warehouse"}]},"hasCommunicationPackage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the product's communication pack is active. Governs whether "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"children":[]}]}]}]},"links":{"$ref":"#/components/schemas/BrandProductLinks"},"gtins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"value":{"type":"string"}}}},"packagingIds":{"type":"array","items":{"type":"string","format":"uuid"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}},"components/schemas/ManufacturedProductPatchPurchasedItem":{"id":"components/schemas/ManufacturedProductPatchPurchasedItem","kind":"json-schema","title":"ManufacturedProductPatchPurchasedItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill-of-materials line sourced from a purchased item. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"purchasedItemId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the purchased item. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchasedItemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the purchased item. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usagePercentage":{"type":"number","nullable":true},"usageCategory":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when the referenced purchased item is a component. Use the same usage category taxonomy as for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/ManufacturedProductCustomerPatchBody":{"id":"components/schemas/ManufacturedProductCustomerPatchBody","kind":"json-schema","title":"ManufacturedProductCustomerPatchBody","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /manufactured-products/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every field is optional; only send properties you want to change. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not part of this schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — omit it (sending it returns HTTP 400)."},"children":[]}]}]}],"properties":{"ownerKind":{"type":"string","enum":["SUPPLIER"],"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the supplier owner. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when setting an owner."},"children":[]}]}]}]},"ownerUniqueIdentifier":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the supplier owner. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Address"},{"description":"Accessible only for clients that do not run traceability collection with Fairly Made."}]},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product category; same allowed values as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProductStep"}},"purchasedItems":{"type":"array","items":{"$ref":"#/components/schemas/ManufacturedProductPatchPurchasedItem"}},"usedProducts":{"type":"array","items":{"$ref":"#/components/schemas/UsedProduct"}},"usedComponents":{"type":"array","items":{"$ref":"#/components/schemas/UsedComponent"}}}}},"components/schemas/ManufacturedProductCustomerPatchResponse":{"id":"components/schemas/ManufacturedProductCustomerPatchResponse","kind":"json-schema","title":"ManufacturedProductCustomerPatchResponse","data":{"type":"object","required":["manufacturedProductId"],"properties":{"manufacturedProductId":{"type":"string","format":"uuid"}}}},"components/schemas/ManufacturedProductCustomerAggregate":{"id":"components/schemas/ManufacturedProductCustomerAggregate","kind":"json-schema","title":"ManufacturedProductCustomerAggregate","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full manufactured product record returned on successful "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/by-unique-identifier/{uniqueIdentifier}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"additionalProperties":true}},"components/schemas/ManufacturedComponentPatchPurchasedItem":{"id":"components/schemas/ManufacturedComponentPatchPurchasedItem","kind":"json-schema","title":"ManufacturedComponentPatchPurchasedItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill-of-materials line sourced from a purchased item. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match the official category lists for component and material inputs. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"purchasedItemId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the purchased item. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchasedItemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the purchased item. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usagePercentage":{"type":"number","nullable":true},"usageCategory":{"type":"string","nullable":true}}}},"components/schemas/ManufacturedComponentPatchUsedMaterial":{"id":"components/schemas/ManufacturedComponentPatchUsedMaterial","kind":"json-schema","title":"ManufacturedComponentPatchUsedMaterial","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill-of-materials line referencing a manufactured material. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"materialId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the material. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"materialUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the material. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"materialId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usagePercentage":{"type":"number","nullable":true}}}},"components/schemas/ManufacturedComponentCustomerPatchBody":{"id":"components/schemas/ManufacturedComponentCustomerPatchBody","kind":"json-schema","title":"ManufacturedComponentCustomerPatchBody","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /manufactured-components/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every field is optional; only send properties you want to change. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not part of this schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — omit it (sending it returns HTTP 400)."},"children":[]}]}]}],"properties":{"reference":{"type":"string"},"ownerKind":{"type":"string","enum":["SUPPLIER"],"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the supplier owner. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when setting an owner."},"children":[]}]}]}]},"ownerUniqueIdentifier":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the supplier owner. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Address"},{"description":"Accessible only for clients that do not run traceability collection with Fairly Made."}]},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Component category; same allowed values as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /manufactured-components"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"compositions":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Composition"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ComponentStep"}},"purchasedItems":{"type":"array","items":{"$ref":"#/components/schemas/ManufacturedComponentPatchPurchasedItem"}},"usedComponents":{"type":"array","items":{"$ref":"#/components/schemas/UsedComponent"}},"usedMaterials":{"type":"array","items":{"$ref":"#/components/schemas/ManufacturedComponentPatchUsedMaterial"}}}}},"components/schemas/ManufacturedComponentCustomerAggregate":{"id":"components/schemas/ManufacturedComponentCustomerAggregate","kind":"json-schema","title":"ManufacturedComponentCustomerAggregate","data":{"type":"object","description":"Full manufactured component record after update (identifiers, reference, category, composition, steps, bill of materials, address or supplier owner, and timestamps as applicable).\n","additionalProperties":true}},"components/schemas/ManufacturedMaterialCustomerPatchBody":{"id":"components/schemas/ManufacturedMaterialCustomerPatchBody","kind":"json-schema","title":"ManufacturedMaterialCustomerPatchBody","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /manufactured-materials/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every field is optional; only send properties you want to change. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not part of this schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — omit it (sending it returns HTTP 400). If you update the raw material, send both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawMaterialAttribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or omit both."},"children":[]}]}]}],"properties":{"ownerKind":{"type":"string","enum":["SUPPLIER"],"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the supplier owner. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when setting an owner."},"children":[]}]}]}]},"ownerUniqueIdentifier":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the supplier owner. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPLIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Address"},{"description":"Accessible only for clients that do not run traceability collection with Fairly Made."}]},"rawMaterialName":{"$ref":"#/components/schemas/RawMaterialName"},"rawMaterialAttribute":{"$ref":"#/components/schemas/RawMaterialAttribute"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/MaterialStep"}},"purchasedItems":{"type":"array","items":{"$ref":"#/components/schemas/MaterialPurchasedItem"}},"usedMaterials":{"type":"array","items":{"$ref":"#/components/schemas/UsedMaterial"}}}}},"components/schemas/ManufacturedMaterialCustomerAggregate":{"id":"components/schemas/ManufacturedMaterialCustomerAggregate","kind":"json-schema","title":"ManufacturedMaterialCustomerAggregate","data":{"type":"object","description":"Full manufactured material record after update.","additionalProperties":true}},"components/schemas/PurchasedItemCustomerPatchBody":{"id":"components/schemas/PurchasedItemCustomerPatchBody","kind":"json-schema","title":"PurchasedItemCustomerPatchBody","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /purchased-items/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every field is optional; only send properties you want to change. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not part of this schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — omit it (sending it returns HTTP 400). The purchased item type (product, component, or material) is fixed at creation and cannot be changed. The buyer and seller are set at creation and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be changed on update — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sellerUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not part of this schema (sending any of them returns HTTP 400)."},"children":[]}]}]}],"properties":{"itemId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the purchased entity. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"itemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the purchased entity. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"purchaseOrder":{"type":"string","nullable":true},"purchaseOrderDate":{"type":"string","format":"date","nullable":true},"transports":{"type":"array","items":{"$ref":"#/components/schemas/Transport"}},"purchasedQuantity":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Quantity"}]},"certifications":{"type":"array","items":{"$ref":"#/components/schemas/Certification"}}}}},"components/schemas/PurchasedItemCustomerAggregate":{"id":"components/schemas/PurchasedItemCustomerAggregate","kind":"json-schema","title":"PurchasedItemCustomerAggregate","data":{"type":"object","description":"Full purchased item record after update.","additionalProperties":true}},"components/schemas/Warehouse":{"id":"components/schemas/Warehouse","kind":"json-schema","title":"Warehouse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the destination warehouse for brand product data. Provide either a warehouse supplier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — not both in the same object."},"children":[]}]}]}],"properties":{"supplierId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the warehouse supplier. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"supplierUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the warehouse supplier. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/Address","description":"Address of the warehouse. Country is mandatory; city, postalCode and street are optional. Accessible only for clients that do not run traceability collection with Fairly Made."}}}},"components/schemas/BrandProductInformation":{"id":"components/schemas/BrandProductInformation","kind":"json-schema","title":"BrandProductInformation","data":{"type":"object","description":"Additional brand product information for a manufactured product or purchased item.","required":["uniqueIdentifier","warehouse"],"properties":{"uniqueIdentifier":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Makes each brand product record unique in our systems. Build it from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the related purchased item (create purchased item). Follow the global "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rules in the API introduction: use prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and underscores between segments—recommended shape "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BP_<ref>_<colorCode>_<collection>_<purchaseOrder>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BP_REF-001_DEFAULT_C01_PO-001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"manufacturedProductId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUID of the manufactured product this brand product row is linked to. At most "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" product link among "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturedProductUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItemUniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use when only a supplier address was provided for the manufactured product and no purchase transaction exists yet."},"children":[]}]}]}]},"manufacturedProductUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the manufactured product. Mutually exclusive with other product link fields."},"children":[]}]}]}]},"purchasedItemId":{"type":"string","format":"uuid","description":"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."},"purchasedItemUniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the purchased item. Mutually exclusive with other product link fields."},"children":[]}]}]}]},"ref":{"type":"string","description":"Optional internal reference for the brand product."},"colorCode":{"type":"string","description":"Unique color reference/name of the product."},"collection":{"type":"string","description":"Collection or season name of the product."},"productName":{"type":"string","description":"Name of the product in your own system."},"packagingIds":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System UUIDs of the associated packagings. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packagingUniqueIdentifiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — send one or the other, not both. Each element is a UUID (v4 format)."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"}},"packagingUniqueIdentifiers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s of the associated packagings (same values as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /packagings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packagingIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — send one or the other, not both."},"children":[]}]}]}],"items":{"type":"string"}},"gtins":{"type":"array","description":"List of Global Trade Item Numbers (GTIN) and/or European Article Numbers (EAN).","items":{"type":"string","description":"Each value should contain 13 digits."}},"marketSegment":{"type":"string","description":"Market segment taxonomy.","enum":["Menswear","Womenswear","Kidswear","Babywear","Lingerie"]},"productPrice":{"type":"number","description":"Product price in euro."},"ecoModulation":{"type":"string","description":"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","REFASHION TLC - ECO-MODULATION 3 - % RECYCLED MAT","REFASHION TLC - ECO-MODULATION 4 - RECYCLABILITY PENALTY"]},"producedQuantity":{"type":"number","description":"Quantity produced for this specific product."},"weight":{"type":"number","description":"Weight of the product in grams."},"warehouse":{"$ref":"#/components/schemas/Warehouse"}}}},"components/schemas/AnalysisReadError":{"id":"components/schemas/AnalysisReadError","kind":"json-schema","title":"AnalysisReadError","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error envelope for analysis read endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /calculated-french-environmental-cost/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /lifecycle-assessment/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /declared-french-environmental-cost/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Machine-readable failure codes are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details[].reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["message","details"],"properties":{"message":{"type":"string","description":"Human-readable error message."},"details":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/AnalysisReadErrorDetail"}}}}},"components/schemas/AnalysisReadErrorDetail":{"id":"components/schemas/AnalysisReadErrorDetail","kind":"json-schema","title":"AnalysisReadErrorDetail","data":{"type":"object","required":["reason"],"properties":{"field":{"type":"string","description":"Path parameter or token context field related to the error."},"reason":{"type":"string","description":"Stable machine-readable error code for client-side handling."},"extra":{"type":"object","additionalProperties":true,"description":"Optional structured context (for example upstream failure details)."}}}},"components/schemas/CalculatedFrenchEnvironmentalCostScoring":{"id":"components/schemas/CalculatedFrenchEnvironmentalCostScoring","kind":"json-schema","title":"CalculatedFrenchEnvironmentalCostScoring","data":{"type":"object","description":"FEC score breakdown (AGEC / Ecobalyse methodology).","properties":{"brandScore":{"type":"number","nullable":true,"description":"Brand-level score component."},"productScore":{"type":"number","nullable":true,"description":"Product-level score component."},"lcaScore":{"type":"number","nullable":true,"description":"LCA-based score component."},"ooeuExportScore":{"type":"number","nullable":true,"description":"Export outside the European Union score component."},"microfibersScore":{"type":"number","nullable":true,"description":"Microfibers release score component."},"malusBonusServiceDuration":{"type":"number","nullable":true,"description":"Malus/bonus applied for service duration."},"referenceServiceDuration":{"type":"number","nullable":true,"description":"Reference service duration used in the calculation (years)."},"frenchEnvironmentalCost":{"type":"number","nullable":true,"description":"Final calculated French Environmental Cost score (points)."}}}},"components/schemas/CalculatedFrenchEnvironmentalCostReadModel":{"id":"components/schemas/CalculatedFrenchEnvironmentalCostReadModel","kind":"json-schema","title":"CalculatedFrenchEnvironmentalCostReadModel","data":{"type":"object","description":"Calculated French Environmental Cost (FEC) for a brand product.","required":["scoring","calculatedAt"],"properties":{"scoring":{"$ref":"#/components/schemas/CalculatedFrenchEnvironmentalCostScoring"},"durabilityCoefficient":{"type":"number","description":"Durability coefficient applied to the FEC calculation."},"pictogram":{"type":"string","format":"uri","description":"URL of the FEC pictogram (Ecobalyse image endpoint)."},"calculatedAt":{"type":"string","format":"date-time","description":"Timestamp when the FEC was calculated."}}}},"components/schemas/LifeCycleAssessmentIndicatorsFR":{"id":"components/schemas/LifeCycleAssessmentIndicatorsFR","kind":"json-schema","title":"LifeCycleAssessmentIndicatorsFR","data":{"type":"object","description":"French regulatory life cycle impact indicators.","additionalProperties":{"type":"number"},"properties":{"climateChange":{"type":"number"},"climateChangeBiogenic":{"type":"number"},"climateChangeFossil":{"type":"number"},"climateChangeLandUse":{"type":"number"},"acidification":{"type":"number"},"ecotoxicityFreshWater":{"type":"number"},"humanToxicityCancer":{"type":"number"},"humanToxicityNonCancer":{"type":"number"},"eutrophicationFreshWater":{"type":"number"},"eutrophicationMarine":{"type":"number"},"eutrophicationTerrestrial":{"type":"number"},"ionisingRadiation":{"type":"number"},"landuse":{"type":"number"},"ozoneDepletion":{"type":"number"},"particulateMatter":{"type":"number"},"photochemicalOzoneFormation":{"type":"number"},"resourceUseFossils":{"type":"number"},"resourceUseMineralsMetals":{"type":"number"},"waterUse":{"type":"number"}}}},"components/schemas/LifeCycleAssessmentIndicatorsPEF":{"id":"components/schemas/LifeCycleAssessmentIndicatorsPEF","kind":"json-schema","title":"LifeCycleAssessmentIndicatorsPEF","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PEF impact indicators (17 categories, including the aggregated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pefSingleScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":["pefSingleScore"],"properties":{"pefSingleScore":{"type":"number","description":"Aggregated PEF single score."},"climateChange":{"type":"number"},"acidification":{"type":"number"},"ecotoxicityFreshWater":{"type":"number"},"humanToxicityCancer":{"type":"number"},"humanToxicityNonCancer":{"type":"number"},"eutrophicationFreshWater":{"type":"number"},"eutrophicationMarine":{"type":"number"},"eutrophicationTerrestrial":{"type":"number"},"ionisingRadiation":{"type":"number"},"landuse":{"type":"number"},"ozoneDepletion":{"type":"number"},"particulateMatter":{"type":"number"},"photochemicalOzoneFormation":{"type":"number"},"resourceUseFossils":{"type":"number"},"resourceUseMineralsMetals":{"type":"number"},"waterUse":{"type":"number"}}}},"components/schemas/LifeCycleAssessmentReadModel":{"id":"components/schemas/LifeCycleAssessmentReadModel","kind":"json-schema","title":"LifeCycleAssessmentReadModel","data":{"type":"object","description":"Life cycle assessment (LCA) results for a brand product.","required":["lcaFR","lcaPEF","calculatedAt"],"properties":{"lcaFR":{"$ref":"#/components/schemas/LifeCycleAssessmentIndicatorsFR"},"lcaPEF":{"$ref":"#/components/schemas/LifeCycleAssessmentIndicatorsPEF"},"calculatedAt":{"type":"string","format":"date-time","description":"Timestamp when the LCA was calculated."}}}},"components/schemas/DeclaredFrenchEnvironmentalCostScoring":{"id":"components/schemas/DeclaredFrenchEnvironmentalCostScoring","kind":"json-schema","title":"DeclaredFrenchEnvironmentalCostScoring","data":{"type":"object","description":"Declared FEC score breakdown.","properties":{"brandScore":{"type":"number","nullable":true},"productScore":{"type":"number","nullable":true},"frenchEnvironmentalCost":{"type":"number","nullable":true,"description":"Declared French Environmental Cost score (points)."}}}},"components/schemas/DeclaredFrenchEnvironmentalCostReadModel":{"id":"components/schemas/DeclaredFrenchEnvironmentalCostReadModel","kind":"json-schema","title":"DeclaredFrenchEnvironmentalCostReadModel","data":{"type":"object","description":"Declared French Environmental Cost (FEC) published for a brand product.","required":["calculatedAt"],"properties":{"scoring":{"$ref":"#/components/schemas/DeclaredFrenchEnvironmentalCostScoring"},"publishedFrenchEnvironmentalCost":{"type":"number","description":"Declared FEC score published on the government platform."},"publishedFrenchEnvironmentalCostPerUnitWeight":{"type":"number","description":"Declared FEC per unit weight (g)."},"pictogram":{"type":"string","format":"uri","description":"URL of the published FEC pictogram."},"isPublishedOnGovernmentPlatform":{"type":"boolean","description":"Whether the FEC has been published on the government platform."},"governmentPlatformPublicationDate":{"type":"string","format":"date-time","nullable":true,"description":"Publication date on the government platform, when available."},"calculatedAt":{"type":"string","format":"date-time","description":"Timestamp of the declared FEC record."}}}},"components/schemas/DeclaredFrenchEnvironmentalCostListItem":{"id":"components/schemas/DeclaredFrenchEnvironmentalCostListItem","kind":"json-schema","title":"DeclaredFrenchEnvironmentalCostListItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One product row in the declared FEC list. Products without a declaration are included, with the published* fields and governmentPlatformPublicationDate as null and the flag as false (or null when no declaration record exists at all)."},"children":[]}]}]}],"required":["brandProductId","gtins"],"properties":{"brandProductId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fairly Made product id — usable on the single-product endpoint."},"children":[]}]}]}]},"brandProductUniqueIdentifier":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The brand product's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"internalReference":{"type":"string","nullable":true,"description":"Product reference from the Fairly Made product repository."},"gtins":{"type":"array","items":{"type":"string"},"description":"The product's GTINs valid for government declaration (13-digit codes)."},"isFrenchEnvironmentalCostPublishedToGovernmentPlatform":{"type":"boolean","nullable":true,"description":"Whether the FEC is published on the government platform."},"governmentPlatformPublicationDate":{"type":"string","format":"date-time","nullable":true,"description":"Publication date on the government platform."},"publishedFrenchEnvironmentalCost":{"type":"integer","nullable":true,"description":"Declared FEC value (points), as submitted at declaration time."},"publishedFrenchEnvironmentalCostPer100grams":{"type":"integer","nullable":true,"description":"Declared FEC per 100 g."},"publishedFrenchEnvironmentalCostPictogram":{"type":"string","format":"uri","nullable":true,"description":"Ecobalyse score-image URL."}}}},"components/schemas/DeclaredFrenchEnvironmentalCostListResponse":{"id":"components/schemas/DeclaredFrenchEnvironmentalCostListResponse","kind":"json-schema","title":"DeclaredFrenchEnvironmentalCostListResponse","data":{"type":"object","description":"Paginated envelope for the declared FEC list.","required":["data","offset","limit","total"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeclaredFrenchEnvironmentalCostListItem"}},"offset":{"type":"integer","description":"Zero-based index of the first row returned."},"limit":{"type":"integer","description":"Maximum number of rows returned in this page."},"total":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of products matching the query — the full match count, independent of the page requested."},"children":[]}]}]}]}}}},"components/schemas/BrandProductCreatedResponse":{"id":"components/schemas/BrandProductCreatedResponse","kind":"json-schema","title":"BrandProductCreatedResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand product as returned after a successful "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["brandProductId","hasCommunicationPackage","links"],"properties":{"brandProductId":{"type":"string","format":"uuid","description":"Identifier of the created brand product record. UUID v4 format."},"uniqueIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", echoed from the request."},"children":[]}]}]}]},"hasCommunicationPackage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the product's communication pack is active. Governs whether "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"children":[]}]}]}]},"links":{"$ref":"#/components/schemas/BrandProductLinks"}}}},"components/schemas/BrandProductLinks":{"id":"components/schemas/BrandProductLinks","kind":"json-schema","title":"BrandProductLinks","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product's QR-code and web links. Both are returned only when the product's communication pack is active ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasCommunicationPackage: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); otherwise both are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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)."},"children":[]}]}]}],"required":["qrCode","web"],"properties":{"qrCode":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable, printable QR-code hub URL for the product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"web":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable, printable web hub URL for the product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/BrandProductListItem":{"id":"components/schemas/BrandProductListItem","kind":"json-schema","title":"BrandProductListItem","data":{"type":"object","description":"One product row in the brand-products list. Every product matching the filters and the caller's brand is returned, whether or not it carries links.\n","required":["id","category","gtins","hasCommunicationPackage","createdAt","links"],"properties":{"id":{"type":"string","format":"uuid","description":"Fairly Made product id."},"uniqueIdentifier":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your brand product "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /brand-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"ref":{"type":"string","nullable":true,"description":"Product reference."},"productName":{"type":"string","nullable":true,"description":"Commercial or internal product name."},"collection":{"type":"string","nullable":true,"description":"Collection the product belongs to."},"category":{"type":"string","description":"Product category. Always present."},"marketSegment":{"type":"string","nullable":true,"description":"Market segment."},"colorCode":{"type":"string","nullable":true,"description":"Colour code."},"ecoModulation":{"type":"string","nullable":true,"description":"Eco-modulation value."},"weight":{"type":"number","nullable":true,"description":"Product weight."},"producedQuantity":{"type":"number","nullable":true,"description":"Produced quantity for the product."},"gtins":{"type":"array","items":{"type":"string"},"description":"The product's GTINs (values only)."},"hasCommunicationPackage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the product's communication pack is active. Governs whether "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"children":[]}]}]}]},"createdAt":{"type":"string","format":"date-time","description":"Product creation date-time (ISO 8601)."},"links":{"$ref":"#/components/schemas/BrandProductLinks"}}}},"components/schemas/BrandProductListResponse":{"id":"components/schemas/BrandProductListResponse","kind":"json-schema","title":"BrandProductListResponse","data":{"type":"object","description":"Paginated envelope for the brand-products list.","required":["data","offset","limit","total"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BrandProductListItem"}},"offset":{"type":"integer","description":"Zero-based index of the first row returned."},"limit":{"type":"integer","description":"Maximum number of rows returned in this page."},"total":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of products matching the query — the full match count, independent of the page requested."},"children":[]}]}]}]}}}},"schema_15":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PublicApiValidationError"},{"$ref":"#/components/schemas/RegistrySupplierBusinessError"}]},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"materialId":{"type":"string","format":"uuid","description":"Identifier of the created material. UUID v4 format."}}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"object","properties":{"componentId":{"type":"string","format":"uuid","description":"Identifier of the created component. UUID v4 format."}}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"object","properties":{"packagingId":{"type":"string","format":"uuid","description":"Identifier of the created packaging. UUID v4 format."}}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"manufacturedProductId":{"type":"string","format":"uuid","description":"Identifier of the created manufactured product. UUID v4 format."}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"purchasedItemId":{"type":"string","format":"uuid","description":"Identifier of the created purchased item. UUID v4 format."}}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":20},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"string"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"string","default":"createdAt"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"default":"asc"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_29"}},"exampleStore":{"paths/~1suppliers/post/requestBody/content/application~1json/examples/minimal":{"value":{"uniqueIdentifier":"SUP-MINIMAL-001","siteAddress":{"country":"DE"}},"key":"minimal","summary":"Minimal accepted body","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only required fields. Created supplier "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"siteName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1suppliers/post/requestBody/content/application~1json/examples/minimal"},"paths/~1suppliers/post/requestBody/content/application~1json/examples/minimalIfFairlyMadeSDC":{"value":{"uniqueIdentifier":"SUP-MINIMAL-SDC-001","siteEmails":["contact@example.com"],"siteAddress":{"country":"DE"}},"key":"minimalIfFairlyMadeSDC","summary":"Minimal if Fairly Made SDC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal body when running Fairly Made supplier data collection — includes the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"siteEmails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contact."},"children":[]}]}]}],"id":"paths/~1suppliers/post/requestBody/content/application~1json/examples/minimalIfFairlyMadeSDC"},"paths/~1suppliers/post/requestBody/content/application~1json/examples/full":{"value":{"uniqueIdentifier":"SUP-PARIS-001","parentCompanyName":"Solo Holding","siteName":"Solo Paris","siteEmails":["contact@solo.paris","quality@solo.paris"],"siteAddress":{"country":"FR","city":"Paris","postalCode":"75001","street":"12 rue de Rivoli"},"siteCertifications":[{"certificationName":"ISO 9001"},{"certificationName":"SA8000"}]},"key":"full","summary":"Full supplier example","id":"paths/~1suppliers/post/requestBody/content/application~1json/examples/full"},"paths/~1suppliers/post/responses/201/content/application~1json/example":{"value":{"supplierId":"8f3e2a4b-1c5d-4e6f-9a8b-7c2d1e0f3a4b","uniqueIdentifier":"SUP-PARIS-001","parentCompanyName":"Solo Holding","siteName":"Solo Paris","siteEmails":["contact@solo.paris","quality@solo.paris"],"siteAddress":{"country":"FR","city":"Paris","postalCode":"75001","street":"12 rue de Rivoli"},"siteCertifications":[{"certificationName":"ISO 9001"},{"certificationName":"SA8000"}]},"id":"paths/~1suppliers/post/responses/201/content/application~1json/example"},"paths/~1suppliers/post/responses/400/content/application~1json/examples/validationError":{"value":{"type":"ValidationError","details":{"uniqueIdentifier":{"_errors":["Required."]}}},"key":"validationError","summary":"Schema validation (e.g. missing uniqueIdentifier, invalid email, unknown certification)","id":"paths/~1suppliers/post/responses/400/content/application~1json/examples/validationError"},"paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidCountry":{"value":{"type":"RegistrySupplier_CountryShouldBeValid","details":{"value":"XX"}},"key":"invalidCountry","summary":"Unrecognized country code","id":"paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidCountry"},"paths/~1suppliers/post/responses/400/content/application~1json/examples/emptyCity":{"value":{"type":"RegistrySupplier_SiteAddress_CityShouldNotBeEmpty","details":{}},"key":"emptyCity","summary":"siteAddress.city sent as empty string or whitespace only","id":"paths/~1suppliers/post/responses/400/content/application~1json/examples/emptyCity"},"paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidEmail":{"value":{"type":"ValidationError","details":{"siteEmails":{"0":{"_errors":["Invalid email."]}}}},"key":"invalidEmail","summary":"siteEmails contains an entry that is not a valid email","id":"paths/~1suppliers/post/responses/400/content/application~1json/examples/invalidEmail"},"paths/~1suppliers/post/responses/400/content/application~1json/examples/unknownCertification":{"value":{"type":"ValidationError","details":{"siteCertifications":{"0":{"certificationName":{"_errors":["Invalid enum value."]}}}}},"key":"unknownCertification","summary":"certificationName not in taxonomy","id":"paths/~1suppliers/post/responses/400/content/application~1json/examples/unknownCertification"},"paths/~1suppliers/post/responses/409/content/application~1json/example":{"value":{"type":"RegistrySupplier_AlreadyExists","details":{"existingSupplierId":"8f3e2a4b-1c5d-4e6f-9a8b-7c2d1e0f3a4b"}},"id":"paths/~1suppliers/post/responses/409/content/application~1json/example"},"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/ownedBySupplier":{"value":{"uniqueIdentifier":"FM-MATERIAL-COTTON-0001","ownerKind":"SUPPLIER","ownerId":"a5765369-b42c-4e6f-849b-0c3873e8deb5","rawMaterialName":"COTTON","rawMaterialAttribute":"CONVENTIONAL"},"key":"ownedBySupplier","summary":"Owned by supplier","description":"Creation of a material with a single supplier (owner). Owner is specified via ownerKind and ownerId; no processing step address.","id":"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/ownedBySupplier"},"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/withProcessingAddress":{"value":{"uniqueIdentifier":"FM-MATERIAL-COTTON-0002","address":{"country":"FR","city":"Toulouse","postalCode":"31000","street":"1 Rue de la Ferme"},"rawMaterialName":"COTTON","rawMaterialAttribute":"CONVENTIONAL","steps":[{"process":"HARVESTING"},{"process":"COMBING"}]},"key":"withProcessingAddress","summary":"With processing address","description":"Creation of a material with a processing step address. Address is specified instead of owner (ownerKind, ownerId).","id":"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/withProcessingAddress"},"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonOwnedBySupplier":{"value":{"uniqueIdentifier":"FM-MATERIAL-TSHIRT-COTTON-001","ownerKind":"SUPPLIER","ownerId":"a5765369-b42c-4e6f-849b-0c3873e8deb5","rawMaterialName":"COTTON","rawMaterialAttribute":"ORGANIC","steps":[{"process":"HARVESTING"},{"process":"PRE_TREATMENT"},{"process":"COMBING"}],"purchasedItems":[{"purchasedItemId":"94edcac0-7e1c-40d5-b58f-3ee40e7af436","usagePercentage":50},{"purchasedItemId":"9fc66ab6-4b55-46c1-97b4-b9107fa10f9e","usagePercentage":30}],"usedMaterials":[{"materialId":"e2652034-0a29-4a19-b817-a5ee9a161537","usagePercentage":20}]},"key":"tshirtCottonOwnedBySupplier","summary":"T-shirt cotton owned by supplier","description":"Cotton material for t-shirt with supplier as owner. Maximum information.","id":"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonOwnedBySupplier"},"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonWithProcessingAddress":{"value":{"uniqueIdentifier":"FM-MATERIAL-TSHIRT-COTTON-002","address":{"country":"FR","city":"Toulouse","postalCode":"31000","street":"2 Rue du Coton"},"rawMaterialName":"COTTON","rawMaterialAttribute":"ORGANIC","steps":[{"process":"HARVESTING"},{"process":"PRE_TREATMENT"},{"process":"COMBING"}],"usedMaterials":[{"materialId":"e2652034-0a29-4a19-b817-a5ee9a161537","usagePercentage":100}]},"key":"tshirtCottonWithProcessingAddress","summary":"T-shirt cotton with processing address","description":"Cotton material for t-shirt with processing step address. Maximum information.","id":"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/tshirtCottonWithProcessingAddress"},"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherOwnedBySupplier":{"value":{"uniqueIdentifier":"FM-MATERIAL-SHOE-LEATHER-001","ownerKind":"SUPPLIER","ownerId":"cefce913-c0e5-4163-9235-a0909bfba9f4","rawMaterialName":"BOVINE LEATHER","rawMaterialAttribute":"CONVENTIONAL","steps":[{"process":"BREEDING"},{"process":"LEATHER_PRESERVATION"}],"purchasedItems":[{"purchasedItemId":"3230e54b-5b4c-470a-8c7e-9b70642331d5","usagePercentage":50}],"usedMaterials":[{"materialId":"ff449b9e-2fda-445f-b747-9059a8fd0fb9","usagePercentage":50}]},"key":"shoesLeatherOwnedBySupplier","summary":"Shoes leather owned by supplier","description":"Leather material for shoes with supplier as owner. Maximum information.","id":"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherOwnedBySupplier"},"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherWithProcessingAddress":{"value":{"uniqueIdentifier":"FM-MATERIAL-SHOE-LEATHER-002","address":{"country":"FR","city":"Lyon","postalCode":"69000","street":"10 Rue du Cuir"},"rawMaterialName":"BOVINE LEATHER","rawMaterialAttribute":"CONVENTIONAL","steps":[{"process":"BREEDING"},{"process":"LEATHER_PRESERVATION"}],"usedMaterials":[{"materialId":"ff449b9e-2fda-445f-b747-9059a8fd0fb9","usagePercentage":100}]},"key":"shoesLeatherWithProcessingAddress","summary":"Shoes leather with processing address","description":"Leather material for shoes with processing step address. Maximum information.","id":"paths/~1manufactured-materials/post/requestBody/content/application~1json/examples/shoesLeatherWithProcessingAddress"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/missingUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"uniqueIdentifier","reason":"Required field missing."}]},"key":"missingUniqueIdentifier","summary":"Missing uniqueIdentifier","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/missingUniqueIdentifier"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Invalid length.","details":[{"field":"uniqueIdentifier","reason":"Must be between 15 and 255 characters."}]},"key":"invalidLengthUniqueIdentifier","summary":"uniqueIdentifier length &lt; 15 or &gt; 255","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialName":{"value":{"code":"VALIDATION_ERROR","message":"Invalid raw material name.","details":[{"field":"rawMaterialName","reason":"Not in raw material name taxonomy."}]},"key":"invalidRawMaterialName","summary":"rawMaterialName not in taxonomy","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialName"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialAttribute":{"value":{"code":"VALIDATION_ERROR","message":"Invalid raw material attribute.","details":[{"field":"rawMaterialAttribute","reason":"Not in raw material attribute taxonomy."}]},"key":"invalidRawMaterialAttribute","summary":"rawMaterialAttribute not in taxonomy","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialAttribute"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialNameAttributeCombination":{"value":{"code":"VALIDATION_ERROR","message":"Raw material name and attribute combination does not match.","details":[{"field":"rawMaterialName","reason":"The attribute is not valid for this raw material name; use an official material–attribute pair from the taxonomy."}]},"key":"invalidRawMaterialNameAttributeCombination","summary":"rawMaterialName and rawMaterialAttribute pair not allowed","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidRawMaterialNameAttributeCombination"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress":{"value":{"code":"VALIDATION_ERROR","message":"Either owner (ownerKind, ownerId) or address must be provided.","details":[]},"key":"neitherOwnerNorAddress","summary":"Neither owner nor address provided","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/bothOwnerAndAddress":{"value":{"code":"VALIDATION_ERROR","message":"Provide either owner or address, not both.","details":[]},"key":"bothOwnerAndAddress","summary":"Both owner and address provided","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/bothOwnerAndAddress"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidOwnerKind":{"value":{"code":"VALIDATION_ERROR","message":"Invalid ownerKind.","details":[{"field":"ownerKind","reason":"Must be SUPPLIER."}]},"key":"invalidOwnerKind","summary":"ownerKind not SUPPLIER","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidOwnerKind"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidAddressCountry":{"value":{"code":"VALIDATION_ERROR","message":"Invalid country code.","details":[{"field":"address.country","reason":"Must be a two-letter ISO country code from the taxonomy."}]},"key":"invalidAddressCountry","summary":"address.country missing or not in enum","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidAddressCountry"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidStepProcess":{"value":{"code":"VALIDATION_ERROR","message":"Invalid step process.","details":[{"field":"steps[0].process","reason":"Not in MaterialStep taxonomy."}]},"key":"invalidStepProcess","summary":"process not in taxonomy (steps)","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidStepProcess"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress":{"value":{"code":"VALIDATION_ERROR","message":"purchasedItems only applicable when the entity is linked with an owner (ownerKind, ownerId); not used when providing a processing step address.","details":[{"field":"purchasedItems","reason":"purchasedItems only applicable when the entity is linked with an owner; not used when providing a processing step address."}]},"key":"purchasedItemsNotAllowedWithAddress","summary":"purchasedItems provided with address (not owner)","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUuid":{"value":{"code":"VALIDATION_ERROR","message":"Invalid UUID.","details":[{"field":"ownerId","reason":"Must be a valid UUID."}]},"key":"invalidUuid","summary":"Any UUID field invalid (e.g. ownerId, purchasedItemId, materialId)","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUuid"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUsagePercentage":{"value":{"code":"VALIDATION_ERROR","message":"Invalid usagePercentage.","details":[{"field":"purchasedItems[0].usagePercentage","reason":"Invalid usagePercentage."}]},"key":"invalidUsagePercentage","summary":"Any usagePercentage invalid (e.g. in purchasedItems, usedMaterials)","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/invalidUsagePercentage"},"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100":{"value":{"code":"VALIDATION_ERROR","message":"Sum of purchased items and used items usagePercentage must equal 100.","details":[{"field":"purchasedItems","reason":"Sum of purchased items and used items usagePercentage must equal 100."}]},"key":"sumPurchasedAndUsedItemsUsagePercentageNot100","summary":"Sum of purchased items and used items usagePercentage ≠ 100","id":"paths/~1manufactured-materials/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"},"paths/~1manufactured-materials/post/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1manufactured-materials/post/responses/401/content/application~1json/example"},"paths/~1manufactured-materials/post/responses/403/content/application~1json/example":{"value":{"code":"FORBIDDEN","message":"Forbidden."},"id":"paths/~1manufactured-materials/post/responses/403/content/application~1json/example"},"paths/~1manufactured-materials/post/responses/409/content/application~1json/example":{"value":{"code":"CONFLICT","message":"Material with this uniqueIdentifier already exists.","details":[{"field":"uniqueIdentifier","reason":"Already in use.","materialId":"00000000-0000-4000-8000-000000000002"}]},"id":"paths/~1manufactured-materials/post/responses/409/content/application~1json/example"},"paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/ownerIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced supplier not found.","details":[{"field":"ownerId","reason":"Supplier does not exist."}]},"key":"ownerIdNotFound","summary":"Referenced supplier (ownerId) not found","id":"paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/ownerIdNotFound"},"paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/materialIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced material not found.","details":[{"field":"usedMaterials[0].materialId","reason":"Material does not exist."}]},"key":"materialIdNotFound","summary":"Referenced material (usedMaterials) not found","id":"paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/materialIdNotFound"},"paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced purchased item not found.","details":[{"field":"purchasedItems[0].purchasedItemId","reason":"Purchased item does not exist."}]},"key":"purchasedItemIdNotFound","summary":"Referenced purchasedItemId not found","id":"paths/~1manufactured-materials/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"},"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/ownedBySupplier":{"value":{"uniqueIdentifier":"FM-COMPONENT-FABRIC-0001","reference":"FAB-001","ownerKind":"SUPPLIER","ownerId":"5d1bb854-6193-465c-a3b1-69f9e34d8d91","category":"MAIN FABRIC (WOVEN)","compositions":[{"compositionRawMaterial":"COTTON","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":100}]},"key":"ownedBySupplier","summary":"Owned by supplier","description":"Creation of a component with a supplier as owner. Owner is specified via ownerKind and ownerId; no processing step address.","id":"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/ownedBySupplier"},"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/withProcessingAddress":{"value":{"uniqueIdentifier":"FM-COMPONENT-FABRIC-0002","address":{"country":"FR","city":"Paris","postalCode":"75000","street":"10 Rue des Composants"},"category":"MAIN FABRIC (WOVEN)","compositions":[{"compositionRawMaterial":"COTTON","compositionRawAttribute":"RECYCLED","compositionPercentage":80,"compositionOrigin":"FR","compositionCertifications":["GRS"]},{"compositionRawMaterial":"POLYESTER","compositionRawAttribute":"RECYCLED","compositionPercentage":20,"compositionOrigin":"DE"}],"steps":[{"process":"PRINTING"}]},"key":"withProcessingAddress","summary":"With processing address","description":"Creation of a component with a processing step address. Address is specified instead of owner (ownerKind, ownerId).","id":"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/withProcessingAddress"},"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricOwnedBySupplier":{"value":{"uniqueIdentifier":"FM-COMPONENT-TSHIRT-FABRIC-001","reference":"TSHIRT-MAIN-FABRIC-001","ownerKind":"SUPPLIER","ownerId":"5d1bb854-6193-465c-a3b1-69f9e34d8d91","category":"MAIN FABRIC (WOVEN)","compositions":[{"compositionRawMaterial":"COTTON","compositionRawAttribute":"ORGANIC","compositionPercentage":85,"compositionOrigin":"FR","compositionCertifications":["GOTS","OCS"]},{"compositionRawMaterial":"ELASTANE","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":15,"compositionOrigin":"DE"}],"steps":[{"process":"WEAVING"},{"process":"DYEING"},{"process":"PRINTING"}],"purchasedItems":[{"purchasedItemId":"a9b4612c-4e15-491a-b0d9-93af9b057408","usageCategory":"MAIN FABRIC (WOVEN)","usagePercentage":40},{"purchasedItemId":"7d60add2-944a-48a6-80b6-b755b01b2f54","usageCategory":"LABELLINGS","usagePercentage":35}],"usedComponents":[{"componentId":"8d55cf34-4ab6-47fa-97ef-b180cd28a9ca","usageCategory":"MAIN FABRIC (WOVEN)","usagePercentage":20}],"usedMaterials":[{"materialId":"52660252-ef6b-43d9-8521-7c77733b9e27","usagePercentage":5}]},"key":"tshirtFabricOwnedBySupplier","summary":"T-shirt fabric component owned by supplier","description":"Main fabric component for t-shirt with supplier as owner. Maximum information.","id":"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricOwnedBySupplier"},"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricWithProcessingAddress":{"value":{"uniqueIdentifier":"FM-COMPONENT-TSHIRT-FABRIC-002","address":{"country":"FR","city":"Paris","postalCode":"75000","street":"5 Avenue des Tissus"},"category":"MAIN FABRIC (WOVEN)","compositions":[{"compositionRawMaterial":"COTTON","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":85,"compositionOrigin":"FR"},{"compositionRawMaterial":"ELASTANE","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":15,"compositionOrigin":"DE"}],"steps":[{"process":"WEAVING"},{"process":"DYEING"},{"process":"PRINTING"}],"usedComponents":[{"componentId":"8d55cf34-4ab6-47fa-97ef-b180cd28a9ca","usageCategory":"MAIN FABRIC (WOVEN)","usagePercentage":100}]},"key":"tshirtFabricWithProcessingAddress","summary":"T-shirt fabric component with processing address","description":"Main fabric component for t-shirt with processing step address. Maximum information.","id":"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/tshirtFabricWithProcessingAddress"},"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperOwnedBySupplier":{"value":{"uniqueIdentifier":"FM-COMPONENT-SHOE-UPPER-001","reference":"SHOE-UPPER-LEATHER-01","ownerKind":"SUPPLIER","ownerId":"cefce913-c0e5-4163-9235-a0909bfba9f4","category":"UPPERS","compositions":[{"compositionRawMaterial":"BOVINE LEATHER","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":70,"compositionOrigin":"IT"},{"compositionRawMaterial":"COTTON","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":30,"compositionOrigin":"PT"}],"steps":[{"process":"CUTTING"},{"process":"LEATHER_FINISHING"},{"process":"STITCHING"}],"purchasedItems":[{"purchasedItemId":"c3c46c6b-e3ad-4246-9d4b-ac9aa3970001","usageCategory":"LEATHER PIECE","usagePercentage":35},{"purchasedItemId":"0e655912-bf89-4299-ba56-7614675ddd42","usageCategory":"LININGS","usagePercentage":25}],"usedComponents":[{"componentId":"fb2eabd2-e8dc-4fd4-b75a-964b33a13df9","usageCategory":"UPPERS","usagePercentage":30}],"usedMaterials":[{"materialId":"e282cd3e-1807-4e60-8128-bc7cfe36c21c","usagePercentage":10}]},"key":"shoesUpperOwnedBySupplier","summary":"Shoes upper component owned by supplier","description":"Upper/leather component for shoes with supplier as owner. Maximum information.","id":"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperOwnedBySupplier"},"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperWithProcessingAddress":{"value":{"uniqueIdentifier":"FM-COMPONENT-SHOE-UPPER-002","address":{"country":"IT","city":"Milan","postalCode":"20100","street":"15 Via del Cuoio"},"category":"UPPERS","compositions":[{"compositionRawMaterial":"BOVINE LEATHER","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":70,"compositionOrigin":"IT"},{"compositionRawMaterial":"COTTON","compositionRawAttribute":"CONVENTIONAL","compositionPercentage":30,"compositionOrigin":"PT"}],"steps":[{"process":"CUTTING"},{"process":"LEATHER_FINISHING"},{"process":"STITCHING"}],"usedComponents":[{"componentId":"fb2eabd2-e8dc-4fd4-b75a-964b33a13df9","usageCategory":"UPPERS","usagePercentage":100}]},"key":"shoesUpperWithProcessingAddress","summary":"Shoes upper component with processing address","description":"Upper/leather component for shoes with processing step address. Maximum information.","id":"paths/~1manufactured-components/post/requestBody/content/application~1json/examples/shoesUpperWithProcessingAddress"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"uniqueIdentifier","reason":"Required field missing."}]},"key":"missingUniqueIdentifier","summary":"Missing uniqueIdentifier","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingUniqueIdentifier"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositions":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"compositions","reason":"Required field missing."}]},"key":"missingCompositions","summary":"Missing compositions","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositions"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCategory":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"category","reason":"Required field missing."}]},"key":"missingCategory","summary":"Missing category","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCategory"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositionRawAttribute":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"compositions[0].compositionRawAttribute","reason":"Required field missing."}]},"key":"missingCompositionRawAttribute","summary":"Missing compositionRawAttribute","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/missingCompositionRawAttribute"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Invalid length.","details":[{"field":"uniqueIdentifier","reason":"Must be between 15 and 255 characters."}]},"key":"invalidLengthUniqueIdentifier","summary":"uniqueIdentifier length &lt; 15 or &gt; 255","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress":{"value":{"code":"VALIDATION_ERROR","message":"Either owner (ownerKind, ownerId) or address must be provided.","details":[]},"key":"neitherOwnerNorAddress","summary":"Neither owner nor address provided","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/bothOwnerAndAddress":{"value":{"code":"VALIDATION_ERROR","message":"Provide either owner or address, not both.","details":[]},"key":"bothOwnerAndAddress","summary":"Both owner and address provided","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/bothOwnerAndAddress"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidOwnerKind":{"value":{"code":"VALIDATION_ERROR","message":"Invalid ownerKind.","details":[{"field":"ownerKind","reason":"Must be SUPPLIER."}]},"key":"invalidOwnerKind","summary":"ownerKind not SUPPLIER","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidOwnerKind"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUuid":{"value":{"code":"VALIDATION_ERROR","message":"Invalid UUID.","details":[{"field":"ownerId","reason":"Must be a valid UUID."}]},"key":"invalidUuid","summary":"Any UUID field invalid (e.g. ownerId, purchasedItemId, componentId)","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUuid"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsagePercentage":{"value":{"code":"VALIDATION_ERROR","message":"Invalid usagePercentage.","details":[{"field":"purchasedItems[0].usagePercentage","reason":"Invalid usagePercentage."}]},"key":"invalidUsagePercentage","summary":"Any usagePercentage invalid (e.g. in purchasedItems, usedComponents, usedMaterials)","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsagePercentage"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent":{"value":{"code":"VALIDATION_ERROR","message":"usageCategory is mandatory when the purchased item is a component.","details":[{"field":"purchasedItems[0].usageCategory","reason":"usageCategory is mandatory when the purchased item is a component."}]},"key":"usageCategoryRequiredWhenPurchasedItemIsComponent","summary":"usageCategory mandatory when purchased item is a component","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsageCategory":{"value":{"code":"VALIDATION_ERROR","message":"Invalid usageCategory.","details":[{"field":"purchasedItems[0].usageCategory","reason":"Not in usageCategory taxonomy."}]},"key":"invalidUsageCategory","summary":"usageCategory not in taxonomy","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidUsageCategory"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress":{"value":{"code":"VALIDATION_ERROR","message":"purchasedItems only applicable when the entity is linked with an owner (ownerKind, ownerId); not used when providing a processing step address.","details":[{"field":"purchasedItems","reason":"purchasedItems only applicable when the entity is linked with an owner; not used when providing a processing step address."}]},"key":"purchasedItemsNotAllowedWithAddress","summary":"purchasedItems provided with address (not owner)","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidAddressCountry":{"value":{"code":"VALIDATION_ERROR","message":"Invalid country code.","details":[{"field":"address.country","reason":"Must be a two-letter ISO country code from the taxonomy."}]},"key":"invalidAddressCountry","summary":"address.country missing or not in enum","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidAddressCountry"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialName":{"value":{"code":"VALIDATION_ERROR","message":"Invalid raw material name.","details":[{"field":"compositions[0].compositionRawMaterial","reason":"Not in raw material name taxonomy."}]},"key":"invalidCompositionRawMaterialName","summary":"compositionRawMaterial not in taxonomy","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialName"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialAttribute":{"value":{"code":"VALIDATION_ERROR","message":"Invalid raw material attribute.","details":[{"field":"compositions[0].compositionRawAttribute","reason":"Not in raw material attribute taxonomy."}]},"key":"invalidCompositionRawMaterialAttribute","summary":"compositionRawAttribute not in taxonomy","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialAttribute"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialNameAttributeCombination":{"value":{"code":"VALIDATION_ERROR","message":"Raw material name and attribute combination does not match.","details":[{"field":"compositions[0]","reason":"The attribute is not valid for this raw material name; use an official material–attribute pair from the taxonomy."}]},"key":"invalidCompositionRawMaterialNameAttributeCombination","summary":"compositionRawMaterial and compositionRawAttribute pair not allowed","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidCompositionRawMaterialNameAttributeCombination"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidComposition":{"value":{"code":"VALIDATION_ERROR","message":"Invalid composition.","details":[{"field":"compositions[0].compositionPercentage","reason":"Must be between 0 and 100; sum must equal 100."}]},"key":"invalidComposition","summary":"Invalid composition (percentage, origin, or other composition rules)","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidComposition"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/compositionPercentageSumNot100":{"value":{"code":"VALIDATION_ERROR","message":"Sum of compositionPercentage must equal 100.","details":[{"field":"compositions","reason":"Sum of compositionPercentage must equal 100."}]},"key":"compositionPercentageSumNot100","summary":"Sum of compositionPercentage ≠ 100","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/compositionPercentageSumNot100"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidStepProcess":{"value":{"code":"VALIDATION_ERROR","message":"Invalid step process.","details":[{"field":"steps[0].process","reason":"Not in ComponentStep taxonomy."}]},"key":"invalidStepProcess","summary":"process not in taxonomy (steps)","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/invalidStepProcess"},"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100":{"value":{"code":"VALIDATION_ERROR","message":"Sum of purchased items and used items usagePercentage must equal 100.","details":[{"field":"purchasedItems","reason":"Sum of purchased items and used items usagePercentage must equal 100."}]},"key":"sumPurchasedAndUsedItemsUsagePercentageNot100","summary":"Sum of purchased items and used items usagePercentage ≠ 100","id":"paths/~1manufactured-components/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"},"paths/~1manufactured-components/post/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1manufactured-components/post/responses/401/content/application~1json/example"},"paths/~1manufactured-components/post/responses/403/content/application~1json/example":{"value":{"code":"FORBIDDEN","message":"Forbidden."},"id":"paths/~1manufactured-components/post/responses/403/content/application~1json/example"},"paths/~1manufactured-components/post/responses/409/content/application~1json/example":{"value":{"code":"CONFLICT","message":"Component with this uniqueIdentifier already exists.","details":[{"field":"uniqueIdentifier","reason":"Already in use.","componentId":"00000000-0000-4000-8000-000000000003"}]},"id":"paths/~1manufactured-components/post/responses/409/content/application~1json/example"},"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/ownerIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced supplier not found.","details":[{"field":"ownerId","reason":"Supplier does not exist."}]},"key":"ownerIdNotFound","summary":"Referenced supplier (ownerId) not found","id":"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/ownerIdNotFound"},"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced purchased item not found.","details":[{"field":"purchasedItems[0].purchasedItemId","reason":"Purchased item does not exist."}]},"key":"purchasedItemIdNotFound","summary":"Referenced purchasedItemId not found","id":"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"},"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/componentIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced component not found.","details":[{"field":"usedComponents[0].componentId","reason":"Component does not exist."}]},"key":"componentIdNotFound","summary":"Referenced componentId (usedComponents) not found","id":"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/componentIdNotFound"},"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/materialIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced material not found.","details":[{"field":"usedMaterials[0].materialId","reason":"Material does not exist."}]},"key":"materialIdNotFound","summary":"Referenced materialId (usedMaterials) not found","id":"paths/~1manufactured-components/post/responses/422/content/application~1json/examples/materialIdNotFound"},"paths/~1packagings/post/requestBody/content/application~1json/examples/minimal":{"value":{"uniqueIdentifier":"FM-PACK-POLYBAG-001","channel":"E-COMMERCE","compostability":"N/A","ecoModulation":"NONE","hazardousSubstances":{"status":"NO"},"percentageRecycled":0,"possibilityReUse":"NO - 0","recyclability":"YES - FULLY RECYCLING","type":"POLYBAG"},"key":"minimal","summary":"Minimal packaging example","id":"paths/~1packagings/post/requestBody/content/application~1json/examples/minimal"},"paths/~1packagings/post/requestBody/content/application~1json/examples/shoeBox":{"value":{"uniqueIdentifier":"FM-PACK-SHOE-BOX-01","channel":"BOTH","compostability":"NO - 0","ecoModulation":"NONE","hazardousSubstances":{"status":"NO"},"percentageRecycled":80,"possibilityReUse":"N/A","recyclability":"YES - FULLY RECYCLING + RECYCLABLE IN THE SAME TYPE OF PACKAGING","type":"SHOE BOX"},"key":"shoeBox","summary":"Shoe box packaging example","id":"paths/~1packagings/post/requestBody/content/application~1json/examples/shoeBox"},"paths/~1packagings/post/responses/400/content/application~1json/examples/missingUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"uniqueIdentifier","reason":"Required field missing."}]},"key":"missingUniqueIdentifier","summary":"Missing uniqueIdentifier","id":"paths/~1packagings/post/responses/400/content/application~1json/examples/missingUniqueIdentifier"},"paths/~1packagings/post/responses/400/content/application~1json/examples/missingRequiredField":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"channel","reason":"Required field missing."}]},"key":"missingRequiredField","summary":"Missing channel, type or other required field","id":"paths/~1packagings/post/responses/400/content/application~1json/examples/missingRequiredField"},"paths/~1packagings/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Invalid length.","details":[{"field":"uniqueIdentifier","reason":"Must be between 1 and 70 characters."}]},"key":"invalidLengthUniqueIdentifier","summary":"uniqueIdentifier length &lt; 1 or &gt; 70","id":"paths/~1packagings/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"},"paths/~1packagings/post/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1packagings/post/responses/401/content/application~1json/example"},"paths/~1packagings/post/responses/403/content/application~1json/example":{"value":{"code":"FORBIDDEN","message":"Forbidden."},"id":"paths/~1packagings/post/responses/403/content/application~1json/example"},"paths/~1packagings/post/responses/409/content/application~1json/example":{"value":{"code":"CONFLICT","message":"Packaging with this uniqueIdentifier already exists.","details":[{"field":"uniqueIdentifier","reason":"Already in use.","packagingId":"00000000-0000-4000-8000-000000000004"}]},"id":"paths/~1packagings/post/responses/409/content/application~1json/example"},"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/ownedBySupplier":{"value":{"uniqueIdentifier":"FM-PRODUCT-SHIRT-0001","ownerKind":"SUPPLIER","ownerId":"f0b5fb65-f065-432e-9e96-c52692931626","category":"SHIRTS"},"key":"ownedBySupplier","summary":"Owned by supplier","description":"Creation of a product with a supplier as owner. Owner is specified via ownerKind and ownerId; no processing step address.","id":"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/ownedBySupplier"},"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/withProcessingAddress":{"value":{"uniqueIdentifier":"FM-PRODUCT-SHIRT-0002","address":{"country":"FR","city":"Paris","postalCode":"75000","street":"5 Avenue des Produits"},"category":"SHIRTS","steps":[{"process":"ASSEMBLY"}]},"key":"withProcessingAddress","summary":"With processing address","description":"Creation of a product with a processing step address. Address is specified instead of owner (ownerKind, ownerId).","id":"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/withProcessingAddress"},"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/fromManufacturedProductOnly":{"value":{"uniqueIdentifier":"FM-PRODUCT-KIT-ASSEMBLY-0001","ownerKind":"SUPPLIER","ownerId":"f0b5fb65-f065-432e-9e96-c52692931626","category":"TSHIRTS","usedProducts":[{"productId":"b2f58d32-5b61-4ba7-ba85-014af28c8a0b","usagePercentage":100}]},"key":"fromManufacturedProductOnly","summary":"Product built only from another manufactured product","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the new product is entirely sourced from an existing manufactured product in your inventory, reference it in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The combined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usagePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchasedItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedComponents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must equal 100."},"children":[]}]}]}],"id":"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/fromManufacturedProductOnly"},"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtOwnedBySupplier":{"value":{"uniqueIdentifier":"FM-PRODUCT-TSHIRT-COTTON-001","ownerKind":"SUPPLIER","ownerId":"f0b5fb65-f065-432e-9e96-c52692931626","category":"TSHIRTS","steps":[{"process":"STITCHING"},{"process":"DYEING"},{"process":"QUALITY_CHECK"}],"purchasedItems":[{"purchasedItemId":"56c3dc3c-7ab4-4c92-a9dc-4f1bf4e672ce","usageCategory":"MAIN FABRIC (WOVEN)","usagePercentage":52},{"purchasedItemId":"b212c126-8832-4c53-944a-dde86caebbd6","usageCategory":"LABELLINGS","usagePercentage":13}],"usedComponents":[{"componentId":"5155efc1-f501-4ffd-b106-816734c16413","usageCategory":"MAIN FABRIC (WOVEN)","usagePercentage":25}],"usedProducts":[{"productId":"b2f58d32-5b61-4ba7-ba85-014af28c8a0b","usagePercentage":10}]},"key":"tshirtOwnedBySupplier","summary":"T-shirt owned by supplier","description":"Full example of a cotton t-shirt product with a supplier as owner. Maximum information.","id":"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtOwnedBySupplier"},"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtWithProcessingAddress":{"value":{"uniqueIdentifier":"FM-PRODUCT-TSHIRT-COTTON-002","address":{"country":"FR","city":"Paris","postalCode":"75000","street":"5 Avenue des T-shirts"},"category":"TSHIRTS","steps":[{"process":"STITCHING"},{"process":"DYEING"},{"process":"QUALITY_CHECK"}],"usedComponents":[{"componentId":"5155efc1-f501-4ffd-b106-816734c16413","usageCategory":"MAIN FABRIC (WOVEN)","usagePercentage":75}],"usedProducts":[{"productId":"b2f58d32-5b61-4ba7-ba85-014af28c8a0b","usagePercentage":25}]},"key":"tshirtWithProcessingAddress","summary":"T-shirt with processing address","description":"Full example of a cotton t-shirt product with a processing step address. Maximum information.","id":"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/tshirtWithProcessingAddress"},"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesOwnedBySupplier":{"value":{"uniqueIdentifier":"FM-PRODUCT-SNEAKER-LEATHER-001","ownerKind":"SUPPLIER","ownerId":"cefce913-c0e5-4163-9235-a0909bfba9f4","category":"SNEAKERS","steps":[{"process":"LASTING"},{"process":"ASSEMBLY"},{"process":"FINISHING"}],"purchasedItems":[{"purchasedItemId":"d5251c86-5f04-4552-899d-ac62982725c9","usageCategory":"LEATHER PIECE","usagePercentage":32},{"purchasedItemId":"2ce539e7-34bb-4a77-ad6c-09b80638331c","usageCategory":"OUTSOLES","usagePercentage":23}],"usedComponents":[{"componentId":"0a1db4a2-cb83-47a6-b47c-29fcf61a258b","usageCategory":"HEELS","usagePercentage":18},{"componentId":"86bbf2d1-7fd2-4886-a8df-3c10ec671391","usageCategory":"OUTSOLES","usagePercentage":12}],"usedProducts":[{"productId":"b2f58d32-5b61-4ba7-ba85-014af28c8a0b","usagePercentage":15}]},"key":"shoesOwnedBySupplier","summary":"Shoes owned by supplier","description":"Full example of a shoe product with a supplier as owner. Maximum information.","id":"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesOwnedBySupplier"},"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesWithProcessingAddress":{"value":{"uniqueIdentifier":"FM-PRODUCT-SNEAKER-LEATHER-002","address":{"country":"FR","city":"Lyon","postalCode":"69000","street":"10 Rue des Chaussures"},"category":"SNEAKERS","steps":[{"process":"LASTING"},{"process":"ASSEMBLY"},{"process":"FINISHING"}],"usedComponents":[{"componentId":"0a1db4a2-cb83-47a6-b47c-29fcf61a258b","usageCategory":"HEELS","usagePercentage":65}],"usedProducts":[{"productId":"b2f58d32-5b61-4ba7-ba85-014af28c8a0b","usagePercentage":35}]},"key":"shoesWithProcessingAddress","summary":"Shoes with processing address","description":"Full example of a shoe product with a processing step address. Maximum information.","id":"paths/~1manufactured-products/post/requestBody/content/application~1json/examples/shoesWithProcessingAddress"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"uniqueIdentifier","reason":"Required field missing."}]},"key":"missingUniqueIdentifier","summary":"Missing uniqueIdentifier","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingUniqueIdentifier"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingCategory":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"category","reason":"Required field missing."}]},"key":"missingCategory","summary":"Missing category","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/missingCategory"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Invalid length.","details":[{"field":"uniqueIdentifier","reason":"Must be between 15 and 255 characters."}]},"key":"invalidLengthUniqueIdentifier","summary":"uniqueIdentifier length &lt; 15 or &gt; 255","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress":{"value":{"code":"VALIDATION_ERROR","message":"Either owner (ownerKind, ownerId) or address must be provided.","details":[]},"key":"neitherOwnerNorAddress","summary":"Neither owner nor address provided","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/neitherOwnerNorAddress"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/bothOwnerAndAddress":{"value":{"code":"VALIDATION_ERROR","message":"Provide either owner or address, not both.","details":[]},"key":"bothOwnerAndAddress","summary":"Both owner and address provided","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/bothOwnerAndAddress"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidOwnerKind":{"value":{"code":"VALIDATION_ERROR","message":"Invalid ownerKind.","details":[{"field":"ownerKind","reason":"Must be SUPPLIER."}]},"key":"invalidOwnerKind","summary":"ownerKind not SUPPLIER","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidOwnerKind"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUuid":{"value":{"code":"VALIDATION_ERROR","message":"Invalid UUID.","details":[{"field":"ownerId","reason":"Must be a valid UUID."}]},"key":"invalidUuid","summary":"Any UUID field invalid (e.g. ownerId, purchasedItemId, componentId, productId)","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUuid"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsagePercentage":{"value":{"code":"VALIDATION_ERROR","message":"Invalid usagePercentage.","details":[{"field":"purchasedItems[0].usagePercentage","reason":"Invalid usagePercentage."}]},"key":"invalidUsagePercentage","summary":"Any usagePercentage invalid (e.g. in purchasedItems, usedComponents, usedProducts)","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsagePercentage"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent":{"value":{"code":"VALIDATION_ERROR","message":"usageCategory is mandatory when the purchased item is a component.","details":[{"field":"purchasedItems[0].usageCategory","reason":"usageCategory is mandatory when the purchased item is a component."}]},"key":"usageCategoryRequiredWhenPurchasedItemIsComponent","summary":"usageCategory mandatory when purchased item is a component","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/usageCategoryRequiredWhenPurchasedItemIsComponent"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsageCategory":{"value":{"code":"VALIDATION_ERROR","message":"Invalid usageCategory.","details":[{"field":"usedComponents[0].usageCategory","reason":"Not in usageCategory taxonomy."}]},"key":"invalidUsageCategory","summary":"usageCategory not in taxonomy (purchasedItems or usedComponents only; not usedProducts)","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidUsageCategory"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress":{"value":{"code":"VALIDATION_ERROR","message":"purchasedItems only applicable when the entity is linked with an owner (ownerKind, ownerId); not used when providing a processing step address.","details":[{"field":"purchasedItems","reason":"purchasedItems only applicable when the entity is linked with an owner; not used when providing a processing step address."}]},"key":"purchasedItemsNotAllowedWithAddress","summary":"purchasedItems provided with address (not owner)","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/purchasedItemsNotAllowedWithAddress"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidAddressCountry":{"value":{"code":"VALIDATION_ERROR","message":"Invalid country code.","details":[{"field":"address.country","reason":"Must be a two-letter ISO country code from the taxonomy."}]},"key":"invalidAddressCountry","summary":"address.country missing or not in enum","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidAddressCountry"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidCategory":{"value":{"code":"VALIDATION_ERROR","message":"Invalid category.","details":[{"field":"category","reason":"Not in product category taxonomy."}]},"key":"invalidCategory","summary":"category not in taxonomy","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidCategory"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidStepProcess":{"value":{"code":"VALIDATION_ERROR","message":"Invalid step process.","details":[{"field":"steps[0].process","reason":"Not in ProductStep taxonomy."}]},"key":"invalidStepProcess","summary":"process not in taxonomy (steps)","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/invalidStepProcess"},"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100":{"value":{"code":"VALIDATION_ERROR","message":"Sum of purchased items and used items usagePercentage must equal 100.","details":[{"field":"purchasedItems","reason":"Sum of purchased items and used items usagePercentage must equal 100."}]},"key":"sumPurchasedAndUsedItemsUsagePercentageNot100","summary":"Sum of purchased items and used items usagePercentage ≠ 100","id":"paths/~1manufactured-products/post/responses/400/content/application~1json/examples/sumPurchasedAndUsedItemsUsagePercentageNot100"},"paths/~1manufactured-products/post/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1manufactured-products/post/responses/401/content/application~1json/example"},"paths/~1manufactured-products/post/responses/403/content/application~1json/example":{"value":{"code":"FORBIDDEN","message":"Forbidden."},"id":"paths/~1manufactured-products/post/responses/403/content/application~1json/example"},"paths/~1manufactured-products/post/responses/409/content/application~1json/example":{"value":{"code":"CONFLICT","message":"Manufactured product with this uniqueIdentifier already exists.","details":[{"field":"uniqueIdentifier","reason":"Already in use.","manufacturedProductId":"00000000-0000-4000-8000-000000000005"}]},"id":"paths/~1manufactured-products/post/responses/409/content/application~1json/example"},"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/ownerIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced supplier not found.","details":[{"field":"ownerId","reason":"Supplier does not exist."}]},"key":"ownerIdNotFound","summary":"Referenced supplier (ownerId) not found","id":"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/ownerIdNotFound"},"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced purchased item not found.","details":[{"field":"purchasedItems[0].purchasedItemId","reason":"Purchased item does not exist."}]},"key":"purchasedItemIdNotFound","summary":"Referenced purchasedItemId not found","id":"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"},"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/componentIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced component not found.","details":[{"field":"usedComponents[0].componentId","reason":"Component does not exist."}]},"key":"componentIdNotFound","summary":"Referenced componentId (usedComponents) not found","id":"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/componentIdNotFound"},"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/productIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced product not found.","details":[{"field":"usedProducts[0].productId","reason":"Product does not exist."}]},"key":"productIdNotFound","summary":"Referenced productId (usedProducts) not found","id":"paths/~1manufactured-products/post/responses/422/content/application~1json/examples/productIdNotFound"},"paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingId":{"value":{"uniqueIdentifier":"FM-PURCHASED-ITEM-MAT-0001","buyerKind":"CUSTOMER","buyerId":"f0b5fb65-f065-432e-9e96-c52692931626","sellerId":"a5765369-b42c-4e6f-849b-0c3873e8deb5","purchaseOrder":"PO-2026-01","itemId":"364c5ece-7f42-418b-baa7-9a272dd044ef"},"key":"minimalUsingId","summary":"Minimal purchased item example using id","id":"paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingId"},"paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingUniqueIdentifier":{"value":{"uniqueIdentifier":"FM-PURCHASED-ITEM-MAT-0002","buyerKind":"SUPPLIER","buyerUniqueIdentifier":"SUP-BUYER-001","sellerUniqueIdentifier":"SUP-SELLER-001","purchaseOrder":"PO-2026-01","itemUniqueIdentifier":"MAT-INPUT-001"},"key":"minimalUsingUniqueIdentifier","summary":"Minimal using uniqueIdentifier","id":"paths/~1purchased-items/post/requestBody/content/application~1json/examples/minimalUsingUniqueIdentifier"},"paths/~1purchased-items/post/requestBody/content/application~1json/examples/full":{"value":{"uniqueIdentifier":"FM-PURCHASED-ITEM-MAT-0001","buyerKind":"CUSTOMER","buyerId":"f0b5fb65-f065-432e-9e96-c52692931626","sellerId":"a5765369-b42c-4e6f-849b-0c3873e8deb5","purchaseOrder":"PO-2026-01","purchaseOrderDate":"2026-01-15","transports":[{"name":"TRUCK","usagePercentage":70},{"name":"BOAT","usagePercentage":30}],"purchasedQuantity":{"value":1000,"unit":"KILOGRAMS"},"certifications":[{"certificationName":"CARBON NEUTRAL"}],"itemId":"364c5ece-7f42-418b-baa7-9a272dd044ef"},"key":"full","summary":"Full purchased item example","id":"paths/~1purchased-items/post/requestBody/content/application~1json/examples/full"},"paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingRequiredField":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"purchaseOrder","reason":"Required field missing."}]},"key":"missingRequiredField","summary":"Missing uniqueIdentifier, buyerKind, buyer or seller reference, itemId or purchaseOrder","id":"paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingRequiredField"},"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidBuyerKind":{"value":{"code":"VALIDATION_ERROR","message":"Invalid buyerKind.","details":[{"field":"buyerKind","reason":"Must be CUSTOMER or SUPPLIER."}]},"key":"invalidBuyerKind","summary":"buyerKind not in enum (CUSTOMER, SUPPLIER)","id":"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidBuyerKind"},"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUuid":{"value":{"code":"VALIDATION_ERROR","message":"Invalid UUID.","details":[{"field":"sellerId","reason":"Must be a valid UUID."}]},"key":"invalidUuid","summary":"Any UUID field invalid (e.g. buyerId, sellerId, itemId)","id":"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUuid"},"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUsagePercentage":{"value":{"code":"VALIDATION_ERROR","message":"Invalid usagePercentage.","details":[{"field":"transports[0].usagePercentage","reason":"Invalid usagePercentage."}]},"key":"invalidUsagePercentage","summary":"Any usagePercentage invalid (e.g. in transports)","id":"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidUsagePercentage"},"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidTransportType":{"value":{"code":"VALIDATION_ERROR","message":"Invalid transport name.","details":[{"field":"transports[0].name","reason":"Must be one of BARGE, BOAT, CAR, PLANE, TRAIN, TRUCK, VAN."}]},"key":"invalidTransportType","summary":"transports[].name not in enum","id":"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidTransportType"},"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidPurchasedQuantityUnit":{"value":{"code":"VALIDATION_ERROR","message":"Invalid unit.","details":[{"field":"purchasedQuantity.unit","reason":"Must be one of GRAMS, KILOGRAMS, METERS, PIECES, SQUARE FOOT, SQUARE METERS."}]},"key":"invalidPurchasedQuantityUnit","summary":"purchasedQuantity.unit not in enum","id":"paths/~1purchased-items/post/responses/400/content/application~1json/examples/invalidPurchasedQuantityUnit"},"paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingCertificationNameWhenCertificationsPresent":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"certifications[0].certificationName","reason":"Required when certifications is non-empty."}]},"key":"missingCertificationNameWhenCertificationsPresent","summary":"certifications[] entry missing certificationName","id":"paths/~1purchased-items/post/responses/400/content/application~1json/examples/missingCertificationNameWhenCertificationsPresent"},"paths/~1purchased-items/post/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1purchased-items/post/responses/401/content/application~1json/example"},"paths/~1purchased-items/post/responses/403/content/application~1json/example":{"value":{"code":"FORBIDDEN","message":"Forbidden."},"id":"paths/~1purchased-items/post/responses/403/content/application~1json/example"},"paths/~1purchased-items/post/responses/409/content/application~1json/example":{"value":{"code":"CONFLICT","message":"Purchased item with this uniqueIdentifier already exists.","details":[{"field":"uniqueIdentifier","reason":"Already in use.","purchasedItemId":"00000000-0000-4000-8000-000000000006"}]},"id":"paths/~1purchased-items/post/responses/409/content/application~1json/example"},"paths/~1purchased-items/post/responses/422/content/application~1json/examples/buyerIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced buyer not found.","details":[{"field":"buyerId","reason":"Buyer does not exist."}]},"key":"buyerIdNotFound","summary":"Referenced buyerId not found","id":"paths/~1purchased-items/post/responses/422/content/application~1json/examples/buyerIdNotFound"},"paths/~1purchased-items/post/responses/422/content/application~1json/examples/sellerIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced seller not found.","details":[{"field":"sellerId","reason":"Seller does not exist."}]},"key":"sellerIdNotFound","summary":"Referenced sellerId not found","id":"paths/~1purchased-items/post/responses/422/content/application~1json/examples/sellerIdNotFound"},"paths/~1purchased-items/post/responses/422/content/application~1json/examples/itemIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced item not found.","details":[{"field":"itemId","reason":"Item (product, component or material) does not exist."}]},"key":"itemIdNotFound","summary":"Referenced itemId not found (product, component or material)","id":"paths/~1purchased-items/post/responses/422/content/application~1json/examples/itemIdNotFound"},"paths/~1brand-products/post/requestBody/content/application~1json/examples/minimal":{"value":{"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"}}},"key":"minimal","summary":"Minimal brand product example","id":"paths/~1brand-products/post/requestBody/content/application~1json/examples/minimal"},"paths/~1brand-products/post/requestBody/content/application~1json/examples/full":{"value":{"uniqueIdentifier":"BP_REF-123_Black_Spring2026_PO-2026-01","manufacturedProductId":"82565027-bee0-4dbe-a2eb-c67b6324c0bd","ref":"REF-123","colorCode":"Black","collection":"Spring 2026","productName":"Cotton Tee Shirt","packagingIds":["c8568d90-0609-4ff6-b76f-5bf14051af43","a1b2c3d4-e5f6-7890-abcd-ef1234567890"],"gtins":["1234567890123","5901234123457","4006381333931"],"marketSegment":"Womenswear","productPrice":29.99,"ecoModulation":"NONE","producedQuantity":500,"weight":200,"warehouse":{"supplierId":"903f0d23-d888-4f94-a053-a992bba3d76a"}},"key":"full","summary":"Full brand product example","id":"paths/~1brand-products/post/requestBody/content/application~1json/examples/full"},"paths/~1brand-products/post/requestBody/content/application~1json/examples/teeShirt":{"value":{"uniqueIdentifier":"BP_TS-REF-001_White_SS26_PO-TS-001","manufacturedProductId":"437eeef0-5d40-4d0e-8ab5-1f4fe2a5823c","ref":"TS-REF-001","colorCode":"White","collection":"SS26","productName":"Basic Cotton Tee Shirt","packagingIds":["c8568d90-0609-4ff6-b76f-5bf14051af43"],"gtins":["3216549870123","8712345678901"],"marketSegment":"Womenswear","productPrice":19.99,"weight":200,"warehouse":{"address":{"country":"FR","city":"Paris","postalCode":"75000","street":"5 Avenue des T-shirts"}}},"key":"teeShirt","summary":"Tee‑shirt brand product example","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of brand product data for a cotton tee‑shirt."},"children":[]}]}]}],"id":"paths/~1brand-products/post/requestBody/content/application~1json/examples/teeShirt"},"paths/~1brand-products/post/requestBody/content/application~1json/examples/shoe":{"value":{"uniqueIdentifier":"BP_SH-REF-001_Brown_FW26_PO-SH-001","manufacturedProductId":"52b9dca7-d632-40a2-ba02-cd997e221ba0","ref":"SH-REF-001","colorCode":"Brown","collection":"FW26","productName":"Leather Shoe","packagingUniqueIdentifiers":["PACK_SHOEBOX_STD"],"gtins":["9876543210123","3614272049582","5031410160099"],"marketSegment":"Menswear","productPrice":49.99,"ecoModulation":"NONE","weight":800,"warehouse":{"supplierId":"4584de85-3765-4dec-b60d-4dcd5c6fdf74"}},"key":"shoe","summary":"Shoe brand product example","description":"Example of brand product data for a leather shoe.","id":"paths/~1brand-products/post/requestBody/content/application~1json/examples/shoe"},"paths/~1brand-products/post/responses/201/content/application~1json/example":{"value":{"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"}},"id":"paths/~1brand-products/post/responses/201/content/application~1json/example"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/missingRequiredField":{"value":{"code":"VALIDATION_ERROR","message":"Validation error.","details":[{"field":"uniqueIdentifier","reason":"Required field missing."}]},"key":"missingRequiredField","summary":"Missing uniqueIdentifier or warehouse","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/missingRequiredField"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier":{"value":{"code":"VALIDATION_ERROR","message":"Invalid length.","details":[{"field":"uniqueIdentifier","reason":"Must be between 1 and 255 characters."}]},"key":"invalidLengthUniqueIdentifier","summary":"uniqueIdentifier length &lt; 1 or &gt; 255","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidLengthUniqueIdentifier"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidUuid":{"value":{"code":"VALIDATION_ERROR","message":"Invalid UUID.","details":[{"field":"manufacturedProductId","reason":"Must be a valid UUID."}]},"key":"invalidUuid","summary":"Any UUID field invalid (e.g. manufacturedProductId, purchasedItemId, packagingIds)","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidUuid"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/neitherManufacturedProductNorPurchasedItem":{"value":{"code":"VALIDATION_ERROR","message":"Either 'manufacturedProductId' or 'purchasedItemId' must be provided.","details":[]},"key":"neitherManufacturedProductNorPurchasedItem","summary":"Neither manufacturedProductId nor purchasedItemId provided","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/neitherManufacturedProductNorPurchasedItem"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/warehouseIncomplete":{"value":{"code":"VALIDATION_ERROR","message":"Either warehouse.supplierId or warehouse.address.country must be provided.","details":[{"field":"warehouse","reason":"Either supplierId or address.country must be provided."}]},"key":"warehouseIncomplete","summary":"warehouse without supplierId nor address.country","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/warehouseIncomplete"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidWarehouseAddressCountry":{"value":{"code":"VALIDATION_ERROR","message":"Invalid country code.","details":[{"field":"warehouse.address.country","reason":"Must be a two-letter ISO country code from the taxonomy."}]},"key":"invalidWarehouseAddressCountry","summary":"warehouse.address.country missing or not in enum","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidWarehouseAddressCountry"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidMarketSegment":{"value":{"code":"VALIDATION_ERROR","message":"Invalid marketSegment.","details":[{"field":"marketSegment","reason":"Must be one of Menswear, Womenswear, Kidswear, Babywear, Lingerie."}]},"key":"invalidMarketSegment","summary":"marketSegment not in enum","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidMarketSegment"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidEcoModulation":{"value":{"code":"VALIDATION_ERROR","message":"Invalid ecoModulation.","details":[{"field":"ecoModulation","reason":"Not in ecoModulation taxonomy."}]},"key":"invalidEcoModulation","summary":"ecoModulation not in taxonomy","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidEcoModulation"},"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidGtins":{"value":{"code":"VALIDATION_ERROR","message":"Each gtins entry must contain 13 digits.","details":[{"field":"gtins[1]","reason":"Must contain exactly 13 digits."}]},"key":"invalidGtins","summary":"gtins entry not 13 digits","id":"paths/~1brand-products/post/responses/400/content/application~1json/examples/invalidGtins"},"paths/~1brand-products/post/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1brand-products/post/responses/401/content/application~1json/example"},"paths/~1brand-products/post/responses/403/content/application~1json/example":{"value":{"code":"FORBIDDEN","message":"Forbidden."},"id":"paths/~1brand-products/post/responses/403/content/application~1json/example"},"paths/~1brand-products/post/responses/409/content/application~1json/example":{"value":{"code":"CONFLICT","message":"Brand product with this uniqueIdentifier already exists.","details":[{"field":"uniqueIdentifier","reason":"Already in use.","brandProductId":"00000000-0000-4000-8000-000000000008"}]},"id":"paths/~1brand-products/post/responses/409/content/application~1json/example"},"paths/~1brand-products/post/responses/422/content/application~1json/examples/manufacturedProductIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced manufactured product not found.","details":[{"field":"manufacturedProductId","reason":"Manufactured product does not exist."}]},"key":"manufacturedProductIdNotFound","summary":"Referenced manufacturedProductId not found","id":"paths/~1brand-products/post/responses/422/content/application~1json/examples/manufacturedProductIdNotFound"},"paths/~1brand-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced purchased item not found.","details":[{"field":"purchasedItemId","reason":"Purchased item does not exist."}]},"key":"purchasedItemIdNotFound","summary":"Referenced purchasedItemId not found","id":"paths/~1brand-products/post/responses/422/content/application~1json/examples/purchasedItemIdNotFound"},"paths/~1brand-products/post/responses/422/content/application~1json/examples/packagingIdsNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced packaging not found.","details":[{"field":"packagingIds","reason":"Packaging does not exist."}]},"key":"packagingIdsNotFound","summary":"Referenced packagingIds not found","id":"paths/~1brand-products/post/responses/422/content/application~1json/examples/packagingIdsNotFound"},"paths/~1brand-products/post/responses/422/content/application~1json/examples/warehouseSupplierIdNotFound":{"value":{"code":"NOT_FOUND","message":"Referenced warehouse supplier not found.","details":[{"field":"warehouse.supplierId","reason":"Supplier does not exist."}]},"key":"warehouseSupplierIdNotFound","summary":"Referenced warehouse.supplierId not found","id":"paths/~1brand-products/post/responses/422/content/application~1json/examples/warehouseSupplierIdNotFound"},"paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp":{"value":{},"key":"noOp","summary":"Empty body (no change)","id":"paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"},"paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"},"paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example":{"value":{"reason":"BrandProductNotFoundByUniqueIdentifier","message":"Brand product not found by unique identifier.","field":"uniqueIdentifier"},"id":"paths/~1brand-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"},"paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/noOp":{"value":{},"key":"noOp","summary":"Empty body (no change)","id":"paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/noOp"},"paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/relinkMp":{"value":{"manufacturedProductId":"82565027-bee0-4dbe-a2eb-c67b6324c0bd"},"key":"relinkMp","summary":"Link to a manufactured product","id":"paths/~1brand-products~1{id}/patch/requestBody/content/application~1json/examples/relinkMp"},"paths/~1brand-products~1{id}/patch/responses/400/content/application~1json/examples/uniqueIdentifierNotAllowed":{"value":{"type":"UNKNOWN_PROPERTY","message":"Property uniqueIdentifier is not allowed in the request body.","field":"uniqueIdentifier"},"key":"uniqueIdentifierNotAllowed","summary":"uniqueIdentifier must not be sent on PATCH","id":"paths/~1brand-products~1{id}/patch/responses/400/content/application~1json/examples/uniqueIdentifierNotAllowed"},"paths/~1brand-products~1{id}/patch/responses/403/content/application~1json/example":{"value":{"reason":"BrandProductOwnershipViolation","message":"Brand product ownership violation.","field":"id"},"id":"paths/~1brand-products~1{id}/patch/responses/403/content/application~1json/example"},"paths/~1brand-products~1{id}/patch/responses/404/content/application~1json/example":{"value":{"reason":"BrandProductNotFound","message":"Brand product not found.","field":"id"},"id":"paths/~1brand-products~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp":{"value":{},"key":"noOp","summary":"noOp","id":"paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"},"paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"},"paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example":{"value":{"reason":"ManufacturedProductNotFoundByUniqueIdentifier","message":"Manufactured product not found by unique identifier.","field":"uniqueIdentifier"},"id":"paths/~1manufactured-products~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"},"paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/noOp":{"value":{},"key":"noOp","summary":"noOp","id":"paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/noOp"},"paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/categoryOnly":{"value":{"category":"TSHIRTS"},"key":"categoryOnly","summary":"categoryOnly","id":"paths/~1manufactured-products~1{id}/patch/requestBody/content/application~1json/examples/categoryOnly"},"paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp":{"value":{},"key":"noOp","summary":"noOp","id":"paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"},"paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"},"paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example":{"value":{"reason":"ManufacturedComponentNotFoundByUniqueIdentifier","message":"Manufactured component not found by unique identifier.","field":"uniqueIdentifier"},"id":"paths/~1manufactured-components~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"},"paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp":{"value":{},"key":"noOp","summary":"noOp","id":"paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/requestBody/content/application~1json/examples/noOp"},"paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"},"paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example":{"value":{"reason":"ManufacturedMaterialNotFoundByUniqueIdentifier","message":"Manufactured material not found by unique identifier.","field":"uniqueIdentifier"},"id":"paths/~1manufactured-materials~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"},"paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized."},"id":"paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/401/content/application~1json/example"},"paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example":{"value":{"reason":"PurchasedItemNotFoundByUniqueIdentifier","message":"Purchased item not found by unique identifier.","field":"uniqueIdentifier"},"id":"paths/~1purchased-items~1by-unique-identifier~1{uniqueIdentifier}/patch/responses/404/content/application~1json/example"},"paths/~1brand-products/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"0d4a1c9e-1a2b-4c3d-8e4f-5a6b7c8d9e0f","uniqueIdentifier":"SHIRT-25W-001","ref":"REF-4812","productName":"Cotton Tee Shirt","collection":"25W","category":"T-SHIRT","marketSegment":"WOMENSWEAR","colorCode":"BLACK","ecoModulation":"NONE","weight":250,"producedQuantity":12000,"gtins":["3401234567890"],"hasCommunicationPackage":true,"createdAt":"2026-03-14T09:30:00.000Z","links":{"qrCode":"https://links.fairlymade.com/49cb7b8f-a4a5-4f6e-bda6-b1441a56d992","web":"https://links.fairlymade.com/71159d67-f38b-4a9c-9ede-b7f7d81ce968"}},{"id":"7f21b0aa-1111-2222-3333-444455556666","uniqueIdentifier":"JEANS-25W-014","ref":"REF-9007","productName":"Straight Jeans","collection":"25W","category":"TROUSERS","marketSegment":"MENSWEAR","colorCode":"INDIGO","ecoModulation":null,"weight":680,"producedQuantity":null,"gtins":[],"hasCommunicationPackage":false,"createdAt":"2026-02-02T14:05:00.000Z","links":{"qrCode":null,"web":null}}],"offset":0,"limit":20,"total":1451},"id":"paths/~1brand-products/get/responses/200/content/application~1json/example"},"paths/~1brand-products/get/responses/400/content/application~1json/example":{"value":{"code":"VALIDATION_ERROR","message":"Invalid query parameter.","details":[{"field":"notARealField","reason":"Unknown field."}]},"id":"paths/~1brand-products/get/responses/400/content/application~1json/example"},"paths/~1brand-products/get/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized.","details":[]},"id":"paths/~1brand-products/get/responses/401/content/application~1json/example"},"paths/~1brand-products/get/responses/502/content/application~1json/example":{"value":{"code":"DEPENDENCY_FAILURE","message":"Upstream data store unavailable.","details":[]},"id":"paths/~1brand-products/get/responses/502/content/application~1json/example"},"paths/~1declared-french-environmental-cost/get/responses/200/content/application~1json/example":{"value":{"data":[{"brandProductId":"0d4a1c9e-1a2b-4c3d-8e4f-5a6b7c8d9e0f","brandProductUniqueIdentifier":"SHIRT-25W-001","internalReference":"REF-4812","gtins":["3401234567890"],"isFrenchEnvironmentalCostPublishedToGovernmentPlatform":true,"governmentPlatformPublicationDate":"2026-03-14T09:30:00.000Z","publishedFrenchEnvironmentalCost":245,"publishedFrenchEnvironmentalCostPer100grams":98,"publishedFrenchEnvironmentalCostPictogram":"https://affichage-environnemental.ecobalyse.beta.gouv.fr/api/image?type=score&score=245&masse=250"},{"brandProductId":"7f21b0aa-1111-2222-3333-444455556666","brandProductUniqueIdentifier":"JEANS-25W-014","internalReference":"REF-9007","gtins":[],"isFrenchEnvironmentalCostPublishedToGovernmentPlatform":false,"governmentPlatformPublicationDate":null,"publishedFrenchEnvironmentalCost":null,"publishedFrenchEnvironmentalCostPer100grams":null,"publishedFrenchEnvironmentalCostPictogram":null}],"offset":0,"limit":20,"total":1451},"id":"paths/~1declared-french-environmental-cost/get/responses/200/content/application~1json/example"},"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownKey":{"value":{"code":"VALIDATION_ERROR","message":"Invalid query parameter.","details":[{"field":"notARealField","reason":"Unknown field."}]},"key":"unknownKey","summary":"Unknown filter or sort key, or wrong value type","id":"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownKey"},"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/numberOperatorConflict":{"value":{"code":"VALIDATION_ERROR","message":"Invalid filter.","details":[{"field":"publishedFrenchEnvironmentalCost","reason":"Use either a comparison operator or a min/max range, not both."}]},"key":"numberOperatorConflict","summary":"A numeric field mixes [op] with [min]/[max]","id":"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/numberOperatorConflict"},"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/incompleteNumberRange":{"value":{"code":"VALIDATION_ERROR","message":"Invalid filter.","details":[{"field":"weight","reason":"Both min and max are required for a numeric range."}]},"key":"incompleteNumberRange","summary":"A numeric range provides only one of [min]/[max]","id":"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/incompleteNumberRange"},"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/dateFormConflict":{"value":{"code":"VALIDATION_ERROR","message":"Invalid filter.","details":[{"field":"governmentPlatformPublicationDate","reason":"Use either an exact date or a start/end range, not both."}]},"key":"dateFormConflict","summary":"A date field mixes the exact form with [start]/[end]","id":"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/dateFormConflict"},"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownOperator":{"value":{"code":"VALIDATION_ERROR","message":"Invalid filter.","details":[{"field":"weight","reason":"Unknown operator 'between'."}]},"key":"unknownOperator","summary":"Unknown numeric operator","id":"paths/~1declared-french-environmental-cost/get/responses/400/content/application~1json/examples/unknownOperator"},"paths/~1declared-french-environmental-cost/get/responses/401/content/application~1json/example":{"value":{"code":"UNAUTHORIZED","message":"Unauthorized.","details":[]},"id":"paths/~1declared-french-environmental-cost/get/responses/401/content/application~1json/example"},"paths/~1declared-french-environmental-cost/get/responses/502/content/application~1json/example":{"value":{"code":"DEPENDENCY_FAILURE","message":"Upstream dependency unavailable.","details":[]},"id":"paths/~1declared-french-environmental-cost/get/responses/502/content/application~1json/example"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example":{"value":{"scoring":{"brandScore":1.41,"productScore":2653,"lcaScore":2102,"ooeuExportScore":173,"microfibersScore":378,"malusBonusServiceDuration":35,"referenceServiceDuration":85,"frenchEnvironmentalCost":1882},"durabilityCoefficient":0.9,"pictogram":"https://affichage-environnemental.ecobalyse.beta.gouv.fr/api/image?type=score&score=1882&masse=0.705","calculatedAt":"2024-11-18T12:50:01.151Z"},"id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier":{"value":{"message":"Invalid unique identifier.","details":[{"field":"uniqueIdentifier","reason":"UniqueIdentifierShouldBeValid"}]},"key":"emptyUniqueIdentifier","summary":"uniqueIdentifier is empty or blank after trim","id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId":{"value":{"message":"Invalid registry customer id in token.","details":[{"field":"registryCustomerId","reason":"UuidV4ShouldBeValid"}]},"key":"invalidRegistryCustomerId","summary":"registryCustomerId in bearer token is not a UUID v4","id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound":{"value":{"message":"Brand product not found for unique identifier.","details":[{"field":"uniqueIdentifier","reason":"FrenchEnvironmentalCostBrandProductNotFoundForUniqueIdentifier"}]},"key":"brandProductNotFound","summary":"No product for this uniqueIdentifier","id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable":{"value":{"message":"Calculated French Environmental Cost is not available for this product.","details":[{"field":"uniqueIdentifier","reason":"FrenchEnvironmentalCostNotAvailable"}]},"key":"fecNotAvailable","summary":"Product found but calculated FEC is not available","id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound":{"value":{"message":"Registry customer not found.","details":[{"field":"registryCustomerId","reason":"FrenchEnvironmentalCostRegistryCustomerNotFound"}]},"key":"registryCustomerNotFound","summary":"registryCustomerId absent from registry","id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed":{"value":{"message":"Failed to find brand product by unique identifier.","details":[{"field":"uniqueIdentifier","reason":"FrenchEnvironmentalCostBrandProductFindByUniqueIdentifierFailed"}]},"key":"findByUniqueIdentifierFailed","summary":"Lookup by unique identifier failed","id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"},"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example":{"value":{"message":"Internal failure while retrieving calculated French Environmental Cost.","details":[{"reason":"FrenchEnvironmentalCostInternalFailure"}]},"id":"paths/~1calculated-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"},"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId":{"value":{"message":"Invalid brand product id.","details":[{"field":"brandProductId","reason":"FrenchEnvironmentalCostBrandProductIdShouldBeValid"}]},"key":"invalidBrandProductId","summary":"brandProductId is not a UUID v4","id":"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId"},"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId":{"value":{"message":"Invalid registry customer id in token.","details":[{"field":"registryCustomerId","reason":"UuidV4ShouldBeValid"}]},"key":"invalidRegistryCustomerId","summary":"registryCustomerId in bearer token is not a UUID v4","id":"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"},"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example":{"value":{"message":"Brand product ownership violation.","details":[{"field":"brandProductId","reason":"FrenchEnvironmentalCostBrandProductOwnershipViolation"}]},"id":"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"},"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound":{"value":{"message":"Brand product not found.","details":[{"field":"brandProductId","reason":"FrenchEnvironmentalCostBrandProductNotFound"}]},"key":"brandProductNotFound","summary":"Unknown brandProductId","id":"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound"},"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable":{"value":{"message":"Calculated French Environmental Cost is not available for this product.","details":[{"field":"brandProductId","reason":"FrenchEnvironmentalCostNotAvailable"}]},"key":"fecNotAvailable","summary":"Product exists but calculated FEC is not available","id":"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"},"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example":{"value":{"message":"Registry customer not found.","details":[{"field":"registryCustomerId","reason":"FrenchEnvironmentalCostRegistryCustomerNotFound"}]},"id":"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"},"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example":{"value":{"message":"Internal failure while retrieving calculated French Environmental Cost.","details":[{"reason":"FrenchEnvironmentalCostInternalFailure"}]},"id":"paths/~1calculated-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example":{"value":{"lcaFR":{"climateChange":8.3307,"climateChangeBiogenic":0.12,"climateChangeFossil":8.1,"climateChangeLandUse":0.11,"acidification":0.0531586,"ecotoxicityFreshWater":66.1,"humanToxicityCancer":0,"humanToxicityNonCancer":4.3e-8,"eutrophicationFreshWater":0.000342653,"eutrophicationMarine":0.0122277,"eutrophicationTerrestrial":0.10436944,"ionisingRadiation":0.84156,"landuse":44.1515,"ozoneDepletion":3.54e-7,"particulateMatter":0.000001187,"photochemicalOzoneFormation":0.026887,"resourceUseFossils":107.346,"resourceUseMineralsMetals":0.000009853,"waterUse":5.3143},"lcaPEF":{"pefSingleScore":764,"climateChange":8.3307,"acidification":0.0531586,"ecotoxicityFreshWater":66.1,"humanToxicityCancer":0,"humanToxicityNonCancer":4.3e-8,"eutrophicationFreshWater":0.000342653,"eutrophicationMarine":0.0122277,"eutrophicationTerrestrial":0.10436944,"ionisingRadiation":0.84156,"landuse":44.1515,"ozoneDepletion":3.54e-7,"particulateMatter":0.000001187,"photochemicalOzoneFormation":0.026887,"resourceUseFossils":107.346,"resourceUseMineralsMetals":0.000009853,"waterUse":5.3143},"calculatedAt":"2024-11-18T12:50:01.151Z"},"id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier":{"value":{"message":"Invalid unique identifier.","details":[{"field":"uniqueIdentifier","reason":"UniqueIdentifierShouldBeValid"}]},"key":"emptyUniqueIdentifier","summary":"uniqueIdentifier is empty or blank after trim","id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId":{"value":{"message":"Invalid registry customer id in token.","details":[{"field":"registryCustomerId","reason":"UuidV4ShouldBeValid"}]},"key":"invalidRegistryCustomerId","summary":"registryCustomerId in bearer token is not a UUID v4","id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound":{"value":{"message":"Brand product not found for unique identifier.","details":[{"field":"uniqueIdentifier","reason":"LifeCycleAssessmentBrandProductNotFoundForUniqueIdentifier"}]},"key":"brandProductNotFound","summary":"No product for this uniqueIdentifier","id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/lcaNotAvailable":{"value":{"message":"Life cycle assessment is not available for this product.","details":[{"field":"uniqueIdentifier","reason":"LifeCycleAssessmentNotAvailable"}]},"key":"lcaNotAvailable","summary":"Product found but LCA is not available","id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/lcaNotAvailable"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound":{"value":{"message":"Registry customer not found.","details":[{"field":"registryCustomerId","reason":"LifeCycleAssessmentRegistryCustomerNotFound"}]},"key":"registryCustomerNotFound","summary":"registryCustomerId absent from registry","id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/registryCustomerNotFound"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed":{"value":{"message":"Failed to find brand product by unique identifier.","details":[{"field":"uniqueIdentifier","reason":"LifeCycleAssessmentBrandProductFindByUniqueIdentifierFailed"}]},"key":"findByUniqueIdentifierFailed","summary":"Lookup by unique identifier failed","id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/examples/findByUniqueIdentifierFailed"},"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example":{"value":{"message":"Internal failure while retrieving life cycle assessment.","details":[{"reason":"AnalysisOrchestratorLifeCycleAssessmentInternalFailure"}]},"id":"paths/~1lifecycle-assessment~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"},"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId":{"value":{"message":"Invalid brand product id.","details":[{"field":"brandProductId","reason":"AnalysisOrchestratorBrandProductIdShouldBeValid"}]},"key":"invalidBrandProductId","summary":"brandProductId is not a UUID v4","id":"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId"},"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId":{"value":{"message":"Invalid registry customer id in token.","details":[{"field":"registryCustomerId","reason":"UuidV4ShouldBeValid"}]},"key":"invalidRegistryCustomerId","summary":"registryCustomerId in bearer token is not a UUID v4","id":"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"},"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/403/content/application~1json/example":{"value":{"message":"Brand product ownership violation.","details":[{"field":"brandProductId","reason":"AnalysisOrchestratorBrandProductOwnershipViolation"}]},"id":"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/403/content/application~1json/example"},"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound":{"value":{"message":"Brand product not found.","details":[{"field":"brandProductId","reason":"AnalysisOrchestratorBrandProductNotFound"}]},"key":"brandProductNotFound","summary":"Unknown brandProductId","id":"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound"},"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/lcaNotAvailable":{"value":{"message":"Life cycle assessment is not available for this product.","details":[{"field":"brandProductId","reason":"AnalysisOrchestratorLifeCycleAssessmentNotAvailable"}]},"key":"lcaNotAvailable","summary":"Product exists but LCA is not available","id":"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/404/content/application~1json/examples/lcaNotAvailable"},"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/422/content/application~1json/example":{"value":{"message":"Registry customer not found.","details":[{"field":"registryCustomerId","reason":"LifeCycleAssessmentRegistryCustomerNotFound"}]},"id":"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/422/content/application~1json/example"},"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/502/content/application~1json/example":{"value":{"message":"Internal failure while retrieving life cycle assessment.","details":[{"reason":"AnalysisOrchestratorLifeCycleAssessmentInternalFailure"}]},"id":"paths/~1lifecycle-assessment~1{brandProductId}/get/responses/502/content/application~1json/example"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example":{"value":{"scoring":{"brandScore":1.41,"productScore":2653,"frenchEnvironmentalCost":1882},"publishedFrenchEnvironmentalCost":1882,"publishedFrenchEnvironmentalCostPerUnitWeight":2.67,"pictogram":"https://affichage-environnemental.ecobalyse.beta.gouv.fr/api/image?type=score&score=1882&masse=0.705","isPublishedOnGovernmentPlatform":true,"governmentPlatformPublicationDate":"2024-11-18T12:50:01.151Z","calculatedAt":"2024-11-18T12:50:01.151Z"},"id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/200/content/application~1json/example"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier":{"value":{"message":"Invalid unique identifier.","details":[{"field":"uniqueIdentifier","reason":"DeclaredFecUniqueIdentifierShouldBeValid"}]},"key":"emptyUniqueIdentifier","summary":"uniqueIdentifier is empty or blank after trim","id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/emptyUniqueIdentifier"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId":{"value":{"message":"Invalid registry customer id in token.","details":[{"field":"registryCustomerId","reason":"DeclaredFecRegistryCustomerIdShouldBeValid"}]},"key":"invalidRegistryCustomerId","summary":"registryCustomerId in bearer token is not a UUID v4","id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/403/content/application~1json/example":{"value":{"message":"Brand product ownership violation.","details":[{"field":"brandProductId","reason":"DeclaredFecBrandProductOwnershipViolation"}]},"id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/403/content/application~1json/example"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound":{"value":{"message":"Brand product not found.","details":[{"field":"uniqueIdentifier","reason":"DeclaredFecBrandProductNotFound"}]},"key":"brandProductNotFound","summary":"No product for this uniqueIdentifier","id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/brandProductNotFound"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable":{"value":{"message":"Declared French Environmental Cost is not available for this product.","details":[{"field":"uniqueIdentifier","reason":"DeclaredFecNotAvailable"}]},"key":"fecNotAvailable","summary":"Product found but declared FEC is not published","id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/404/content/application~1json/examples/fecNotAvailable"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/example":{"value":{"message":"Registry customer not found.","details":[{"field":"registryCustomerId","reason":"DeclaredFecRegistryCustomerNotFound"}]},"id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/422/content/application~1json/example"},"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example":{"value":{"message":"Internal failure while retrieving declared French Environmental Cost.","details":[{"reason":"DeclaredFecInternalFailure"}]},"id":"paths/~1declared-french-environmental-cost~1by-unique-identifier~1{uniqueIdentifier}/get/responses/502/content/application~1json/example"},"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId":{"value":{"message":"Invalid brand product id.","details":[{"field":"brandProductId","reason":"DeclaredFecBrandProductIdShouldBeValid"}]},"key":"invalidBrandProductId","summary":"brandProductId is not a UUID v4","id":"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidBrandProductId"},"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId":{"value":{"message":"Invalid registry customer id in token.","details":[{"field":"registryCustomerId","reason":"DeclaredFecRegistryCustomerIdShouldBeValid"}]},"key":"invalidRegistryCustomerId","summary":"registryCustomerId in bearer token is not a UUID v4","id":"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/400/content/application~1json/examples/invalidRegistryCustomerId"},"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example":{"value":{"message":"Brand product ownership violation.","details":[{"field":"brandProductId","reason":"DeclaredFecBrandProductOwnershipViolation"}]},"id":"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/403/content/application~1json/example"},"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound":{"value":{"message":"Brand product not found.","details":[{"field":"brandProductId","reason":"DeclaredFecBrandProductNotFound"}]},"key":"brandProductNotFound","summary":"Unknown brandProductId","id":"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/brandProductNotFound"},"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable":{"value":{"message":"Declared French Environmental Cost is not available for this product.","details":[{"field":"brandProductId","reason":"DeclaredFecNotAvailable"}]},"key":"fecNotAvailable","summary":"Product exists but declared FEC is not published","id":"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/404/content/application~1json/examples/fecNotAvailable"},"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example":{"value":{"message":"Registry customer not found.","details":[{"field":"registryCustomerId","reason":"DeclaredFecRegistryCustomerNotFound"}]},"id":"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/422/content/application~1json/example"},"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example":{"value":{"message":"Internal failure while retrieving declared French Environmental Cost.","details":[{"reason":"DeclaredFecInternalFailure"}]},"id":"paths/~1declared-french-environmental-cost~1{brandProductId}/get/responses/502/content/application~1json/example"}},"securitySchemeStore":{},"servers":[{"url":"/_mock/swagger-fairlymadeapi-v3","isMockServer":true,"description":"Mock server"},{"url":"https://api.fairlymade.com/v3","description":"Production"},{"url":"https://api.sandbox.fairlymade.com/v3","description":"Sandbox"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/swagger-fairlymadeapi-v3","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/swagger-FairlyMadeAPI-v3.json?download"},{"url":"/_bundle/swagger-FairlyMadeAPI-v3.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fairly Made API","description":"The Fairly Made API describes endpoints for creating and retrieving supply‑chain entities such as suppliers, manufactured materials, manufactured components, manufactured products and purchased items.\n\n### `uniqueIdentifier` convention\n\nThe `uniqueIdentifier` is your item's unique key in the Fairly Made system. It defines the granularity of analysis you want Fairly Made to perform: **one `uniqueIdentifier` = one analysis**.\n\nFor create payloads that include a `uniqueIdentifier`, start the value with a short **resource prefix**, then add your own reference segments separated by underscores (`_`) instead of spaces or concatenated camelCase where practical.\n\nUse one of these prefixes depending on the entity: `SUP` (supplier), `MAT` (material), `COMP` (component), `PACK` (packaging), `MP` (manufactured product), `PI` (purchased item), `FILE` (file), `BP` (brand product). Each endpoint’s schema describes how to compose the segments after the prefix for that resource.\n\n### Entity references (id vs unique identifier)\n\nWhen a schema exposes both a UUID field (`*Id`) and a client reference field (`*UniqueIdentifier`), send **exactly one** of them — not both, not neither. Violations return HTTP **400** (e.g. `*ReferenceConflict`, `*ReferenceRequired`, `*BothIdAndUniqueIdentifier`).\n\n**Owner (supplier)** — on manufactured materials, components, and products: provide either `ownerId` or `ownerUniqueIdentifier` (with `ownerKind` = `SUPPLIER`), or an `address` instead — not both owner and address. `ownerUniqueIdentifier` requires `ownerKind` = `SUPPLIER`.\n\n**Purchased items** — for the buyer, send exactly one of `buyerId` or `buyerUniqueIdentifier` (`buyerUniqueIdentifier` requires `buyerKind` = `SUPPLIER`). For the seller, send exactly one of `sellerId` or `sellerUniqueIdentifier`. For the purchased entity (material, component, or product), send exactly one of `itemId` or `itemUniqueIdentifier`. `purchaseOrder` is required. If you run traceability collection with Fairly Made, every purchased item needs at least a `purchaseOrder` so supplier data collection can be launched; if your analysis granularity is not at purchase-order level, use a representative PO for the panel covered by that granularity. If you are unable to provide a PO at all, you can set the value to `NOT_SPECIFIED`. Links made only through used items (`usedMaterials`, `usedComponents`, `usedProducts`, etc.) instead of `purchasedItems` are not taken into account for the analysis.\n\n**Brand products** — include at most one product reference: exactly one of `manufacturedProductId`, `manufacturedProductUniqueIdentifier`, `purchasedItemId`, or `purchasedItemUniqueIdentifier`. For the warehouse supplier, send exactly one of `supplierId` or `supplierUniqueIdentifier`. For packaging, send either `packagingIds` or `packagingUniqueIdentifiers`, not both.\n\n### Manufactured items and their purchased items\n\nWhen you run traceability collection with Fairly Made, each manufactured item must be created as a **pair**: the manufactured item **and** its corresponding purchased item. For a given item (manufactured material, manufactured component, or manufactured product), first create the manufactured item, then create the matching purchased item (`POST /purchased-items`) that references it and carries a `purchaseOrder`. Without this pair, supplier data collection cannot be launched for that item. If you handle traceability yourself, the purchased item stays optional.\n\n### Authentication\n\nAuthenticate with a Bearer access token (`Authorization: Bearer <token>`). Your registry context is resolved from the token.\n\n### Environments\n\nTwo environments are available — **Production** and **Sandbox** — each with its own base URL (see `servers` above). The documented paths and request/response schemas are identical; only the host changes. Use Sandbox for integration tests, Production for live data.\n"}},"baseSlug":"/swagger-fairlymadeapi-v3","routesMapping":{}}