API ReferenceGuides
Guides
Home

Add SalesOrder

Use this operation to add new SalesOrder object.

Suggest Edits

Parameters

Body Params
JSON:json
Salesorder details needs to be passed as body parameter,it should be in JSON format.
XML:string
Salesorder details needs to be passed as body parameter,it should be in XML format.
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/SalesOrder will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/SalesOrder
Header Params
Accept:string
Response header need to be passed for eg. application/json or application/xml.
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
NOTE: For SalesOrder ,

  • OrderNo field contains channel order id.
  • SalesOrderid and Orderno is auto generated.
  • If AccountId is provided in XML/JSON ,Salesorder will fetch account based on that accountid.
{
	"Orders": {
		"Order": [{
			"OrderNo": 5531,
			"ChannelId": 2563,
			"ChannelName": "Amazon",
			"OrderDate": "01-24-2020 07:08:13",
			"ModifiedDate": "01-24-2020 07:08:13",
			"Subject": "Test New SalesOrder",
			"PotentialName": "New Potential",
			"QuoteName": "15march",
			"AccountId": 156961,
			"AccountName": "Test Account",
			"AccountPhone": 2344452,
			"AccountEmailAddress": "[email protected]",
			"ContactFirstName": "Contact Firstname",
			"ContactLastName": "Contact Lastname",
			"ContactPhone": 56984663,
			"ContactEmailAddress": "[email protected]",
			"BillingName": "Contact Firstname Contact Lastname",
			"BillingStreet": "45623 Clean Drive",
			"BillingCity": "Oakland",
			"BillingState": "CA",
			"BillingZipCode": 94601,
			"BillingCountry": "UnitedStates",
			"ShipToName": "Jane Doe",
			"ShipToPhone": "(415)675-3134",
			"ShipToEmailAddress": "[email protected]",
			"ShippingStreet": "4567DoeCircle",
			"ShippingCity": "SanFrancisco",
			"ShippingState": "CA",
			"ShippingZipCode": 94104,
			"ShippingCountry": "UnitedStates",
			"OrderDiscount": 5.55,
			"OrderDiscountCode": "",
			"SubTotal": 270.43,
			"ShippingCost": 6.75,
			"SalesTaxAuthority": "",
			"SalesTaxes": 24.25,
			"GrandTotal": 301.43,
			"DefaultCurrency": "",
			"ExchangeRate": "",
			"Status": "Created,Paid,",
			"ShippingStatus": "Ready to Pick,",
			"AdditionalFees": 3.45,
			"DefaultPriceBook": "Default",
			"PaymentLineItems": {
				"Payment": [{
						"PaymentMethod": "Cash",
						"PaymentAmount": 9,
						"PaymentDate": "2021-01-19"
					},
					{
						"PaymentMethod": "Check",
						"PaymentAmount": 11,
						"PaymentDate": "2021-01-20",
						"CheckNumber": "",
						"CheckWriter": "Test"
					}
				]
			},
			"DueDate": "01-24-2020",
			"InvoiceNo": "1881",
			"InvoiceDate": "07-08-2021",
			"CallDate": "01-24-2020",
			"CustomerNo": 23276,
			"AssignedTo": "admin",
			"ExportToQuickbooks": 2,
			"Type": "ASAP",
			"Priority": "Standard",
			"Pending": "Nothing",
			"Salescommission": 30.14,
			"TermsAndConditions": "Prepaid",
			"Description": "Order notes goes here.",
			"Carrier": "USPS",
			"ShippingMethod": "Priority Mail 2-Day",
			"DeliverFrom": "OAK",
			"ShippingDate": "",
			"TrackingNo": "",
			"ActualShippingCost": 23,
			"SpecialHandling": "Special Instructions goes here.",
			"ShipQPriority": "Standard",
			"BackorderHandling": "ShipAsAvailable",
			"PacklistType": "Show Company Details and Logo",
			"AmazonPrimeShipping": "Yes",
			"Cancelled": "No",
			"OnHold": "No",
			"RelatedPOs": "",
			"RelatedDropShipPOs": "",
			"OrdersCustomFields": {
				"CustomField": [{
						"Name": "CustomFied1",
						"Value": "Custom info 1"
					},
					{
						"Name": "CustomFied2",
						"Value": "Custom info 2"
					}
				]
			},
			"OrderDetails": {
				"OD": [{
						"ProductsName": "Test New Product1",
						"ProductCode": "TNP1",
						"MatrixSKUCode": 0,
						"SerialNo": "",
						"ProductNotes": "Product notes goes here.",
						"ProductQty": 2,
						"ProductPrice": 15,
						"ProductDiscount": 0,
						"ProductTotal": 30,
						"LineItemLocation": "OAK",
						"LineItemShippingCarrier": "UPS",
						"LineItemShippingMethod": "UPS Ground",
						"LineItemTrackingNumber": "221133",
						"LineItemShippingCost": "0.00",
						"LineItemShippingDate": "07-08-2021",
						"LineItemShippingStatus": "Ready to pick,"
					},
					{
						"ProductsName": "Test Matrix Product2",
						"ProductCode": "TMP2",
						"MatrixSKUCode": "13420",
						"SerialNo": "",
						"ProductNotes": "Product notes goes here.",
						"ProductQty": 2,
						"ProductPrice": 5,
						"ProductDiscount": 0,
						"ProductTotal": 10,
						"LineItemLocation": "OAK",
						"LineItemShippingCarrier": "UPS",
						"LineItemShippingMethod": "UPS Ground",
						"LineItemTrackingNumber": "221133",
						"LineItemShippingCost": "0.00",
						"LineItemShippingDate": "07-08-2021",
						"LineItemShippingStatus": "Ready to pick,"
					}
				]
			}
		}]
	}
}

