GET /product_drafts

GET /product_drafts

Fetch all product drafts

Query parameters

  • expand string

    boolean flag to expand associated entities in the response

  • page integer

    requested page number

    Minimum value is 1. Default value is 1.

  • page_size integer

    requested page size

    Minimum value is 1, maximum value is 100. Default value is 12.

Responses

  • 200

    successful operation

    Hide response attributes Show response attributes array[object]
    • id integer(int32)
    • author_user_id integer(int32)
    • reviewer_user_id integer(nullable)
    • product_attributes object
      Hide product_attributes attributes Show product_attributes attributes object
      • image string
      • title string
      • brand_id integer(int32)
      • raw_label string
      • category_id integer
    • ingredient_classifications array[object]
      Hide ingredient_classifications attributes Show ingredient_classifications attributes array[object]
      • label_text string
      • label_order integer(int32)
      • normalized_label string
      • recognized_ingredients array[object]
        Hide recognized_ingredients attributes Show recognized_ingredients attributes array[object]
        • id integer(int32)
        • title string
      • classified_ingredient_id integer(int32)
    • draft_version integer(int32)
    • created_at string(DateTime)
    • updated_at string(DateTime)
    • approved_at string(nullable)
    • approved_product_id integer(int32)
    • brand object
      Hide brand attributes Show brand attributes object
      • id integer
      • alias string
      • title string
      • created_at string(DateTime)
      • updated_at string(DateTime)
      • owner_user_id integer
    • category object
      Hide category attributes Show category attributes object
      • id integer(int32)
      • title string
      • alias string
      • menuindex integer(int32)
      • parent_id integer(int32)
    • approved_product object
      Hide approved_product attributes Show approved_product attributes object
      • id integer(int32)
      • full_title string
      • alias string
      • image string(nullable)
    • 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
  • 400

    Bad Request

  • 401

    Authorization information is missing or invalid.

  • 500

    Server Error

GET /product_drafts
curl \
 -X GET https://api.cosmily.com/api/v1/product_drafts \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "id": 42,
    "author_user_id": 42,
    "reviewer_user_id": 42,
    "product_attributes": {
      "image": "string",
      "title": "string",
      "brand_id": 42,
      "raw_label": "string",
      "category_id": 42
    },
    "ingredient_classifications": [
      {
        "label_text": "string",
        "label_order": 42,
        "normalized_label": "string",
        "recognized_ingredients": [
          {
            "id": 42,
            "title": "string"
          }
        ],
        "classified_ingredient_id": 42
      }
    ],
    "draft_version": 42,
    "created_at": "string",
    "updated_at": "string",
    "approved_at": "string",
    "approved_product_id": 42,
    "brand": {
      "id": 42,
      "alias": "string",
      "title": "string",
      "created_at": "string",
      "updated_at": "string",
      "owner_user_id": 42
    },
    "category": {
      "id": 42,
      "title": "string",
      "alias": "string",
      "menuindex": 42,
      "parent_id": 42
    },
    "approved_product": {
      "id": 42,
      "full_title": "string",
      "alias": "string",
      "image": "string"
    },
    "product_image": {
      "id": 42,
      "product_id": 42,
      "product_draft_id": 42,
      "image": "string",
      "url": "string"
    }
  }
]
Response examples (200)
[
  {
    "id": 42,
    "author_user_id": 42,
    "reviewer_user_id": 42,
    "product_attributes": {
      "image": "string",
      "title": "string",
      "brand_id": 42,
      "raw_label": "string",
      "category_id": 42
    },
    "ingredient_classifications": [
      {
        "label_text": "string",
        "label_order": 42,
        "normalized_label": "string",
        "recognized_ingredients": [
          {
            "id": 42,
            "title": "string"
          }
        ],
        "classified_ingredient_id": 42
      }
    ],
    "draft_version": 42,
    "created_at": "string",
    "updated_at": "string",
    "approved_at": "string",
    "approved_product_id": 42,
    "brand": {
      "id": 42,
      "alias": "string",
      "title": "string",
      "created_at": "string",
      "updated_at": "string",
      "owner_user_id": 42
    },
    "category": {
      "id": 42,
      "title": "string",
      "alias": "string",
      "menuindex": 42,
      "parent_id": 42
    },
    "approved_product": {
      "id": 42,
      "full_title": "string",
      "alias": "string",
      "image": "string"
    },
    "product_image": {
      "id": 42,
      "product_id": 42,
      "product_draft_id": 42,
      "image": "string",
      "url": "string"
    }
  }
]