Magento2
GET /V1/stock-hub/quotes

List all Stock Hub quotes

Query parameters

  • searchCriteria[filterGroups][0][filters][0][field] string

    Field

  • searchCriteria[filterGroups][0][filters][0][value] string

    Value

  • searchCriteria[filterGroups][0][filters][0][conditionType] string

    Condition type

  • searchCriteria[sortOrders][0][field] string

    Sorting field.

  • searchCriteria[sortOrders][0][direction] string

    Sorting direction.

  • searchCriteria[pageSize] integer

    Page size.

  • searchCriteria[currentPage] integer

    Current page.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • id integer Required

        .

      • created_at string Required

        Timestamp when quote is created

      • updated_at string Required

        Timestamp when quote is updated

      • items array[object] Required

        Quote items

        Hide items attributes Show items attributes object
        • sku string Required

          SKU

        • parent_sku string

          Parent SKU

        • qty integer Required

          Quantity

        • item_price_inc_tax number Required

          Price of single item including VAT

        • row_total_inc_tax number Required

          Price of order line (items X quantity) including VAT

        • manufacturer string

          Manufacturer name

        • size string

          Size

        • mpn string

          Manufacturer product number

      • billing_address object Required
        Hide billing_address attributes Show billing_address attributes object
        • first_name string

          Firstname

        • company_name string

          Company name

        • last_name string

          Lastname

        • email string

          Email

        • telephone string

          Telephone. Needs to be in international format +XXXXXXXXXXX.

        • street string

          Street. Needs to be "street name" and "house number"

        • house_number string Required

          House number with addition.

        • postcode string

          Postcode

        • city string

          City

        • region_code string

          Region code

        • country_id string

          Country id. Needs to a ALPHA-2 ISO 3166 country code.

      • shipping_address object Required
        Hide shipping_address attributes Show shipping_address attributes object
        • first_name string

          Firstname

        • company_name string

          Company name

        • last_name string

          Lastname

        • email string

          Email

        • telephone string

          Telephone. Needs to be in international format +XXXXXXXXXXX.

        • street string

          Street. Needs to be "street name" and "house number"

        • house_number string Required

          House number with addition.

        • postcode string

          Postcode

        • city string

          City

        • region_code string

          Region code

        • country_id string

          Country id. Needs to a ALPHA-2 ISO 3166 country code.

      • payment object
        Hide payment attributes Show payment attributes object
        • method string

          Payment method

        • po_number string

          Purchase order number

      • grand_total number Required

        Grand total (inc. VAT)

      • shipping_price number

        Shipping & handling costs (incl. VAT)

      • currency string
    • search_criteria object Required

      Search criteria interface.

      Hide search_criteria attributes Show search_criteria attributes object
      • filter_groups array[object] Required

        A list of filter groups.

        Hide filter_groups attribute Show filter_groups attribute object

        Groups two or more filters together using a logical OR

        • filters array[object]

          A list of filters in this group

          Hide filters attributes Show filters attributes object

          Filter which can be used by any methods from service layer.

          • field string Required

            Field

          • value string Required

            Value

          • condition_type string

            Condition type

      • sort_orders array[object]

        Sort order.

        Hide sort_orders attributes Show sort_orders attributes object

        Data object for sort order.

        • field string Required

          Sorting field.

        • direction string Required

          Sorting direction.

      • page_size integer

        Page size.

      • current_page integer

        Current page.

    • total_count integer Required

      Total count.

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • id integer Required

        .

      • created_at string Required

        Timestamp when quote is created

      • updated_at string Required

        Timestamp when quote is updated

      • items array[object] Required

        Quote items

        Hide items attributes Show items attributes object
        • sku string Required

          SKU

        • parent_sku string

          Parent SKU

        • qty integer Required

          Quantity

        • item_price_inc_tax number Required

          Price of single item including VAT

        • row_total_inc_tax number Required

          Price of order line (items X quantity) including VAT

        • manufacturer string

          Manufacturer name

        • size string

          Size

        • mpn string

          Manufacturer product number

      • billing_address object Required
        Hide billing_address attributes Show billing_address attributes object
        • first_name string

          Firstname

        • company_name string

          Company name

        • last_name string

          Lastname

        • email string

          Email

        • telephone string

          Telephone. Needs to be in international format +XXXXXXXXXXX.

        • street string

          Street. Needs to be "street name" and "house number"

        • house_number string Required

          House number with addition.

        • postcode string

          Postcode

        • city string

          City

        • region_code string

          Region code

        • country_id string

          Country id. Needs to a ALPHA-2 ISO 3166 country code.

      • shipping_address object Required
        Hide shipping_address attributes Show shipping_address attributes object
        • first_name string

          Firstname

        • company_name string

          Company name

        • last_name string

          Lastname

        • email string

          Email

        • telephone string

          Telephone. Needs to be in international format +XXXXXXXXXXX.

        • street string

          Street. Needs to be "street name" and "house number"

        • house_number string Required

          House number with addition.

        • postcode string

          Postcode

        • city string

          City

        • region_code string

          Region code

        • country_id string

          Country id. Needs to a ALPHA-2 ISO 3166 country code.

      • payment object
        Hide payment attributes Show payment attributes object
        • method string

          Payment method

        • po_number string

          Purchase order number

      • grand_total number Required

        Grand total (inc. VAT)

      • shipping_price number

        Shipping & handling costs (incl. VAT)

      • currency string
    • search_criteria object Required

      Search criteria interface.

      Hide search_criteria attributes Show search_criteria attributes object
      • filter_groups array[object] Required

        A list of filter groups.

        Hide filter_groups attribute Show filter_groups attribute object

        Groups two or more filters together using a logical OR

        • filters array[object]

          A list of filters in this group

          Hide filters attributes Show filters attributes object

          Filter which can be used by any methods from service layer.

          • field string Required

            Field

          • value string Required

            Value

          • condition_type string

            Condition type

      • sort_orders array[object]

        Sort order.

        Hide sort_orders attributes Show sort_orders attributes object

        Data object for sort order.

        • field string Required

          Sorting field.

        • direction string Required

          Sorting direction.

      • page_size integer

        Page size.

      • current_page integer

        Current page.

    • total_count integer Required

      Total count.
  • 401

    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
  • default

    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/stock-hub/quotes 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/stock-hub/quotes'
