v2 > Services > DeclarationsUpdate


Update one or more declarations in Origin.

  • URL

    /connect/v2/declarations/update

    /connect/v2/async/declarations/update

  • Method:

    POST

  • URL Params

    none

  • Request :

Field Type Required Description Domain of value
declarations[] array of object At least one The list of declarations to update Declaration object(s)
declarations[].locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
declarations[].originId string Only if no declarations[].externalId The declaration unique origin ID Any string
declarations[].externalId string Only if no declarations[].originId The declaration unique ID in your system Any string
declarations[].declarationNumber string No The number of the declaration Any string
declarations[].url string No The URL to the declaration document A valid public facing URL
declarations[].additionalsDocuments[] array of object No The additional documents Document object(s)
declarations[].additionalsDocuments[].collectionBehavior string Only if declarations[].additionalsDocuments[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
declarations[].additionalsDocuments[].originalUrl string Only if declarations[].additionalsDocuments[] is present URL of a document related to the declaration A valid public facing URL
declarations[].reportingBody object No The reporting body A reporting body object
declarations[].reportingBody.name string Only allowed when declarations[].reportingBody.selfReported is absent The reporting body name. Remove self reported status if set. An existing reporting body name in Origin. See data[].name ReportingBodiesLookup or any string for a custom one.
declarations[].reportingBody.selfReported string Only allowed when declarations[].reportingBody.name is absent Set the declarations as self reported. Erase existing reporting name if any. TRUE
declarations[].standard object No The certified standard A standard object
declarations[].standard.code string Only if declarations[].standard is present The standard code data[].code StandardsLookup or any string for a custom one.
declarations[].issueDate date No The date when the declaration is issued A ISO-8601 date
declarations[].expiryDate date No The date when the declaration will be expired A ISO-8601 date
declarations[].brands[] array of brand No The related brands Brand object(s)
declarations[].brands[].collectionBehavior string Only if declarations[].brands[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
declarations[].brands[].name string Only if declarations[].brands[] is present The brand name Any string
declarations[].brands[].website string No The brand website A valid public facing URL
declarations[].contacts[] array of contact No The related contacts Contact object(s)
declarations[].contacts[].collectionBehavior string Only if declarations[].contacts[] is present The way the current collection element is updated.ADD will update attribute of existing element. ADD, REMOVE
declarations[].contacts[].externalId string Only if declarations[].contacts[] is present A unique identifier of your choosing that serves as a unique key for the contact Any string
declarations[].contacts[].type string No The contact type MANUFACTURER, AUDITOR or VENDOR
declarations[].contacts[].companyName string No The contact company name Any string
declarations[].contacts[].phone string No The contact phone Any string
declarations[].contacts[].email string No The contact email A valid email
declarations[].contacts[].name string No The contact name Any string
declarations[].contacts[].website string No The contact website A valid public facing URL
declarations[].contacts[].postalAddress string No The contact postal address Any string
declarations[].channels[] array of object No The list of channels on which the declaration will be published Channel object(s). Not published if empty.
declarations[].channels[].collectionBehavior string Only if declarations[].channels[] is present The way the current collection element is updated. ADD publish the declaration, REMOVE will unpublish it. ADD, REMOVE
declarations[].channels[].name string Only if declarations[].channels[] is present The channel name.
If you set the name to 'ORIGIN' this is equivalent to publish or unpublish your declaration on Origin (only for Manufacturer and Reporting Body users).
'ORIGIN' (more to come)
declarations[].regulatoryStandardCompliances[] array of object no The regulatory standard compliances RegulatoryStandardCompliance Object(s)
declarations[].regulatoryStandardCompliances[].collectionBehavior string Only if declarations[].regulatoryStandardCompliances[] is present The way the current collection element is updated.ADD will update attribute of existing element. ADD, REMOVE
declarations[].regulatoryStandardCompliances[].code string Only if declarations[].regulatoryStandardCompliances[] The standard code data[].code StandardsLookup
declarations[].featuresCustoms[] array of object No The Custom features for the declaration Custom feature object(s)
declarations[].featuresCustoms[].collectionBehavior string Only if declarations[].featuresCustoms[] is present The update action. ADD does nothing is the feature already exist. ADD, REMOVE
declarations[].featuresCustoms[].originId string - To create (collectionBehavior = ADD) a feature : No
- To update (collectionBehavior = ADD) a feature : No, but it's highly recommanded.
- To remove (collectionBehavior = REMOVE) a feature : No, but it's highly recommanded.
If it's present, the action will be performed on the right feature
The custom feature unique origin ID A UUID
declarations[].featuresCustoms[].name string Only if declarations[].featuresCustoms[] is present The custom feature name Any string
declarations[].featuresCustoms[].code string Only if declarations[].featuresCustoms[] is present The custom feature property code CUSTOM_TEXT_ATTRIBUTE
declarations[].featuresCustoms[].value object Only if declarations[].featuresCustoms[] is present The custom feature value Value object
declarations[].featuresCustoms[].value.content string If the property does not require a reference code The custom feature value content Any string
declarations[].featuresProperties[] array of object No The feature properties for the declaration Feature property object(s)
declarations[].featuresProperties[].collectionBehavior string Only if declarations[].featuresProperties[] is present The update action. ADD does nothing is the feature already exist. ADD, REMOVE
declarations[].featuresCustoms[].originId string - To create (collectionBehavior = ADD) a feature : No
- To update (collectionBehavior = ADD) a feature : No, but it's highly recommanded.
- To remove (collectionBehavior = REMOVE) a feature : No, but it's highly recommanded.
If it's present, the action will be performed on the right feature
The property feature unique origin ID A UUID
declarations[].featuresProperties[].code string Only if declarations[].featuresProperties[] is present The property feature code data[].standardProperties[].code in StandardsLookup
declarations[].featuresProperties[].value object Only if declarations[].featuresProperties[] is present The property feature value Value object
declarations[].featuresProperties[].value.code string If the property require a reference code The property feature value reference code possibleValues[].code in PropertyDetailsLookup
declarations[].featuresProperties[].value.content string If the property does not require a reference code The property feature value content Any string
declarations[].featuresProperties[].unit string No The property feature unit Unit object
declarations[].featuresProperties[].unit.code string No The property feature unit code possibleUnits[].code in PropertyDetailsLookup
declarations[].voc object no The VOC section VOC object
declarations[].voc.content object no The VOC Content section VOC Content object
declarations[].voc.content.densityLimitGL string no The density limit (By default, the density unit is g/L) A decimal value
declarations[].voc.content.densityUnit object no The density unit. If it not present, the unit will be set to the default (g/L) DensityUnit object
declarations[].voc.content.densityUnit.code string Only if declarations[].voc.content.densityUnit is present The density unit code data[].code in VOCUnitsLookup
declarations[].voc.content.containsAddedMCPCE string no Flag for intentionally added Methylene Chloride and/or Perchloroethylene A boolean value
declarations[].voc.content.regulatoryStandardCompliances[] array of object Only if declarations[].voc.content.densityLimitGL is set The list of compliant standards VOC Content compliance object(s)
declarations[].voc.content.regulatoryStandardCompliances[].collectionBehavior string only if declarations[].voc.content.regulatoryStandardCompliances[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
declarations[].voc.content.regulatoryStandardCompliances[].standard string only if declarations[].voc.content.regulatoryStandardCompliances[] is present A compliant standard Standard object
declarations[].voc.content.regulatoryStandardCompliances[].standard.code string only if declarations[].voc.content.regulatoryStandardCompliances[] is present The standard code See the references
declarations[].voc.content.regulatoryStandardCompliances[].productTypeCode string only if declarations[].voc.content.regulatoryStandardCompliances[] is present The product type code See the references
declarations[].voc.content.regulatoryStandardCustoms[] array of object no The list of custom standards Custom standard object(s)
declarations[].voc.content.regulatoryStandardCustoms[].collectionBehavior string only if declarations[].voc.content.regulatoryStandardCustoms[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
declarations[].voc.content.regulatoryStandardCustoms[].standard object only if declarations[].voc.content.regulatoryStandardCustoms[] is present A custom standard Standard object
declarations[].voc.content.regulatoryStandardCustoms[].standard.code string only if declarations[].voc.content.regulatoryStandardCustoms[] is present The custom standard code Any string
declarations[].voc.content.testMethods[] array of object no The list of standard test methods Test method object(s)
declarations[].voc.content.testMethods[].collectionBehavior string only if declarations[].voc.content.regulatoryStandardCompliances[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
declarations[].voc.content.testMethods[].standard object only if declarations[].voc.content.testMethods[] is present A test method standard A standard object
declarations[].voc.content.testMethods[].standard.code string only if declarations[].voc.content.testMethods[] is present The standard code See the references
declarations[].voc.content.exemptCompounds[] array of object no The list of exempt compounds Exempt compound object(s)
declarations[].voc.content.exemptCompounds[].collectionBehavior string only if declarations[].voc.content.exemptCompounds[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
declarations[].voc.content.exemptCompounds[].CAS string only if declarations[].voc.content.exemptCompounds[] is present CAS registry number http://www.commonchemistry.org/
declarations[].voc.content.exemptCompounds[].name string only if declarations[].voc.content.exemptCompounds[] is present Chemical name http://www.commonchemistry.org/
declarations[].voc.content.exemptCompounds[].percentByWeight string only if declarations[].voc.content.exemptCompounds[] is present Composition percent by weight A decimal value
declarations[].voc.emission object no The VOC Emission section VOC Emission object
declarations[].voc.emission.densityMin string no Minimum density (By default, the density unit is µg/m³) A decimal value
declarations[].voc.emission.densityMax string no Maximum density (By default, the density unit is µg/m³) A decimal value
declarations[].voc.emission.densityUnit object no The density unit. If it not present, the unit will be set to the default (µg/m³) DensityUnit object
declarations[].voc.emission.densityUnit.code string Only if declarations[].voc.emission.densityUnit is present The density unit code data[].code in VOCUnitsLookup
declarations[].voc.emission.regulatoryStandardCompliances[] array of object no The list of compliant standard VOC Emission compliance object(s)
declarations[].voc.emission.regulatoryStandardCompliances[].collectionBehavior string only if declarations[].voc.emission.exemptCompounds[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
declarations[].voc.emission.regulatoryStandardCompliances[].standard object only if declarations[].voc.emission.regulatoryStandardCompliances[] is present A compliant standard Standard object
declarations[].voc.emission.regulatoryStandardCompliances[].standard.code string only if declarations[].voc.emission.regulatoryStandardCompliances[] is present The standard code See the references
  • Sample Request (Update of declarations attributes):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "url":"https://public.facing.url/declaration.pdf",
      "declarationNumber":"123456",
      "issueDate":"2008-09-15T15:53:00",
      "expiryDate":"2010-09-15T15:53:00"
    }
  ]
}
  • Sample Request (Update of standard):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "standard":{
        "code":"EPD"
      }
    }
  ]
}
  • Sample Request (Update of reporting body):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "reportingBody":{
        "name":"Veritas"
      }
    }
  ]
}
  • Sample Request (Update the declaration by ADDING a brand):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "brands":[
        {
          "collectionBehavior":"ADD",
          "name":"ACME Inc.",
          "website":"www.acmexyz.com"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by UPDATING a brand website):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
       "brands":[
        {
          "collectionBehavior":"ADD",
          "name":"ACME Inc.",
          "website":"www.acmexyz-2000.com"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by REMOVING a brand.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "brands":[
        {
          "collectionBehavior":"REMOVE",
          "name":"ACME Inc."
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by ADDING a contact):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"ADD",
          "externalId":"JOHNSMITHVENDOR1",
          "type":"VENDOR",
          "companyName":"ACME Inc.",
          "name":"John Smith",
          "website":"https://www.acme.com/",
          "postalAddress":"2500 Street Avenue P.O. Box 999 Manchester, PA 1234",
          "phone":"1-999-123-1234",
          "email":"salesrep@acme.com"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by UPDATING a contact website):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"ADD",
          "externalId":"JOHNSMITHVENDOR1",
          "website":"https://www.acme-2000.com/"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by REMOVING a contact):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"REMOVE",
          "externalId":"JOHNSMITHVENDOR1"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by ADDING a document):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "additionalsDocuments":[
        {
          "collectionBehavior":"ADD",
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by REMOVING a document):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "additionalsDocuments":[
        {
          "collectionBehavior":"REMOVE",
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration visibility. ADD channel = PUBLISH on that channel):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "channels":[
        {
          "collectionBehavior":"ADD",
          "name":"ORIGIN"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration visibility. REMOVE channel = UNPUBLISH from that channel):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "channels":[
        {
          "collectionBehavior":"REMOVE",
          "name":"ORIGIN"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by ADDING a regulatory standard compliance):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "regulatoryStandardCompliances":[
        {
          "collectionBehavior":"ADD",
          "code":"ISO 9001"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by REMOVING a regulatory standard compliance):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "regulatoryStandardCompliances":[
        {
          "collectionBehavior":"REMOVE",
          "code":"ISO 9001"
        }
      ]
    }
  ]
}
  • Sample Request (Update the declaration by ADDING a custom feature):

Note : If the feature already exist, nothing happen.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"ADD",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by UPDATING a custom feature) New and Recommanded way with originId:

Note : To update a custom feature, the custom feature code and originId must be identical to those returned by the DeclarationsSearch to be updated

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"ADD",
               "originId":"93a7e4f2-3443-4cd9-befa-d54cb8760357",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"2000C"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by UPDATING a custom feature) Old and Not Recommanded way:

Note : To update a custom feature, you must delete the old custom feature and add the new custom feature. The old custom feature payload must be identical to the payload returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"REMOVE",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            },
            {
               "collectionBehavior":"ADD",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"2000C"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by REMOVING a custom feature.) New and Recommanded way with originId:

Note : If the feature does not exist, nothing happen. The custom feature code and originId must be identical to those returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"REMOVE",
               "originId":"93a7e4f2-3443-4cd9-befa-d54cb8760357",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by REMOVING a custom feature.) Old and Not Recommanded way:

Note : If the feature does not exist, nothing happen. The custom feature payload must be identical to the payload returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"REMOVE",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by ADDING a property feature):

Note : If the feature already exist, nothing happen.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"ADD",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by UPDATING a property feature) New and Recommanded way with originId:

Note : To update a property feature, the property feature code and originId must be identical to those returned by the DeclarationsSearch to be updated.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"ADD",
               "originId":"2c3b80e3-c1de-4a93-b2db-a7143962fdea",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"24"
               },
               "unit":{
                  "code":"MONTH"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by UPDATING a property feature) Old and Not Recommanded way:

Note : To update a property feature, you must delete the old property feature and add the new property feature. The old property feature payload must be identical to the payload returned by the DeclarationsSearch to be removed.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"REMOVE",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            },
            {
               "collectionBehavior":"ADD",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"24"
               },
               "unit":{
                  "code":"MONTH"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by REMOVING a property feature.) New and Recommanded way with originId:

Note : If the feature does not exist, nothing happen. The property feature code and originId must be identical to those returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"REMOVE",
               "originId":"2c3b80e3-c1de-4a93-b2db-a7143962fdea",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            }
         ]
      }
   ]
}
  • Sample Request (Update the declaration by REMOVING a property feature.) Old and Not Recommanded way:

Note : If the feature does not exist, nothing happen. The property feature payload must be identical to the payload returned by the DeclarationsSearch to be removed.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"REMOVE",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            }
         ]
      }
   ]
}

For more sample requests related to features, please see the Advanced Guidelines Multilingual Declaration Features

  • Sample Request (Update the declaration voc content by UPDATING its attributes.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "densityLimitGL":"40",
          "densityUnit": {
            "code": "EM_UGM3"
          },  
          "containsAddedMCPCE":"true"
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by ADDING a regulatory standard compliance.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"Hong Kong Air Pollution Control (VOC) regulation"
              },
              "productTypeCode":"Graphic arts (sign) coatings"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by REMOVING a regulatory standard compliance.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"Hong Kong Air Pollution Control (VOC) regulation"
              },
              "productTypeCode":"Graphic arts (sign) coatings"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by ADDING a custom standard compliance.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCustoms":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by REMOVING a custom standard compliance.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCustoms":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by ADDING a test method.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "testMethods":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by REMOVING a test method.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "testMethods":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by ADDING an exempt compound.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"ADD",
              "CAS":"109-99-9",
              "name":"Tetrahydrofuran",
              "percentByWeight":"1"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by UPDATING an exempt compound attributes.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"ADD",
              "CAS":"109-99-9",
              "name":"Tetrahydrofuran",
              "percentByWeight":"1.5"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc content by REMOVING an exempt compound.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"REMOVE",
              "CAS":"109-99-9"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc emission by UPDATING its attributes.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "densityMinGL":"250",
          "densityMaxGL":"500",
          "densityUnit": {
            "code": "EM_MGM2H"
          },          
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc emission by ADDING a regulatory standard compliance.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"CDPH Standard Method 2010 v1.1"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the declaration voc emission by REMOVING a regulatory standard compliance.):
{
  "declarations":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "densityMinGL":"250",
          "densityMaxGL":"500",
          "densityUnit": {
            "code": "EM_MGM2H"
          },  
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"CDPH Standard Method 2010 v1.1"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (All fields):
{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "declarationNumber":"ABC-123-000001",
         "url":"https://public.facing.url/declaration.pdf",
         "issueDate":"2008-09-15T15:53:00",
         "expiryDate":"2010-09-15T15:53:00",
         "additionalsDocuments":[
            {
               "collectionBehavior":"ADD",
               "originalUrl":"https://public.facing.url/image.jpg"
            }
         ],
         "regulatoryStandardCompliances":[
            {
               "code":"ISO 9001"
            }
         ],
         "reportingBody":{
            "name":"Veritas"
         },
         "standard":{
            "code":"EPD"
         },
         "brands":[
            {
               "collectionBehavior":"ADD",
               "name":"ACME Inc.",
               "website":"www.acmexyz.com"
            }
         ],
         "contacts":[
            {
               "collectionBehavior":"ADD",
               "externalId":"JOHNSMITHVENDOR1",
               "type":"VENDOR",
               "companyName":"ACME Inc.",
               "name":"John Smith",
               "website":"https://www.acme.com/",
               "postalAddress":"2500 Street Avenue P.O. Box 999 Manchester, PA 1234",
               "phone":"1-999-123-1234",
               "email":"salesrep@acme.com"
            }
         ],
         "channels":[
            {
               "collectionBehavior":"ADD",
               "name":"ORIGIN"
            }
         ],
         "featuresCustoms":[
            {
               "collectionBehavior":"ADD",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ],
         "featuresProperties":[
            {
               "collectionBehavior":"ADD",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            },
            {
               "collectionBehavior":"ADD",
               "code":"FSC_LABEL_TYPE",
               "value":{
                  "code":"FSC 100%"
               }
            }
         ],
         "voc":{
            "content":{
               "densityLimitGL":"10",
               "densityUnit": {
                  "code": "EM_GL"
                },  
               "containsAddedMCPCE":"true",
               "regulatoryStandardCompliances":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"CARB SCM (2007)"
                     },
                     "productTypeCode":"Specialty Coatings - Bituminous Roof Coatings"
                  }
               ],
               "regulatoryStandardCustoms":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"A CUSTOM CODE"
                     }
                  }
               ],
               "testMethods":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"ASTM Methods D2369"
                     }
                  }
               ],
               "exemptCompounds":[
                  {
                     "collectionBehavior":"ADD",
                     "CAS":"142731-63-32",
                     "name":"TRANS-3-HEPTENE",
                     "percentByWeight":"1.9"
                  }
               ]
            },
            "emission":{
               "densityMin":"250",
               "densityMax":"500",
               "densityUnit": {
                  "code": "EM_MGM2H"
                },  
               "regulatoryStandardCompliances":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"Blue Angel Elastic Floorings"
                     }
                  }
               ]
            }
         }
      }
   ]
}
  • Response (sync mode) :
Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of error causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'DECLARATION'
result.result object On success A simple completion message 'Update completed.'
connectRequest object Always The exact request sent that produced this response A DeclarationsUpdate request
  • Sample Response (Success in sync mode):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"DECLARATION",
    "result":"Update completed."
  },
  "connectRequest":{
    "declarations":[
      {
        "locale":"en",
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
        "url":"https://public.facing.url/declaration.pdf"
      }
    ]
  }
}
  • Response (async mode):
