v2 > Services > DeclarationsCreate

Create one or more declarations in Origin.

• URL

  /connect/v2/declarations/create

  /connect/v2/async/declarations/create

• Method:

  POST

• URL Params

  none

• Request :

Sample Request (Required fields)

{
  "declarations":[
    {
      "locale":"en",
      "externalId":"ABC-123",
      "reportingBody":{
        "name":"Veritas"
      },
      "standard":{
        "code":"EPD"
      }
    }
  ]
}

Sample Request (All fields)

{
  "declarations":[
    {
      "locale":"en",
      "externalId":"ABC-123",
      "declarationNumber":"ABC-123-000001",
      "url":"https://public.facing.url/declaration.pdf",
      "additionalsDocuments":[
        {
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ],
      "reportingBody":{
        "name":"Veritas"
      },
      "standard":{
        "code":"EPD"
      },
      "issueDate":"2008-09-15T15:53:00",
      "expiryDate":"2010-09-15T15:53:00",
      "brands":[
        {
          "name":"ACME Inc.",
          "website":"www.acmexyz.com"
        }
      ],
      "contacts":[
        {
          "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":[
        {
          "name":"ORIGIN"
        }
      ],
      "regulatoryStandardCompliances":[
        {
          "code":"ISO 9001"
        }
      ],
      "featuresCustoms":[
        {
          "code":"CUSTOM_TEXT_ATTRIBUTE",
          "name":"Highest supported temperature",
          "value":{
            "content":"1500C"
          }
        }
      ],
      "featuresProperties":[
        {
          "code":"LIFEEXPECTANCY",
          "value":{
            "content":"3"
          },
          "unit":{
            "code":"YEAR"
          }
        },
        {
          "code":"FSC_LABEL_TYPE",
          "value":{
            "code":"FSC 100%"
          }
        }
      ],
      "voc":{
        "content":{
          "densityLimitGL":"10",
          "densityUnit": {
            "code": "EM_GL"
          },
          "containsAddedMCPCE":"true",
          "regulatoryStandardCompliances":[
            {
              "standard":{
                "code":"CARB SCM (2007)"
              },
              "productTypeCode":"Specialty Coatings - Bituminous Roof Coatings"
            }
          ],
          "regulatoryStandardCustoms":[
            {
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ],
          "testMethods":[
            {
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ],
          "exemptCompounds":[
            {
              "CAS":"142731-63-32",
              "name":"TRANS-3-HEPTENE",
              "percentByWeight":"1.9"
            }
          ]
        },
        "emission":{
          "densityMin":"250",
          "densityMax":"500",
          "densityUnit": {
            "code": "EM_UGM3"
          },
          "regulatoryStandardCompliances":[
            {
              "standard":{
                "code":"Blue Angel Elastic Floorings"
              }
            }
          ]
        }
      }
    }
  ]
}

Sample Request (End of Life Circularity Driver)

{
  "declarations":[
    {
      "locale":"en",
      "externalId":"EOL-001",
      "declarationNumber":"MY-EOL-001",
      "reportingBody":{
        "selfReported":"true"
      },
      "standard":{
        "code":"END_OF_LIFE_CIRCULARITY_DRIVER"
      },
      "channels":[
        {
          "name":"ORIGIN"
        }
      ],
      "featuresProperties":[
        {
          "code":"EOL_CIRCULARITY_DRIVER",
          "value":{
            "code":"eolProgramWithContract"
          }
        },
        {
          "code":"APPLICABLE_CITY",
          "value":{
            "location":{
              "cityDetails":{
                "originId":"b8315bb8-6ced-4708-902b-962055b21e51"
              }
            }
          }
        }
      ]
    }
  ]
}

• Response (sync mode) :

Sample Response (Success in sync mode)

• HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"DECLARATION",
    "correlations":[
      {
        "externalId":"ABC-123",
        "originId":"f6f2c73e-4054-44bc-95f2-9e033b9c2282"
      }
    ]
  },
  "connectRequest":{
    "declarations":[
      {
        "locale":"en",
        "externalId":"ABC-123",
        "declarationNumber":"123456",
        "url":"https://public.facing.url/declaration.pdf",
        "reportingBody":{
          "name":"Veritas"
        },
        "standard":{
          "code":"EPD"
        }
      }
    ]
  }
}

• Response (async mode):

Sample Response (Success in async mode)

• HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "poolingCallback": "https://origin.build/connect/v2/result/declarations_create/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2"
  },
  "connectRequest":{
    "declarations":[
      {
        "locale":"en",
        "externalId":"ABC-123",
        "declarationNumber":"123456",
        "url":"https://public.facing.url/declaration.pdf",
        "reportingBody":{
          "name":"Veritas"
        },
        "standard":{
          "code":"EPD"
        }
      }
    ]
  }
}

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 externalId.",
      "declarations[1] require one reportingBody.name or reportingBody.selfReported.",
      "declarations[1] require one standard.code.",
      "declarations[1] has an invalid date format for issueDate. Date must be ISO-8601.",
    ]
  },
  "connectRequest":{
    "declarations":[
      {
        "declarationNumber":"123456",
        "issueDate":"2017-09-15T15:53:00ZBC",
        "expiryDate":"2018-09-15T15:53:00"
      }
    ]
  }
}