Response examples (200) 
{
  "items": [
    {
      "id": 42,
      "created_at": "string",
      "updated_at": "string",
      "items": [
        {
          "sku": "string",
          "parent_sku": "string",
          "qty": 42,
          "item_price_inc_tax": 42.0,
          "row_total_inc_tax": 42.0,
          "manufacturer": "string",
          "size": "string",
          "mpn": "string"
        }
      ],
      "billing_address": {
        "first_name": "string",
        "company_name": "string",
        "last_name": "string",
        "email": "string",
        "telephone": "string",
        "street": "string",
        "house_number": "string",
        "postcode": "string",
        "city": "string",
        "region_code": "string",
        "country_id": "string"
      },
      "shipping_address": {
        "first_name": "string",
        "company_name": "string",
        "last_name": "string",
        "email": "string",
        "telephone": "string",
        "street": "string",
        "house_number": "string",
        "postcode": "string",
        "city": "string",
        "region_code": "string",
        "country_id": "string"
      },
      "payment": {
        "method": "string",
        "po_number": "string"
      },
      "grand_total": 42.0,
      "shipping_price": 42.0,
      "currency": "string"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <id type="integer">42</id>
      <created-at>string</created-at>
      <updated-at>string</updated-at>
      <items type="array">
        <item>
          <sku>string</sku>
          <parent-sku>string</parent-sku>
          <qty type="integer">42</qty>
          <item-price-inc-tax type="float">42.0</item-price-inc-tax>
          <row-total-inc-tax type="float">42.0</row-total-inc-tax>
          <manufacturer>string</manufacturer>
          <size>string</size>
          <mpn>string</mpn>
        </item>
      </items>
      <billing-address>
        <first-name>string</first-name>
        <company-name>string</company-name>
        <last-name>string</last-name>
        <email>string</email>
        <telephone>string</telephone>
        <street>string</street>
        <house-number>string</house-number>
        <postcode>string</postcode>
        <city>string</city>
        <region-code>string</region-code>
        <country-id>string</country-id>
      </billing-address>
      <shipping-address>
        <first-name>string</first-name>
        <company-name>string</company-name>
        <last-name>string</last-name>
        <email>string</email>
        <telephone>string</telephone>
        <street>string</street>
        <house-number>string</house-number>
        <postcode>string</postcode>
        <city>string</city>
        <region-code>string</region-code>
        <country-id>string</country-id>
      </shipping-address>
      <payment>
        <method>string</method>
        <po-number>string</po-number>
      </payment>
      <grand-total type="float">42.0</grand-total>
      <shipping-price type="float">42.0</shipping-price>
      <currency>string</currency>
    </item>
  </items>
  <search-criteria>
    <filter-groups type="array">
      <filter-group>
        <filters type="array">
          <filter>
            <field>string</field>
            <value>string</value>
            <condition-type>string</condition-type>
          </filter>
        </filters>
      </filter-group>
    </filter-groups>
    <sort-orders type="array">
      <sort-order>
        <field>string</field>
        <direction>string</direction>
      </sort-order>
    </sort-orders>
    <page-size type="integer">42</page-size>
    <current-page type="integer">42</current-page>
  </search-criteria>
  <total-count type="integer">42</total-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 (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>