Read

Read

This is pre-release documentation and could be changed.

Read

Returns information for a single quote or sale.

Request

Method
URL
POST
 https://api.solatech-dos.com/orders/v1/readorder 

Headers

Name
Required
Type
Description
APIKey
Guid
A valid API key with a scope of Quotes | Read or Sales | Read

Body

Property
Required
Type
Description
EntityUniqueID
GUID
The unique ID of the quote or sale.
IncludeLines
Boolean
Whether the line items are returned. Defaults to True.
{
  "EntityUniqueID": "0964b206-61e0-4fc0-a753-09a74eff7f64",
  "IncludeLines": true
}

Remarks

The EntityUniqueID must identify a quote or a sale. Purchase orders and pending orders are not returned by this action.
The quote or sale must belong to the account that owns the API key.
The API key must have a Read scope for the type of order being read. A quote requires the Quotes scope and a sale requires the Sales scope.
Property names in the body are not case sensitive.
Setting IncludeLines to False omits the line items from the response. Use it when only the order totals and header information are needed.
Order history, workflow, and status details are not returned by the API.

Response

Headers

None

Status Code

Code
Description
200 OK
The quote or sale was read.
400 Bad Request
The quote or sale could not be read. The reason why will be returned.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
404 Not Found
The quote or sale could not be found.

Body

All details, except the history, workflow, and status, are returned.

Order

Property
Type
Description
uniqueID
GUID
The unique ID of the quote or sale.
orderType
Text
The type of the order, either Quote or Sale.
orderNumber
Number
The quote or sale number.
customer
Object
The customer the order belongs to. See Customer.
salesRepEmail
Text
The email address of the sales rep.
installerEmail
Text
The email address of the installer.
sidemark
Text
The sidemark.
terms
Text
The payment terms.
leadSource
Text
The lead source.
deliveryRange
Text
The delivery range.
appointmentType
Text
The appointment type.
location
Text
The location.
total
Number
The total of the order.
balance
Number
The amount still owed on the order.
suggestedDeposit
Number
The suggested deposit.
onHold
True/False
Whether the order is on hold.
onHoldMessage
Text
The reason the order is on hold.
canceled
True/False
Whether the order is canceled.
closed
True/False
Whether the order is closed.
additionalCharges
Array
The charges applied to the order. See Additional Charge.
taxCodes
Array
The tax codes applied to the order. See Tax Code.
payments
Array
The payments received for the order. See Payment.
lineItems
Array
The line items on the order. See Line Item.
comments
Array
The comments on the order. See Comment.
notes
Array
The notes on the order. See Note.
tags
Array
The tags assigned to the order. See Tag.
links
Array
The links attached to the order. See Link.
warnings
Array
Any non-fatal warnings raised while reading the order.

Customer

Property
Type
Description
uniqueID
GUID
The unique ID of the customer.
externalID
Text
The external ID of the customer.
displayName
Text
The display name of the customer.
firstName
Text
The first name of the customer.
lastName
Text
The last name of the customer.
The remaining customer details are accessed by the Customers API.

Additional Charge

Property
Type
Description
group
Text
The group of the original charge.
category
Text
The category of the original charge.
name
Text
The name of the original charge.
chargeCode
Text
The charge code.
quantity
Number
The quantity the price and cost are multiplied by.
quantityOverridden
True/False
Whether the quantity was overridden by a user.
taxable
True/False
Whether the amount is taxable.
resultTo
Number
Where the value is applied. See Result To.
discount
True/False
Whether the amount is a discount instead of a surcharge.
automatic
True/False
Whether the charge was added automatically.
price
Number
The amount added to the total price.
priceOverridden
True/False
Whether the price is applied without evaluating the values.
cost
Number
The amount added to the total cost.
values
Array
The values the charge was calculated from. See Charge Value.

Charge Value

Property
Type
Description
type
Text
The type of the value.
price
Number
How the value affects the price.
cost
Number
How the value affects the cost.

Tax Code

Property
Type
Description
code
Text
The tax code.
agency
Text
The name of the tax agency.
rate
Number
The tax rate as a percent.
amount
Number
The tax calculated for the order.

