Search.../

createCheckout( )

Creates a checkout.

Description

The createCheckout() function returns a Promise that resolves to the new checkout when it's created.

Notes:

  • Checkout must include at least 1 item in the options.lineItems array.
  • options.channelType is required.
  • If _id for options.lineItems is added, make sure that each _id is unique.
  • If options.checkoutInfo.customFields are added, then options.checkoutInfo.customFields.value is required.

Syntax

function createCheckout(options: CreateCheckoutOptions): Promise<Checkout>

createCheckout Parameters

NAME
TYPE
DESCRIPTION
options
Optional
CreateCheckoutOptions

Checkout creation options.

Returns

Fulfilled - the newly created checkout.

Return Type:

Promise<
Checkout
>
NAME
TYPE
DESCRIPTION
_createdDate
Date

Date and time the checkout was created.

_id
string

Checkout ID.

_updatedDate
Date

Date and time the checkout was updated.

additionalFees
Array<
AdditionalFee
>

Additional Fees.

appliedDiscounts
Array<
AppliedDiscount
>

Applied discounts.

billingInfo
AddressWithContact

Billing information.

buyerInfo
BuyerInfo

Buyer information.

buyerLanguage
string

Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.

buyerNote
string

Buyer note left by the customer.

calculationErrors
CalculationErrors

Errors when calculating totals.

cartId
string

Cart ID that this checkout was created from. Empty if this checkout wasn't created out of a cart.

channelType
string

Sales channel that created the checkout. Supported values:

  • "WEB", "POS", "EBAY", "AMAZON", "WIX_APP_STORE", "WIX_INVOICES", "BACKOFFICE_MERCHANT", "WISH", "OTHER_PLATFORM".
completed
boolean

Whether an order was successfully created from this checkout. For an order to be successful, it must be successfully paid for (unless the total is 0).

conversionCurrency
string

All converted prices are displayed in this currency in three-letter ISO-4217 alphabetic format.

createdBy
CreatedBy

ID of the checkout's initiator.

currency
string

The currency used when submitting the order.

customFields
Array<
CustomField
>

Custom fields.

giftCard
GiftCard

Applied gift card details.

Note: Gift cards are supported through the Wix UI, though the SPI is not currently available. Learn more about Wix Gift Cards.

lineItems
Array<
LineItem
>

Line items.

Max: 300 items

membershipOptions
MembershipOptions

Information about valid and invalid memberships, and which ones are selected for usage

payLater
PriceSummary

Remaining amount for the order to be fully paid.

payNow
PriceSummary

Minimal amount to pay in order to place the order.

payNowTotalAfterGiftCard
MultiCurrencyPrice

The pay now total amount after gift card reduction

priceSummary
PriceSummary

Calculated price summary for the checkout.

shippingInfo
ShippingInfo

Shipping information.

siteLanguage
string

Site language in which original values are shown.

taxIncludedInPrice
boolean

Whether tax is included in line item prices.

taxSummary
TaxSummary

Tax summary.

weightUnit
string

Weight measurement unit - defaults to site's weight unit. Supported values:

  • "KG"
  • "LB"

Was this helpful?

Create a checkout with minimum required properties

