v1 > Services > MaterialsUpdate

Update one or more materials in Origin.

  • URL

    /connect/v1/materials/update

    /connect/v1/async/materials/update

  • Method:

    POST

  • URL Params

    none

  • Request :

Field Type Required Description Domain of value
materials[] array of object At least one The list of materials to update Material object(s)
materials[].locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
materials[].originId string Only if no materials[].externalId The material unique origin ID Any string
materials[].externalId string Only if no materials[].originId The material unique ID in your system Any string
materials[].productId string No An identification code (ex: a catalog id, SKU code) Any string
materials[].managementPermission string No The access permission profile COMPANY_READONLY, COMPANY_EDITABLE, ONLY_ME
materials[].name string No The material name Any string
materials[].description string No The material description Any string
materials[].brand object No The material brand A brand object
materials[].brand.name string Only if materials[].brand is present The brand name Any string
materials[].brand.website string No The brand website A valid public facing URL
materials[].logoUrl object No The material logo URL. In Origin, It refers to the material thumbnail image and the first image of the material. This image can also be set in Origin Website -> Material edit page -> Image Section -> Featured Image checkbox. A logoUrl object
materials[].logoUrl.originalUrl string Only if materials[].logoUrl is present The logo URL A valid public facing URL
materials[].collection object No The Material collection (ex: winter collection) A collection object
materials[].collection.name string Only if materials[].collection is present The collection name Any string
materials[].libraries[] array of object No The list of libraries for the material Library object(s)
materials[].libraries[].collectionBehavior string Only if materials[].libraries[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].libraries[].name string Only if materials[].libraries[] is present The library name Any string
materials[].category object No The category for the material A category object
materials[].category.name string Only if materials[].category is present The category name See CategoriesLookup for a list of possible values
materials[].csiDivisions[] array of object No The CSI Divisions for the material CsiDivision object(s)
materials[].csiDivisions[].collectionBehavior string Only if materials[].csiDivisions[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].csiDivisions[].code string Only if materials[].csiDivisions[] is present and if materials[].csiDivisions.name is empty The CSI Division code See CsiDivisionsLookup for a list of possible values
materials[].csiDivisions[].name string Only if materials[].csiDivisions[] is present and if materials[].csiDivisions.code is empty The CSI Division name See CsiDivisionsLookup for a list of possible values
materials[].idealProjects[] array of object No The list of ideal projects for the material IdealProject object(s)
materials[].idealProjects[].collectionBehavior string Only if materials[].idealProjects[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].idealProjects[].value string Only if materials[].idealProjects[] is present The ideal project value See PropertyDetailsLookup for a list of possible values with the code 'IDEALPROJECTS'
materials[].images[] array of object No The list of images for the material Image object(s)
materials[].images[].collectionBehavior string Only if materials[].images[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].images[].originalUrl string Only if materials[].images[] is present URL of an image related to the material A valid public facing URL
materials[].additionalsDocuments[] array of object No The list of document for the material Document object(s)
materials[].additionalsDocuments[].collectionBehavior string Only if materials[].additionalsDocuments[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].additionalsDocuments[].originalUrl string Only if materials[].additionalsDocuments[] is present URL of a document related to the material A valid public facing URL
materials[].contacts[] array of object No The related contacts Contact object(s)
materials[].contacts[].collectionBehavior string Only if materials[].contacts[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].contacts[].externalId string Only if materials[].contacts[] is present A unique identifier of your choosing that serves as a unique key for the contact Any string
materials[].contacts[].type string No The contact type MANUFACTURER, AUDITOR or VENDOR
materials[].contacts[].companyName string No The contact company name Any string
materials[].contacts[].name string No The contact name Any string
materials[].contacts[].website string No The contact website A valid public facing URL
materials[].contacts[].postalAddress string No The contact postal address Any string
materials[].contacts[].phone string No The contact phone Any string
materials[].contacts[].email string No The contact email A valid email
materials[].channels[] array of object The list of channels on which the material will be published Channel object(s). Not published if empty.
materials[].channels[].collectionBehavior string Only if materials[].channels[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].channels[].name string Only if materials[].channels[] is present The channel name 'ORIGIN' (more to come)
materials[].featuresCustoms[] array of object No The list of Origin Customs features for the material Custom feature object(s)
materials[].featuresCustoms[].collectionBehavior string Only if materials[].featuresCustoms[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].featuresCustoms[].name string Only if materials[].featuresCustoms[] is present The custom feature name Any string
materials[].featuresCustoms[].value string Only if materials[].featuresCustoms[] is present The custom feature value Any string
materials[].featuresProperties[] array of object No The list of Origin Properties features for the material Feature property object(s)
materials[].featuresProperties[].collectionBehavior string Only if materials[].featuresProperties[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].featuresProperties[].code string Only if materials[].featuresProperties[] is present The property feature code See PropertiesLookup for a list of possible values
materials[].featuresProperties[].value string Only if materials[].featuresProperties[] is present The property feature value See PropertyDetailsLookup for a list of possible values
materials[].featuresProperties[].unit string No The property feature unit See PropertyDetailsLookup for a list of possible values
materials[].tags[] array of object No The list of tags for the material Tag object(s)
materials[].tags[].collectionBehavior string Only if materials[].tags[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].tags[].name string Only if materials[].tags[] is present The tag name Any string
materials[].skus[] array of object No The list of SKUs for the material Sku object(s)
materials[].skus[].collectionBehavior string Only if materials[].skus[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].skus[].name string Only if materials[].skus[] is present The SKU name Any string
materials[].skus[].productId string No An identification code (ex: a catalog id, SKU code) Any string
materials[].skus[].images[] array of object No The list of images for the SKU Image object(s)
materials[].skus[].images[].collectionBehavior string Only if materials[].skus[].images[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].skus[].images[].originalUrl string Only if materials[].skus[].images[] is present URL of an image related to the SKU A valid public facing URL
materials[].skus[].additionalsDocuments[] string No The list of document for the SKU Document object(s)
materials[].skus[].additionalsDocuments[].collectionBehavior string Only if materials[].skus[].additionalsDocuments[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].skus[].additionalsDocuments[].originalUrl string Only if materials[].skus[].additionalsDocuments[] is present URL of a document related to the SKU A valid public facing URL
materials[].skus[].featuresCustoms[] array of object No The list of Origin Customs features for the SKU Custom feature object(s)
materials[].skus[].featuresCustoms[].collectionBehavior string Only if materials[].skus[].featuresCustoms[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].skus[].featuresCustoms[].name string Only if materials[].skus[].featuresCustoms[] is present The custom feature name Any string
materials[].skus[].featuresCustoms[].value string Only if materials[].skus[].featuresCustoms[] is present The custom feature value Any string
materials[].skus[].featuresProperties[] array of object No The list of Origin Properties features for the SKU Feature property object
materials[].skus[].featuresProperties[].collectionBehavior string Only if materials[].skus[].featuresProperties[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].skus[].featuresProperties[].code string Only if materials[].skus[].featuresProperties[] is present The property feature code See PropertiesLookup for a list of possible values
materials[].skus[].featuresProperties[].value string Only if materials[].skus[].featuresProperties[] is present The property feature value See PropertyDetailsLookup for a list of possible values
materials[].skus[].featuresProperties[].unit string No The property feature unit See PropertyDetailsLookup for a list of possible values
materials[].connectedCertifications[] array of object No The list of certifications connected to the material Certification object(s)
materials[].connectedCertifications[].collectionBehavior string Only if materials[].connectedCertifications[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].connectedCertifications[].originId string Only if materials[].connectedCertifications[] is present The certification unique origin ID Any string
materials[].connectedDeclarations[] array of object No The list of declarations connected to the material Declaration object(s)
materials[].connectedDeclarations[].collectionBehavior string Only if materials[].connectedDeclarations[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
materials[].connectedDeclarations[].originId string Only if materials[].connectedDeclarations[] is present The declaration unique origin ID Any string
materials[].url string No The material URL A valid public facing URL
  • Sample Request (Update of materials attributes):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "productId": "MY-MAT-001",
            "managementPermission": "ONLY_ME",
            "name": "My material",
            "description": "a new material description",
            "url": "https://public.facing.url/mynewmaterial.html"
        }
    ]
}
  • Sample Request (Update of brand):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "brand": {
                "name": "ACME new brand.",
                "website": "www.acmenewxyz.com"
            }
        }
    ]
}
  • Sample Request (Update of category):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "category": {
                "name": "DOORS"
            }
        }
    ]
}
  • Sample Request (Update of logoUrl):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "logoUrl": {
                "originalUrl": ""https://public.facing.url/newlogo.jpg""
            }
        }
    ]
}
  • Sample Request (Update of collection):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "collection": {
                "name": "Summer Collection"
            }
        }
    ]
}
  • Sample Request (Update the material by ADDING a library):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "libraries": [
                {
                    "collectionBehavior": "ADD",
                    "name": "My new Library"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a library):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "libraries": [
                {
                    "collectionBehavior": "REMOVE",
                    "name": "My Acme Library"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a CSI division):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "csiDivisions": [
                {
                    "collectionBehavior": "ADD",
                    "code": "126800",
                    "name": "Seat and Table Assemblies"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a CSI division):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "csiDivisions": [
                {
                    "collectionBehavior": "REMOVE",
                    "code": "126800"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING an ideal project):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "idealProjects": [
                {
                    "collectionBehavior": "ADD",
                    "value": "COMMERCIAL"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING an ideal project):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "idealProjects": [
                {
                    "collectionBehavior": "REMOVE",
                    "value": "COMMERCIAL"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING an image):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "images": [
                {
                    "collectionBehavior": "ADD",
                    "originalUrl": "https://public.facing.url/image2.jpg"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING an image):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "images": [
                {
                    "collectionBehavior": "REMOVE",
                    "originalUrl": "https://public.facing.url/image2.jpg"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a document):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "additionalsDocuments": [
                {
                    "collectionBehavior": "ADD",
                    "originalUrl": "https://public.facing.url/document.doc"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a document):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "additionalsDocuments": [
                {
                    "collectionBehavior": "REMOVE",
                    "originalUrl": "https://public.facing.url/document.doc"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a contact):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "contacts": [
                {
                    "collectionBehavior": "ADD",
                    "externalId": "JOHNSMITHAUDITOR1",
                    "type": "AUDITOR",
                    "companyName": "ACME Inc.",
                    "name": "John Smith",
                    "website": "https://www.acme.com/",
                    "postalAddress": "2500 Street Avenues",
                    "phone": "1-999-123-1234",
                    "email": "auditsrep@acme.com"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by UPDATING a contact website):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "contacts": [
                {
                    "collectionBehavior": "ADD",
                    "externalId": "JOHNSMITHAUDITOR1",
                    "website": "https://www.acme-2000.com/"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a contact):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "contacts": [
                {
                    "collectionBehavior": "REMOVE",
                    "externalId": "JOHNSMITHAUDITOR1"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material visibility. ADD channel = PUBLISH on that channel):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "channels": [
                {
                    "collectionBehavior": "ADD",
                    "name": "ORIGIN"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material visibility. REMOVE channel = UNPUBLISH from that channel):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "channels": [
                {
                    "collectionBehavior": "REMOVE",
                    "name": "ORIGIN"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a custom feature):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd"
            "featuresCustoms": [
                {
                    "collectionBehavior": "ADD",
                    "name": "Highest supported temperature",
                    "value": "1550C"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by UPDATING a custom feature.):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "featuresCustoms": [
                {
                    "collectionBehavior": "ADD",
                    "name": "Highest supported temperature",
                    "value": "2000C"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a custom feature.):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "featuresCustoms": [
                {
                    "collectionBehavior": "REMOVE",
                    "name": "Highest supported temperature"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a property feature):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "featuresProperties": [
                {
                    "collectionBehavior": "ADD",
                    "code": "LENGTH",
                    "value": "12",
                    "unit": "CENTIMETER"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by UPDATING a property feature):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "featuresProperties": [
                {
                    "collectionBehavior": "ADD",
                    "code": "LENGTH",
                    "value": "20",
                    "unit": "CENTIMETER"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a property feature):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "featuresProperties": [
                {
                    "collectionBehavior": "REMOVE",
                    "code": "LENGTH",
                    "value": "20"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a tag):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "tags": [
                {
                    "collectionBehavior": "ADD",
                    "name": "modern"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a tag):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "tags": [
                {
                    "collectionBehavior": "REMOVE",
                    "name": "modern"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a SKU):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "skus": [
                {
                    "collectionBehavior": "ADD",
                    "name": "New sku",
                    "productId": "SKU-A01",
                    "images": [
                        {
                            "collectionBehavior": "ADD",
                            "originalUrl": "https://public.facing.url/001.jpg"
                        }
                    ],
                    "additionalsDocuments": [
                        {
                            "collectionBehavior": "ADD",
                            "originalUrl": "https://public.facing.url/001.pdf"
                        }
                    ],
                    "featuresCustoms": [
                        {
                            "collectionBehavior": "ADD",
                            "name": "Highest supported temperature",
                            "value": "1550C"
                        }
                    ],
                    "featuresProperties": [
                        {
                            "collectionBehavior": "ADD",
                            "code": "LENGTH",
                            "value": "12",
                            "unit": "CENTIMETER"
                        }
                    ]
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a SKU):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "skus": [
                {
                    "collectionBehavior": "REMOVE",
                    "name": "New sku"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a connecting certification):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "connectedCertifications": [
                {
                    "collectionBehavior": "ADD",
                    "originId": "f6f2c73e-4054-44bc-95f2-9e033b9c2282"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a connecting certification):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "connectedCertifications": [
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "f6f2c73e-4054-44bc-95f2-9e033b9c2282"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by ADDING a connecting declaration):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "connectedDeclarations": [
                {
                    "collectionBehavior": "ADD",
                    "originId": "f6f2c73e-4054-44bc-95f2-9e033b9c2282"
                }
            ]
        }
    ]
}
  • Sample Request (Update the material by REMOVING a connecting declaration):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "connectedDeclarations": [
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "f6f2c73e-4054-44bc-95f2-9e033b9c2282"
                }
            ]
        }
    ]
}
  • Sample Request (All fields):
{
    "materials": [
        {
            "locale": "en",
            "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
            "productId": "MY-MAT-001",
            "managementPermission": "COMPANY_EDITABLE",
            "name": "My material",
            "description": "a new material description",
            "brand": {
                "name": "ACME Super brand.",
                "website": "www.acmesuperxyz.com"
            },
            "logoUrl": {
                "originalUrl": "https://public.facing.url/newlogo.jpg"
            },
            "collection": {
                "name": "Spring Collection"
            },
            "libraries": [
                {
                    "collectionBehavior": "ADD",
                    "name": "My Acme Library"
                }
            ],
            "category": {
                "name": "TABLES"
            },
            "csiDivisions": [
                {
                    "collectionBehavior": "ADD",
                    "code": "126800",
                    "name": "Seat and Table Assemblies"
                }
            ],
            "idealProjects": [
                {
                    "collectionBehavior": "ADD",
                    "value": "COMMERCIAL"
                }
            ],
            "images": [
                {
                    "collectionBehavior": "ADD",
                    "originalUrl": "https://public.facing.url/image2.jpg"
                }
            ],
            "additionalsDocuments": [
                {
                    "collectionBehavior": "ADD",
                    "originalUrl": "https://public.facing.url/document.doc"
                }
            ],
            "contacts": [
                {
                    "collectionBehavior": "ADD",
                    "externalId": "JOHNSMITHAUDITOR1",
                    "type": "AUDITOR",
                    "companyName": "ACME Inc.",
                    "name": "John Smith",
                    "website": "https://www.acme.com/",
                    "postalAddress": "2500 Street Avenues",
                    "phone": "1-999-123-1234",
                    "email": "auditsrep@acme.com"
                }
            ],
            "channels": [
                {
                    "collectionBehavior": "ADD",
                    "name": "ORIGIN"
                }
            ],
            "featuresCustoms": [
                {
                    "collectionBehavior": "ADD",
                    "name": "Highest supported temperature",
                    "value": "1550C"
                }
            ],
            "featuresProperties": [
                {
                    "collectionBehavior": "ADD",
                    "code": "LENGTH",
                    "value": "12",
                    "unit": "CENTIMETER"
                }
            ],
            "tags": [
                {
                    "collectionBehavior": "ADD",
                    "name": "modern"
                }
            ],
            "skus": [
                {
                    "collectionBehavior": "ADD",
                    "name": "New sku",
                    "productId": "SKU-A01",
                    "images": [
                        {
                            "collectionBehavior": "ADD",
                            "originalUrl": "https://public.facing.url/001.jpg"
                        }
                    ],
                    "additionalsDocuments": [
                        {
                            "collectionBehavior": "ADD",
                            "originalUrl": "https://public.facing.url/001.pdf"
                        }
                    ],
                    "featuresCustoms": [
                        {
                            "collectionBehavior": "ADD",
                            "name": "Highest supported temperature",
                            "value": "1550C"
                        }
                    ],
                    "featuresProperties": [
                        {
                            "collectionBehavior": "ADD",
                            "code": "LENGTH",
                            "value": "12",
                            "unit": "CENTIMETER"
                        }
                    ]
                }
            ],
            "connectedCertifications": [
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "f6f2c73e-4054-44bc-95f2-9e033b9c2282"
                }
            ],
            "url": "https://public.facing.url/mynewmaterial.html"
        }
    ]
}
  • 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 'MATERIAL'
result.result object On success A simple completion message 'Update completed.'
connectRequest object Always The exact request sent that produced this response A MaterialsUpdate request

  • Sample Response (Success in sync mode):

    HTTP Code : 200

{
    "status":{
        "state":"SUCCESS"
    },
    "result":{
        "entityType":"MATERIAL",
        "result":"Update completed."
    },
    "connectRequest":{
        "materials":[
            {
                "locale":"en",
                "originId":"88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
                "url":"https://public.facing.url/material"
            }
        ]
    }
}
  • 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 error 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 MaterialsUpdate request

  • Sample Response (Success in async mode):

    HTTP Code : 200

{
    "status":{
        "state":"SUCCESS"
    },
    "result":{
        "poolingCallback":"https://origin.build/equinox/connect/v1/result/materials_update/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2"
    },
    "connectRequest":{
        "materials": [
            {
                "locale": "en",
                "originId":"88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
                "url":"https://public.facing.url/material"
            }
        ]
    }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "materials[1] has invalid value 'eee' for field locale. Allowed value(s) : [de, es_MX, en, fr, zh_CN]",
            "materials[1] has invalid value 'Empty string' for field name. Allowed value(s) : [Non-empty string]",
            "materials[1] require one brand.name.",
            "materials[1] has invalid value 'COMPANY_WRITE' for field managementPermission. Allowed value(s) : [COMPANY_EDITABLE,COMPANY_READONLY,ONLY_ME]",
            "materials[1] require one originId or externalId.",
            "materials[1] has invalid value 'Empty string' for field productId. Allowed value(s) : [Non-empty string]",
            "materials[1] require one csiDivisions[1].code or csiDivisions[1].name.",
            "materials[1] has invalid value 'ADD_ITEM' for field libraries[1].collectionBehavior. Allowed value(s) : [ADD,REMOVE]",
            "materials[1] require one contacts[1].externalId.",
            "materials[1] require one skus[1].name.",
            "materials[1] require one logoUrl.originalUrl."
        ]
    },
    "connectRequest": {
        "materials": [
            {
                "locale": "eee",
                "productId": " ",
                "managementPermission": "COMPANY_WRITE",
                "name": "",
                "description": "a new material description",
                "brand": {
                    "website": "www.acmesuperxyz.com"
                },
                "logoUrl": {
                },
                "libraries": [
                    {
                        "collectionBehavior": "ADD_ITEM",
                        "name": "My Acme Library"
                    }
                ],
                "csiDivisions": [
                    {
                        "collectionBehavior": "ADD"
                    }
                ],
                "contacts": [
                    {
                        "collectionBehavior": "ADD",
                        "type": "AUDITOR",
                        "name": "John Smith",
                        "companyName": "ACME Inc.",
                        "website": "https://www.acme.com/",
                        "postalAddress": "2500 Street Avenues",
                        "phone": "1-999-123-1234",
                        "email": "auditsrep@acme.com"
                    }
                ],
                "skus": [
                    {
                        "collectionBehavior": "ADD",
                        "productId": "SKU-A01"
                    }
                ]
            }
        ]
    }
}

results matching ""

    No results matching ""