Sitecore Ordercloud

Estimate shipping cost

POST
/orders/{direction}/{orderID}/estimateshipping

Roles

At least one of the roles below is required to access this endpoint

FullAccess
IntegrationEventAdmin
OrderAdmin
Shopper

Parameters

NameTypeDescriptionPossible Values
directionstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDstringID of the order.---

Response Body

PropertyTypeFormatMax LengthPossible Values
Orderobject---------
PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
FromUser
Read Only
object---------

PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
CompanyID
Read Only
string---------
Username
Read Only
string---100 characters---

Password
Read Only
stringpassword------
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Email
Read Only
string---200 characters---
Phone
Read Only
string---100 characters---
TermsAccepted
Read Only
stringdate-time------
Active
Read Only
boolean---------

xp
Read Only
object---------
AvailableRoles
Read Only
array---------

Locale
Read Only
object---------

PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
OwnerID
Read Only
string---------

Currency
Read Only
string---100 characters---

Language
Read Only
string---100 characters---

DateCreated
Read Only
stringdate-time------
PasswordLastSetDate
Read Only
stringdate-time------

FromCompanyIDstring---------

ToCompanyIDstring---------

FromUserIDstring---------

BillingAddressIDstring---------
BillingAddress
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
DateCreated
Read Only
stringdate-time------
CompanyName
Read Only
string---100 characters---
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Street1
Read Only
string---100 characters---
Street2
Read Only
string---100 characters---
City
Read Only
string---100 characters---
State
Read Only
string---100 characters---
Zip
Read Only
string---100 characters---
Country
Read Only
string---2 characters---
Phone
Read Only
string---100 characters---
AddressName
Read Only
string---100 characters---
xp
Read Only
object---------
ShippingAddressIDstring---------

Commentsstring---2000 characters---
LineItemCount
Read Only
integerint32------
Status
Read Only
string------Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled
DateCreated
Read Only
stringdate-time------
DateSubmitted
Read Only
stringdate-time------

DateApproved
Read Only
stringdate-time------
DateDeclined
Read Only
stringdate-time------
DateCanceled
Read Only
stringdate-time------
DateCompleted
Read Only
stringdate-time------

LastUpdated
Read Only
stringdate-time------
Subtotal
Read Only
numberfloat------

ShippingCostnumberfloat------

TaxCostnumberfloat------

PromotionDiscount
Read Only
numberfloat------

Currency
Read Only
string---------

Total
Read Only
numberfloat------

IsSubmitted
Read Only
boolean---------

xpobject---------
LineItemsarray---------
PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
ProductIDstring---------
Quantityintegerint32------
DateAdded
Read Only
stringdate-time------
QuantityShipped
Read Only
integerint32------

UnitPricenumberfloat------

PromotionDiscount
Read Only
numberfloat------

LineTotal
Read Only
numberfloat------

LineSubtotal
Read Only
numberfloat------

CostCenterstring---------

DateNeededstringdate-time------
ShippingAccountstring---------

ShippingAddressIDstring---------
ShipFromAddressIDstring---------

Product
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
Name
Read Only
string---------
Description
Read Only
string---------
Returnable
Read Only
boolean---------
QuantityMultiplier
Read Only
integerint32------
ShipWeight
Read Only
numberfloat------
ShipHeight
Read Only
numberfloat------
ShipWidth
Read Only
numberfloat------
ShipLength
Read Only
numberfloat------
DefaultSupplierID
Read Only
string---------
xp
Read Only
object---------
Variant
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
Name
Read Only
string---------
Description
Read Only
string---------
ShipWeight
Read Only
numberfloat------
ShipHeight
Read Only
numberfloat------
ShipWidth
Read Only
numberfloat------
ShipLength
Read Only
numberfloat------
xp
Read Only
object---------
ShippingAddress
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
DateCreated
Read Only
stringdate-time------
CompanyName
Read Only
string---100 characters---
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Street1
Read Only
string---100 characters---
Street2
Read Only
string---100 characters---
City
Read Only
string---100 characters---
State
Read Only
string---100 characters---
Zip
Read Only
string---100 characters---
Country
Read Only
string---2 characters---
Phone
Read Only
string---100 characters---
AddressName
Read Only
string---100 characters---
xp
Read Only
object---------
ShipFromAddress
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
DateCreated
Read Only
stringdate-time------
CompanyName
Read Only
string---100 characters---
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Street1
Read Only
string---100 characters---
Street2
Read Only
string---100 characters---
City
Read Only
string---100 characters---
State
Read Only
string---100 characters---
Zip
Read Only
string---100 characters---
Country
Read Only
string---2 characters---
Phone
Read Only
string---100 characters---
AddressName
Read Only
string---100 characters---
xp
Read Only
object---------
SupplierID
Read Only
string---------
InventoryRecordIDstring---------

