Features - Connectors Framework - Inbound REST API - Sales Orders
Sales Order
Overview
All the API methods available for Sales Order.
Parameters
Allows the API to create and update your sales orders. You can retrieve individual sales orders as well as a list of all your sales orders.
type
required
String
The sales order type
customerId
required
Long
The ID of the customer the sales order is for
customerName
optional
String
The name of the customer the sales order is for
externalId
optional
String
The third-party internal ID
customStatus
optional
Long
The ID of the custom status if set
status
optional
String
The current status of the sales order
rebate
optional
String
The rebate for this sales order if any
rebatePercent
optional
Double
The percent of the rebate for the sales order
shippingCost
optional
Double
The shipping cost for the sales order
Example
<salesOrder>
<type>sales order store catalog</type>
<customerId>123</customerId>
<customerName>John Doe</customerName>
<externalId>ABC123</externalId>
<customStatus>3</customStatus>
<status></status>
<rebate></rebate>
<rebatePercent>10</rebatePercent>
<shippingCost>0</shippingCost>
</salesOrder>