POST api/magento/orders/{orderId}/ship

Ships order (creates a new shipment and adds shipping tracking numbers)

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId	order id	string	Required

Body Parameters

ship order request

SuiteBridge.Models.Magento.ShipOrderRequest

Name	Description	Type	Additional information
shipping_method	Carrier code (ups, usps, dhl, fedex, or dhlint)	string	None.
shipping_description	shipping serice name	string	None.
tracking	shipping tracking number	string	None.
items	items/quantity shipped	Collection of SuiteBridge.MagentoWebService.orderItemIdQty	None.

Request Formats

application/json, text/json

Sample:

{
  "shipping_method": "sample string 1",
  "shipping_description": "sample string 2",
  "tracking": "sample string 3",
  "items": [
    {
      "order_item_id": 1,
      "qty": 2.1
    },
    {
      "order_item_id": 1,
      "qty": 2.1
    }
  ]
}

application/xml, text/xml

Sample:

<ShipOrderRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <shipping_method>sample string 1</shipping_method>
  <shipping_description>sample string 2</shipping_description>
  <tracking>sample string 3</tracking>
  <items>
    <orderItemIdQty>
      <order_item_id>1</order_item_id>
      <qty>2.1</qty>
    </orderItemIdQty>
    <orderItemIdQty>
      <order_item_id>1</order_item_id>
      <qty>2.1</qty>
    </orderItemIdQty>
  </items>
</ShipOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

shipment reference and adds a url link in the header to the created shipment with 201 Created response

SuiteBridge.Models.Magento.ResourceRef

Name	Description	Type	Additional information
increment_id	resource id	string	None.
type	resource type	string	None.

Response Formats

application/json, text/json

Sample:

{
  "increment_id": "sample string 1",
  "type": "sample string 2"
}

application/xml, text/xml

Sample:

<ResourceRef xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <increment_id>sample string 1</increment_id>
  <type>sample string 2</type>
</ResourceRef>