<Orders>
	<Order>
		<OrderNo>5531</OrderNo>
		<ChannelId>2563</ChannelId>
		<ChannelName>Amazon</ChannelName>
		<OrderDate>01-24-2020 07:08:13</OrderDate>
		<ModifiedDate>01-24-2020 07:08:13</ModifiedDate>
		<Subject>Test New SalesOrder</Subject>
		<PotentialName>New Potential</PotentialName>
		<QuoteName>15march</QuoteName>
		<AccountId>156961</AccountId>
		<AccountName>Test Account</AccountName>
		<AccountPhone>2344452</AccountPhone>
		<AccountEmailAddress>[email protected]</AccountEmailAddress>
		<ContactFirstName>Contact Firstname</ContactFirstName>
		<ContactLastName>Contact Lastname</ContactLastName>
		<ContactPhone>56984663</ContactPhone>
		<ContactEmailAddress>[email protected]</ContactEmailAddress>
		<BillingName>Contact Firstname Contact Lastname</BillingName>
		<BillingStreet>45623 Clean Drive</BillingStreet>
		<BillingCity>Oakland</BillingCity>
		<BillingState>CA</BillingState>
		<BillingZipCode>94601</BillingZipCode>
		<BillingCountry>UnitedStates</BillingCountry>
		<ShipToName>Jane Doe</ShipToName>
		<ShipToPhone>(415)675-3134</ShipToPhone>
		<ShipToEmailAddress>[email protected]</ShipToEmailAddress>
		<ShippingStreet>4567DoeCircle</ShippingStreet>
		<ShippingCity>SanFrancisco</ShippingCity>
		<ShippingState>CA</ShippingState>
		<ShippingZipCode>94104</ShippingZipCode>
		<ShippingCountry>UnitedStates</ShippingCountry>
		<OrderDiscount>5.55</OrderDiscount>
		<OrderDiscountCode></OrderDiscountCode>
		<SubTotal>270.430</SubTotal>
		<ShippingCost>6.750</ShippingCost>
		<SalesTaxAuthority></SalesTaxAuthority>
		<SalesTaxes>24.250</SalesTaxes>
		<GrandTotal>301.430</GrandTotal>
		<DefaultCurrency></DefaultCurrency>
		<ExchangeRate></ExchangeRate>
		<Status>Created,Paid,</Status>
		<ShippingStatus>Ready to Pick,</ShippingStatus>
		<AdditionalFees>3.45</AdditionalFees>
		<DefaultPriceBook>Default</DefaultPriceBook>
		<PaymentLineItems>
			<Payment>
				<PaymentMethod>Cash</PaymentMethod>
				<PaymentAmount>9</PaymentAmount>
				<PaymentDate>2021-01-19</PaymentDate>
			</Payment>
			<Payment>
				<PaymentMethod>Check</PaymentMethod>
				<PaymentAmount>11</PaymentAmount>
				<PaymentDate>2021-01-20</PaymentDate>
				<CheckNumber></CheckNumber>
				<CheckWriter>Test</CheckWriter>
			</Payment>
		</PaymentLineItems>
		<DueDate>01-24-2020</DueDate>
		<InvoiceNo>1881</InvoiceNo>
		<InvoiceDate>07-08-2021</InvoiceDate>
		<CallDate>01-24-2020</CallDate>
		<CustomerNo>23276</CustomerNo>
		<AssignedTo>admin</AssignedTo>
		<ExportToQuickbooks>2</ExportToQuickbooks>
		<Type>ASAP</Type>
		<Priority>Standard</Priority>
		<Pending>Nothing</Pending>
		<Salescommission>30.140</Salescommission>
		<TermsAndConditions>Prepaid</TermsAndConditions>
		<Description>Order notes goes here.</Description>
		<Carrier>USPS</Carrier>
		<ShippingMethod>Priority Mail 2-Day</ShippingMethod>
		<DeliverFrom>OAK</DeliverFrom>
		<ShippingDate></ShippingDate>
		<TrackingNo></TrackingNo>
		<ActualShippingCost>23.00</ActualShippingCost>
		<SpecialHandling>Special Instructions goes here.</SpecialHandling>
		<ShipQPriority>Standard</ShipQPriority>
		<BackorderHandling>ShipAsAvailable</BackorderHandling>
		<PacklistType>Show Company Details and Logo</PacklistType>
		<AmazonPrimeShipping>Yes</AmazonPrimeShipping>
		<Cancelled>No</Cancelled>
		<OnHold>No</OnHold>
		<RelatedPOs></RelatedPOs>
		<RelatedDropShipPOs></RelatedDropShipPOs>
		<OrdersCustomFields>
			<CustomField>
				<Name>CustomFied1</Name>
				<Value>Custom info 1</Value>
			</CustomField>
			<CustomField>
				<Name>CustomFied2</Name>
				<Value>Custom info 2</Value>
			</CustomField>
		</OrdersCustomFields>
		<OrderDetails>
			<OD>
				<ProductsName>Test New Product1</ProductsName>
				<ProductCode>TNP1</ProductCode>
				<MatrixSKUCode>0</MatrixSKUCode>
				<SerialNo></SerialNo>
				<ProductNotes>Product notes goes here.</ProductNotes>
				<ProductQty>2</ProductQty>
				<ProductPrice>15</ProductPrice>
				<ProductDiscount>0</ProductDiscount>
				<ProductTotal>30</ProductTotal>
				<LineItemLocation>OAK</LineItemLocation>
				<LineItemShippingCarrier>UPS</LineItemShippingCarrier>
				<LineItemShippingMethod>UPS Ground</LineItemShippingMethod>
				<LineItemTrackingNumber>221133</LineItemTrackingNumber>
				<LineItemShippingCost>0.00</LineItemShippingCost>
				<LineItemShippingDate>07-08-2021</LineItemShippingDate>
				<LineItemShippingStatus>Ready to pick,</LineItemShippingStatus>
			</OD>
			<OD>
				<ProductsName>Test Matrix Product2</ProductsName>
				<ProductCode>TMP2</ProductCode>
				<MatrixSKUCode>13420</MatrixSKUCode>
				<SerialNo></SerialNo>
				<ProductNotes>Product notes goes here.</ProductNotes>
				<ProductQty>2</ProductQty>
				<ProductPrice>5</ProductPrice>
				<ProductDiscount>0</ProductDiscount>
				<ProductTotal>10</ProductTotal>
				<LineItemLocation>OAK</LineItemLocation>
				<LineItemShippingCarrier>UPS</LineItemShippingCarrier>
				<LineItemShippingMethod>UPS Ground</LineItemShippingMethod>
				<LineItemTrackingNumber>221133</LineItemTrackingNumber>
				<LineItemShippingCost>0.00</LineItemShippingCost>
				<LineItemShippingDate>07-08-2021</LineItemShippingDate>
				<LineItemShippingStatus>Ready to pick,</LineItemShippingStatus>
			</OD>
		</OrderDetails>
	</Order>
