Update Customer Messages

PUT

https://your_store.example.com/api/storefront/checkouts/:checkoutId

PUT

/api/storefront/checkouts/:checkoutId

$ curl -X PUT https://your_store.example.com/api/storefront/checkouts/checkoutId \
>      -H "Accept: application/json" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "value": {
3     "billingAddress": {
4       "address1": "123 Main Street",
5       "address2": "",
6       "city": "Austin",
7       "company": "",
8       "country": "United States",
9       "countryCode": "US",
10       "customFields": [
11         {
12           "fieldId": "field_25",
13           "fieldValue": "Leave in backyard"
14         }
15       ],
16       "email": "janedoe@example.com",
17       "firstName": "Jane",
18       "id": "5ba11e4a10fb5",
19       "lastName": "Doe",
20       "phone": "1234567890",
21       "postalCode": "78751",
22       "stateOrProvince": "Texas",
23       "stateOrProvinceCode": "TX"
24     },
25     "cart": {
26       "baseAmount": 119.93,
27       "cartAmount": 112.93,
28       "coupons": [
29         {
30           "code": "S2549JM0Y",
31           "couponType": "per_total_discount",
32           "discountedAmount": 5,
33           "displayName": "$5.00 off the order total",
34           "id": 1
35         }
36       ],
37       "createdTime": "2018-09-18T15:48:26+00:00",
38       "currency": {
39         "code": "USD",
40         "decimalPlaces": 2,
41         "name": "US Dollars",
42         "symbol": "$"
43       },
44       "customerId": 11,
45       "discountAmount": 0,
46       "discounts": [
47         {
48           "discountedAmount": 2.59,
49           "id": 1
50         },
51         {
52           "discountedAmount": 1.06,
53           "id": 2
54         },
55         {
56           "discountedAmount": 2.12,
57           "id": 3
58         },
59         {
60           "discountedAmount": 0.8,
61           "id": 4
62         },
63         {
64           "discountedAmount": 0.43,
65           "id": 5
66         }
67       ],
68       "email": "janedoe@example.com",
69       "id": "b6fbd994-61a8-4f25-9167-6ec10489c448",
70       "isTaxIncluded": false,
71       "lineItems": {
72         "customItems": [],
73         "digitalItems": [
74           {
75             "addedByPromotion": false,
76             "brand": "OFS",
77             "categoryNames": [
78               "Essentials",
79               "Just arrived"
80             ],
81             "comparisonPrice": 0,
82             "couponAmount": 0,
83             "discountAmount": 0,
84             "discounts": [
85               {
86                 "discountedAmount": 0.8,
87                 "id": 1
88               }
89             ],
90             "extendedComparisonPrice": 0,
91             "extendedListPrice": 18.95,
92             "extendedSalePrice": 18.95,
93             "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234",
94             "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2",
95             "isShippingRequired": false,
96             "isTaxable": true,
97             "listPrice": 18.95,
98             "name": "Gather Journal Issue 7 - Digital",
99             "options": [
100               {
101                 "name": "Color",
102                 "nameId": 1,
103                 "value": "Red",
104                 "valueId": "2"
105               }
106             ],
107             "originalPrice": 18.95,
108             "parentId": "",
109             "productId": 189,
110             "quantity": 1,
111             "salePrice": 18.95,
112             "type": "digital",
113             "url": "https://{store_domain}/all/gather-journal-issue-7/",
114             "variantId": 360
115           }
116         ],
117         "giftCertificates": [
118           {
119             "amount": 10,
120             "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac",
121             "message": "Thank you!",
122             "name": "$10.00 Gift Certificate",
123             "recipient": {
124               "email": "johndoe@example.com",
125               "name": "John Doe"
126             },
127             "sender": {
128               "email": "janedoe@example.com",
129               "name": "Jane Doe"
130             },
131             "taxable": false,
132             "theme": "Celebration",
133             "type": "giftCertificate"
134           }
135         ],
136         "physicalItems": [
137           {
138             "addedByPromotion": false,
139             "brand": "OFS",
140             "categoryNames": [
141               "Essentials",
142               "Just arrived"
143             ],
144             "comparisonPrice": 0,
145             "couponAmount": 0,
146             "discountAmount": 2,
147             "discounts": [
148               {
149                 "discountedAmount": 0.59,
150                 "id": 1
151               },
152               {
153                 "discountedAmount": 2,
154                 "id": 2
155               }
156             ],
157             "extendedComparisonPrice": 0,
158             "extendedListPrice": 15.99,
159             "extendedSalePrice": 13.99,
160             "giftWrapping": {},
161             "id": "69791a88-85c9-4c19-8042-e537621e8a55",
162             "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2",
163             "isShippingRequired": true,
164             "isTaxable": true,
165             "listPrice": 15.99,
166             "name": "Canvas Laundry Cart",
167             "options": [
168               {
169                 "name": "Color",
170                 "nameId": 1,
171                 "value": "Red",
172                 "valueId": "2"
173               }
174             ],
175             "originalPrice": 17.99,
176             "parentId": "",
177             "productId": 184,
178             "quantity": 1,
179             "salePrice": 13.99,
180             "sku": "SMA-RED",
181             "url": "https://{store_domain}/all/canvas-laundry-cart/",
182             "variantId": 364
183           },
184           {
185             "addedByPromotion": false,
186             "brand": "OFS",
187             "categoryNames": [
188               "Essentials",
189               "Just arrived"
190             ],
191             "comparisonPrice": 0,
192             "couponAmount": 0,
193             "discountAmount": 0,
194             "discounts": [
195               {
196                 "discountedAmount": 1.06,
197                 "id": 1
198               }
199             ],
200             "extendedComparisonPrice": 0,
201             "extendedListPrice": 25,
202             "extendedSalePrice": 25,
203             "giftWrapping": {},
204             "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450",
205             "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2",
206             "isShippingRequired": true,
207             "isTaxable": true,
208             "listPrice": 25,
209             "name": "Ceramic Measuring Spoons",
210             "options": [
211               {
212                 "name": "Color",
213                 "nameId": 1,
214                 "value": "Red",
215                 "valueId": "2"
216               }
217             ],
218             "originalPrice": 25,
219             "parentId": "",
220             "productId": 170,
221             "quantity": 1,
222             "salePrice": 25,
223             "sku": "",
224             "url": "https://{store_domain}/all/ceramic-measuring-spoons/",
225             "variantId": 341
226           },
227           {
228             "addedByPromotion": false,
229             "brand": "OFS",
230             "categoryNames": [
231               "Essentials",
232               "Just arrived"
233             ],
234             "comparisonPrice": 0,
235             "couponAmount": 0,
236             "discountAmount": 0,
237             "discounts": [
238               {
239                 "discountedAmount": 2.12,
240                 "id": 1
241               }
242             ],
243             "extendedComparisonPrice": 0,
244             "extendedListPrice": 49.99,
245             "extendedSalePrice": 49.99,
246             "giftWrapping": {},
247             "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5",
248             "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2",
249             "isShippingRequired": true,
250             "isTaxable": true,
251             "listPrice": 49.99,
252             "name": "Chambray Towel",
253             "options": [
254               {
255                 "name": "Color",
256                 "nameId": 1,
257                 "value": "Red",
258                 "valueId": "2"
259               }
260             ],
261             "originalPrice": 49.99,
262             "parentId": "",
263             "productId": 158,
264             "quantity": 1,
265             "salePrice": 49.99,
266             "sku": "SKU-A0C8A203",
267             "url": "https://{store_domain}/all/chambray-towel/",
268             "variantId": 376
269           }
270         ]
271       },
272       "locale": "en",
273       "updatedTime": "2018-09-18T16:59:45+00:00",
274       "version": 1
275     },
276     "channelId": 1,
277     "comparisonShippingCost": 64.94,
278     "consignments": [
279       {
280         "address": {
281           "address1": "123 Main Street",
282           "address2": "",
283           "city": "Austin",
284           "company": "",
285           "country": "United States",
286           "countryCode": "US",
287           "customFields": [
288             {
289               "fieldId": "field_25",
290               "fieldValue": "Leave in backyard"
291             }
292           ],
293           "email": "janedoe@example.com",
294           "firstName": "Jane",
295           "lastName": "Doe",
296           "phone": "1234567890",
297           "postalCode": "78751",
298           "stateOrProvince": "Texas",
299           "stateOrProvinceCode": "TX"
300         },
301         "availableShippingOptions": [
302           {
303             "additionalDescription": "Fragile items",
304             "cost": 8,
305             "description": "Ship by Weight",
306             "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841",
307             "imageUrl": "",
308             "transitTime": "",
309             "type": "shipping_byweight"
310           }
311         ],
312         "comparisonShippingCost": 64.94,
313         "couponDiscounts": [],
314         "discounts": [],
315         "handlingCost": 0,
316         "id": "5ba121929619b",
317         "lineItemIds": [
318           "69791a88-85c9-4c19-8042-e537621e8a55",
319           "ba2c619d-e6b4-48c2-8809-d88e424ed450",
320           "c72d6651-978d-45e5-881b-c2bb5f7ff1d5"
321         ],
322         "selectedShippingOption": {
323           "additionalDescription": "Fragile items",
324           "cost": 69.94,
325           "description": "UPS® (UPS Next Day Air®)",
326           "id": "bb3c818f-17ce-46fe-9475-65933095da0d",
327           "imageUrl": "",
328           "transitTime": "1 business day",
329           "type": "shipping_upsready"
330         },
331         "shippingCost": 69.94,
332         "shippingCostBeforeDiscount": 69.94
333       }
334     ],
335     "coupons": [
336       {
337         "code": "S2549JM0Y",
338         "couponType": 2,
339         "discountedAmount": 5,
340         "displayName": "$5.00 off the order total",
341         "id": 1
342       }
343     ],
344     "createdTime": "2018-09-18T15:48:26+00:00",
345     "customer": {
346       "addresses": [
347         {}
348       ],
349       "customerGroup": {
350         "id": 1,
351         "name": "Wholesale customers"
352       },
353       "email": "string",
354       "firstName": "string",
355       "fullName": "string",
356       "id": 1,
357       "isGuest": false,
358       "lastName": "string",
359       "shouldEncourageSignIn": false,
360       "storeCredit": 1
361     },
362     "customerMessage": "Thank you, BigCommerce",
363     "fees": [
364       {
365         "cost": 12.02,
366         "displayName": "Package Protection Insurance",
367         "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
368         "name": "AAINS",
369         "source": "AA",
370         "taxClassId": 12,
371         "type": "custom_fee"
372       }
373     ],
374     "giftCertificates": [
375       {
376         "balance": 4,
377         "code": "1234ABC",
378         "purchaseDate": "string",
379         "remaining": 2,
380         "used": 5
381       }
382     ],
383     "giftWrappingCostTotal": 0,
384     "grandTotal": 211.49,
385     "handlingCostTotal": 0,
386     "id": "b6fbd994-61a8-4f25-9167-6ec10489c448",
387     "isStoreCreditApplied": false,
388     "orderId": null,
389     "outstandingBalance": 0,
390     "payments": [
391       {}
392     ],
393     "promotions": [],
394     "shippingCostBeforeDiscount": 69.94,
395     "shippingCostTotal": 69.94,
396     "shouldExecuteSpamCheck": false,
397     "subtotal": 117.93,
398     "taxTotal": 28.62,
399     "taxes": [
400       {
401         "amount": 28.62,
402         "name": "Store Tax"
403       }
404     ],
405     "updatedTime": "2018-09-18T16:59:45+00:00",
406     "version": 1
407   }
408 }

