GET SalesOrder/GetSalesOrder?SalesOrderNumber={SalesOrderNumber}

Returns sales order details for a customer.

Request Information

URI Parameters

Name	Description	Type	Additional Information
SalesOrderNumber	Order number of the sales order to return the sales order details for.	string	Required

Body Parameters

Response Information

Resource Description

Returns sales order details for a customer.

AgvSalesOrderDetails

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
SalesOrderNumber	Sales order number.	string
SalesOrderObj	JSON dictionary of SalesOrderObject.	SalesOrderObject

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "SalesOrderNumber": "sample string 3",
  "SalesOrderObj": {
    "SalesOrderSplits": [
      {
        "OrderNumber": "sample string 1",
        "CustID": "sample string 2",
        "CustomerName": "sample string 3",
        "SplitNumber": 4,
        "SplitPercent1": 5.1,
        "SplitPercent2": 6.1,
        "SplitPercent3": 7.1
      },
      {
        "OrderNumber": "sample string 1",
        "CustID": "sample string 2",
        "CustomerName": "sample string 3",
        "SplitNumber": 4,
        "SplitPercent1": 5.1,
        "SplitPercent2": 6.1,
        "SplitPercent3": 7.1
      }
    ],
    "SalesOrderLineItems": [
      {
        "OrderNumber": "sample string 1",
        "CustID": "sample string 2",
        "LineItem": 3,
        "DeptID": "sample string 4",
        "ProdID": "sample string 5",
        "ProductName": "sample string 6",
        "Quantity": 7.1,
        "InvUnits": "sample string 8",
        "Price": 9.1,
        "BillUnits": "sample string 10",
        "CropCode": "sample string 11",
        "AllocationNumber": "sample string 12",
        "BillingDivisor": "sample string 13",
        "PriceLevel": "sample string 14",
        "AlternateProductId": "sample string 15"
      },
      {
        "OrderNumber": "sample string 1",
        "CustID": "sample string 2",
        "LineItem": 3,
        "DeptID": "sample string 4",
        "ProdID": "sample string 5",
        "ProductName": "sample string 6",
        "Quantity": 7.1,
        "InvUnits": "sample string 8",
        "Price": 9.1,
        "BillUnits": "sample string 10",
        "CropCode": "sample string 11",
        "AllocationNumber": "sample string 12",
        "BillingDivisor": "sample string 13",
        "PriceLevel": "sample string 14",
        "AlternateProductId": "sample string 15"
      }
    ],
    "SalesOrderDiscounts": [
      {
        "OrderNum": 1,
        "LineItem": 2,
        "DiscountName": "sample string 3",
        "Quantity": 4.1,
        "Total": 5.1,
        "Manual": 6.1,
        "Rate": 7.1,
        "DiscountType": "sample string 8",
        "SoDiscountKey": 9
      },
      {
        "OrderNum": 1,
        "LineItem": 2,
        "DiscountName": "sample string 3",
        "Quantity": 4.1,
        "Total": 5.1,
        "Manual": 6.1,
        "Rate": 7.1,
        "DiscountType": "sample string 8",
        "SoDiscountKey": 9
      }
    ],
    "SalesOrderHead": {
      "OrderNumber": "sample string 1",
      "OrderDate": "sample string 2",
      "CustID": "sample string 3",
      "FieldID": "sample string 4",
      "ShipTo": "sample string 5",
      "EstimatedDeliveryDate": "sample string 6",
      "StartDate": "sample string 7",
      "ExpirationDate": "sample string 8",
      "OrderType": "sample string 9",
      "Status": "sample string 10",
      "SalespersonID": "sample string 11",
      "Comments": "sample string 12",
      "Processed": true,
      "LocationID": "sample string 14",
      "Terms": "sample string 15",
      "OfferExpires": "sample string 16",
      "CustPo": "sample string 17"
    }
  }
}

application/xml, text/xml

Sample:

<AgvSalesOrderDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Inventory.SalesOrder">
  <Message>sample string 2</Message>
  <SalesOrderNumber>sample string 3</SalesOrderNumber>
  <SalesOrderObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI">
    <d2p1:SalesOrderDiscounts>
      <d2p1:ClsQuickOrderDoNotUseForOldApiOnly.ClsQuickOrderDiscount>
        <d2p1:DiscountName>sample string 3</d2p1:DiscountName>
        <d2p1:DiscountType>sample string 8</d2p1:DiscountType>
        <d2p1:LineItem>2</d2p1:LineItem>
        <d2p1:Manual>6.1</d2p1:Manual>
        <d2p1:OrderNum>1</d2p1:OrderNum>
        <d2p1:Quantity>4.1</d2p1:Quantity>
        <d2p1:Rate>7.1</d2p1:Rate>
        <d2p1:SoDiscountKey>9</d2p1:SoDiscountKey>
        <d2p1:Total>5.1</d2p1:Total>
      </d2p1:ClsQuickOrderDoNotUseForOldApiOnly.ClsQuickOrderDiscount>
      <d2p1:ClsQuickOrderDoNotUseForOldApiOnly.ClsQuickOrderDiscount>
        <d2p1:DiscountName>sample string 3</d2p1:DiscountName>
        <d2p1:DiscountType>sample string 8</d2p1:DiscountType>
        <d2p1:LineItem>2</d2p1:LineItem>
        <d2p1:Manual>6.1</d2p1:Manual>
        <d2p1:OrderNum>1</d2p1:OrderNum>
        <d2p1:Quantity>4.1</d2p1:Quantity>
        <d2p1:Rate>7.1</d2p1:Rate>
        <d2p1:SoDiscountKey>9</d2p1:SoDiscountKey>
        <d2p1:Total>5.1</d2p1:Total>
      </d2p1:ClsQuickOrderDoNotUseForOldApiOnly.ClsQuickOrderDiscount>
    </d2p1:SalesOrderDiscounts>
    <d2p1:SalesOrderHead>
      <d2p1:Comments>sample string 12</d2p1:Comments>
      <d2p1:CustID>sample string 3</d2p1:CustID>
      <d2p1:CustPo>sample string 17</d2p1:CustPo>
      <d2p1:EstimatedDeliveryDate>sample string 6</d2p1:EstimatedDeliveryDate>
      <d2p1:ExpirationDate>sample string 8</d2p1:ExpirationDate>
      <d2p1:FieldID>sample string 4</d2p1:FieldID>
      <d2p1:LocationID>sample string 14</d2p1:LocationID>
      <d2p1:OfferExpires>sample string 16</d2p1:OfferExpires>
      <d2p1:OrderDate>sample string 2</d2p1:OrderDate>
      <d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
      <d2p1:OrderType>sample string 9</d2p1:OrderType>
      <d2p1:Processed>true</d2p1:Processed>
      <d2p1:SalespersonID>sample string 11</d2p1:SalespersonID>
      <d2p1:ShipTo>sample string 5</d2p1:ShipTo>
      <d2p1:StartDate>sample string 7</d2p1:StartDate>
      <d2p1:Status>sample string 10</d2p1:Status>
      <d2p1:Terms>sample string 15</d2p1:Terms>
    </d2p1:SalesOrderHead>
    <d2p1:SalesOrderLineItems>
      <d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderLineItem>
        <d2p1:AllocationNumber>sample string 12</d2p1:AllocationNumber>
        <d2p1:AlternateProductId>sample string 15</d2p1:AlternateProductId>
        <d2p1:BillUnits>sample string 10</d2p1:BillUnits>
        <d2p1:BillingDivisor>sample string 13</d2p1:BillingDivisor>
        <d2p1:CropCode>sample string 11</d2p1:CropCode>
        <d2p1:CustID>sample string 2</d2p1:CustID>
        <d2p1:DeptID>sample string 4</d2p1:DeptID>
        <d2p1:InvUnits>sample string 8</d2p1:InvUnits>
        <d2p1:LineItem>3</d2p1:LineItem>
        <d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
        <d2p1:Price>9.1</d2p1:Price>
        <d2p1:PriceLevel>sample string 14</d2p1:PriceLevel>
        <d2p1:ProdID>sample string 5</d2p1:ProdID>
        <d2p1:ProductName>sample string 6</d2p1:ProductName>
        <d2p1:Quantity>7.1</d2p1:Quantity>
      </d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderLineItem>
      <d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderLineItem>
        <d2p1:AllocationNumber>sample string 12</d2p1:AllocationNumber>
        <d2p1:AlternateProductId>sample string 15</d2p1:AlternateProductId>
        <d2p1:BillUnits>sample string 10</d2p1:BillUnits>
        <d2p1:BillingDivisor>sample string 13</d2p1:BillingDivisor>
        <d2p1:CropCode>sample string 11</d2p1:CropCode>
        <d2p1:CustID>sample string 2</d2p1:CustID>
        <d2p1:DeptID>sample string 4</d2p1:DeptID>
        <d2p1:InvUnits>sample string 8</d2p1:InvUnits>
        <d2p1:LineItem>3</d2p1:LineItem>
        <d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
        <d2p1:Price>9.1</d2p1:Price>
        <d2p1:PriceLevel>sample string 14</d2p1:PriceLevel>
        <d2p1:ProdID>sample string 5</d2p1:ProdID>
        <d2p1:ProductName>sample string 6</d2p1:ProductName>
        <d2p1:Quantity>7.1</d2p1:Quantity>
      </d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderLineItem>
    </d2p1:SalesOrderLineItems>
    <d2p1:SalesOrderSplits>
      <d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderSplit>
        <d2p1:CustID>sample string 2</d2p1:CustID>
        <d2p1:CustomerName>sample string 3</d2p1:CustomerName>
        <d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
        <d2p1:SplitNumber>4</d2p1:SplitNumber>
        <d2p1:SplitPercent1>5.1</d2p1:SplitPercent1>
        <d2p1:SplitPercent2>6.1</d2p1:SplitPercent2>
        <d2p1:SplitPercent3>7.1</d2p1:SplitPercent3>
      </d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderSplit>
      <d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderSplit>
        <d2p1:CustID>sample string 2</d2p1:CustID>
        <d2p1:CustomerName>sample string 3</d2p1:CustomerName>
        <d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
        <d2p1:SplitNumber>4</d2p1:SplitNumber>
        <d2p1:SplitPercent1>5.1</d2p1:SplitPercent1>
        <d2p1:SplitPercent2>6.1</d2p1:SplitPercent2>
        <d2p1:SplitPercent3>7.1</d2p1:SplitPercent3>
      </d2p1:ClsQuickOrderDoNotUseForOldApiOnly.SalesOrderSplit>
    </d2p1:SalesOrderSplits>
  </SalesOrderObj>
  <Status>sample string 1</Status>
</AgvSalesOrderDetails>