</Orders>

{
	"Orders": {
		"Order": [{
				"OrderNo": 5531,
				"ChannelId": 2563,
				"ChannelName": "Amazon",
				"OrderDate": "01-24-2020 07:08:13",
				"ModifiedDate": "01-24-2020 07:08:13",
				"Subject": "Test New SalesOrder",
				"PotentialName": "New Potential",
				"QuoteName": "15march",
				"AccountId": 156961,
				"AccountName": "Test Account",
				"AccountPhone": 2344452,
				"AccountEmailAddress": "[email protected]",
				"ContactFirstName": "Contact Firstname",
				"ContactLastName": "Contact Lastname",
				"ContactPhone": 56984663,
				"ContactEmailAddress": "[email protected]",
				"BillingName": "Contact Firstname Contact Lastname",
				"BillingStreet": "45623 Clean Drive",
				"BillingCity": "Oakland",
				"BillingState": "CA",
				"BillingZipCode": 94601,
				"BillingCountry": "UnitedStates",
				"ShipToName": "Jane Doe",
				"ShipToPhone": "(415)675-3134",
				"ShipToEmailAddress": "[email protected]",
				"ShippingStreet": "4567DoeCircle",
				"ShippingCity": "SanFrancisco",
				"ShippingState": "CA",
				"ShippingZipCode": 94104,
				"ShippingCountry": "UnitedStates",
				"OrderDiscount": 5.55,
				"OrderDiscountCode": "",
				"SubTotal": 270.43,
				"ShippingCost": 6.75,
				"SalesTaxAuthority": "",
				"SalesTaxes": 24.25,
				"GrandTotal": 301.43,
				"DefaultCurrency": "",
				"ExchangeRate": "",
				"Status": "Created,Paid,",
				"ShippingStatus": "Ready to Pick,",
				"AdditionalFees": 3.45,
				"DefaultPriceBook": "Default",
				"PaymentLineItems": {
					"Payment": [{
							"PaymentMethod": "Cash",
							"PaymentAmount": 9,
							"PaymentDate": "2021-01-19"
						},
						{
							"PaymentMethod": "Check",
							"PaymentAmount": 11,
							"PaymentDate": "2021-01-20",
							"CheckNumber": "",
							"CheckWriter": "Test"
						}
					]
				},
				"DueDate": "01-24-2020",
				"InvoiceNo": "1881",
				"InvoiceDate": "07-08-2021",
				"CallDate": "01-24-2020",
				"CustomerNo": 23276,
				"AssignedTo": "admin",
				"ExportToQuickbooks": 2,
				"Type": "ASAP",
				"Priority": "Standard",
				"Pending": "Nothing",
				"Salescommission": 30.14,
				"TermsAndConditions": "Prepaid",
				"Description": "Order notes goes here.",
				"Carrier": "USPS",
				"ShippingMethod": "Priority Mail 2-Day",
				"DeliverFrom": "OAK",
				"ShippingDate": "",
				"TrackingNo": "",
				"ActualShippingCost": 23,
				"SpecialHandling": "Special Instructions goes here.",
				"ShipQPriority": "Standard",
				"BackorderHandling": "ShipAsAvailable",
				"PacklistType": "Show Company Details and Logo",
				"AmazonPrimeShipping": "Yes",
				"Cancelled": "No",
				"OnHold": "No",
				"RelatedPOs": "",
				"RelatedDropShipPOs": "",
				"OrdersCustomFields": {
					"CustomField": [{
							"Name": "CustomFied1",
							"Value": "Custom info 1"
						},
						{
							"Name": "CustomFied2",
							"Value": "Custom info 2"
						}
					]
				},
				"OrderDetails": {
					"OD": [{
							"ProductsName": "Test New Product1",
							"ProductCode": "TNP1",
							"MatrixSKUCode": 0,
							"SerialNo": "",
							"ProductNotes": "Product notes goes here.",
							"ProductQty": 2,
							"ProductPrice": 15,
							"ProductDiscount": 0,
							"ProductTotal": 30,
							"LineItemLocation": "OAK",
							"LineItemShippingCarrier": "UPS",
							"LineItemShippingMethod": "UPS Ground",
							"LineItemTrackingNumber": "221133",
							"LineItemShippingCost": "0.00",
							"LineItemShippingDate": "07-08-2021",
							"LineItemShippingStatus": "Ready to pick,"
						},
						{
							"ProductsName": "Test Matrix Product2",
							"ProductCode": "TMP2",
							"MatrixSKUCode": "13420",
							"SerialNo": "",
							"ProductNotes": "Product notes goes here.",
							"ProductQty": 2,
							"ProductPrice": 5,
							"ProductDiscount": 0,
							"ProductTotal": 10,
							"LineItemLocation": "OAK",
							"LineItemShippingCarrier": "UPS",
							"LineItemShippingMethod": "UPS Ground",
							"LineItemTrackingNumber": "221133",
							"LineItemShippingCost": "0.00",
							"LineItemShippingDate": "07-08-2021",
							"LineItemShippingStatus": "Ready to pick,"
						}
					]
				}
			},
			{
				"OrderNo": 5532,
				"ChannelId": 2563,
				"ChannelName": "Amazon",
				"OrderDate": "01-24-2020 07:08:13",
				"ModifiedDate": "01-24-2020 07:08:13",
				"Subject": "Test New SalesOrder 2",
				"PotentialName": "New Potential",
				"QuoteName": "15march",
				"AccountId": 156961,
				"AccountName": "Test Account",
				"AccountPhone": 2344452,
				"AccountEmailAddress": "[email protected]",
				"ContactFirstName": "Contact Firstname",
				"ContactLastName": "Contact Lastname",
				"ContactPhone": 56984663,
				"ContactEmailAddress": "[email protected]",
				"BillingName": "Contact Firstname Contact Lastname",
				"BillingStreet": "45623 Clean Drive",
				"BillingCity": "Oakland",
				"BillingState": "CA",
				"BillingZipCode": 94601,
				"BillingCountry": "UnitedStates",
				"ShipToName": "Jane Doe",
				"ShipToPhone": "(415)675-3134",
				"ShipToEmailAddress": "[email protected]",
				"ShippingStreet": "4567DoeCircle",
				"ShippingCity": "SanFrancisco",
				"ShippingState": "CA",
				"ShippingZipCode": 94104,
				"ShippingCountry": "UnitedStates",
				"OrderDiscount": 5.55,
				"OrderDiscountCode": "",
				"SubTotal": 270.43,
				"ShippingCost": 6.75,
				"SalesTaxAuthority": "",
				"SalesTaxes": 24.25,
				"GrandTotal": 301.43,
				"DefaultCurrency": "",
				"ExchangeRate": "",
				"Status": "Created,Paid,",
				"ShippingStatus": "Ready to Pick,",
				"AdditionalFees": 3.45,
				"DefaultPriceBook": "Default",
				"PaymentLineItems": {
					"Payment": [{
							"PaymentMethod": "Cash",
							"PaymentAmount": 9,
							"PaymentDate": "2021-01-19"
						},
						{
							"PaymentMethod": "Check",
							"PaymentAmount": 11,
							"PaymentDate": "2021-01-20",
							"CheckNumber": "",
							"CheckWriter": "Test"
						}
					]
				},
				"DueDate": "01-24-2020",
				"InvoiceNo": "1881",
				"InvoiceDate": "07-08-2021",
				"CallDate": "01-24-2020",
				"CustomerNo": 23276,
				"AssignedTo": "admin",
				"ExportToQuickbooks": 2,
				"Type": "ASAP",
				"Priority": "Standard",
				"Pending": "Nothing",
				"Salescommission": 30.14,
				"TermsAndConditions": "Prepaid",
				"Description": "Order notes goes here.",
				"Carrier": "USPS",
				"ShippingMethod": "Priority Mail 2-Day",
				"DeliverFrom": "OAK",
				"ShippingDate": "",
				"TrackingNo": "",
				"ActualShippingCost": 23,
				"SpecialHandling": "Special Instructions goes here.",
				"ShipQPriority": "Standard",
				"BackorderHandling": "ShipAsAvailable",
				"PacklistType": "Show Company Details and Logo",
				"AmazonPrimeShipping": "Yes",
				"Cancelled": "No",
				"OnHold": "No",
				"RelatedPOs": "",
				"RelatedDropShipPOs": "",
				"OrdersCustomFields": {
					"CustomField": [{
							"Name": "CustomFied1",
							"Value": "Custom info 1"
						},
						{
							"Name": "CustomFied2",
							"Value": "Custom info 2"
						}
					]
				},
				"OrderDetails": {
					"OD": [{
							"ProductsName": "Test New Product1",
							"ProductCode": "TNP1",
							"MatrixSKUCode": 0,
							"SerialNo": "",
							"ProductNotes": "Product notes goes here.",
							"ProductQty": 2,
							"ProductPrice": 15,
							"ProductDiscount": 0,
							"ProductTotal": 30,
							"LineItemLocation": "OAK",
							"LineItemShippingCarrier": "UPS",
							"LineItemShippingMethod": "UPS Ground",
							"LineItemTrackingNumber": "221133",
							"LineItemShippingCost": "0.00",
							"LineItemShippingDate": "07-08-2021",
							"LineItemShippingStatus": "Ready to pick,"
						},
						{
							"ProductsName": "Test Matrix Product2",
							"ProductCode": "TMP2",
							"MatrixSKUCode": "13420",
							"SerialNo": "",
							"ProductNotes": "Product notes goes here.",
							"ProductQty": 2,
							"ProductPrice": 5,
							"ProductDiscount": 0,
							"ProductTotal": 10,
							"LineItemLocation": "OAK",
							"LineItemShippingCarrier": "UPS",
							"LineItemShippingMethod": "UPS Ground",
							"LineItemTrackingNumber": "221133",
							"LineItemShippingCost": "0.00",
							"LineItemShippingDate": "07-08-2021",
							"LineItemShippingStatus": "Ready to pick,"
						}
					]
				}
			}
		]
	}
}

