GET SalesOrderV2/GetSalesOrderV2?salesOrderGuid={salesOrderGuid}&orderNumber={orderNumber}&custIdOrGuid={custIdOrGuid}&statusFilter={statusFilter}&processedFilter={processedFilter}

Returns a list of Sales Orders

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
salesOrderGuid

The unique identifier for a specific sales order (optional)

globally unique identifier
orderNumber

The unique user facing identifier for a specific sales order (optional)

integer

Default value is 0

custIdOrGuid

Customer ID or Customer GUID of a customer on a sales order (optional)

string

Default value is string.Empty

statusFilter

The enumeration value to filter the results to a given status. This will be ignored if the salesOrderGuid or orderNumber are set. (optional)

EnumStatusFilter

Default value is All

processedFilter

The enumeration value to filter the results based on the processed setting. The default is to only return the Unprocessed sales orders. This will be ignored if the salesOrderGuid or orderNumber are set. (optional)

EnumProcessedFilter

Default value is OnlyUnprocessed

Body Parameters

Response Information

Resource Description

Returns a list of Sales Orders

AgvSalesOrderV2
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
ErrorList

List of error messages of the API call.

Collection of string
Count

Number of results returned.

string
SalesOrders

List of Properties and Values returned for each Sales Order that matches the request.

