GET api/magento/shipments/{shipmentId}

Gets an order shipment by id

Request Information

URI Parameters

Name	Description	Type	Additional information
shipmentId	shipment Id	string	Required

Body Parameters

None.

Response Information

Resource Description

shipment

SuiteBridge.MagentoWebService.salesOrderShipmentEntity

Name	Type	Additional information
increment_id	string	None.
parent_id	string	None.
store_id	string	None.
created_at	string	None.
updated_at	string	None.
is_active	string	None.
shipping_address_id	string	None.
shipping_firstname	string	None.
shipping_lastname	string	None.
order_id	string	None.
order_increment_id	string	None.
order_created_at	string	None.
total_qty	string	None.
shipment_id	string	None.
items	Collection of SuiteBridge.MagentoWebService.salesOrderShipmentItemEntity	None.
tracks	Collection of SuiteBridge.MagentoWebService.salesOrderShipmentTrackEntity	None.
comments	Collection of SuiteBridge.MagentoWebService.salesOrderShipmentCommentEntity	None.

Response Formats

application/json, text/json

Sample:

{
  "increment_id": "sample string 1",
  "parent_id": "sample string 2",
  "store_id": "sample string 3",
  "created_at": "sample string 4",
  "updated_at": "sample string 5",
  "is_active": "sample string 6",
  "shipping_address_id": "sample string 7",
  "shipping_firstname": "sample string 8",
  "shipping_lastname": "sample string 9",
  "order_id": "sample string 10",
  "order_increment_id": "sample string 11",
  "order_created_at": "sample string 12",
  "total_qty": "sample string 13",
  "shipment_id": "sample string 14",
  "items": [
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "sku": "sample string 6",
      "name": "sample string 7",
      "order_item_id": "sample string 8",
      "product_id": "sample string 9",
      "weight": "sample string 10",
      "price": "sample string 11",
      "qty": "sample string 12",
      "item_id": "sample string 13"
    },
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "sku": "sample string 6",
      "name": "sample string 7",
      "order_item_id": "sample string 8",
      "product_id": "sample string 9",
      "weight": "sample string 10",
      "price": "sample string 11",
      "qty": "sample string 12",
      "item_id": "sample string 13"
    }
  ],
  "tracks": [
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "carrier_code": "sample string 6",
      "title": "sample string 7",
      "number": "sample string 8",
      "order_id": "sample string 9",
      "track_id": "sample string 10"
    },
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "carrier_code": "sample string 6",
      "title": "sample string 7",
      "number": "sample string 8",
      "order_id": "sample string 9",
      "track_id": "sample string 10"
    }
  ],
  "comments": [
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "comment": "sample string 6",
      "is_customer_notified": "sample string 7",
      "comment_id": "sample string 8"
    },
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "comment": "sample string 6",
      "is_customer_notified": "sample string 7",
      "comment_id": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<salesOrderShipmentEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <increment_id>sample string 1</increment_id>
  <parent_id>sample string 2</parent_id>
  <store_id>sample string 3</store_id>
  <created_at>sample string 4</created_at>
  <updated_at>sample string 5</updated_at>
  <is_active>sample string 6</is_active>
  <shipping_address_id>sample string 7</shipping_address_id>
  <shipping_firstname>sample string 8</shipping_firstname>
  <shipping_lastname>sample string 9</shipping_lastname>
  <order_id>sample string 10</order_id>
  <order_increment_id>sample string 11</order_increment_id>
  <order_created_at>sample string 12</order_created_at>
  <total_qty>sample string 13</total_qty>
  <shipment_id>sample string 14</shipment_id>
  <items>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <sku>sample string 6</sku>
      <name>sample string 7</name>
      <order_item_id>sample string 8</order_item_id>
      <product_id>sample string 9</product_id>
      <weight>sample string 10</weight>
      <price>sample string 11</price>
      <qty>sample string 12</qty>
      <item_id>sample string 13</item_id>
    </complexObjectArray>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <sku>sample string 6</sku>
      <name>sample string 7</name>
      <order_item_id>sample string 8</order_item_id>
      <product_id>sample string 9</product_id>
      <weight>sample string 10</weight>
      <price>sample string 11</price>
      <qty>sample string 12</qty>
      <item_id>sample string 13</item_id>
    </complexObjectArray>
  </items>
  <tracks>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <carrier_code>sample string 6</carrier_code>
      <title>sample string 7</title>
      <number>sample string 8</number>
      <order_id>sample string 9</order_id>
      <track_id>sample string 10</track_id>
    </complexObjectArray>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <carrier_code>sample string 6</carrier_code>
      <title>sample string 7</title>
      <number>sample string 8</number>
      <order_id>sample string 9</order_id>
      <track_id>sample string 10</track_id>
    </complexObjectArray>
  </tracks>
  <comments>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <comment>sample string 6</comment>
      <is_customer_notified>sample string 7</is_customer_notified>
      <comment_id>sample string 8</comment_id>
    </complexObjectArray>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <comment>sample string 6</comment>
      <is_customer_notified>sample string 7</is_customer_notified>
      <comment_id>sample string 8</comment_id>
    </complexObjectArray>
  </comments>
</salesOrderShipmentEntity>