GET /routines/:id/compatibility

GET /routines/{id}/compatibility

Returns a routine step ingredients compatibility

Path parameters

  • id integer(int64) Required

    ID of the resource to fetch

Responses

  • 200

    successful operation

    Hide response attributes Show response attributes array[object]
    • left_product object
      Hide left_product attributes Show left_product attributes object
      • id integer
      • title string
      • alias string
      • routine_step_id integer
      • product_category_id integer
      • product_category object
        Hide product_category attributes Show product_category attributes object
        • id integer
        • title string
        • alias string
      • product_image object
        Hide product_image attributes Show product_image attributes object
        • id integer
        • product_id integer
        • product_draft_id integer
        • image string
        • url string
      • brand_id integer
      • brand object
        Hide brand attributes Show brand attributes object
        • id integer
        • title string
        • alias string
    • right_product object
      Hide right_product attributes Show right_product attributes object
      • id integer
      • title string
      • alias string
      • routine_step_id integer
      • product_category_id integer
      • product_category object
        Hide product_category attributes Show product_category attributes object
        • id integer
        • title string
        • alias string
      • product_image object
        Hide product_image attributes Show product_image attributes object
        • id integer
        • product_id integer
        • product_draft_id integer
        • image string
        • url string
      • brand_id integer
      • brand object
        Hide brand attributes Show brand attributes object
        • id integer
        • title string
        • alias string
    • results object
      Hide results attributes Show results attributes object
      • compatible? boolean
      • benefit_reasons array[object]
        Hide benefit_reasons attributes Show benefit_reasons attributes array[object]
        • ingredient_1 string
        • ingredient_2 string
        • reason string
      • incompatible_reasons array[object]
        Hide incompatible_reasons attributes Show incompatible_reasons attributes array[object]
        • ingredient_1 string
        • ingredient_2 string
        • reason string
  • 400

    Bad Request

  • 401

    Authorization information is missing or invalid.

  • 404

    Routine Not Found

  • 500

    Server Error

GET /routines/{id}/compatibility
curl \
 -X GET https://api.cosmily.com/api/v1/routines/{id}/compatibility \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "left_product": {
      "id": 42,
      "title": "string",
      "alias": "string",
      "routine_step_id": 42,
      "product_category_id": 42,
      "product_category": {
        "id": 42,
        "title": "string",
        "alias": "string"
      },
      "product_image": {
        "id": 42,
        "product_id": 42,
        "product_draft_id": 42,
        "image": "string",
        "url": "string"
      },
      "brand_id": 42,
      "brand": {
        "id": 42,
        "title": "string",
        "alias": "string"
      }
    },
    "right_product": {
      "id": 42,
      "title": "string",
      "alias": "string",
      "routine_step_id": 42,
      "product_category_id": 42,
      "product_category": {
        "id": 42,
        "title": "string",
        "alias": "string"
      },
      "product_image": {
        "id": 42,
        "product_id": 42,
        "product_draft_id": 42,
        "image": "string",
        "url": "string"
      },
      "brand_id": 42,
      "brand": {
        "id": 42,
        "title": "string",
        "alias": "string"
      }
    },
    "results": {
      "compatible?": true,
      "benefit_reasons": [
        {
          "ingredient_1": "string",
          "ingredient_2": "string",
          "reason": "string"
        }
      ],
      "incompatible_reasons": [
        {
          "ingredient_1": "string",
          "ingredient_2": "string",
          "reason": "string"
        }
      ]
    }
  }
]
Response examples (200)
[
  {
    "left_product": {
      "id": 42,
      "title": "string",
      "alias": "string",
      "routine_step_id": 42,
      "product_category_id": 42,
      "product_category": {
        "id": 42,
        "title": "string",
        "alias": "string"
      },
      "product_image": {
        "id": 42,
        "product_id": 42,
        "product_draft_id": 42,
        "image": "string",
        "url": "string"
      },
      "brand_id": 42,
      "brand": {
        "id": 42,
        "title": "string",
        "alias": "string"
      }
    },
    "right_product": {
      "id": 42,
      "title": "string",
      "alias": "string",
      "routine_step_id": 42,
      "product_category_id": 42,
      "product_category": {
        "id": 42,
        "title": "string",
        "alias": "string"
      },
      "product_image": {
        "id": 42,
        "product_id": 42,
        "product_draft_id": 42,
        "image": "string",
        "url": "string"
      },
      "brand_id": 42,
      "brand": {
        "id": 42,
        "title": "string",
        "alias": "string"
      }
    },
    "results": {
      "compatible?": true,
      "benefit_reasons": [
        {
          "ingredient_1": "string",
          "ingredient_2": "string",
          "reason": "string"
        }
      ],
      "incompatible_reasons": [
        {
          "ingredient_1": "string",
          "ingredient_2": "string",
          "reason": "string"
        }
      ]
    }
  }
]