<Orders>
	<Order>
		<OrderNo>5531</OrderNo>
		<ChannelId>2563</ChannelId>
		<ChannelName>Amazon</ChannelName>
		<OrderDate>01-24-2020 07:08:13</OrderDate>
		<ModifiedDate>01-24-2020 07:08:13</ModifiedDate>
		<Subject>Test New SalesOrder</Subject>
		<PotentialName>New Potential</PotentialName>
		<QuoteName>15march</QuoteName>
		<AccountId>156961</AccountId>
		<AccountName>Test Account</AccountName>
		<AccountPhone>2344452</AccountPhone>
		<AccountEmailAddress>[email protected]</AccountEmailAddress>
		<ContactFirstName>Contact Firstname</ContactFirstName>
		<ContactLastName>Contact Lastname</ContactLastName>
		<ContactPhone>56984663</ContactPhone>
		<ContactEmailAddress>[email protected]</ContactEmailAddress>
		<BillingName>Contact Firstname Contact Lastname</BillingName>
		<BillingStreet>45623 Clean Drive</BillingStreet>
		<BillingCity>Oakland</BillingCity>
		<BillingState>CA</BillingState>
		<BillingZipCode>94601</BillingZipCode>
		<BillingCountry>UnitedStates</BillingCountry>
		<ShipToName>Jane Doe</ShipToName>
		<ShipToPhone>(415)675-3134</ShipToPhone>
		<ShipToEmailAddress>[email protected]</ShipToEmailAddress>
		<ShippingStreet>4567DoeCircle</ShippingStreet>
		<ShippingCity>SanFrancisco</ShippingCity>
		<ShippingState>CA</ShippingState>
		<ShippingZipCode>94104</ShippingZipCode>
		<ShippingCountry>UnitedStates</ShippingCountry>
		<OrderDiscount>5.55</OrderDiscount>
		<OrderDiscountCode />
		<SubTotal>270.430</SubTotal>
		<ShippingCost>6.750</ShippingCost>
		<SalesTaxAuthority />
		<SalesTaxes>24.250</SalesTaxes>
		<GrandTotal>301.430</GrandTotal>
		<DefaultCurrency />
		<ExchangeRate />
		<Status>Created,Paid,</Status>
		<ShippingStatus>Ready to Pick,</ShippingStatus>
		<AdditionalFees>3.45</AdditionalFees>
		<DefaultPriceBook>Default</DefaultPriceBook>
		<PaymentLineItems>
			<Payment>
				<PaymentMethod>Cash</PaymentMethod>
				<PaymentAmount>9</PaymentAmount>
				<PaymentDate>2021-01-19</PaymentDate>
			</Payment>
			<Payment>
				<PaymentMethod>Check</PaymentMethod>
				<PaymentAmount>11</PaymentAmount>
				<PaymentDate>2021-01-20</PaymentDate>
				<CheckNumber />
				<CheckWriter>Test</CheckWriter>
			</Payment>
		</PaymentLineItems>
		<DueDate>01-24-2020</DueDate>
		<InvoiceNo>1881</InvoiceNo>
		<InvoiceDate>07-08-2021</InvoiceDate>
		<CallDate>01-24-2020</CallDate>
		<CustomerNo>23276</CustomerNo>
		<AssignedTo>admin</AssignedTo>
		<ExportToQuickbooks>2</ExportToQuickbooks>
		<Type>ASAP</Type>
		<Priority>Standard</Priority>
		<Pending>Nothing</Pending>
		<Salescommission>30.140</Salescommission>
		<TermsAndConditions>Prepaid</TermsAndConditions>
		<Description>Order notes goes here.</Description>
		<Carrier>USPS</Carrier>
		<ShippingMethod>Priority Mail 2-Day</ShippingMethod>
		<DeliverFrom>OAK</DeliverFrom>
		<ShippingDate />
		<TrackingNo />
		<ActualShippingCost>23.00</ActualShippingCost>
		<SpecialHandling>Special Instructions goes here.</SpecialHandling>
		<ShipQPriority>Standard</ShipQPriority>
		<BackorderHandling>ShipAsAvailable</BackorderHandling>
		<PacklistType>Show Company Details and Logo</PacklistType>
		<AmazonPrimeShipping>Yes</AmazonPrimeShipping>
		<Cancelled>No</Cancelled>
		<OnHold>No</OnHold>
		<RelatedPOs></RelatedPOs>
		<RelatedDropShipPOs></RelatedDropShipPOs>
		<OrdersCustomFields>
			<CustomField>
				<Name>CustomFied1</Name>
				<Value>Custom info 1</Value>
			</CustomField>
			<CustomField>
				<Name>CustomFied2</Name>
				<Value>Custom info 2</Value>
			</CustomField>
		</OrdersCustomFields>
		<OrderDetails>
			<OD>
				<ProductsName>Test New Product1</ProductsName>
				<ProductCode>TNP1</ProductCode>
				<MatrixSKUCode>0</MatrixSKUCode>
				<SerialNo />
				<ProductNotes>Product notes goes here.</ProductNotes>
				<ProductQty>2</ProductQty>
				<ProductPrice>15</ProductPrice>
				<ProductDiscount>0</ProductDiscount>
				<ProductTotal>30</ProductTotal>
				<LineItemLocation>OAK</LineItemLocation>
				<LineItemShippingCarrier>UPS</LineItemShippingCarrier>
				<LineItemShippingMethod>UPS Ground</LineItemShippingMethod>
				<LineItemTrackingNumber>221133</LineItemTrackingNumber>
				<LineItemShippingCost>0.00</LineItemShippingCost>
				<LineItemShippingDate>07-08-2021</LineItemShippingDate>
				<LineItemShippingStatus>Ready to pick,</LineItemShippingStatus>
			</OD>
			<OD>
				<ProductsName>Test Matrix Product2</ProductsName>
				<ProductCode>TMP2</ProductCode>
				<MatrixSKUCode>13420</MatrixSKUCode>
				<SerialNo />
				<ProductNotes>Product notes goes here.</ProductNotes>
				<ProductQty>2</ProductQty>
				<ProductPrice>5</ProductPrice>
				<ProductDiscount>0</ProductDiscount>
				<ProductTotal>10</ProductTotal>
				<LineItemLocation>OAK</LineItemLocation>
				<LineItemShippingCarrier>UPS</LineItemShippingCarrier>
				<LineItemShippingMethod>UPS Ground</LineItemShippingMethod>
				<LineItemTrackingNumber>221133</LineItemTrackingNumber>
				<LineItemShippingCost>0.00</LineItemShippingCost>
				<LineItemShippingDate>07-08-2021</LineItemShippingDate>
				<LineItemShippingStatus>Ready to pick,</LineItemShippingStatus>
			</OD>
		</OrderDetails>
	</Order>
	<Order>
		<OrderNo>5532</OrderNo>
		<ChannelId>2563</ChannelId>
		<ChannelName>Amazon</ChannelName>
		<OrderDate>01-24-2020 07:08:13</OrderDate>
		<ModifiedDate>01-24-2020 07:08:13</ModifiedDate>
		<Subject>Test New SalesOrder 2</Subject>
		<PotentialName>New Potential</PotentialName>
		<QuoteName>15march</QuoteName>
		<AccountId>156961</AccountId>
		<AccountName>Test Account</AccountName>
		<AccountPhone>2344452</AccountPhone>
		<AccountEmailAddress>[email protected]</AccountEmailAddress>
		<ContactFirstName>Contact Firstname</ContactFirstName>
		<ContactLastName>Contact Lastname</ContactLastName>
		<ContactPhone>56984663</ContactPhone>
		<ContactEmailAddress>[email protected]</ContactEmailAddress>
		<BillingName>Contact Firstname Contact Lastname</BillingName>
		<BillingStreet>45623 Clean Drive</BillingStreet>
		<BillingCity>Oakland</BillingCity>
		<BillingState>CA</BillingState>
		<BillingZipCode>94601</BillingZipCode>
		<BillingCountry>UnitedStates</BillingCountry>
		<ShipToName>Jane Doe</ShipToName>
		<ShipToPhone>(415)675-3134</ShipToPhone>
		<ShipToEmailAddress>[email protected]</ShipToEmailAddress>
		<ShippingStreet>4567DoeCircle</ShippingStreet>
		<ShippingCity>SanFrancisco</ShippingCity>
		<ShippingState>CA</ShippingState>
		<ShippingZipCode>94104</ShippingZipCode>
		<ShippingCountry>UnitedStates</ShippingCountry>
		<OrderDiscount>5.55</OrderDiscount>
		<OrderDiscountCode />
		<SubTotal>270.430</SubTotal>
		<ShippingCost>6.750</ShippingCost>
		<SalesTaxAuthority />
		<SalesTaxes>24.250</SalesTaxes>
		<GrandTotal>301.430</GrandTotal>
		<DefaultCurrency />
		<ExchangeRate />
		<Status>Created,Paid,</Status>
		<ShippingStatus>Ready to Pick,</ShippingStatus>
		<AdditionalFees>3.45</AdditionalFees>
		<DefaultPriceBook>Default</DefaultPriceBook>
		<PaymentLineItems>
			<Payment>
				<PaymentMethod>Cash</PaymentMethod>
				<PaymentAmount>9</PaymentAmount>
				<PaymentDate>2021-01-19</PaymentDate>
			</Payment>
			<Payment>
				<PaymentMethod>Check</PaymentMethod>
				<PaymentAmount>11</PaymentAmount>
				<PaymentDate>2021-01-20</PaymentDate>
				<CheckNumber />
				<CheckWriter>Test</CheckWriter>
			</Payment>
		</PaymentLineItems>
		<DueDate>01-24-2020</DueDate>
		<InvoiceNo>1881</InvoiceNo>
		<InvoiceDate>07-08-2021</InvoiceDate>
		<CallDate>01-24-2020</CallDate>
		<CustomerNo>23276</CustomerNo>
		<AssignedTo>admin</AssignedTo>
		<ExportToQuickbooks>2</ExportToQuickbooks>
		<Type>ASAP</Type>
		<Priority>Standard</Priority>
		<Pending>Nothing</Pending>
		<Salescommission>30.140</Salescommission>
		<TermsAndConditions>Prepaid</TermsAndConditions>
		<Description>Order notes goes here.</Description>
		<Carrier>USPS</Carrier>
		<ShippingMethod>Priority Mail 2-Day</ShippingMethod>
		<DeliverFrom>OAK</DeliverFrom>
		<ShippingDate />
		<TrackingNo />
		<ActualShippingCost>23.00</ActualShippingCost>
		<SpecialHandling>Special Instructions goes here.</SpecialHandling>
		<ShipQPriority>Standard</ShipQPriority>
		<BackorderHandling>ShipAsAvailable</BackorderHandling>
		<PacklistType>Show Company Details and Logo</PacklistType>
		<AmazonPrimeShipping>Yes</AmazonPrimeShipping>
		<Cancelled>No</Cancelled>
		<OnHold>No</OnHold>
		<RelatedPOs></RelatedPOs>
		<RelatedDropShipPOs></RelatedDropShipPOs>
		<OrdersCustomFields>
			<CustomField>
				<Name>CustomFied1</Name>
				<Value>Custom info 1</Value>
			</CustomField>
			<CustomField>
				<Name>CustomFied2</Name>
				<Value>Custom info 2</Value>
			</CustomField>
		</OrdersCustomFields>
		<OrderDetails>
			<OD>
				<ProductsName>Test New Product1</ProductsName>
				<ProductCode>TNP1</ProductCode>
				<MatrixSKUCode>0</MatrixSKUCode>
				<SerialNo />
				<ProductNotes>Product notes goes here.</ProductNotes>
				<ProductQty>2</ProductQty>
				<ProductPrice>15</ProductPrice>
				<ProductDiscount>0</ProductDiscount>
				<ProductTotal>30</ProductTotal>
				<LineItemLocation>OAK</LineItemLocation>
				<LineItemShippingCarrier>UPS</LineItemShippingCarrier>
				<LineItemShippingMethod>UPS Ground</LineItemShippingMethod>
				<LineItemTrackingNumber>221133</LineItemTrackingNumber>
				<LineItemShippingCost>0.00</LineItemShippingCost>
				<LineItemShippingDate>07-08-2021</LineItemShippingDate>
				<LineItemShippingStatus>Ready to pick,</LineItemShippingStatus>
			</OD>
			<OD>
				<ProductsName>Test Matrix Product2</ProductsName>
				<ProductCode>TMP2</ProductCode>
				<MatrixSKUCode>13420</MatrixSKUCode>
				<SerialNo />
				<ProductNotes>Product notes goes here.</ProductNotes>
				<ProductQty>2</ProductQty>
				<ProductPrice>5</ProductPrice>
				<ProductDiscount>0</ProductDiscount>
				<ProductTotal>10</ProductTotal>
				<LineItemLocation>OAK</LineItemLocation>
				<LineItemShippingCarrier>UPS</LineItemShippingCarrier>
				<LineItemShippingMethod>UPS Ground</LineItemShippingMethod>
				<LineItemTrackingNumber>221133</LineItemTrackingNumber>
				<LineItemShippingCost>0.00</LineItemShippingCost>
				<LineItemShippingDate>07-08-2021</LineItemShippingDate>
				<LineItemShippingStatus>Ready to pick,</LineItemShippingStatus>
			</OD>
		</OrderDetails>
	</Order>