Updates Checkout customer messages.

Limits

2000 character limit

Note

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

This endpoint requires using Stencil CLI, a local session, and a CSRF token to work.

Updates *Checkout* customer messages. **Limits** * 2000 character limit > #### Note > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint. > * This endpoint requires using Stencil CLI, a local session, and a CSRF token to work.

Path parameters

checkoutIdstringRequiredformat: "uuid"

The ID of the subject checkout. Identical to the cart ID.

Request

This endpoint expects an object.

customerMessagestringOptional

versionintegerOptional

The cart version that you expect to apply the updates. If the provided version doesn’t match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.

Response

billingAddressobject

cartobject

A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

channelIdinteger

Channel ID.

consignmentslist of objects

couponslist of objects

Coupons applied at the checkout level.

feeslist of objects

Fees applied at the checkout level.

createdTimestring

Time when the cart was created.

customerobject

Customer details.

customerMessagestring

Shopperʼs message provided as details for the order to be created from this cart

giftCertificateslist of objects

Applied gift certificate (as a payment method).

giftWrappingCostTotaldouble

Gift wrapping cost for all items, including or excluding tax.

grandTotalfloat

The total payable amount, before applying any store credit or gift certificate.

handlingCostTotalfloat

Handling cost for all consignments including or excluding tax.

idstringformat: "uuid"

isStoreCreditAppliedboolean

true value indicates StoreCredit has been applied.

orderIdstring or null

outstandingBalancedouble

grandTotal subtract the store-credit amount

paymentslist of objects

promotionslist of objects

shippingCostBeforeDiscountfloat

Total shipping cost for the checkout before discounts are applied.

comparisonShippingCostfloat

Total shipping cost for the checkout after automatic promotions are applied.

shippingCostTotalfloat

Shipping cost before any discounts are applied.

shouldExecuteSpamCheckboolean

subtotalfloat

Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.

taxeslist of objects

taxTotalfloat

updatedTimestring

Time when the cart was last updated.

versioninteger

The current version of the checkout increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.

Errors

409

Conflict Error

Note

Path parameters

Headers

Request

Response

Errors

Note