API ReferenceGuides
Guides
Home
Start typing to search…

Read Shipment Transaction

Retrieves the details of a Shipment Transaction object that has been previously created.

Parameters

Path Params

yourCompany:

string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/ShipmentTransaction will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/ShipmentTransaction

Query Params

filter:

string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. ShipmentId,eq,601-1

  1. To fetch ShipmentTransaction with ShipmentId equal to 601-1 , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ShipmentTransaction?filter=ShipmentId,eq,601-1&key=xyzkey

  1. To fetch ShipmentTransaction with shipped date between 01-15-2020 to 01-31-2020 (Use | between two dates), the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ShipmentTransaction?filter=ShippedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey

  1. To fetch ShipmentTransaction with shipped datetime between 01-15-2020 01:03:10 to 01-31-2020 20:00:00 (Use | between two dates), the following url must be used

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:
"cs": contain string (string contains value)
"sw": start with (string starts with value)
"ew": end with (string end with value)
"neq": not equal (string or number should not match)
"eq": equal (string or number matches exactly)
"lt": lower than (number is lower than value)
"le": lower or equal (number is lower than or equal to value)
"ge": greater or equal (number is higher than or equal to value)
"gt": greater than (number is higher than value)
"bt": between (number is between two comma separated values)

page:

int
Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch ShipmentTransaction with ShipmentId equal to 601-1 and page equal to 10, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ShipmentTransaction?filter=ShipmentId,eq,601-1&page=10&key=xyzkey

pageSize:

int
In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch ShipmentTransaction with ShipmentId equal to 601-1 and page size equal to 10, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ShipmentTransaction?filter=ShipmentId,eq,601-1&pageSize=10&key=xyzkey

Header Params

Accept:

string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.

Query Auth

key:

string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth

apiKey:

string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

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

© Copyright 2022 Agiliron - All Rights Reserved.