Estimate Cart
Using the Estimate Cart endpoint you can discover the estimated totals and available shipping methods for any combination of Sku’s and a shipping address. This feature can be useful for debugging failed carts where one or more Sku’s may have been unavailable in a certain region or no shipping methods were returned for an address.
Cart estimation is not a part of the checkout process and is instead best used as a method for anticipating the behavior of a cart or debugging a failed cart.
When using Estimate Cart you do not need to manage the lifecycle of a cart. Violet will handle the creation, modification, and deletion of any external carts that may need to be created while estimating a cart.
When the Estimate Cart process fails in the external commerce platform, Violet will attempt to parse and surface all error messages from the external system so that you are able to fully understand why the estimation failed. The most common reasons for failure will be Sku unavailability and incorrectly formatted shipping addresses.
Body
Calculate Cart Request
A list of one or more Violet Sku's. Sku's from the same merchant will be grouped and calculated together.
The address the items in the cart should be shipped to.
The base currency the cart should be calculated in.
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, BTN Response
Order Refund
ID of the Order being refunded
ID of the merchant making the refund
ID of the App that created the Order
ID of the Transaction being refunded
ID of the Transaction in the Payment Gateway
Amount being refunded. In Cents
ID of the Bag being refunded
Amount being taken back from the associated transfer to the merchant. In Cents
Amount being taken back from the associated transfer to the developer. In Cents
Reason for refund
Reason code for refund
OTHER, CUSTOMER, INVENTORY, FRAUD, DECLINED Currency set for this refund by the external ecom platform
Status of the Refund
PROCESSING, COMPLETED, CANCELED, PARTIALLY_COMPLETED, FAILED, EXTERNAL SKUs the refund applies to
Date of creation
Date of last update
ID of the refund on the external commerce platform. This value will only be populated if the external commerce platform supports refund ID's.
List of errors associated to this refund during processing. This value will only be populated if there are errors during processing
Details of any refunded shipping amounts.
Tax amount being refunded. In Cents.
x > 0Was this page helpful?