PriceScheduleID
Read Only
string---------

PriceOverridden
Read Only
boolean---------

Specsarray---------
PropertyTypeFormatMax LengthPossible Values
SpecIDstring---------
Name
Read Only
string---------
OptionIDstring---------
Valuestring---2000 characters---
PriceMarkupTypestring------NoMarkup, AmountPerQuantity, AmountTotal, Percentage
PriceMarkupnumberfloat------
xpobject---------
OrderPromotionsarray---------
PropertyTypeFormatMax LengthPossible Values
Amount
Read Only
numberfloat------
LineItemID
Read Only
string---------
IDstring---100 characters---
LineItemLevelboolean---------

Codestring---100 characters---

Namestring---100 characters---
RedemptionLimitintegerint32------

RedemptionLimitPerUserintegerint32------

RedemptionCount
Read Only
integerint32------

Descriptionstring---2000 characters---
FinePrintstring---2000 characters---

StartDatestringdate-time------
ExpirationDatestringdate-time------
EligibleExpressionstring---400 characters---

ValueExpressionstring---400 characters---

CanCombineboolean---------

AllowAllBuyersboolean---------

OwnerIDstring---------

xpobject---------
ShipEstimateResponseobject---------
PropertyTypeFormatMax LengthPossible Values
ShipEstimatesarray---------
PropertyTypeFormatMax LengthPossible Values
IDstring---------
xpobject---------
SelectedShipMethodIDstring---------
ShipEstimateItemsarray---------
PropertyTypeFormatMax LengthPossible Values
LineItemIDstring---------
Quantityintegerint32------
ShipMethodsarray---------
PropertyTypeFormatMax LengthPossible Values
IDstring---------
Namestring---------
Costnumberfloat------
EstimatedTransitDaysintegerint32------
xpobject---------
HttpStatusCodeintegerint32------
UnhandledErrorBodystring---------
xpobject---------
Succeededboolean---------
OrderCalculateResponseobject---------
PropertyTypeFormatMax LengthPossible Values
LineItemOverridesarray---------
PropertyTypeFormatMax LengthPossible Values
LineItemIDstring---------
UnitPricenumberfloat------
Productobject---------
PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Namestring---100 characters---
Descriptionstring---2000 characters---
QuantityMultiplierintegerint32------

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
DefaultSupplierIDstring---------

Returnableboolean---------

xpobject---------
PromotionOverridesarray---------
PropertyTypeFormatMax LengthPossible Values
PromotionIDstring---------
Amountnumberfloat------

Removeboolean---------
ShippingTotalnumberfloat------
TaxTotalnumberfloat------
HttpStatusCodeintegerint32------
UnhandledErrorBodystring---------
xpobject---------
Succeededboolean---------
OrderSubmitResponseobject---------
PropertyTypeFormatMax LengthPossible Values
HttpStatusCodeintegerint32------
UnhandledErrorBodystring---------
xpobject---------
Succeededboolean---------
OrderSubmitForApprovalResponseobject---------
PropertyTypeFormatMax LengthPossible Values
HttpStatusCodeintegerint32------
UnhandledErrorBodystring---------
xpobject---------
Succeededboolean---------
OrderApprovedResponseobject---------
PropertyTypeFormatMax LengthPossible Values
HttpStatusCodeintegerint32------
UnhandledErrorBodystring---------
xpobject---------
Succeededboolean---------