</Orders>

Sample Response

{
    "MCM": {
        "response": {
            "objectType": "Orders",
            "syncTime": "2021-06-10 08:08:57"
        },
        "parameters": {
            "results": {
                "message": {
                    "status": "Success",
                    "success_message": {
                        "order_no": "6448",
                        "order_id": "203066",
                        "warning": {}
                    }
                }
            }
        }
    }
}

<MCM>
  <response>
    <objectType>Orders</objectType>
    <syncTime>2021-06-10 08:08:57</syncTime>
  </response>
  <parameters>
    <results>
      <message>
        <status>Success</status>
        <success_message>
          <order_id>203066</order_id>
          <order_no>6448</order_no>
          <warning></warning>
        </success_message>
      </message>
    </results>
  </parameters>
</MCM>

{
	"MCM": {
		"response": {
			"objectType": "Orders",
			"syncTime": "2021-06-10 08:13:01"
		},
		"parameters": {
			"results": {
				"message": {
					"success_message": {
						"order": [{
								"order_no": "6449",
								"order_id": "203068",
								"warning": {}
							},
							{
								"order_no": "6450",
								"order_id": "203070",
								"warning": {}
							}
						]
					},
					"error_message": {}
				}
			}
		}
	}
}

<MCM>
  <response>
    <objectType>Orders</objectType>
    <syncTime>2021-06-10 08:13:01</syncTime>
  </response>
  <parameters>
    <results>
      <message>
        <success_message>
          <order>
            <order_id>203068</order_id>
            <order_no>6449</order_no>
            <warning></warning>
          </order>
          <order>
            <order_id>203070</order_id>
            <order_no>6450</order_no>
            <warning></warning>
          </order>
        </success_message>
        <error_message></error_message>
      </message>
    </results>
  </parameters>
