Read Shipment Transaction
Retrieves the details of a Shipment Transaction object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
https://xyzcompany.agiliron.net/agiliron/api-40/ShipmentTransaction?filter=ShippedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/ShipmentTransaction?filter=ShippedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey List of condition abbrevations to be used: |
page: | int |
pageSize: | int |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"ShipmentTransactions": {
"ShipmentTransaction": [{
"Id": "53",
"ShipmentId": "61004-1",
"SalesOrderNo": "61004",
"ShippedBy": "admin",
"ShippedTime": "03-02-2022 02:32:01",
"ShippedTimeUTC": "01-24-2020 15:01:35",
"InvoiceNumber": "61004-1",
"Invoiced": "Yes",
"ShipmentStatus": "Created,Shipped,Paid,Completed,",
"OrderDetails": {
"OD": [
{
"ProductName": "Test Product 28feb1",
"ProductCode": "TP28feb1",
"OrderLineNo": "0",
"TrackingNumber": "TL1232",
"OrderedQuantity": "10",
"ShippedQuantity": "2"
},
{
"ProductName": "Test Product 28feb2",
"ProductCode": "TP28feb2",
"OrderLineNo": "1",
"TrackingNumber": "TL3456",
"OrderedQuantity": "20",
"ShippedQuantity": "3"
},
{
"ProductName": "Test Product 28feb3",
"ProductCode": "TP28feb3",
"SKUCode": "HSTYW",
"OrderLineNo": "2",
"TrackingNumber": "TL3457",
"OrderedQuantity": "12",
"ShippedQuantity": "7"
},
{
"ProductName": "Test Product 28feb4",
"ProductCode": "TP28feb4",
"LotNo": "651267",
"OrderLineNo": "3",
"TrackingNumber": "TL3458",
"OrderedQuantity": "5",
"ShippedQuantity": "3"
},
{
"ProductName": "Test Product 28feb5",
"ProductCode": "TP28feb5",
"SerialNo": "98728179",
"OrderLineNo": "4",
"TrackingNumber": "TL3459",
"OrderedQuantity": "9",
"ShippedQuantity": "6"
}
]
}
}],
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "1"
}
}
<ShipmentTransactions>
<ShipmentTransaction>
<Id>53</Id>
<ShipmentId>61004-1</ShipmentId>
<SalesOrderNo>61004</SalesOrderNo>
<ShippedBy>admin</ShippedBy>
<ShippedTime>03-02-2022 02:32:01</ShippedTime>
<ShippedTimeUTC>01-24-2020 15:01:35</ShippedTimeUTC>
<InvoiceNumber>61004-1</InvoiceNumber>
<Invoiced>Yes</Invoiced>
<ShipmentStatus>Created,Shipped,Paid,Completed,</ShipmentStatus>
<OrderDetails>
<OD>
<ProductName>Test Product 28feb1</ProductName>
<ProductCode>TP28feb1</ProductCode>
<OrderLineNo>0</OrderLineNo>
<TrackingNumber>TL1232</TrackingNumber>
<OrderedQuantity>10</OrderedQuantity>
<ShippedQuantity>2</ShippedQuantity>
</OD>
<OD>
<ProductName>Test Product 28feb2</ProductName>
<ProductCode>TP28feb2</ProductCode>
<OrderLineNo>1</OrderLineNo>
<TrackingNumber>TL3456</TrackingNumber>
<OrderedQuantity>20</OrderedQuantity>
<ShippedQuantity>3</ShippedQuantity>
</OD>
<OD>
<ProductName>Test Product 28feb3</ProductName>
<ProductCode>TP28feb3</ProductCode>
<SKUCode>HSTYW</SKUCode>
<OrderLineNo>2</OrderLineNo>
<TrackingNumber>TL3457</TrackingNumber>
<OrderedQuantity>12</OrderedQuantity>
<ShippedQuantity>7</ShippedQuantity>
</OD>
<OD>
<ProductName>Test Product 28feb4</ProductName>
<ProductCode>TP28feb4</ProductCode>
<LotNo>651267</LotNo>
<OrderLineNo>3</OrderLineNo>
<TrackingNumber>TL3458</TrackingNumber>
<OrderedQuantity>5</OrderedQuantity>
<ShippedQuantity>3</ShippedQuantity>
</OD>
<OD>
<ProductName>Test Product 28feb5</ProductName>
<ProductCode>TP28feb5</ProductCode>
<SerialNo>98728179</SerialNo>
<OrderLineNo>4</OrderLineNo>
<TrackingNumber>TL3459</TrackingNumber>
<OrderedQuantity>9</OrderedQuantity>
<ShippedQuantity>6</ShippedQuantity>
</OD>
</OrderDetails>
</ShipmentTransaction>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>1</PageSize>
</ShipmentTransactions>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="ShipmentTransaction">
<method name="GET">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="Filter" type="xsd:string" style="query"/>
</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 22 hours ago