Estimate shipping cost

Request

Security

OAuth2(Required scopes: FullAccessShopper)

curl -i -X POST \
  https://api.ordercloud.io/v1/cart/estimateshipping \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

Orderobject(Order)

Example:

{
  "ID": "",
  "FromUser": {
    "ID": "",
    "CompanyID": "",
    "Username": "",
    "Password": "",
    "FirstName": "",
    "LastName": "",
    "Email": "",
    "Phone": "",
    "TermsAccepted": "2018-01-01T00:00:00-06:00",
    "Active": false,
    "xp": {},
    "AvailableRoles": [ … ],
    "Locale": { … },
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "LastActive": "2018-01-01T00:00:00-06:00",
    "PasswordLastSetDate": "2018-01-01T00:00:00-06:00"
  },
  "FromCompanyID": "",
  "ToCompanyID": "",
  "FromUserID": "",
  "BillingAddressID": "",
  "BillingAddress": {
    "ID": "",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  },
  "ShippingAddressID": "",
  "Comments": "",
  "LineItemCount": 0,
  "Status": "Unsubmitted",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "DateSubmitted": "2018-01-01T00:00:00-06:00",
  "DateApproved": "2018-01-01T00:00:00-06:00",
  "DateDeclined": "2018-01-01T00:00:00-06:00",
  "DateCanceled": "2018-01-01T00:00:00-06:00",
  "DateCompleted": "2018-01-01T00:00:00-06:00",
  "LastUpdated": "2018-01-01T00:00:00-06:00",
  "Subtotal": 0,
  "ShippingCost": 0,
  "TaxCost": 0,
  "Gratuity": 0,
  "Fees": 0,
  "BaseDiscount": 0,
  "PromotionDiscount": 0,
  "Currency": "",
  "Total": 0,
  "IsSubmitted": false,
  "SubscriptionID": "",
  "xp": {}
}

LineItemsArray of objects(LineItem)

Example:

[
  {
    "ID": "",
    "ProductID": "",
    "Quantity": 0,
    "BundleItemID": "",
    "IsBundle": false,
    "DateAdded": "2018-01-01T00:00:00-06:00",
    "QuantityShipped": 0,
    "UnitPrice": 0,
    "PromotionDiscount": 0,
    "BaseDiscount": 0,
    "DiscountID": "",
    "LineTotal": 0,
    "LineSubtotal": 0,
    "CostCenter": "",
    "DateNeeded": "2018-01-01T00:00:00-06:00",
    "ShippingAccount": "",
    "ShippingAddressID": "",
    "ShipFromAddressID": "",
    "Product": { … },
    "Variant": { … },
    "ShippingAddress": { … },
    "ShipFromAddress": { … },
    "SupplierID": "",
    "InventoryRecordID": "",
    "PriceScheduleID": "",
    "IsOnSale": false,
    "PriceOverridden": false,
    "Specs": [ … ],
    "IncomingOrderID": "",
    "OutgoingOrderID": "",
    "xp": {}
  }
]

OrderPromotionsArray of objects(OrderPromotion)

Example:

[
  {
    "Amount": 0,
    "LineItemID": "",
    "AmountOverridden": false,
    "DateApplied": "2018-01-01T00:00:00-06:00",
    "ID": "",
    "LineItemLevel": false,
    "Code": "",
    "Name": "",
    "RedemptionLimit": 0,
    "RedemptionLimitPerUser": 0,
    "RedemptionCount": 0,
    "QuantityLimitPerOrder": 0,
    "ItemLimitPerOrder": 0,
    "ItemSortBy": "",
    "Description": "",
    "FinePrint": "",
    "StartDate": "2018-01-01T00:00:00-06:00",
    "ExpirationDate": "2018-01-01T00:00:00-06:00",
    "EligibleExpression": "",
    "ValueExpression": "",
    "CanCombine": false,
    "AllowAllBuyers": false,
    "OwnerID": "",
    "AutoApply": false,
    "Active": false,
    "UseIntegration": false,
    "Priority": 0,
    "xp": {}
  }
]

Subscriptionobject(Subscription)

Example:

{
  "ID": "",
  "Frequency": 0,
  "Interval": "Days",
  "NextOrderDate": "2018-01-01T00:00:00-06:00",
  "LastOrderDate": "2018-01-01T00:00:00-06:00",
  "NotificationDate": "2018-01-01T00:00:00-06:00",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "EndDate": "2018-01-01T00:00:00-06:00",
  "Active": false,
  "FromCompanyID": "",
  "FromUserID": "",
  "ToCompanyID": "",
  "Payment": {
    "Type": "PurchaseOrder",
    "CreditCardID": "",
    "SpendingAccountID": ""
  },
  "BillingAddressID": "",
  "ShippingAddressID": "",
  "ProjectedSubtotal": 0,
  "xp": {}
}