</MCM>

WADL

<application>
  <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
    <resource path="SalesOrder">
      <method name="POST">
        <request>
          <param name="key" type="xsd:string" style="query" required="true" />
          <param name="OrderNo" type="xsd:int" style="body" required="true" />
          <param name="ChannelId" type="xsd:int" style="body" />
          <param name="ChannelName" type="xsd:int" style="body" />
          <param name="OrderDate" type="xsd:dateTime" style="body" />
          <param name="ModifiedDate" type="xsd:dateTime" style="body" />
          <param name="Subject" type="xsd:string" style="body" required="true" />
          <param name="PotentialName" type="xsd:string" style="body" />
          <param name="AccountId" type="xsd:int" style="body" />
          <param name="AccountName" type="xsd:int" style="body" required="true" />
          <param name="AccountPhone" type="xsd:string" style="body" />
          <param name="AccountEmailAddress" type="xsd:string" style="body" />
          <param name="ContactFirstName" type="xsd:string" style="body" required="true" />
          <param name="ContactLastName" type="xsd:string" style="body" required="true" />
          <param name="ContactPhone" type="xsd:string" style="body" />
          <param name="ContactEmailAddress" type="xsd:string" style="body" />
          <param name="BillingName" type="xsd:string" style="body" />
          <param name="BillingStreet" type="xsd:string" style="body" />
          <param name="BillingCity" type="xsd:string" style="body" />
          <param name="BillingState" type="xsd:string" style="body" />
          <param name="BillingZipCode" type="xsd:string" style="body" />
          <param name="BillingCountry" type="xsd:string" style="body" />
          <param name="ShipToName" type="xsd:string" style="body" />
          <param name="ShipToPhone" type="xsd:string" style="body" />
          <param name="ShipToEmailAddress" type="xsd:string" style="body" />
          <param name="ShippingStreet" type="xsd:string" style="body" />
          <param name="ShippingCity" type="xsd:string" style="body" />
          <param name="ShippingState" type="xsd:string" style="body" />
          <param name="ShippingZipCode" type="xsd:string" style="body" />
          <param name="ShippingCountry" type="xsd:string" style="body" />
          <param name="OrderDiscount" type="xsd:decimal" style="body" />
          <param name="OrderDiscountCode" type="xsd:string" style="body" />
          <param name="SubTotal" type="xsd:decimal" style="body" />
          <param name="ShippingCost" type="xsd:decimal" style="body" />
          <param name="SalesTaxAuthority" type="xsd:string" style="body" />
          <param name="SalesTaxes" type="xsd:decimal" style="body" />
          <param name="GrandTotal" type="xsd:decimal" style="body" />
          <param name="DefaultCurrency" type="xsd:string" style="body" />
          <param name="ExchangeRate" type="xsd:string" style="body" />
          <param name="Status" type="xsd:string" style="body" />
          <param name="ShippingStatus" type="xsd:string" style="body" />
          <param name="AdditionalFees" type="xsd:decimal" style="body" />
          <param name="DefaultPriceBook" type="xsd:string" style="body" />
          <param name="PaymentMethod" type="xsd:string" style="body" />
          <param name="CreditCardType" type="xsd:string" style="body" />
          <param name="CheckNumber" type="xsd:string" style="body" />
          <param name="CreditCardOwner" type="xsd:string" style="body" />
          <param name="CheckWriter" type="xsd:string" style="body" />
          <param name="PaymentAmount" type="xsd:string" style="body" />
          <param name="PaymentDate" type="xsd:date" style="body" />
          <param name="InvoiceNumber" type="xsd:int" style="body" />
          <param name="InvoiceDate" type="xsd:date" style="body" />
          <param name="DueDate" type="xsd:date" style="body" />
          <param name="CallDate" type="xsd:date" style="body" />
          <param name="CustomerNo" type="xsd:int" style="body" />
          <param name="AssignedTo" type="xsd:string" style="body" />
          <param name="ExportToQuickbooks" type="xsd:string" style="body" />
          <param name="Type" type="xsd:string" style="body" />
          <param name="Priority" type="xsd:string" style="body" />
          <param name="Pending" type="xsd:string" style="body" />
          <param name="Salescommission" type="xsd:string" style="body" />
          <param name="TermsAndConditions" type="xsd:string" style="body" />
          <param name="Description" type="xsd:string" style="body" />
          <param name="Carrier" type="xsd:string" style="body" />
          <param name="ShippingMethod" type="xsd:string" style="body" />
          <param name="DeliverFrom" type="xsd:string" style="body" />
          <param name="ShippingDate" type="xsd:date" style="body" />
          <param name="TrackingNo" type="xsd:string" style="body" />
          <param name="ActualShippingCost" type="xsd:decimal" style="body" />
          <param name="SpecialHandling" type="xsd:string" style="body" />
          <param name="ShipQPriority" type="xsd:string" style="body" />
          <param name="BackorderHandling" type="xsd:string" style="body" />
          <param name="Cancelled" type="xsd:string" style="body" />
          <param name="OnHold" type="xsd:string" style="body" />
          <param name="RelatedPOs" type="xsd:string" style="body" />
          <param name="RelatedDropShipPOs" type="xsd:string" style="body" />
          <param name="OrderDetails">
            <param name="ProductsName" type="xsd:string" style="body" />
            <param name="ProductCode" type="xsd:string" style="body" required="true"/>
            <param name="MatrixSKUCode" type="xsd:string" style="body" />
            <param name="SerialNo" type="xsd:int" style="body" />
            <param name="ProductNotes" type="xsd:string" style="body"/>
            <param name="ProductQty" type="xsd:int" style="body" required="true"/>
            <param name="ProductPrice" type="xsd:decimal" style="body"/>
            <param name="ProductDiscount" type="xsd:decimal" style="body"/>
            <param name="ProductTotal" type="xsd:decimal" style="body"/>
            <param name="LineItemLocation" type="xsd:string" style="body"/>
            <param name="LineItemShippingCarrier" type="xsd:string" style="body"/>
            <param name="LineItemShippingMethod" type="xsd:string" style="body"/>
            <param name="LineItemTrackingNumber" type="xsd:string" style="body"/>
            <param name="LineItemShippingCost" type="xsd:decimal" style="body"/>
            <param name="LineItemShippingDate" type="xsd:date" style="body"/>
            <param name="LineItemShippingStatus" type="xsd:string" style="body"/>
          </param>
        </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 over 1 year ago

© Copyright 2022 Agiliron - All Rights Reserved.