Field Type Presence Description Domain of value
status object Always The execution status A status object
status[].state string Always The state of execution 'SUCCESS' or 'ERROR'
status[].code string On error The general error code and message See Errors reference
status[].messages[] array of string On error List of errors causes A validation message or other causes
result object On success The execution result A result object
result.poolingCallback string On success The URL callback to pool using the ResultGet endpoint A URL
connectRequest object Always The exact request you sent that produced this response A DeclarationsCreate request
  • Sample Response (Success in async mode):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "poolingCallback":"https://origin.build/equinox/connect/v2/result/declarations_update/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2"
  },
  "connectRequest":{
    "declarations":[
      {
        "locale":"en",
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
        "url":"https://public.facing.url/declaration.pdf"
      }
    ]
  }
}
  • Sample Response (Error):

    HTTP Code : 400, 500

{
  "status":{
    "state":"ERROR",
    "code":"CE00001 - Connect request failed validation. Refer to provided messages for details.",
    "messages":[
      "declarations[1] require one locale.",
      "declarations[1] require one originId or externalId.",
      "declarations[1] has invalid value ''ADD ITEM'' for field contact[1].collectionBehavior. Allowed value(s) : [ADD,REMOVE]",
      "declarations[1] require one externalId"
    ]
  },
  "connectRequest":{
    "declarations":[
      {
        "url":"https://public.facing.url/declaration.pdf",
        "contacts":{
          "collectionBehavior":"ADD ITEM",
          "name":"Jack Smith"
        }
      }
    ]
  }
}

results matching ""

    No results matching ""