Megaventory API v2017a

<back to all web services

SalesQuoteGet

The following routes are available for this service:
GET POST/SalesQuote/SalesQuoteGetGets information on existing sales quotesUses your API Key and some Filters in an array format and returns the search results using given filters. Optionally, you can use ReturnTopNRecords to limit the number of the results to the specified number (omit, or add ReturnTopNRecords = -1 to get all the available results). The ReturnTopNRecords chooses the top records in a SalesQuoteId descending order.

Examples:



A.

Return the first mvSalesQuotes object that we have to pickup out of Athens. The results are returned as mvSalesQuotes objects.

Value: 

 {
   "Filters": [
      {
         "FieldName": "SalesQuoteShippingAddress",
         "SearchOperator": "NotEquals",
         "SearchValue": "Athens"
      }
   ],
   "ReturnTopNRecords": 1
}

Response: 

{
   "mvSalesQuotes": [
      {
         "SalesQuoteId": 49411,
         "SalesQuoteTypeId": -10,
         "SalesQuoteTypeAbbreviation": "QUOTE",
         "SalesQuoteTypeDescription": "Sales Quote",
         "SalesQuoteNo": "62",
         "RelatedSalesOrderNo": "",
         "RelatedSalesOrderTypeId": 0,
         "SalesQuoteReferenceNo": "",
         "SalesQuoteReferenceApplication": "",
         "SalesQuoteDate": "/Date(1531342800000-0000)/",
         "SalesQuoteCustomOrderDate1": "/Date(-62135596800000-0000)/",
         "SalesQuoteCustomOrderDate2": "/Date(-62135596800000-0000)/",
         "SalesQuoteCurrencyCode": "USD",
         "SalesQuoteClientID": 5357,
         "SalesQuoteShippingAddress": "",
         "SalesQuoteBillingAddress": "1 Ship Add, Cupertino CA 95014",
         "SalesQuoteContactPerson": "c2",
         "SalesQuoteInventoryLocationID": 0,
         "SalesQuoteCustomFlag1": false,
         "SalesQuoteCustomFlag2": false,
         "SalesQuoteCustomFlag3": false,
         "SalesQuoteCustomFlag4": false,
         "SalesQuoteCustomFlag5": false,
         "SalesQuoteCustomFlag6": false,
         "SalesQuoteCustomFlag7": false,
         "SalesQuoteCustomFlag8": false,
         "SalesQuoteCustomFlag9": false,
         "SalesQuoteCustomFlag10": false,
         "SalesQuoteComments": "",
         "SalesQuoteTags": "",
         "SalesQuotePaymentTermsEnumeration": "None",
         "SalesQuoteTotalQuantity": 1,
         "SalesQuoteAmountSubtotalWithoutTaxAndDiscount": 0,
         "SalesQuoteAmountTotalDiscount": 0,
         "SalesQuoteAmountTotalTax": 0,
         "SalesQuoteAmountGrandTotal": 0,
         "SalesQuoteAmountShipping": 0,
         "SalesQuoteDetails": [
            {
               "SalesQuoteRowDetailID": 112932,
               "SalesQuoteRowProductID": 66492,
               "SalesQuoteRowProductSKU": "product",
               "SalesQuoteRowProductDescription": "product",
               "SalesQuoteRowQuantity": 1,
               "SalesQuoteRowUnitPriceWithoutTaxOrDiscount": 0,
               "SalesQuoteRowTaxID": 0,
               "SalesQuoteRowTotalTaxAmount": 0,
               "SalesQuoteRowDiscountID": 0,
               "SalesQuoteRowTotalDiscountAmount": 0,
               "SalesQuoteRowTotalAmount": 0,
               "SalesQuoteRowRemarks": ""
            }
         ],
         "SalesQuoteStatus": "Pending",
         "SalesQuoteCreationDate": "/Date(1531413275417-0000)/",
         "SalesQuoteLastUpdatedDate": "/Date(1531413538977-0000)/"
      }
   ],
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/SalesQuoteGet HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/jsv
Content-Length: length

{
	Filters: 
	[
		{
			AndOr: And,
			Group: Undefined,
			FieldName: String,
			SearchOperator: Undefined,
			SearchValue: String
		}
	],
	ReturnTopNRecords: 0,
	APIKEY: String,
	mvSalesQuoteNo: String,
	mvSalesQuoteStatus: ValidStatus
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	mvSalesQuotes: 
	[
		{
			SalesQuoteId: 0,
			SalesQuoteTypeId: 0,
			SalesQuoteTypeAbbreviation: String,
			SalesQuoteTypeDescription: String,
			SalesQuoteNo: String,
			RelatedSalesOrderNo: String,
			RelatedSalesOrderTypeId : 0,
			SalesQuoteReferenceNo: String,
			SalesQuoteReferenceApplication: String,
			SalesQuoteDate: 0001-01-01,
			SalesQuoteCustomOrderDate1: 0001-01-01,
			SalesQuoteCustomOrderDate2: 0001-01-01,
			SalesQuoteCurrencyCode: String,
			SalesQuoteClientID: 0,
			SalesQuoteClientName: String,
			SalesQuoteBillingAddress: String,
			SalesQuoteShippingAddress: String,
			SalesQuoteAddresses: 
			[
				{
					AddressType: General,
					AddressLine1: String,
					AddressLine2: String,
					AddressLine3: String,
					Name: String,
					Phone: String,
					Email: String,
					TaxIdNumber: String,
					Organization: String,
					City: String,
					State: String,
					Country: NONE,
					CountryName: String,
					Longitude: String,
					Latitude: String,
					ZipCode: String
				}
			],
			SalesQuoteContactPerson: String,
			SalesQuoteInventoryLocationID: 0,
			SalesQuoteCustomFlag1: False,
			SalesQuoteCustomFlag2: False,
			SalesQuoteCustomFlag3: False,
			SalesQuoteCustomFlag4: False,
			SalesQuoteCustomFlag5: False,
			SalesQuoteCustomFlag6: False,
			SalesQuoteCustomFlag7: False,
			SalesQuoteCustomFlag8: False,
			SalesQuoteCustomFlag9: False,
			SalesQuoteCustomFlag10: False,
			SalesQuoteComments: String,
			SalesQuoteTags: String,
			SalesQuotePaymentTermsEnumeration: None,
			SalesQuotePaymentMethod: None,
			SalesQuoteTotalQuantity: 0,
			SalesQuoteAmountSubtotalWithoutTaxAndDiscount: 0.00,
			SalesQuoteAmountShipping: 0.00,
			SalesQuoteAmountTotalDiscount: 0.00,
			SalesQuoteAmountTotalTax: 0.00,
			SalesQuoteAmountGrandTotal: 0.00,
			SalesQuoteTotalWeight: 0,
			SalesQuoteTotalWeightUnitID: 0,
			SalesQuoteDetails: 
			[
				{
					SalesQuoteRowDetailID: 0,
					SalesQuoteRowProductID: 0,
					SalesQuoteRowProductSKU: String,
					SalesQuoteRowProductDescription: String,
					SalesQuoteRowQuantity: 0,
					SalesQuoteRowUnitPriceWithoutTaxOrDiscount: 0,
					SalesQuoteRowTaxID: 0,
					SalesQuoteRowTotalTaxAmount: 0,
					SalesQuoteRowDiscountID: 0,
					SalesQuoteRowTotalDiscountAmount: 0,
					SalesQuoteRowTotalAmount: 0,
					SalesQuoteRowRemarks: String,
					SalesQuoteRowTotalWeight: 0,
					SalesQuoteRowTotalWeightUnitID: 0
				}
			],
			SalesQuoteShipDocumentTypeID: String,
			SalesQuoteStatus: ValidStatus,
			SalesQuoteCreationDate: 0001-01-01,
			SalesQuoteLastUpdatedDate: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	InternalErrorCode: String
}