Payment

Property
Type
Description
paymentType
Text
The type of payment, such as Check or Cash.
referenceNumber
Text
The reference number of the payment.
receivedOn
Date
The date the payment was received.
amount
Number
The amount of the payment.
memo
Text
The memo attached to the payment.

Comment

Property
Type
Description
userName
Text
The name of the user who added the comment.
comment
Text
The comment.

Note

Property
Type
Description
userName
Text
The name of the user who added the note.
note
Text
The note.

Tag

Property
Type
Description
tag
Text
The tag.

Link

Property
Type
Description
type
Number
The type of the link. See Link Type.
name
Text
The display name of the link. Only used by URL links.
url
Text
The URL of the link. Only used by URL links.
uniqueID
GUID
The unique ID of the link. Only used by entity links.
relateType
Number
How the link relates to the order. See Relate Type.
relateTarget
Number
The type of entity the link relates to. See Relate Target.
relateUniqueID
GUID
The unique ID of the related entity. Only used by entity links.
The relateType, relateTarget, and relateUniqueID are only used by entity links. They are returned as 0, 0, and an empty GUID by URL links.

Line Item

Property
Type
Description
lineItem
Number
The line number of the item within the order.
uniqueid
GUID
The unique id of the line item.
quantity
Number
The quantity ordered.
puid
GUID
The unique ID of the product.
productName
Text
The name of the product.
productVersion
Number
The version of the product the item was priced with.
productDate
Date
The date of the product version the item was priced with.
productState
Number
The state of the product. See Product State.
productTypeUniqueId
GUID
The unique ID of the product type.
productType
Text
The name of the product type.
manufacturerUniqueId
GUID
The unique ID of the manufacturer.
manufacturer
Text
The name of the manufacturer.
style
Text
The style of the product.
taxable
Boolean
Whether the item is taxable.
description
Text
The primary description of the item.
description2
Text
The additional description of the item.
notes
Text
The notes on the item.
options
Array
The options selected for the item. See Option.
pricing
Object
The pricing of the item. See Pricing.
messages
Array
The messages raised when the item was priced. See Message.

Option

Property
Type
Description
group
Text
The group the option belongs to.
groupSequence
Number
The position of the group within the product.
name
Text
The name of the option.
value
Text
The value of the option.
sequence
Number
The position of the option within the group.
type
Number
The type of the option. See Option Type.
visible
Boolean
Whether the option is visible.
processIfHidden
Boolean
Whether the option is processed while it is hidden.
dimension
Boolean
Whether the option is a dimension.

Message

Property
Type
Description
type
Number
The type of the message. See Message Type.
message
Text
The message.

Pricing