Copy Code
1/**************************************
2 * Backend code - my-backend-file.jsw *
3 *************************************/
4
5import { checkout } from 'wix-ecom-backend';
6
7export async function myCreateCheckoutFunction(options) {
8 try {
9 const newCheckout = await checkout.createCheckout(options);
10 console.log('Success! Checkout created, checkout:', newCheckout);
11 return newCheckout;
12 } catch (error) {
13 console.error(error);
14 // Handle the error
15 }
16}
17
18/*************
19 * Page code *
20 ************/
21
22import { myCreateCheckoutFunction } from 'backend/my-backend-file';
23
24// Sample options object:
25const options = {
26 "lineItems": [{
27 "quantity": 3,
28 "catalogReference": {
29 // Wix Stores appId
30 "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
31 // Wix Stores productId
32 "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a"
33 }
34 }],
35 "channelType": "WEB"
36}
37
38myCreateCheckoutFunction(options)
39 .then((newCheckout) => {
40 console.log('Success! Checkout created:', newCheckout);
41 return newCheckout;
42 })
43 .catch((error) => {
44 console.error(error);
45 // Handle the error
46 });
47
48/* Promise resolves to:
49 *
50 * {
51 * "_id": "8a27ba84-0814-4b0e-8db3-b6057a421bd9",
52 * "lineItems": [
53 * {
54 * "_id": "00000000-0000-0000-0000-000000000001",
55 * "quantity": 3,
56 * "catalogReference": {
57 * "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
58 * "appId": "1380b703-ce81-ff05-f115-39571d94dfcd"
59 * },
60 * "productName": {
61 * "original": "Shirt",
62 * "translated": "Shirt"
63 * },
64 * "url": "https://example.wixsite.com",
65 * "price": {
66 * "amount": "10",
67 * "convertedAmount": "10",
68 * "formattedAmount": "$10.00",
69 * "formattedConvertedAmount": "$10.00"
70 * },
71 * "lineItemPrice": {
72 * "amount": "30",
73 * "convertedAmount": "30",
74 * "formattedAmount": "$30.00",
75 * "formattedConvertedAmount": "$30.00"
76 * },
77 * "fullPrice": {
78 * "amount": "10",
79 * "convertedAmount": "10",
80 * "formattedAmount": "$10.00",
81 * "formattedConvertedAmount": "$10.00"
82 * },
83 * "priceBeforeDiscounts": {
84 * "amount": "10",
85 * "convertedAmount": "10",
86 * "formattedAmount": "$10.00",
87 * "formattedConvertedAmount": "$10.00"
88 * },
89 * "totalPriceAfterTax": {
90 * "amount": "30",
91 * "convertedAmount": "30",
92 * "formattedAmount": "$30.00",
93 * "formattedConvertedAmount": "$30.00"
94 * },
95 * "totalPriceBeforeTax": {
96 * "amount": "30",
97 * "convertedAmount": "30",
98 * "formattedAmount": "$30.00",
99 * "formattedConvertedAmount": "$30.00"
100 * },
101 * "taxDetails": {
102 * "taxableAmount": {
103 * "amount": "30",
104 * "convertedAmount": "30",
105 * "formattedAmount": "$30.00",
106 * "formattedConvertedAmount": "$30.00"
107 * },
108 * "taxRate": "0",
109 * "totalTax": {
110 * "amount": "0",
111 * "convertedAmount": "0",
112 * "formattedAmount": "$0.00",
113 * "formattedConvertedAmount": "$0.00"
114 * },
115 * "rateBreakdown": []
116 * },
117 * "discount": {
118 * "amount": "0",
119 * "convertedAmount": "0",
120 * "formattedAmount": "$0.00",
121 * "formattedConvertedAmount": "$0.00"
122 * },
123 * "descriptionLines": [],
124 * "media": "wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000",
125 * "availability": {
126 * "status": "AVAILABLE"
127 * },
128 * "physicalProperties": {
129 * "sku": "364115376135191",
130 * "shippable": true
131 * },
132 * "couponScopes": [
133 * {
134 * "namespace": "stores",
135 * "group": {
136 * "name": "collection",
137 * "entityId": "00000000-000000-000000-000000000001"
138 * }
139 * },
140 * {
141 * "namespace": "stores",
142 * "group": {
143 * "name": "product",
144 * "entityId": "c8539b66-7a44-fe18-affc-afec4be8562a"
145 * }
146 * }
147 * ],
148 * "itemType": {
149 * "preset": "PHYSICAL"
150 * },
151 * "paymentOption": "FULL_PAYMENT_ONLINE",
152 * "rootCatalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a"
153 * }
154 * ],
155 * "shippingInfo": {
156 * "carrierServiceOptions": []
157 * },
158 * "buyerInfo": {
159 * "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
160 * },
161 * "conversionCurrency": "USD",
162 * "priceSummary": {
163 * "subtotal": {
164 * "amount": "30",
165 * "convertedAmount": "30",
166 * "formattedAmount": "$30.00",
167 * "formattedConvertedAmount": "$30.00"
168 * },
169 * "shipping": {
170 * "amount": "0",
171 * "convertedAmount": "0",
172 * "formattedAmount": "$0.00",
173 * "formattedConvertedAmount": "$0.00"
174 * },
175 * "tax": {
176 * "amount": "0",
177 * "convertedAmount": "0",
178 * "formattedAmount": "$0.00",
179 * "formattedConvertedAmount": "$0.00"
180 * },
181 * "discount": {
182 * "amount": "0",
183 * "convertedAmount": "0",
184 * "formattedAmount": "$0.00",
185 * "formattedConvertedAmount": "$0.00"
186 * },
187 * "total": {
188 * "amount": "30",
189 * "convertedAmount": "30",
190 * "formattedAmount": "$30.00",
191 * "formattedConvertedAmount": "$30.00"
192 * }
193 * },
194 * "calculationErrors": {
195 * "orderValidationErrors": []
196 * },
197 * "appliedDiscounts": [],
198 * "customFields": [],
199 * "weightUnit": "KG",
200 * "currency": "USD",
201 * "channelType": "WEB",
202 * "siteLanguage": "en",
203 * "buyerLanguage": "en",
204 * "completed": false,
205 * "taxIncludedInPrice": false,
206 * "createdBy": {
207 * "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
208 * },
209 * "_createdDate": "2022-07-18T13:39:03.023Z",
210 * "_updatedDate": "2022-07-18T13:39:03.023Z",
211 * "payNow": {
212 * "subtotal": {
213 * "amount": "30",
214 * "convertedAmount": "30",
215 * "formattedAmount": "$30.00",
216 * "formattedConvertedAmount": "$30.00"
217 * },
218 * "shipping": {
219 * "amount": "0",
220 * "convertedAmount": "0",
221 * "formattedAmount": "$0.00",
222 * "formattedConvertedAmount": "$0.00"
223 * },
224 * "tax": {
225 * "amount": "0",
226 * "convertedAmount": "0",
227 * "formattedAmount": "$0.00",
228 * "formattedConvertedAmount": "$0.00"
229 * },
230 * "discount": {
231 * "amount": "0",
232 * "convertedAmount": "0",
233 * "formattedAmount": "$0.00",
234 * "formattedConvertedAmount": "$0.00"
235 * },
236 * "total": {
237 * "amount": "30",
238 * "convertedAmount": "30",
239 * "formattedAmount": "$30.00",
240 * "formattedConvertedAmount": "$30.00"
241 * }
242 * },
243 * "payLater": {
244 * "subtotal": {
245 * "amount": "0",
246 * "convertedAmount": "0",
247 * "formattedAmount": "$0.00",
248 * "formattedConvertedAmount": "$0.00"
249 * },
250 * "shipping": {
251 * "amount": "0",
252 * "convertedAmount": "0",
253 * "formattedAmount": "$0.00",
254 * "formattedConvertedAmount": "$0.00"
255 * },
256 * "tax": {
257 * "amount": "0",
258 * "convertedAmount": "0",
259 * "formattedAmount": "$0.00",
260 * "formattedConvertedAmount": "$0.00"
261 * },
262 * "discount": {
263 * "amount": "0",
264 * "convertedAmount": "0",
265 * "formattedAmount": "$0.00",
266 * "formattedConvertedAmount": "$0.00"
267 * },
268 * "total": {
269 * "amount": "0",
270 * "convertedAmount": "0",
271 * "formattedAmount": "$0.00",
272 * "formattedConvertedAmount": "$0.00"
273 * }
274 * },
275 * "membershipOptions": {
276 * "eligibleMemberships": [],
277 * "invalidMemberships": [],
278 * "selectedMemberships": {
279 * "memberships": []
280 * }
281 * }
282 * }
283 *
284 */
Create a checkout, full object

