Magento2
GET /V1/stock-hub/orders/{orderIncrementId}

Get specific order

Path parameters

  • orderIncrementId string Required

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • increment_id string Required
    • created_at string Required
    • updated_at string Required
    • items array[object] Required
      Hide items attributes Show items attributes object
      • sku string Required

        SKU

      • parent_sku string

        Parent SKU

      • qty_ordered integer Required

        Quantity ordered

      • 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

      • size string Required

        Size

      • mpn string

        Manufacturer product number

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

        Firstname

      • last_name string Required

        Lastname

      • email string Required

        Email

      • telephone string Required

        Telephone. Needs to be in international format +XXXXXXXXXXX.

      • street string Required

        Street

      • house_number string Required

        House number

      • postcode string Required

        Postcode

      • city string Required

        City

      • region_code string

        Region code

      • country_id string

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

      • company_name string

        Company name

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

        Firstname

      • last_name string Required

        Lastname

      • email string Required

        Email

      • telephone string Required

        Telephone. Needs to be in international format +XXXXXXXXXXX.

      • street string Required

        Street

      • house_number string Required

        House number

      • postcode string Required

        Postcode

      • city string Required

        City

      • region_code string

        Region code

      • country_id string

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

      • company_name string

        Company name

    • status string
    • shipping_price number
    • subtotal number
    • grand_total number
    • currency string
    • is_invoiced boolean Required
    • is_shipped boolean Required
    Hide response attributes Show response attributes object
    • increment_id string Required
    • created_at string Required
    • updated_at string Required
    • items array[object] Required
      Hide items attributes Show items attributes object
      • sku string Required

        SKU

      • parent_sku string

        Parent SKU

      • qty_ordered integer Required

        Quantity ordered

      • 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

      • size string Required

        Size

      • mpn string

        Manufacturer product number

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

        Firstname

      • last_name string Required

        Lastname

      • email string Required

        Email

      • telephone string Required

        Telephone. Needs to be in international format +XXXXXXXXXXX.

      • street string Required

        Street

      • house_number string Required

        House number

      • postcode string Required

        Postcode

      • city string Required

        City

      • region_code string

        Region code

      • country_id string

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

      • company_name string

        Company name

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

        Firstname

      • last_name string Required

        Lastname

      • email string Required

        Email

      • telephone string Required

        Telephone. Needs to be in international format +XXXXXXXXXXX.

      • street string Required

        Street

      • house_number string Required

        House number

      • postcode string Required

        Postcode

      • city string Required

        City

      • region_code string

        Region code

      • country_id string

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

      • company_name string

        Company name

    • status string
    • shipping_price number
    • subtotal number
    • grand_total number
    • currency string
    • is_invoiced boolean Required
    • is_shipped boolean Required
  • 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/orders/{orderIncrementId} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/stock-hub/orders/{orderIncrementId}'
Response examples (200) 
{
  "increment_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "items": [
    {
      "sku": "string",
      "parent_sku": "string",
      "qty_ordered": 42,
      "item_price_inc_tax": 42.0,
      "row_total_inc_tax": 42.0,
      "manufacturer": "string",
      "size": "string",
      "mpn": "string"
    }
  ],
  "shipping_address": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "telephone": "string",
    "street": "string",
    "house_number": "string",
    "postcode": "string",
    "city": "string",
    "region_code": "string",
    "country_id": "string",
    "company_name": "string"
  },
  "billing_address": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "telephone": "string",
    "street": "string",
    "house_number": "string",
    "postcode": "string",
    "city": "string",
    "region_code": "string",
    "country_id": "string",
    "company_name": "string"
  },
  "status": "string",
  "shipping_price": 42.0,
  "subtotal": 42.0,
  "grand_total": 42.0,
  "currency": "string",
  "is_invoiced": true,
  "is_shipped": true
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <increment-id>string</increment-id>
  <created-at>string</created-at>
  <updated-at>string</updated-at>
  <items type="array">
    <item>
      <sku>string</sku>
      <parent-sku>string</parent-sku>
      <qty-ordered type="integer">42</qty-ordered>
      <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>
  <shipping-address>
    <first-name>string</first-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>
    <company-name>string</company-name>
  </shipping-address>
  <billing-address>
    <first-name>string</first-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>
    <company-name>string</company-name>
  </billing-address>
  <status>string</status>
  <shipping-price type="float">42.0</shipping-price>
  <subtotal type="float">42.0</subtotal>
  <grand-total type="float">42.0</grand-total>
  <currency>string</currency>
  <is-invoiced type="boolean">true</is-invoiced>
  <is-shipped type="boolean">true</is-shipped>
</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>