POST /compare/share

Generate a permanent identifier for sharing a product comparison

Body Required

left_product string Required

id or alias of the left product in the comparison
right_product string Required

id or alias of the right product in the comparison

Responses

201

successful operation
Hide response attributes Show response attributes object
- data object
  
  Hide data attributes Show data attributes object
  
  left_product object
  
  Hide left_product attributes Show left_product attributes object
  
  id integer
  
  alias string
  
  right_product object
  
  Hide right_product attributes Show right_product attributes object
  
  id integer
  
  alias string
  
  share_token string(uuid)
- links object
  
  Hide links attributes Show links attributes object
  
  left_product string(url)
  
  right_product string(url)
  
  left_analysis string(url)
  
  right_analysis string(url)
400

Bad Request
401

Authorization information is missing or invalid.
422

Unprocessable Entity
500

Server Error

POST /compare/share

curl \
 -X POST https://api.cosmily.com/api/v1/compare/share \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"left_product":"string","right_product":"string"}'

Request example

{
  "left_product": "string",
  "right_product": "string"
}

Request examples

{
  "left_product": "string",
  "right_product": "string"
}

Response examples (201)

{
  "data": {
    "left_product": {
      "id": 42,
      "alias": "string"
    },
    "right_product": {
      "id": 42,
      "alias": "string"
    },
    "share_token": "string"
  },
  "links": {
    "left_product": "string",
    "right_product": "string",
    "left_analysis": "string",
    "right_analysis": "string"
  }
}

Response examples (201)

{
  "data": {
    "left_product": {
      "id": 42,
      "alias": "string"
    },
    "right_product": {
      "id": 42,
      "alias": "string"
    },
    "share_token": "string"
  },
  "links": {
    "left_product": "string",
    "right_product": "string",
    "left_analysis": "string",
    "right_analysis": "string"
  }
}