Copy Code
1/**************************************
2 * Backend code - my-backend-file.jsw *
3 **************************************/
4
5import { checkout } from 'wix-ecom-backend';
6
7export async function myCreateCheckoutFunction(options) {
8 try {
9 const newCheckout = await checkout.createCheckout(options);
10 console.log('Success! Checkout created, checkout:', newCheckout);
11 return newCheckout;
12 } catch (error) {
13 console.error(error);
14 // Handle the error
15 }
16}
17
18/*************
19 * Page code *
20 ************/
21
22import { myCreateCheckoutFunction } from 'backend/my-backend-file';
23
24// Sample options object:
25const options = {
26 "lineItems": [{
27 "quantity": 3,
28 "catalogReference": {
29 // Wix Stores appId
30 "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
31 // Wix Stores productId
32 "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a"
33 }
34 },
35 {
36 "quantity": 1,
37 "catalogReference": {
38 "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
39 "catalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e",
40 "options": {
41 "variantId": "2f430d69-9b75-4874-bfbd-c5f6fa5aff3d",
42 "customTextFields": {
43 "birthday card": "Happy Birthday!"
44 }
45 }
46 }
47 },
48 {
49 "quantity": 1,
50 "catalogReference": {
51 "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
52 "catalogItemId": "9fe8c5b2-9c94-7153-ebb9-8533695e2b6f",
53 "options": {
54 "Size": "Large",
55 "Color": "White"
56 }
57 }
58 }
59 ],
60 "channelType": "WEB",
61 "couponCode": "SUMMERSALE10",
62 "checkoutInfo": {
63 "shippingInfo": {
64 "shippingDestination": {
65 "address": {
66 "country": "US",
67 "subdivision": "US-NY",
68 "city": "New York",
69 "postalCode": "10011",
70 "addressLine1": "235 West 23rd Street",
71 "addressLine2": "3rd floor"
72 },
73 "contactDetails": {
74 "firstName": "Jane",
75 "lastName": "Doe",
76 "phone": "+1234567890"
77 }
78 },
79 "selectedCarrierServiceOption": {
80 "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc",
81 "code": "ed5bbce2-9533-dff4-7db0-13702fd139c5"
82 }
83 },
84 "billingInfo": {
85 "address": {
86 "country": "US",
87 "subdivision": "US-NY",
88 "city": "New York",
89 "postalCode": "10011",
90 "addressLine1": "235 West 23rd Street",
91 "addressLine2": "3rd floor"
92 },
93 "contactDetails": {
94 "firstName": "Jane",
95 "lastName": "Doe",
96 "phone": "+1234567890"
97 }
98 },
99 "buyerInfo": {
100 "email": "Janedoe@example.com"
101 },
102 "buyerNote": "Please wrap it up as a present",
103 "customFields": [{
104 "title": "Tax ID",
105 "translatedTitle": "Tax ID",
106 "value": "12345"
107 }]
108 }
109}
110
111myCreateCheckoutFunction(options)
112 .then((newCheckout) => {
113 console.log('Success! Checkout created:', newCheckout);
114 return newCheckout;
115 })
116 .catch((error) => {
117 console.error(error);
118 // Handle the error
119 });
120
121/* Promise resolves to:
122 *
123 * {
124 * "_id": "74cc6825-82a1-4f1f-9fbb-7d73f6be152a",
125 * "lineItems": [
126 * {
127 * "_id": "00000000-0000-0000-0000-000000000001",
128 * "quantity": 3,
129 * "catalogReference": {
130 * "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
131 * "appId": "1380b703-ce81-ff05-f115-39571d94dfcd"
132 * },
133 * "productName": {
134 * "original": "Shirt",
135 * "translated": "Shirt"
136 * },
137 * "url": "https://example.wixsite.com",
138 * "price": {
139 * "amount": "10",
140 * "convertedAmount": "10",
141 * "formattedAmount": "$10.00",
142 * "formattedConvertedAmount": "$10.00"
143 * },
144 * "lineItemPrice": {
145 * "amount": "30",
146 * "convertedAmount": "30",
147 * "formattedAmount": "$30.00",
148 * "formattedConvertedAmount": "$30.00"
149 * },
150 * "fullPrice": {
151 * "amount": "10",
152 * "convertedAmount": "10",
153 * "formattedAmount": "$10.00",
154 * "formattedConvertedAmount": "$10.00"
155 * },
156 * "priceBeforeDiscounts": {
157 * "amount": "10",
158 * "convertedAmount": "10",
159 * "formattedAmount": "$10.00",
160 * "formattedConvertedAmount": "$10.00"
161 * },
162 * "totalPriceAfterTax": {
163 * "amount": "20",
164 * "convertedAmount": "20",
165 * "formattedAmount": "$20.00",
166 * "formattedConvertedAmount": "$20.00"
167 * },
168 * "totalPriceBeforeTax": {
169 * "amount": "20",
170 * "convertedAmount": "20",
171 * "formattedAmount": "$20.00",
172 * "formattedConvertedAmount": "$20.00"
173 * },
174 * "taxDetails": {
175 * "taxableAmount": {
176 * "amount": "20",
177 * "convertedAmount": "20",
178 * "formattedAmount": "$20.00",
179 * "formattedConvertedAmount": "$20.00"
180 * },
181 * "taxRate": "0",
182 * "totalTax": {
183 * "amount": "0",
184 * "convertedAmount": "0",
185 * "formattedAmount": "$0.00",
186 * "formattedConvertedAmount": "$0.00"
187 * },
188 * "rateBreakdown": []
189 * },
190 * "discount": {
191 * "amount": "10",
192 * "convertedAmount": "10",
193 * "formattedAmount": "$10.00",
194 * "formattedConvertedAmount": "$10.00"
195 * },
196 * "descriptionLines": [],
197 * "media": "wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000",
198 * "availability": {
199 * "status": "AVAILABLE"
200 * },
201 * "physicalProperties": {
202 * "sku": "364115376135191",
203 * "shippable": true
204 * },
205 * "couponScopes": [
206 * {
207 * "namespace": "stores",
208 * "group": {
209 * "name": "collection",
210 * "entityId": "00000000-000000-000000-000000000001"
211 * }
212 * },
213 * {
214 * "namespace": "stores",
215 * "group": {
216 * "name": "product",
217 * "entityId": "c8539b66-7a44-fe18-affc-afec4be8562a"
218 * }
219 * }
220 * ],
221 * "itemType": {
222 * "preset": "PHYSICAL"
223 * },
224 * "paymentOption": "FULL_PAYMENT_ONLINE",
225 * "rootCatalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a"
226 * },
227 * {
228 * "_id": "00000000-0000-0000-0000-000000000002",
229 * "quantity": 1,
230 * "catalogReference": {
231 * "catalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e",
232 * "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
233 * "options": {
234 * "variantId": "2f430d69-9b75-4874-bfbd-c5f6fa5aff3d",
235 * "customTextFields": {
236 * "birthday card": "Happy Birthday!"
237 * }
238 * }
239 * },
240 * "productName": {
241 * "original": "Shoe",
242 * "translated": "Shoe"
243 * },
244 * "url": "https://example.wixsite.com",
245 * "price": {
246 * "amount": "85",
247 * "convertedAmount": "85",
248 * "formattedAmount": "$85.00",
249 * "formattedConvertedAmount": "$85.00"
250 * },
251 * "lineItemPrice": {
252 * "amount": "85",
253 * "convertedAmount": "85",
254 * "formattedAmount": "$85.00",
255 * "formattedConvertedAmount": "$85.00"
256 * },
257 * "fullPrice": {
258 * "amount": "85",
259 * "convertedAmount": "85",
260 * "formattedAmount": "$85.00",
261 * "formattedConvertedAmount": "$85.00"
262 * },
263 * "priceBeforeDiscounts": {
264 * "amount": "85",
265 * "convertedAmount": "85",
266 * "formattedAmount": "$85.00",
267 * "formattedConvertedAmount": "$85.00"
268 * },
269 * "totalPriceAfterTax": {
270 * "amount": "85",
271 * "convertedAmount": "85",
272 * "formattedAmount": "$85.00",
273 * "formattedConvertedAmount": "$85.00"
274 * },
275 * "totalPriceBeforeTax": {
276 * "amount": "85",
277 * "convertedAmount": "85",
278 * "formattedAmount": "$85.00",
279 * "formattedConvertedAmount": "$85.00"
280 * },
281 * "taxDetails": {
282 * "taxableAmount": {
283 * "amount": "85",
284 * "convertedAmount": "85",
285 * "formattedAmount": "$85.00",
286 * "formattedConvertedAmount": "$85.00"
287 * },
288 * "taxRate": "0",
289 * "totalTax": {
290 * "amount": "0",
291 * "convertedAmount": "0",
292 * "formattedAmount": "$0.00",
293 * "formattedConvertedAmount": "$0.00"
294 * },
295 * "rateBreakdown": []
296 * },
297 * "discount": {
298 * "amount": "0",
299 * "convertedAmount": "0",
300 * "formattedAmount": "$0.00",
301 * "formattedConvertedAmount": "$0.00"
302 * },
303 * "descriptionLines": [
304 * {
305 * "name": {
306 * "original": "Color",
307 * "translated": "Color"
308 * },
309 * "colorInfo": {
310 * "original": "Brown",
311 * "translated": "Brown",
312 * "code": "#783f04"
313 * }
314 * },
315 * {
316 * "name": {
317 * "original": "birthday card",
318 * "translated": "birthday card"
319 * },
320 * "plainText": {
321 * "original": "Happy Birthday!",
322 * "translated": "Happy Birthday!"
323 * }
324 * }
325 * ],
326 * "media": "wix:image://v1/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg#originWidth=1000&originHeight=1000",
327 * "availability": {
328 * "status": "AVAILABLE",
329 * "quantityAvailable": 30
330 * },
331 * "physicalProperties": {
332 * "sku": "364215376135191",
333 * "shippable": true
334 * },
335 * "couponScopes": [
336 * {
337 * "namespace": "stores",
338 * "group": {
339 * "name": "collection",
340 * "entityId": "00000000-000000-000000-000000000001"
341 * }
342 * },
343 * {
344 * "namespace": "stores",
345 * "group": {
346 * "name": "product",
347 * "entityId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e"
348 * }
349 * }
350 * ],
351 * "itemType": {
352 * "preset": "PHYSICAL"
353 * },
354 * "paymentOption": "FULL_PAYMENT_ONLINE",
355 * "rootCatalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e"
356 * },
357 * {
358 * "_id": "00000000-0000-0000-0000-000000000003",
359 * "quantity": 1,
360 * "catalogReference": {
361 * "catalogItemId": "9fe8c5b2-9c94-7153-ebb9-8533695e2b6f",
362 * "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
363 * "options": {
364 * "Size": "Large",
365 * "Color": "White"
366 * }
367 * },
368 * "price": {
369 * "amount": "0",
370 * "convertedAmount": "0",
371 * "formattedAmount": "",
372 * "formattedConvertedAmount": ""
373 * },
374 * "fullPrice": {
375 * "amount": "0",
376 * "convertedAmount": "0",
377 * "formattedAmount": "",
378 * "formattedConvertedAmount": ""
379 * },
380 * "priceBeforeDiscounts": {
381 * "amount": "0",
382 * "convertedAmount": "0",
383 * "formattedAmount": "",
384 * "formattedConvertedAmount": ""
385 * },
386 * "descriptionLines": [],
387 * "availability": {
388 * "status": "NOT_FOUND"
389 * },
390 * "couponScopes": [],
391 * "paymentOption": "FULL_PAYMENT_ONLINE"
392 * }
393 * ],
394 * "billingInfo": {
395 * "address": {
396 * "addressLine1": "235 West 23rd Street",
397 * "addressLine2": "3rd floor",
398 * "city": "New York",
399 * "subdivision": "US-NY",
400 * "country": "US",
401 * "postalCode": "10011"
402 * },
403 * "contactDetails": {
404 * "firstName": "Jane",
405 * "lastName": "Doe",
406 * "phone": "+1234567890"
407 * }
408 * },
409 * "shippingInfo": {
410 * "shippingDestination": {
411 * "address": {
412 * "addressLine1": "235 West 23rd Street",
413 * "addressLine2": "3rd floor",
414 * "city": "New York",
415 * "subdivision": "US-NY",
416 * "country": "US",
417 * "postalCode": "10011"
418 * },
419 * "contactDetails": {
420 * "firstName": "Jane",
421 * "lastName": "Doe",
422 * "phone": "+1234567890"
423 * }
424 * },
425 * "selectedCarrierServiceOption": {
426 * "code": "ed5bbce2-9533-dff4-7db0-13702fd139c5",
427 * "title": "Standard US Shipping",
428 * "logistics": {
429 * "deliveryTime": ""
430 * },
431 * "cost": {
432 * "totalPriceAfterTax": {
433 * "amount": "10",
434 * "convertedAmount": "10",
435 * "formattedAmount": "$10.00",
436 * "formattedConvertedAmount": "$10.00"
437 * },
438 * "totalPriceBeforeTax": {
439 * "amount": "10",
440 * "convertedAmount": "10",
441 * "formattedAmount": "$10.00",
442 * "formattedConvertedAmount": "$10.00"
443 * },
444 * "taxDetails": {
445 * "taxRate": "0",
446 * "totalTax": {
447 * "amount": "0",
448 * "convertedAmount": "0",
449 * "formattedAmount": "$0.00",
450 * "formattedConvertedAmount": "$0.00"
451 * },
452 * "rateBreakdown": []
453 * },
454 * "price": {
455 * "amount": "10",
456 * "convertedAmount": "10",
457 * "formattedAmount": "$10.00",
458 * "formattedConvertedAmount": "$10.00"
459 * }
460 * },
461 * "requestedShippingOption": true,
462 * "otherCharges": [],
463 * "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc"
464 * },
465 * "region": {
466 * "_id": "009fbe5d-89d3-7825-cbbf-1aab4d908b73",
467 * "name": "USA shipping"
468 * },
469 * "carrierServiceOptions": [
470 * {
471 * "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc",
472 * "shippingOptions": [
473 * {
474 * "code": "ed5bbce2-9533-dff4-7db0-13702fd139c5",
475 * "title": "Standard US Shipping",
476 * "logistics": {
477 * "deliveryTime": ""
478 * },
479 * "cost": {
480 * "price": {
481 * "amount": "10",
482 * "convertedAmount": "10",
483 * "formattedAmount": "$10.00",
484 * "formattedConvertedAmount": "$10.00"
485 * },
486 * "otherCharges": []
487 * }
488 * }
489 * ]
490 * }
491 * ]
492 * },
493 * "buyerNote": "Please wrap it up as a present",
494 * "buyerInfo": {
495 * "email": "Janedoe@example.com",
496 * "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
497 * },
498 * "conversionCurrency": "USD",
499 * "priceSummary": {
500 * "subtotal": {
501 * "amount": "115",
502 * "convertedAmount": "115",
503 * "formattedAmount": "$115.00",
504 * "formattedConvertedAmount": "$115.00"
505 * },
506 * "shipping": {
507 * "amount": "10",
508 * "convertedAmount": "10",
509 * "formattedAmount": "$10.00",
510 * "formattedConvertedAmount": "$10.00"
511 * },
512 * "tax": {
513 * "amount": "0",
514 * "convertedAmount": "0",
515 * "formattedAmount": "$0.00",
516 * "formattedConvertedAmount": "$0.00"
517 * },
518 * "discount": {
519 * "amount": "10",
520 * "convertedAmount": "10",
521 * "formattedAmount": "$10.00",
522 * "formattedConvertedAmount": "$10.00"
523 * },
524 * "total": {
525 * "amount": "115",
526 * "convertedAmount": "115",
527 * "formattedAmount": "$115.00",
528 * "formattedConvertedAmount": "$115.00"
529 * }
530 * },
531 * "calculationErrors": {
532 * "orderValidationErrors": []
533 * },
534 * "appliedDiscounts": [
535 * {
536 * "discountType": "GLOBAL",
537 * "lineItemIds": [],
538 * "coupon": {
539 * "_id": "fbb94b06-7447-4161-9c48-59bfcdc39e77",
540 * "code": "SUMMERSALE10",
541 * "amount": {
542 * "amount": "10",
543 * "convertedAmount": "10",
544 * "formattedAmount": "$10.00",
545 * "formattedConvertedAmount": "$10.00"
546 * },
547 * "name": "SUMMERSALE10",
548 * "couponType": "MoneyOff"
549 * }
550 * }
551 * ],
552 * "customFields": [
553 * {
554 * "value": "12345",
555 * "title": "Tax ID",
556 * "translatedTitle": "Tax ID"
557 * }
558 * ],
559 * "weightUnit": "KG",
560 * "currency": "USD",
561 * "channelType": "WEB",
562 * "siteLanguage": "en",
563 * "buyerLanguage": "en",
564 * "completed": false,
565 * "taxIncludedInPrice": false,
566 * "createdBy": {
567 * "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
568 * },
569 * "_createdDate": "2022-07-18T13:25:22.141Z",
570 * "_updatedDate": "2022-07-18T13:25:22.141Z",
571 * "payNow": {
572 * "subtotal": {
573 * "amount": "115",
574 * "convertedAmount": "115",
575 * "formattedAmount": "$115.00",
576 * "formattedConvertedAmount": "$115.00"
577 * },
578 * "shipping": {
579 * "amount": "10",
580 * "convertedAmount": "10",
581 * "formattedAmount": "$10.00",
582 * "formattedConvertedAmount": "$10.00"
583 * },
584 * "tax": {
585 * "amount": "0",
586 * "convertedAmount": "0",
587 * "formattedAmount": "$0.00",
588 * "formattedConvertedAmount": "$0.00"
589 * },
590 * "discount": {
591 * "amount": "10",
592 * "convertedAmount": "10",
593 * "formattedAmount": "$10.00",
594 * "formattedConvertedAmount": "$10.00"
595 * },
596 * "total": {
597 * "amount": "115",
598 * "convertedAmount": "115",
599 * "formattedAmount": "$115.00",
600 * "formattedConvertedAmount": "$115.00"
601 * }
602 * },
603 * "payLater": {
604 * "subtotal": {
605 * "amount": "0",
606 * "convertedAmount": "0",
607 * "formattedAmount": "$0.00",
608 * "formattedConvertedAmount": "$0.00"
609 * },
610 * "shipping": {
611 * "amount": "0",
612 * "convertedAmount": "0",
613 * "formattedAmount": "$0.00",
614 * "formattedConvertedAmount": "$0.00"
615 * },
616 * "tax": {
617 * "amount": "0",
618 * "convertedAmount": "0",
619 * "formattedAmount": "$0.00",
620 * "formattedConvertedAmount": "$0.00"
621 * },
622 * "discount": {
623 * "amount": "0",
624 * "convertedAmount": "0",
625 * "formattedAmount": "$0.00",
626 * "formattedConvertedAmount": "$0.00"
627 * },
628 * "total": {
629 * "amount": "0",
630 * "convertedAmount": "0",
631 * "formattedAmount": "$0.00",
632 * "formattedConvertedAmount": "$0.00"
633 * }
634 * },
635 * "membershipOptions": {
636 * "eligibleMemberships": [],
637 * "invalidMemberships": [],
638 * "selectedMemberships": {
639 * "memberships": []
640 * }
641 * }
642 * }
643 *
644 */