Requirements for Pushing Data by the Fairly Made® API

Everything related to project management around the actual implementation and how we can help you with this can be found here and here. Keep in mind that everything API-related can be found in its documentation page.

These 2 slides sum up most of the information you need:

Some key take-aways

• Authentication : you need a Bearer token for each environnement (Sandbox and Production) to access your product data. To retrieve it, access the platform, go to My Account, then Token API tab or ask your IT referent
• Sandbox properties : by default, the Sandbox is empty and fills up as you run your tests. It will be cleaned at your demand, before running next tests
• Creation Order : always respect the order of creation for the objects : SUPPLIER→ (eventually PACKAGINGS)→ PRODUCTS → COMPONENTS
• Attributes Unicity :
  • A Fairly Made study is uniquely identified by three attributes: productRef, productCollectionRef & productColorCode
  • Currently, a component is considered unique based only on its ComponentRef. If the same component is used in different categories or exist across multiple suppliers, we recommend concatenating other fields within the ComponentRef to ensure its uniqueness when necessary.
• Rate Limitations :
  • Don’t send more than 500 requests in a single second, our infrastructure will block it and some information may not pass
  • Wait 2-5 seconds between different objects’ creation for the proper relations between them to take place (do not send a supplier, component, product in the same batch. Instead send all suppliers at once, wait 4 seconds, send all components at once, wait 4 seconds, then send al the products)
• BatchImport : respect the naming of the batchImport for easier storage and to avoid troubleshooting. Example : BrandName-Collection-WaveNumber-SendingDate
• Error logs : Store the error responses 

Requirements

For each object, here are the required fields (found in the documentation) :

Suppliers

4 data attributes required & 8 fields optional

• category
• supplierRef
• contact_email
• address_country

Packaging

Sending Packaging data is optional but if filled there are 9 data attributes required

• packagingRef
• type
• channel (STORE / E-COMMERCE)
• percentageRecycled
• compostability
• ecoModulation
• possibilityReUse
• hazardousSubstances

Products

7 data attributes required & 10 fields optional

• productRef
• productCollectionRef
• category
• supplierRef
• warehouseRef
• reachCompliance (default response : “1”)
• ecoModulation
• productColorCode : optional but will be filled by “DEFAULT” if empty, as it is one of the 3 unicity attributes of a study
• weight : optional but highly recommended, it will contribute to the score

Components

4 data attributes required & 13 fields optional

• componentRef
• type
• category
• composition
• componentWeight : optional but highly recommended, it will contribute to the score