The cost of the item.
Property
Type
Description
taxable
Boolean
Whether the item is taxable.
baseCost
Number
The base cost of the item.
costCalc
Number
How the cost is calculated. See Cost Calculation.
costDiscount
Number
The cost discount percent.
originalCostDiscount
Number
The cost discount percent before it was overridden.
costDiscountAmount
Number
The cost discount amount.
costMultiplier
Number
The cost multiplier.
originalCostMultiplier
Number
The cost multiplier before it was overridden.
costMultiplierAmount
Number
The cost multiplier amount.
netSurchargeCost
Number
The net surcharge cost.
originalNetSurchargeCost
Number
The net surcharge cost before it was overridden.
itemCost
Number
The total cost of the item.
originalItemCost
Number
The total cost of the item before it was overridden.
The retail price of the item.
Property
Type
Description
baseRetailPrice
Number
The base retail price.
baseRetailCalc
Number
How the retail price is calculated. See Price Calculation.
baseRetailPriceDiscount
Number
The retail price discount percent.
originalBaseRetailPriceDiscount
Number
The retail price discount percent before it was overridden.
baseRetailPriceDiscountAmount
Number
The retail price discount amount.
baseRetailPriceMargin
Number
The retail price margin percent.
originalBaseRetailPriceMargin
Number
The retail price margin percent before it was overridden.
baseRetailPriceMarginAmount
Number
The retail price margin amount.
actualRetailPrice
Number
The retail price after the discount or margin is applied.
The net surcharge of the item.
Property
Type
Description
netSurchargePrice
Number
The net surcharge price.
netSurchargeCalc
Number
How the net surcharge is calculated. See Net Surcharge Calculation.
netSurchargeMargin
Number
The net surcharge margin percent.
originalNetSurchargeMargin
Number
The net surcharge margin percent before it was overridden.
netSurchargeMarginAmount
Number
The net surcharge margin amount.
netSurchargeMarkup
Number
The net surcharge markup percent.
originalNetSurchargeMarkup
Number
The net surcharge markup percent before it was overridden.
netSurchargeMarkupAmount
Number
The net surcharge markup amount.
actualNetSurcharge
Number
The net surcharge after the margin or markup is applied.
The price of the item.
Property
Type
Description
calculatedItemPrice
Number
The price of the item before the adjustments are applied.
adjustmentsTotal
Number
The total of all of the adjustments.
itemSurcharge
Number
The surcharge on the item.
preCustomerDiscountPrice
Number
The price before the customer discount is applied.
customerCalc
Number
How the customer price is calculated. See Customer Calculation.
customerMargin
Number
The customer margin percent.
customerMarginAmount
Number
The customer margin amount.
customerDiscount
Number
The customer discount percent.
customerDiscountAmount
Number
The customer discount amount.
customerMultiplier
Number
The customer multiplier.
customerMultiplierAmount
Number
The customer multiplier amount.
preDiscountPrice
Number
The price before the item discount is applied.
itemDiscountCalc
Number
How the item discount is applied. See Discount Calculation.
itemDiscountPercent
Number
The item discount percent.
itemDiscountAmount
Number
The item discount amount.
discountedItemPrice
Number
The price after the item discount is applied.
unroundedPrice
Number
The price before the rounding rules are applied.
itemPrice
Number
The final price of the item.
originalItemPrice
Number
The final price of the item before it was overridden.
itemProfit
Number
The profit on the item.
itemMargin
Number
The margin percent on the item.
margin
Object
How the cost and price were sourced. See Margin.
priceLines
Array
The price lines the item was priced from. See Price Line.
adjustments
Array
The adjustments applied to the item. See Additional Charge.

Margin

Property
Type
Description
costSource
Number
Where the cost is sourced from. See Cost & Price Source.
costMethod
Number
How the cost is calculated. See Cost & Price Method.
priceSource
Number
Where the price is sourced from. See Cost & Price Source.
priceMethod
Number
How the price is calculated. See Cost & Price Method.
netSurchargeMethod
Number
How the net surcharge is calculated. See Net Surcharge Method.
margin
Number
The margin percent.
netMargin
Number
The net margin percent.
surcharge
Number
The surcharge amount.

Price Line

Property
Type
Description
name
Text
The name of the price line.
code
Text
The code of the price line.
value
Number
The value of the price line.
apply
Number
Where the price line is applied.
type
Number
The type of the price line.

Values

The properties below are returned as numbers.

Result To

Value
Description
0
The default location.
1
Applied to the base cost.
2
Applied to the item cost.
3
Applied to the cost discount or multiplier.
4
Applied to the net surcharge cost.

Option Type

Value
Description
1
The value is entered as text.
2
The value is entered as a number.
4
The value is chosen from a list.
5
The value is chosen from a list or entered as text.
6
The value is calculated by the option's formula.
7
The value is calculated by the option's formula as a substitution expression.

Message Type

Value
Description
1
Error
2
Notice

Link Type

Value
Description
0
An entity link.
1
A URL link.

Relate Type

Value
Description
0
Relates to.
1
Duplicates.
2
Is duplicated by.
3
Replaces.
4
Is replaced by.

Relate Target

Value
Description
0
A customer.
1
An order.
2
A purchase order.
3
A vendor.
4
A site vendor.
5
An account vendor.

Product State

Product states are combined. A product that is both discontinued and out of date is returned as 5.
Value
Description
0
No state is set.
1
The product is discontinued.
2
The product is disabled.
4
The product is out of date.
8
The product's style is discontinued.
16
The product's price has changed.

