Update Shipping
Use this operation to ship existing Salesorder object.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
NOTE: For Shipping,
- If the order contains serailized or lot products then OrderDetails needs to be passed in the XML or JSON format.
- ProductsQuantityShipped will be current shipping quantity which user needs to ship.
- To Send the Order to ShipStation user needs to send Yes in SendToShipStation field of JSON/XML.
{
"Shipping": {
"ShippingDate": "01-24-2020",
"OrderNo": "1596",
"ShippingCarrier": "Fedex",
"ShippingMethod": "Fedex 2 Day",
"TrackingNumber": "AZ_UPS-1111",
"ShippingCost": "10.00",
"DeliverFrom": "USA",
"SendToShipStation": "No",
"OrderDetails": {
"OD": [
{
"ProductCode": "TNP1",
"ProductsQuantityShipped": "3",
"OrderLineNo": "0",
"LineItemLocation": "OAK",
"LineItemShippingCarrier": "Fedex",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
},
{
"ProductCode": "TNP2",
"ProductsQuantityShipped": "3",
"OrderLineNo": "1",
"LineItemLocation": "PDX",
"LineItemShippingCarrier": "Fedexx",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
}
]
}
}
}
<Shipping>
<ShippingDate>01-24-2020</ShippingDate>
<OrderNo>1596</OrderNo>
<ShippingCarrier>Fedex</ShippingCarrier>
<ShippingMethod>Fedex 2 Day</ShippingMethod>
<TrackingNumber>AZ_UPS-1111</TrackingNumber>
<ShippingCost>10.00</ShippingCost>
<DeliverFrom>USA</DeliverFrom>
<SendToShipStation>No</SendToShipStation>
<OrderDetails>
<OD>
<ProductCode>TNP1</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<OrderLineNo>0</OrderLineNo>
<LineItemLocation>OAK</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1122</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
<OD>
<ProductCode>TNP2</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<OrderLineNo>1</OrderLineNo>
<LineItemLocation>PDX</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1133</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
</OrderDetails>
</Shipping>
{
"Shipping": {
"ShippingDate": "01-24-2020",
"OrderNo": "1596",
"ShippingCarrier": "Fedex",
"ShippingMethod": "Fedex 2 Day",
"TrackingNumber": "AZ_UPS-1111",
"ShippingCost": "10.00",
"DeliverFrom": "USA",
"SendToShipStation": "No",
"OrderDetails": {
"OD": [
{
"ProductCode": "TNP1",
"ProductsQuantityShipped": "3",
"SKUCode": "1230",
"OrderLineNo": "0",
"LineItemLocation": "OAK",
"LineItemShippingCarrier": "Fedex",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
},
{
"ProductCode": "TNP2",
"ProductsQuantityShipped": "3",
"SKUCode": "1231",
"OrderLineNo": "1",
"LineItemLocation": "PDX",
"LineItemShippingCarrier": "Fedexx",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
}
]
}
}
}
<Shipping>
<ShippingDate>01-24-2020</ShippingDate>
<OrderNo>1596</OrderNo>
<ShippingCarrier>Fedexx</ShippingCarrier>
<ShippingMethod>Fedex 2 Day</ShippingMethod>
<TrackingNumber>AZ_UPS-1111</TrackingNumber>
<ShippingCost>10.00</ShippingCost>
<DeliverFrom>USA</DeliverFrom>
<SendToShipStation>No</SendToShipStation>
<OrderDetails>
<OD>
<ProductCode>TNP1</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<SKUCode>1230</SKUCode>
<OrderLineNo>0</OrderLineNo>
<LineItemLocation>OAK</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1122</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
<OD>
<ProductCode>TNP2</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<SKUCode>1231</SKUCode>
<OrderLineNo>1</OrderLineNo>
<LineItemLocation>PDX</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1133</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
</OrderDetails>
</Shipping>
{
"Shipping": {
"ShippingDate": "01-24-2020",
"OrderNo": "1596",
"ShippingCarrier": "Fedexx",
"ShippingMethod": "Fedex 2 Day",
"TrackingNumber": "AZ_UPS-1111",
"ShippingCost": "10.00",
"DeliverFrom": "USA",
"SendToShipStation": "No",
"OrderDetails": {
"OD": [
{
"ProductCode": "TNP1",
"ProductsQuantityShipped": "3",
"SerialNo": "1111",
"OrderLineNo": "0",
"LineItemLocation": "OAK",
"LineItemShippingCarrier": "Fedex",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
},
{
"ProductCode": "TNP2",
"ProductsQuantityShipped": "3",
"SerialNo": "1112",
"OrderLineNo": "1",
"LineItemLocation": "PDX",
"LineItemShippingCarrier": "Fedexx",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
}
]
}
}
}
<Shipping>
<ShippingDate>01-24-2020</ShippingDate>
<OrderNo>1596</OrderNo>
<ShippingCarrier>Fedexx</ShippingCarrier>
<ShippingMethod>Fedex 2 Day</ShippingMethod>
<TrackingNumber>AZ_UPS-1111</TrackingNumber>
<ShippingCost>10.00</ShippingCost>
<DeliverFrom>USA</DeliverFrom>
<SendToShipStation>No</SendToShipStation>
<OrderDetails>
<OD>
<ProductCode>TNP1</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<SerialNo>1111</SerialNo>
<OrderLineNo>0</OrderLineNo>
<LineItemLocation>OAK</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1122</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
<OD>
<ProductCode>TNP2</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<SerialNo>1112</SerialNo>
<OrderLineNo>1</OrderLineNo>
<LineItemLocation>PDX</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1133</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
</OrderDetails>
</Shipping>
{
"Shipping": {
"ShippingDate": "01-24-2020",
"OrderNo": "1596",
"ShippingCarrier": "Fedexx",
"ShippingMethod": "Fedex 2 Day",
"TrackingNumber": "AZ_UPS-1111",
"ShippingCost": "10.00",
"DeliverFrom": "USA",
"SendToShipStation": "No",
"OrderDetails": {
"OD": [
{
"ProductCode": "TNP1",
"ProductsQuantityShipped": "3",
"LotExpiry": "01-24-2020",
"LotNo": "4321",
"LotQty": "1",
"OrderLineNo": "0",
"LineItemLocation": "OAK",
"LineItemShippingCarrier": "Fedex",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
},
{
"ProductCode": "TNP2",
"ProductsQuantityShipped": "3",
"LotExpiry": "01-24-2020",
"LotNo": "4322",
"LotQty": "1",
"OrderLineNo": "1",
"LineItemLocation": "PDX",
"LineItemShippingCarrier": "Fedexx",
"LineItemShippingMethod": "Fedex 2 Day",
"LineItemTrackingNumber": "AZ_UPS-1122",
"LineItemShippingCost": "10",
"LineItemShippingDate": "01-24-2020",
"LineItemStatus": "Created,Shipped"
}
]
}
}
}
<Shipping>
<ShippingDate>01-24-2020</ShippingDate>
<OrderNo>1596</OrderNo>
<ShippingCarrier>Fedexx</ShippingCarrier>
<ShippingMethod>Fedex 2 Day</ShippingMethod>
<TrackingNumber>AZ_UPS-1111</TrackingNumber>
<ShippingCost>10.00</ShippingCost>
<DeliverFrom>USA</DeliverFrom>
<SendToShipStation>No</SendToShipStation>
<OrderDetails>
<OD>
<ProductCode>TNP1</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<LotExpiry>01-24-2020</LotExpiry>
<LotNo>4321</LotNo>
<LotQty>1</LotQty>
<OrderLineNo>0</OrderLineNo>
<LineItemLocation>OAK</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1122</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
<OD>
<ProductCode>TNP2</ProductCode>
<ProductsQuantityShipped>3</ProductsQuantityShipped>
<LotExpiry>01-24-2020</LotExpiry>
<LotNo>4322</LotNo>
<LotQty>1</LotQty>
<OrderLineNo>1</OrderLineNo>
<LineItemLocation>PDX</LineItemLocation>
<LineItemShippingCarrier>Fedex</LineItemShippingCarrier>
<LineItemShippingMethod>Fedex 2 Day</LineItemShippingMethod>
<LineItemTrackingNumber>AZ_UPS-1133</LineItemTrackingNumber>
<LineItemShippingCost>10</LineItemShippingCost>
<LineItemShippingDate>01-24-2020</LineItemShippingDate>
<LineItemStatus>Created,Shipped,<LineItemStatus>
</OD>
</OrderDetails>
</Shipping>
Sample Response
{
"MCM": {
"response": {
"objectType": "Shipping",
"syncTime": "2021-06-10 08:08:57"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"order_no": "6448",
"order_id": "203066",
"warning": {}
}
}
}
}
}
}
<MCM>
<response>
<objectType>Shipping</objectType>
<syncTime>2021-06-10 08:08:57</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<order_no>203066</order_no>
<order_id>6448</order_id>
<warning></warning>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Shipping">
<method name="PUT">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="ShippingDate" type="xsd:date" style="body" required="true"/>
<param name="OrderNo" type="xsd:int" style="body" required="true"/>
<param name="ShippingCarrier" type="xsd:string" style="body" required="true"/>
<param name="ShippingMethod" type="xsd:string" style="body" required="true"/>
<param name="TrackingNumber" type="xsd:string" style="body"/>
<param name="ShippingCost" type="xsd:decimal" style="body"/>
<param name="DeliverFrom" type="xsd:string" style="body"/>
<param name="SendToShipStation" type="xsd:string" style="body"/>
<param name="OrderDetails">
<param name="ProductCode" type="xsd:string" style="body" required="true"/>
<param name="ProductsQuantityShipped" type="xsd:int" style="body" required="true"/>
<param name="OrderLineNo" type="xsd:int" style="body" required="true"/>
<param name="LineItemLocation" type="xsd:string" style="body"/>
<param name="LineItemShippingCarrier" type="xsd:string" style="body"/>
<param name="LineItemShippingMethod" type="xsd:string" style="body"/>
<param name="LineItemTrackingNumber" type="xsd:string" style="body"/>
<param name="LineItemShippingCost" type="xsd:decimal" style="body"/>
<param name="LineItemShippingDate" type="xsd:date" style="body"/>
</param>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 21 hours ago