Collection of ClsSalesOrder

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "SalesOrders": [
    {
      "SalesOrderGUID": "bfa886ce-dd12-4a25-8080-f3bbbd122bf5",
      "OrderNum": 8,
      "OrderDate": "2022-12-08T03:59:56.260963+00:00",
      "FieldOwnerId": "sample string 10",
      "FieldOwnerGuid": "6bd98bf5-76e5-47f8-9107-be538c6fb96e",
      "FieldOwnerFirstName": "sample string 11",
      "FieldOwnerLastName": "sample string 12",
      "FieldOwnerName": "sample string 11 sample string 12",
      "FieldId": "sample string 13",
      "FieldGuid": "de7f9fa2-eb7c-45d1-83f2-0499a037ee61",
      "FieldDescription": "sample string 14",
      "BillComment": "sample string 15",
      "EstDelDate": "2022-12-08T03:59:56.260963+00:00",
      "PickupOrDeliver": 0,
      "PickupOrDeliverAsString": "Pickup",
      "Status": 0,
      "StatusAsString": "Offered",
      "ShipVia": "sample string 17",
      "ShipTo": "sample string 18",
      "County": "sample string 19",
      "Territory": "sample string 20",
      "ControlNum": "sample string 21",
      "SalespersonId": "sample string 22",
      "SalespersonFirstName": "sample string 23",
      "SalespersonLastName": "sample string 24",
      "SalespersonName": "sample string 23 sample string 24",
      "CropId": "sample string 25",
      "CropGuid": "7f0ff5a4-52e7-4953-8895-4808025fa844",
      "CustPo": "sample string 26",
      "AuthAgent": "sample string 27",
      "AaRelatedHow": "sample string 28",
      "AaAddr1": "sample string 29",
      "AaAddr2": "sample string 30",
      "AaCity": "sample string 31",
      "AaState": "sample string 32",
      "AaZip": "sample string 33",
      "CustomApplied": true,
      "AddComments": "sample string 35",
      "Acres": 36.1,
      "UnitType": 0,
      "UnitTypeAsString": "A",
      "FedPermit": "sample string 37",
      "FedPermitExpDate": "2022-12-08T03:59:56.260963+00:00",
      "DiscOpt": "sample string 38",
      "PaymentTermDescription": "sample string 39",
      "ProcessedYn": true,
      "Location": "sample string 41",
      "LocationGuid": "3a2f16bf-f119-4480-a9e3-f2074237c428",
      "LocationName": "sample string 43",
      "OfferExpiresDate": "2022-12-08T03:59:56.260963+00:00",
      "PaymentDate": "2022-12-08T03:59:56.260963+00:00",
      "CheckNumber": "sample string 44",
      "StartDate": "2022-12-08T03:59:56.260963+00:00",
      "ExpirationDate": "2022-12-08T03:59:56.260963+00:00",
      "AddedByUserId": "sample string 45",
      "AddedByUserGuid": "466d49ea-6415-4e87-905d-15a22c935aec",
      "AddedByUserFirstName": "sample string 46",
      "AddedByUserLastName": "sample string 47",
      "AddedByUserName": "sample string 46 sample string 47",
      "LastEditedUserId": "sample string 48",
      "LastEditedUserGuid": "91bb059c-d741-4dad-a385-2376246415b1",
      "LastEditedUserFirstName": "sample string 49",
      "LastEditedUserLastName": "sample string 50",
      "LastEditedUserName": "sample string 49 sample string 50",
      "Splits": [
        {
          "SalesOrderSplitGUID": "fa6d5547-8da4-4e99-a3f2-ccf1d4ce282b",
          "SplitNum": 2,
          "CustId": "sample string 3",
          "CustomerGuid": "1698a077-d9e8-440a-af58-fca358c94127",
          "CustomerFirstName": "sample string 5",
          "CustomerLastName": "sample string 6",
          "CustomerName": "sample string 5 sample string 6",
          "PercentS1": 7.1,
          "PercentS2": 8.1,
          "PercentS3": 9.1,
          "LineItems": [
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            },
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            }
          ]
        },
        {
          "SalesOrderSplitGUID": "fa6d5547-8da4-4e99-a3f2-ccf1d4ce282b",
          "SplitNum": 2,
          "CustId": "sample string 3",
          "CustomerGuid": "1698a077-d9e8-440a-af58-fca358c94127",
          "CustomerFirstName": "sample string 5",
          "CustomerLastName": "sample string 6",
          "CustomerName": "sample string 5 sample string 6",
          "PercentS1": 7.1,
          "PercentS2": 8.1,
          "PercentS3": 9.1,
          "LineItems": [
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            },
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            }
          ]
        }
      ],
      "Applications": [
        {
          "SalesOrderApplicationGUID": "1d539dad-47ca-4b9c-810a-ad81824f076e",
          "LineItem": 2,
          "ApplicatorId": "sample string 3",
          "ApplicatorFirstName": "sample string 4",
          "ApplicatorLastName": "sample string 5",
          "ApplicatorName": "sample string 4 sample string 5",
          "VehicleId": "sample string 6",
          "Vehicledescription": "sample string 7",
          "Acres": 8.1
        },
        {
          "SalesOrderApplicationGUID": "1d539dad-47ca-4b9c-810a-ad81824f076e",
          "LineItem": 2,
          "ApplicatorId": "sample string 3",
          "ApplicatorFirstName": "sample string 4",
          "ApplicatorLastName": "sample string 5",
          "ApplicatorName": "sample string 4 sample string 5",
          "VehicleId": "sample string 6",
          "Vehicledescription": "sample string 7",
          "Acres": 8.1
        }
      ],
      "Discounts": [
        {
          "SalesOrderDiscountGUID": "3122ac77-8b84-480b-bcf6-ed4b70bce99d",
          "LineItem": 3,
          "DiscountName": "sample string 4",
          "Quantity": 5.1,
          "Total": 6.1,
          "Manual": 7.1,
          "Rate": 8.1,
          "DiscountType": 0,
          "DiscountTypeAsString": "Percent",
          "SalesOrderDiscountKey": 9
        },
        {
          "SalesOrderDiscountGUID": "3122ac77-8b84-480b-bcf6-ed4b70bce99d",
          "LineItem": 3,
          "DiscountName": "sample string 4",
          "Quantity": 5.1,
          "Total": 6.1,
          "Manual": 7.1,
          "Rate": 8.1,
          "DiscountType": 0,
          "DiscountTypeAsString": "Percent",
          "SalesOrderDiscountKey": 9
        }
      ]
    },
    {
      "SalesOrderGUID": "bfa886ce-dd12-4a25-8080-f3bbbd122bf5",
      "OrderNum": 8,
      "OrderDate": "2022-12-08T03:59:56.260963+00:00",
      "FieldOwnerId": "sample string 10",
      "FieldOwnerGuid": "6bd98bf5-76e5-47f8-9107-be538c6fb96e",
      "FieldOwnerFirstName": "sample string 11",
      "FieldOwnerLastName": "sample string 12",
      "FieldOwnerName": "sample string 11 sample string 12",
      "FieldId": "sample string 13",
      "FieldGuid": "de7f9fa2-eb7c-45d1-83f2-0499a037ee61",
      "FieldDescription": "sample string 14",
      "BillComment": "sample string 15",
      "EstDelDate": "2022-12-08T03:59:56.260963+00:00",
      "PickupOrDeliver": 0,
      "PickupOrDeliverAsString": "Pickup",
      "Status": 0,
      "StatusAsString": "Offered",
      "ShipVia": "sample string 17",
      "ShipTo": "sample string 18",
      "County": "sample string 19",
      "Territory": "sample string 20",
      "ControlNum": "sample string 21",
      "SalespersonId": "sample string 22",
      "SalespersonFirstName": "sample string 23",
      "SalespersonLastName": "sample string 24",
      "SalespersonName": "sample string 23 sample string 24",
      "CropId": "sample string 25",
      "CropGuid": "7f0ff5a4-52e7-4953-8895-4808025fa844",
      "CustPo": "sample string 26",
      "AuthAgent": "sample string 27",
      "AaRelatedHow": "sample string 28",
      "AaAddr1": "sample string 29",
      "AaAddr2": "sample string 30",
      "AaCity": "sample string 31",
      "AaState": "sample string 32",
      "AaZip": "sample string 33",
      "CustomApplied": true,
      "AddComments": "sample string 35",
      "Acres": 36.1,
      "UnitType": 0,
      "UnitTypeAsString": "A",
      "FedPermit": "sample string 37",
      "FedPermitExpDate": "2022-12-08T03:59:56.260963+00:00",
      "DiscOpt": "sample string 38",
      "PaymentTermDescription": "sample string 39",
      "ProcessedYn": true,
      "Location": "sample string 41",
      "LocationGuid": "3a2f16bf-f119-4480-a9e3-f2074237c428",
      "LocationName": "sample string 43",
      "OfferExpiresDate": "2022-12-08T03:59:56.260963+00:00",
      "PaymentDate": "2022-12-08T03:59:56.260963+00:00",
      "CheckNumber": "sample string 44",
      "StartDate": "2022-12-08T03:59:56.260963+00:00",
      "ExpirationDate": "2022-12-08T03:59:56.260963+00:00",
      "AddedByUserId": "sample string 45",
      "AddedByUserGuid": "466d49ea-6415-4e87-905d-15a22c935aec",
      "AddedByUserFirstName": "sample string 46",
      "AddedByUserLastName": "sample string 47",
      "AddedByUserName": "sample string 46 sample string 47",
      "LastEditedUserId": "sample string 48",
      "LastEditedUserGuid": "91bb059c-d741-4dad-a385-2376246415b1",
      "LastEditedUserFirstName": "sample string 49",
      "LastEditedUserLastName": "sample string 50",
      "LastEditedUserName": "sample string 49 sample string 50",
      "Splits": [
        {
          "SalesOrderSplitGUID": "fa6d5547-8da4-4e99-a3f2-ccf1d4ce282b",
          "SplitNum": 2,
          "CustId": "sample string 3",
          "CustomerGuid": "1698a077-d9e8-440a-af58-fca358c94127",
          "CustomerFirstName": "sample string 5",
          "CustomerLastName": "sample string 6",
          "CustomerName": "sample string 5 sample string 6",
          "PercentS1": 7.1,
          "PercentS2": 8.1,
          "PercentS3": 9.1,
          "LineItems": [
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            },
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            }
          ]
        },
        {
          "SalesOrderSplitGUID": "fa6d5547-8da4-4e99-a3f2-ccf1d4ce282b",
          "SplitNum": 2,
          "CustId": "sample string 3",
          "CustomerGuid": "1698a077-d9e8-440a-af58-fca358c94127",
          "CustomerFirstName": "sample string 5",
          "CustomerLastName": "sample string 6",
          "CustomerName": "sample string 5 sample string 6",
          "PercentS1": 7.1,
          "PercentS2": 8.1,
          "PercentS3": 9.1,
          "LineItems": [
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            },
            {
              "SalesOrderLineItemGUID": "68cf1d4b-e943-4f9b-8dd0-345863a00e22",
              "LineItem": 2,
              "DeptId": "sample string 3",
              "ProdId": "sample string 4",
              "ProductGuid": "0759d541-165c-4350-9b4c-740860d2f817",
              "ProductDescription": "sample string 6",
              "Quantity": 7.1,
              "QuantityUnits": "sample string 8",
              "Price": 9.1,
              "PriceUnits": "sample string 10",
              "QuantityToPricingRatio": 11.1,
              "PriceLevel": 0,
              "PriceLevelDescription": "sample string 12",
              "SplitNum": 13,
              "SplitPercent": 14.1,
              "LotNumber": "sample string 15",
              "CropCode": "sample string 17",
              "CropCodeGuid": "381e9ec3-bd08-4465-98ab-e55baf8bf1df",
              "AllocationNumber": 20,
              "ProdIdAlternate": "sample string 22"
            }
          ]
        }
      ],
      "Applications": [
        {
          "SalesOrderApplicationGUID": "1d539dad-47ca-4b9c-810a-ad81824f076e",
          "LineItem": 2,
          "ApplicatorId": "sample string 3",
          "ApplicatorFirstName": "sample string 4",
          "ApplicatorLastName": "sample string 5",
          "ApplicatorName": "sample string 4 sample string 5",
          "VehicleId": "sample string 6",
          "Vehicledescription": "sample string 7",
          "Acres": 8.1
        },
        {
          "SalesOrderApplicationGUID": "1d539dad-47ca-4b9c-810a-ad81824f076e",
          "LineItem": 2,
          "ApplicatorId": "sample string 3",
          "ApplicatorFirstName": "sample string 4",
          "ApplicatorLastName": "sample string 5",
          "ApplicatorName": "sample string 4 sample string 5",
          "VehicleId": "sample string 6",
          "Vehicledescription": "sample string 7",
          "Acres": 8.1
        }
      ],
      "Discounts": [
        {
          "SalesOrderDiscountGUID": "3122ac77-8b84-480b-bcf6-ed4b70bce99d",
          "LineItem": 3,
          "DiscountName": "sample string 4",
          "Quantity": 5.1,
          "Total": 6.1,
          "Manual": 7.1,
          "Rate": 8.1,
          "DiscountType": 0,
          "DiscountTypeAsString": "Percent",
          "SalesOrderDiscountKey": 9
        },
        {
          "SalesOrderDiscountGUID": "3122ac77-8b84-480b-bcf6-ed4b70bce99d",
          "LineItem": 3,
          "DiscountName": "sample string 4",
          "Quantity": 5.1,
          "Total": 6.1,
          "Manual": 7.1,
          "Rate": 8.1,
          "DiscountType": 0,
          "DiscountTypeAsString": "Percent",
          "SalesOrderDiscountKey": 9
        }
      ]
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'LastEditedUserName' in type 'SSI.plbl.ClsSalesOrder'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'LastEditedUserName' in type 'SSI.plbl.ClsSalesOrder'.