Cost Calculation

Value
Description
0
The discount is applied.
1
The multiplier is applied.

Price Calculation

Value
Description
0
The discount is applied.
1
The margin is applied.

Net Surcharge Calculation

Value
Description
1
The margin is applied.
2
The markup is applied.

Customer Calculation

Value
Description
0
The discount is applied.
1
The multiplier is applied.
2
The margin is applied.
3
The margin is applied, then the discount.
4
The margin is applied, then the multiplier.

Discount Calculation

Value
Description
0
The percent is applied.
1
The amount is applied.

Cost & Price Source

Value
Description
0
The cost comes from the product.
1
The price comes from the product.
2
The cost is calculated.

Cost & Price Method

Value
Description
0
The discount is applied.
1
The margin is applied.

Net Surcharge Method

Value
Description
1
The margin is applied.
2
The markup is applied.

Remarks

The lineItems are returned as null when IncludeLines is False and when the order has no line items. The options, messages, priceLines, and adjustments are returned the same way when they are empty.
The warnings are returned as null when there are no warnings.
The pricing of a line item is returned as null when the item has not been priced.

Example

{
  "customer": {
    "firstName": "Jack",
    "lastName": "Black",
    "displayName": "Jack Black",
    "uniqueID": "c24b6b54-319a-47dc-a482-37110569ac26",
    "externalID": ""
  },
  "salesRepEmail": "odiemckraken@solatech-darious.com",
  "installerEmail": "",
  "orderType": "Sale",
  "orderNumber": 1042,
  "sidemark": "Black Residence",
  "terms": "Net 30",
  "leadSource": "Flyer",
  "deliveryRange": "3-4 Weeks",
  "total": 486.75,
  "balance": 236.75,
  "suggestedDeposit": 243.38,
  "uniqueID": "0964b206-61e0-4fc0-a753-09a74eff7f64",
  "appointmentType": "",
  "location": "",
  "onHold": false,
  "onHoldMessage": "",
  "canceled": false,
  "closed": false,
  "additionalCharges": [
    {
      "group": "Delivery",
      "category": "Freight",
      "name": "Delivery Charge",
      "chargeCode": "DEL",
      "quantity": 1,
      "quantityOverridden": false,
      "taxable": false,
      "resultTo": 0,
      "discount": false,
      "automatic": true,
      "price": 25.00,
      "priceOverridden": false,
      "cost": 15.00,
      "values": null
    }
  ],
  "comments": [
    {
      "userName": "Odie McKraken",
      "comment": "Customer approved the revised sidemark."
    }
  ],
  "lineItems": [
    {
      "lineItem": 1,
      "quantity": 2,
      "productTypeUniqueId": "3f2a91cc-8d14-4a77-b0f5-2c6f9e7d1a04",
      "productType": "Roller Shades",
      "manufacturerUniqueId": "a17c4e88-51b6-49f2-9e33-7d0b8c2f6a15",
      "manufacturer": "Solatech",
      "puid": "e6b0d4a2-7c39-4f81-95ad-1b8e3c07d562",
      "productName": "Designer Roller Shade",
      "productVersion": 12,
      "productDate": "2026-03-14T00:00:00",
      "productState": 0,
      "style": "Standard",
      "taxable": true,
      "description": "Designer Roller Shade, 36 x 48",
      "description2": "Living Room",
      "notes": "Mount inside the frame.",
      "options": [
        {
          "group": "Size",
          "name": "Width",
          "value": "36",
          "visible": true,
          "sequence": 1,
          "groupSequence": 1,
          "processIfHidden": false,
          "type": 2,
          "dimension": true
        },
        {
          "group": "Size",
          "name": "Height",
          "value": "48",
          "visible": true,
          "sequence": 2,
          "groupSequence": 1,
          "processIfHidden": false,
          "type": 2,
          "dimension": true
        },
        {
          "group": "Fabric",
          "name": "Color",
          "value": "Alabaster",
          "visible": true,
          "sequence": 1,
          "groupSequence": 2,
          "processIfHidden": false,
          "type": 4,
          "dimension": false
        }
      ],
      "pricing": {
        "taxable": true,
        "baseCost": 92.00,
        "costCalc": 0,
        "costDiscount": 0.00,
        "originalCostDiscount": null,
        "costDiscountAmount": 0.00,
        "costMultiplier": 0.00,
        "originalCostMultiplier": null,
        "costMultiplierAmount": 0.00,
        "netSurchargeCost": 0.00,
        "originalNetSurchargeCost": null,
        "itemCost": 92.00,
        "originalItemCost": null,
        "baseRetailPrice": 184.00,
        "baseRetailCalc": 1,
        "baseRetailPriceDiscount": 0.00,
        "originalBaseRetailPriceDiscount": null,
        "baseRetailPriceDiscountAmount": 0.00,
        "baseRetailPriceMargin": 50.00,
        "originalBaseRetailPriceMargin": null,
        "baseRetailPriceMarginAmount": 92.00,
        "actualRetailPrice": 184.00,
        "netSurchargePrice": 0.00,
        "netSurchargeCalc": 1,
        "netSurchargeMargin": 0.00,
        "originalNetSurchargeMargin": null,
        "netSurchargeMarginAmount": 0.00,
        "netSurchargeMarkup": 0.00,
        "originalNetSurchargeMarkup": null,
        "netSurchargeMarkupAmount": 0.00,
        "actualNetSurcharge": 0.00,
        "calculatedItemPrice": 184.00,
        "adjustmentsTotal": 0.00,
        "itemSurcharge": 0.00,
        "preCustomerDiscountPrice": 184.00,
        "customerCalc": 0,
        "customerMargin": 0.00,
        "customerMarginAmount": 0.00,
        "customerDiscount": 0.00,
        "customerDiscountAmount": 0.00,
        "customerMultiplier": 0.00,
        "customerMultiplierAmount": 0.00,
        "preDiscountPrice": 184.00,
        "itemDiscountCalc": 0,
        "itemDiscountAmount": 0.00,
        "itemDiscountPercent": 0.00,
        "discountedItemPrice": 184.00,
        "unroundedPrice": null,
        "itemPrice": 184.00,
        "originalItemPrice": null,
        "itemProfit": 92.00,
        "itemMargin": 50.00,
        "margin": {
          "costSource": 0,
          "costMethod": 1,
          "priceSource": 0,
          "priceMethod": 1,
          "netSurchargeMethod": 1,
          "margin": 50.00,
          "netMargin": 0.00,
          "surcharge": 0.00
        },
        "priceLines": [
          {
            "name": "Fabric",
            "code": "FAB",
            "value": 92.00,
            "apply": 0,
            "type": 1
          }
        ],
        "adjustments": null
      },
      "messages": [
        {
          "type": 2,
          "message": "The width was rounded up to the next available size."
        }
      ]
    }
  ],
  "links": [
    {
      "name": "Fabric Specification",
      "url": "https://example.com/specs/designer-roller-shade.pdf",
      "type": 1,
      "relateType": 0,
      "relateTarget": 0,
      "relateUniqueID": "00000000-0000-0000-0000-000000000000",
      "uniqueID": "00000000-0000-0000-0000-000000000000"
    },
    {
      "name": "",
      "url": "",
      "type": 0,
      "relateType": 3,
      "relateTarget": 1,
      "relateUniqueID": "b8f27a90-4d61-42c8-9a5e-6f10c3b7e284",
      "uniqueID": "7c395e11-a0d8-4b26-8f43-59e2d1a6c073"
    }
  ],
  "payments": [
    {
      "paymentType": "Check",
      "referenceNumber": "1187",
      "receivedOn": "2026-07-28T00:00:00",
      "amount": 250.00,
      "memo": "Deposit"
    }
  ],
  "notes": [
    {
      "userName": "Odie McKraken",
      "note": "Gate code is 12345."
    }
  ],
  "tags": [
    {
      "tag": "Big-House"
    }
  ],
  "taxCodes": [
    {
      "code": "NC-GUIL",
      "agency": "Guilford County",
      "rate": 6.75,
      "amount": 27.75
    }
  ],
  "warnings": null
}