ShipEstimateResponseobject(ShipEstimateResponse)

Example:

{
  "ShipEstimates": [
    { … }
  ],
  "HttpStatusCode": 0,
  "UnhandledErrorBody": "",
  "xp": {},
  "Succeeded": false
}

OrderCalculateResponseobject(OrderCalculateResponse)

Example:

{
  "LineItemOverrides": [
    { … }
  ],
  "ShippingTotal": 0,
  "TaxTotal": 0,
  "FeeTotal": 0,
  "HttpStatusCode": 0,
  "UnhandledErrorBody": "",
  "xp": {},
  "Succeeded": false
}

OrderSubmitResponseobject(OrderSubmitResponse)

Example:

{
  "HttpStatusCode": 0,
  "UnhandledErrorBody": "",
  "xp": {},
  "Succeeded": false
}

OrderSubmitForApprovalResponseobject(OrderSubmitForApprovalResponse)

Example:

{
  "HttpStatusCode": 0,
  "UnhandledErrorBody": "",
  "xp": {},
  "Succeeded": false
}

OrderApprovedResponseobject(OrderApprovedResponse)

Example:

{
  "HttpStatusCode": 0,
  "UnhandledErrorBody": "",
  "xp": {},
  "Succeeded": false
}

SubscriptionIntegrationResponseobject(SubscriptionIntegrationResponse)

Example:

{
  "HttpStatusCode": 0,
  "UnhandledErrorBody": "",
  "xp": {},
  "Succeeded": false
}

Response

{
  "Order": {
    "ID": "",
    "FromUser": { … },
    "FromCompanyID": "",
    "ToCompanyID": "",
    "FromUserID": "",
    "BillingAddressID": "",
    "BillingAddress": { … },
    "ShippingAddressID": "",
    "Comments": "",
    "LineItemCount": 0,
    "Status": "Unsubmitted",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "DateSubmitted": "2018-01-01T00:00:00-06:00",
    "DateApproved": "2018-01-01T00:00:00-06:00",
    "DateDeclined": "2018-01-01T00:00:00-06:00",
    "DateCanceled": "2018-01-01T00:00:00-06:00",
    "DateCompleted": "2018-01-01T00:00:00-06:00",
    "LastUpdated": "2018-01-01T00:00:00-06:00",
    "Subtotal": 0,
    "ShippingCost": 0,
    "TaxCost": 0,
    "Gratuity": 0,
    "Fees": 0,
    "BaseDiscount": 0,
    "PromotionDiscount": 0,
    "Currency": "",
    "Total": 0,
    "IsSubmitted": false,
    "SubscriptionID": "",
    "xp": {}
  },
  "LineItems": [
    { … }
  ],
  "OrderPromotions": [
    { … }
  ],
  "Subscription": {
    "ID": "",
    "Frequency": 0,
    "Interval": "Days",
    "NextOrderDate": "2018-01-01T00:00:00-06:00",
    "LastOrderDate": "2018-01-01T00:00:00-06:00",
    "NotificationDate": "2018-01-01T00:00:00-06:00",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "EndDate": "2018-01-01T00:00:00-06:00",
    "Active": false,
    "FromCompanyID": "",
    "FromUserID": "",
    "ToCompanyID": "",
    "Payment": { … },
    "BillingAddressID": "",
    "ShippingAddressID": "",
    "ProjectedSubtotal": 0,
    "xp": {}
  },
  "ShipEstimateResponse": {
    "ShipEstimates": [ … ],
    "HttpStatusCode": 0,
    "UnhandledErrorBody": "",
    "xp": {},
    "Succeeded": false
  },
  "OrderCalculateResponse": {
    "LineItemOverrides": [ … ],
    "ShippingTotal": 0,
    "TaxTotal": 0,
    "FeeTotal": 0,
    "HttpStatusCode": 0,
    "UnhandledErrorBody": "",
    "xp": {},
    "Succeeded": false
  },
  "OrderSubmitResponse": {
    "HttpStatusCode": 0,
    "UnhandledErrorBody": "",
    "xp": {},
    "Succeeded": false
  },
  "OrderSubmitForApprovalResponse": {
    "HttpStatusCode": 0,
    "UnhandledErrorBody": "",
    "xp": {},
    "Succeeded": false
  },
  "OrderApprovedResponse": {
    "HttpStatusCode": 0,
    "UnhandledErrorBody": "",
    "xp": {},
    "Succeeded": false
  },
  "SubscriptionIntegrationResponse": {
    "HttpStatusCode": 0,
    "UnhandledErrorBody": "",
    "xp": {},
    "Succeeded": false
  }
}