v2 > Services > CollectionsUpdate

Update one or more collections in Origin.

  • URL

    /connect/v2/collections/update

    /connect/v2/async/collections/update

  • Method:

    POST

  • URL Params

    none

  • Request :

Field Type Required Description Domain of value
collections[] array of object At least one The list of collections to update Collection object(s)
collections[].locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
collections[].originId string Only if no collections[].externalId The collection unique origin ID A UUID
collections[].externalId string Only if no collections[].originId The collection unique ID in your system Any string
collections[].name string No The collection name Any string
collections[].description string No The collection description Any string
collections[].website string No The collection website A valid public facing URL
collections[].logoUrl object No The collection logo URL A logoUrl object
collections[].logoUrl.originalUrl string Only if collections[].logoUrl is present The logo URL A valid public facing URL

Sample Request (Add or Update externalId)

To add or update externalId on an existing collection, you must provide both originId and externalId.

{
  "collections": [
    {
      "locale": "en",
      "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
      "externalId": "MY-NEW-COLLECTION-ID"
    }
  ]
}

Sample Request (Update of collections attributes)

{
  "collections": [
    {
      "locale": "en",
      "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
      "name": "My new collection name",
      "description": "a new collection description",
      "website": "https://public.facing.url/mynewcollection.html"
    }
  ]
}

Sample Request (Update of logoUrl)

{
  "collections": [
    {
      "locale": "en",
      "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
      "logoUrl": {
        "originalUrl": "https://public.facing.url/newlogo.jpg"
      }
    }
  ]
}

Sample Request (All fields)

{
  "collections": [
    {
      "locale": "en",
      "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
      "name": "My new collection name",
      "description": "a new collection description",
      "website": "https://public.facing.url/mynewcollection.html",
      "logoUrl": {
        "originalUrl": "https://public.facing.url/newlogo.jpg"
      }
    }
  ]
}
  • 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 'COLLECTION'
result.result object On success A simple completion message 'Update completed.'
connectRequest object Always The exact request sent that produced this response A CollectionsUpdate request

Sample Response (Success in sync mode)

  • HTTP Code : 200
{
  "status": {
    "state": "SUCCESS"
  },
  "result": {
    "entityType": "COLLECTION",
    "result": "Update completed."
  },
  "connectRequest": {
    "collections": [
      {
        "locale": "en",
        "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
        "website": "https://public.facing.url/collection"
      }
    ]
  }
}
  • 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 CollectionsUpdate request

Sample Response (Success in async mode)

  • HTTP Code : 200
{
  "status": {
    "state": "SUCCESS"
  },
  "result": {
    "poolingCallback": "https://origin.build/connect/v2/result/collections_update/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2"
  },
  "connectRequest": {
    "collections": [
      {
        "locale": "en",
        "originId": "88dada05-5d38-4b60-91b9-f1bf9d6bf5dd",
        "website": "https://public.facing.url/collection"
      }
    ]
  }
}

Sample Response (Error)

  • HTTP Code : 400, 500
{
  "status": {
    "state": "ERROR",
    "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
    "messages": [
      "collections[1] has invalid value 'eee' for field locale. Allowed value(s) : [de, es_MX, en, fr, zh_CN]",
      "collections[1] has invalid value 'Empty string' for field name. Allowed value(s) : [Non-empty string]",
      "collections[1] require one originId or externalId.",
      "collections[1] require one logoUrl.originalUrl."
    ]
  },
  "connectRequest": {
    "collections": [
      {
        "locale": "eee",
        "name": "",
        "description": "a new collection description",
        "logoUrl": {
        }
      }
    ]
  }
}

results matching ""

    No results matching ""