Get Bulk summary data with list of operations items full data

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Magento2 MCP server": {
    "url": "https://magento2.doc.winkelstraat.nl/mcp"
  }
}

Close
GET /V1/bulk/{bulkUuid}/detailed-status

Get Bulk summary data with list of operations items full data.

Path parameters

  • bulkUuid string Required

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • operations_list array[object] Required

      Operations list.

      Hide operations_list attributes Show operations_list attributes object

      Class OperationInterface

      • extension_attributes object

        ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\OperationInterface

        Hide extension_attributes attribute Show extension_attributes attribute object
        • start_time string
      • id integer Required

        Id

      • bulk_uuid string Required

        Bulk uuid

      • topic_name string Required

        Queue Topic

      • serialized_data string Required

        Data

      • result_serialized_data string Required

        Serialized Data

      • status integer Required

        Operation status

      • result_message string Required

        Result message

      • error_code integer Required

        Error code

    • extension_attributes object

      ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface

    • user_type integer Required

      User type

    • bulk_id string Required

      Bulk uuid

    • description string Required

      Bulk description

    • start_time string Required

      Bulk scheduled time

    • user_id integer Required

      User id

    • operation_count integer Required

      Total number of operations scheduled in scope of this bulk

    Hide response attributes Show response attributes object
    • operations_list array[object] Required

      Operations list.

      Hide operations_list attributes Show operations_list attributes object

      Class OperationInterface

      • extension_attributes object

        ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\OperationInterface

        Hide extension_attributes attribute Show extension_attributes attribute object
        • start_time string
      • id integer Required

        Id

      • bulk_uuid string Required

        Bulk uuid

      • topic_name string Required

        Queue Topic

      • serialized_data string Required

        Data

      • result_serialized_data string Required

        Serialized Data

      • status integer Required

        Operation status

      • result_message string Required

        Result message

      • error_code integer Required

        Error code

    • extension_attributes object

      ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface

    • user_type integer Required

      User type

    • bulk_id string Required

      Bulk uuid

    • description string Required

      Bulk description

    • start_time string Required

      Bulk scheduled time

    • user_id integer Required

      User id

    • operation_count integer Required

      Total number of operations scheduled in scope of this bulk

  • 401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • 400 Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/bulk/{bulkUuid}/detailed-status
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/bulk/{bulkUuid}/detailed-status'
Response examples (200)
{
  "operations_list": [
    {
      "extension_attributes": {
        "start_time": "string"
      },
      "id": 42,
      "bulk_uuid": "string",
      "topic_name": "string",
      "serialized_data": "string",
      "result_serialized_data": "string",
      "status": 42,
      "result_message": "string",
      "error_code": 42
    }
  ],
  "extension_attributes": {},
  "user_type": 42,
  "bulk_id": "string",
  "description": "string",
  "start_time": "string",
  "user_id": 42,
  "operation_count": 42
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <operations-list type="array">
    <operations-list>
      <extension-attributes>
        <start-time>string</start-time>
      </extension-attributes>
      <id type="integer">42</id>
      <bulk-uuid>string</bulk-uuid>
      <topic-name>string</topic-name>
      <serialized-data>string</serialized-data>
      <result-serialized-data>string</result-serialized-data>
      <status type="integer">42</status>
      <result-message>string</result-message>
      <error-code type="integer">42</error-code>
    </operations-list>
  </operations-list>
  <extension-attributes>
  </extension-attributes>
  <user-type type="integer">42</user-type>
  <bulk-id>string</bulk-id>
  <description>string</description>
  <start-time>string</start-time>
  <user-id type="integer">42</user-id>
  <operation-count type="integer">42</operation-count>
</root>
Response examples (401)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (400)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (400)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>