From b34f32ed5fee37671adbc0c3668a9d147619f903 Mon Sep 17 00:00:00 2001 From: Torbjorn van Heeswijck Date: Mon, 23 Jun 2025 15:31:00 +0930 Subject: [PATCH 1/3] Bump yarn to 4.9.2 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index aa5cb02..2694e6e 100644 --- a/package.json +++ b/package.json @@ -66,5 +66,5 @@ "node-fetch": "^3.3.2", "query-string": "^9.1.1" }, - "packageManager": "yarn@4.9.1+sha512.f95ce356460e05be48d66401c1ae64ef84d163dd689964962c6888a9810865e39097a5e9de748876c2e0bf89b232d583c33982773e9903ae7a76257270986538" + "packageManager": "yarn@4.9.2" } From 14966fa55e94334e536e93a4b9b5cdf5c6c20684 Mon Sep 17 00:00:00 2001 From: Torbjorn van Heeswijck Date: Mon, 23 Jun 2025 15:42:30 +0930 Subject: [PATCH 2/3] Rebuild reference files for 1.0.0 --- docs/changelog/1.0.0.md | 157 + package.json | 2 +- src/internal/reference/generated/carts.sf.ts | 5 + src/internal/reference/generated/carts.v3.ts | 62 + .../generated/catalog/brands_catalog.v3.ts | 415 + .../catalog/categories_catalog.v3.ts | 269 + .../catalog/category_trees_catalog.v3.ts | 84 + .../catalog/product_modifiers_catalog.v3.ts | 261 + .../product_variant_options_catalog.v3.ts | 157 + .../catalog/product_variants_catalog.v3.ts | 281 + .../generated/catalog/products_catalog.v3.ts | 984 ++ .../reference/generated/channels.v3.ts | 30 + .../reference/generated/checkouts.sf.ts | 4865 ++++++++ .../reference/generated/checkouts.v3.ts | 10246 ++++++++++++++++ .../reference/generated/customers.v2.ts | 12 + .../reference/generated/customers.v3.ts | 38 + .../reference/generated/geography.v2.ts | 22 + .../reference/generated/locations.v3.ts | 24 + .../reference/generated/marketing.v2.ts | 464 + .../reference/generated/orders.v2.oas2.ts | 6 + src/internal/reference/generated/orders.v3.ts | 30 + src/internal/reference/generated/pages.v3.ts | 6 +- .../reference/generated/price_lists.v3.ts | 397 + .../reference/generated/pricing.sf.ts | 105 + .../generated/promotion_settings.v3.ts | 6 + .../reference/generated/promotions.v3.ts | 174 +- .../reference/generated/shipping.v3.ts | 22 + .../reference/generated/store_content.v2.ts | 269 + .../generated/store_information.v2.ts | 13 + .../reference/generated/tax_classes.v2.ts | 26 + .../reference/generated/wishlists.v3.ts | 274 + 31 files changed, 19677 insertions(+), 29 deletions(-) create mode 100644 docs/changelog/1.0.0.md diff --git a/docs/changelog/1.0.0.md b/docs/changelog/1.0.0.md new file mode 100644 index 0000000..caff2bf --- /dev/null +++ b/docs/changelog/1.0.0.md @@ -0,0 +1,157 @@ +# Interface Change Summary: 0.0.1-alpha.3 + +## Modified files +### `catalog/brands_catalog.v3.ts` + +components.parameters: +```diff ++ readonly DirectionQuery: "asc" | "desc"; +``` + +operations.getBrands.parameters.query: +```diff ++ readonly direction?: components["parameters"]["DirectionQuery"]; +``` + +### `pages.v3.ts` + +components.schemas.pageMeta: +```diff +- readonly meta_keywords: string; ++ readonly meta_keywords: string | null; +- readonly meta_description: string; ++ readonly meta_description: string | null; +``` + +components.schemas.searchKeywords: +```diff +- readonly search_keywords: string; ++ readonly search_keywords: string | null; +``` + +### `promotions.v3.ts` + +components.schemas: +```diff ++ readonly CreatedFrom: "react_ui" | "legacy_ui" | "api"; +- readonly PromotionCoupon: components["schemas"]["PromotionBase"] & { ++ readonly PatchCouponPromotion: components["schemas"]["PromotionBase"] & { +- readonly PromotionAutomatic: components["schemas"]["PromotionBase"]; ++ readonly DraftCouponPromotion: components["schemas"]["PromotionBase"] & { +``` + +components.schemas.PromotionBase: +```diff +- readonly name: string; ++ readonly name?: string; +- readonly rules: readonly components["schemas"]["Rule"][]; ++ readonly rules?: readonly components["schemas"]["Rule"][]; +``` + +components.schemas.PatchCouponPromotion: +```diff ++ readonly codes?: components["schemas"]["CouponCode"]; +``` + +components.schemas.DraftCouponPromotion: +```diff ++ readonly codes?: components["schemas"]["CouponCode"]; ++ readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; ++ readonly redemption_type: "COUPON"; ++ }; ++ readonly SavedCouponPromotion: WithRequired & { ++ readonly id: number; ++ readonly created_from: components["schemas"]["CreatedFrom"]; ++ readonly codes?: components["schemas"]["CouponCode"]; ++ readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; ++ readonly redemption_type: "COUPON"; ++ readonly multiple_codes?: { ++ readonly has_multiple_codes: boolean; ++ }; ++ }; ++ readonly PatchAutomaticPromotion: components["schemas"]["PromotionBase"]; ++ readonly DraftAutomaticPromotion: WithRequired & { ++ readonly redemption_type: "AUTOMATIC"; ++ }; ++ readonly SavedAutomaticPromotion: WithRequired & { ++ readonly redemption_type: "AUTOMATIC"; ++ readonly id: number; ++ readonly created_from: components["schemas"]["CreatedFrom"]; ++ }; +``` + +components.schemas.CollectionMeta: +```diff +- readonly pagination?: components["schemas"]["Pagination"]; ++ readonly pagination: components["schemas"]["Pagination"]; +``` + +components.schemas.Pagination: +```diff +- readonly total?: number; ++ readonly total: number; +- readonly count?: number; ++ readonly count: number; +- readonly per_page?: number; ++ readonly per_page: number; +- readonly current_page?: number; ++ readonly current_page: number; +- readonly total_pages?: number; ++ readonly total_pages: number; +- readonly links?: { ++ readonly links: { +``` + +components.schemas.CouponCode: +```diff +- readonly id?: number; ++ readonly id: number; +- readonly current_uses?: number; ++ readonly current_uses: number; +- readonly created?: string; ++ readonly created: string; +``` + +components.responses.PromotionsCollectionResponse.content."application/json": +```diff +- readonly data?: readonly (components["schemas"]["PromotionAutomatic"] | components["schemas"]["PromotionCoupon"])[]; ++ readonly data: readonly (components["schemas"]["SavedAutomaticPromotion"] | components["schemas"]["SavedCouponPromotion"])[]; +- readonly meta?: components["schemas"]["CollectionMeta"]; ++ readonly meta: components["schemas"]["CollectionMeta"]; +``` + +components.responses.PromotionsResponse.content."application/json": +```diff +- readonly data?: components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; ++ readonly data?: components["schemas"]["SavedCouponPromotion"] | components["schemas"]["SavedAutomaticPromotion"]; +``` + +components.parameters: +```diff ++ readonly Query: string; +``` + +operations.getPromotions.parameters.query: +```diff ++ readonly query?: components["parameters"]["Query"]; +``` + +operations.createPromotion.requestBody.content: +```diff +- readonly "application/json": components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; ++ readonly "application/json": components["schemas"]["DraftCouponPromotion"] | components["schemas"]["DraftAutomaticPromotion"]; +``` + +operations.updatePromotion.requestBody.content: +```diff +- readonly "application/json": components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; ++ readonly "application/json": components["schemas"]["PatchCouponPromotion"] | components["schemas"]["PatchAutomaticPromotion"]; +``` + +: +```diff ++ type WithRequired = T & { ++ [P in K]-?: T[P]; ++ }; +``` + diff --git a/package.json b/package.json index 2694e6e..6e13cf7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@aligent/bigcommerce-api", - "version": "0.0.1-alpha.3", + "version": "1.0.0", "type": "module", "scripts": { "test": "tsd", diff --git a/src/internal/reference/generated/carts.sf.ts b/src/internal/reference/generated/carts.sf.ts index 8ef87ea..fa7baf0 100644 --- a/src/internal/reference/generated/carts.sf.ts +++ b/src/internal/reference/generated/carts.sf.ts @@ -786,6 +786,11 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 409, + * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/carts.v3.ts b/src/internal/reference/generated/carts.v3.ts index 0bb971d..5ac923c 100644 --- a/src/internal/reference/generated/carts.v3.ts +++ b/src/internal/reference/generated/carts.v3.ts @@ -2047,6 +2047,11 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 409, + * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; @@ -2451,6 +2456,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2563,6 +2574,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2666,6 +2683,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": "24", + * "key": "Staff Name", + * "value": "Sam", + * "namespace": "Sales Department", + * "permission_set": "app_only", + * "resource_type": "cart", + * "resource_id": "b810114d-9926-45b7-bba5-7633b251154b", + * "description": "Name of staff member", + * "date_created": "2023-11-15T15:16:35+00:00", + * "date_modified": "2023-11-15T15:16:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": components["schemas"]["MetaFieldCollectionResponse"]; }; }; @@ -2675,6 +2707,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2797,6 +2835,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2943,6 +2987,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2999,6 +3049,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3049,6 +3105,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/catalog/brands_catalog.v3.ts b/src/internal/reference/generated/catalog/brands_catalog.v3.ts index f62dbc1..4fbe252 100644 --- a/src/internal/reference/generated/catalog/brands_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/brands_catalog.v3.ts @@ -885,6 +885,9 @@ export interface components { }; }; parameters: { + /** @description Sort direction. Acceptable values are: `asc`, `desc`. + * */ + readonly DirectionQuery: "asc" | "desc"; /** @description The ID of the brand to which the resource belongs. * */ readonly BrandIdPath: number; @@ -987,6 +990,9 @@ export interface operations { readonly exclude_fields?: components["parameters"]["ExcludeFieldsQuery"]; /** @description Field name to sort by. */ readonly sort?: components["parameters"]["SortQuery"]; + /** @description Sort direction. Acceptable values are: `asc`, `desc`. + * */ + readonly direction?: components["parameters"]["DirectionQuery"]; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ @@ -1002,6 +1008,249 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 35, + * "name": "Sagaform", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/brands/Sagaform.html", + * "is_customized": false + * } + * }, + * { + * "id": 36, + * "name": "OFS", + * "page_title": "OFS", + * "meta_keywords": [ + * "modern", + * "clean", + * "contemporary" + * ], + * "meta_description": "OFS is a modern brand.", + * "image_url": "", + * "search_keywords": "kitchen, laundry, cart, storage", + * "custom_url": { + * "url": "/brands/OFS.html", + * "is_customized": false + * } + * }, + * { + * "id": 37, + * "name": "Common Good", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/k/screen%20shot%202018-05-07%20at%2012.24.24%20pm_1525785365__65102.png", + * "search_keywords": "", + * "custom_url": { + * "url": "/brands/Common-Good.html", + * "is_customized": false + * } + * }, + * { + * "id": 38, + * "name": "BigCommerce", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/bigcommerce/", + * "is_customized": false + * } + * }, + * { + * "id": 39, + * "name": "Test Brand One", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/q/apihqggzm__53766.jpg", + * "search_keywords": "", + * "custom_url": { + * "url": "/test-brand-one/", + * "is_customized": false + * } + * }, + * { + * "id": 40, + * "name": "Fog Linen Work", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/fog-linen-work/", + * "is_customized": false + * } + * }, + * { + * "id": 41, + * "name": "Barr-Co.", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/barr-co/", + * "is_customized": false + * } + * }, + * { + * "id": 42, + * "name": "Thames & Hudson", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/thames-hudson/", + * "is_customized": false + * } + * }, + * { + * "id": 43, + * "name": "Able Brewing", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/able-brewing/", + * "is_customized": false + * } + * }, + * { + * "id": 44, + * "name": "Chemex", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/chemex/", + * "is_customized": false + * } + * }, + * { + * "id": 45, + * "name": "Kinfolk", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/kinfolk/", + * "is_customized": false + * } + * }, + * { + * "id": 46, + * "name": "Iris Hantverk", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/iris-hantverk/", + * "is_customized": false + * } + * }, + * { + * "id": 47, + * "name": "Gather Journal", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/gather-journal/", + * "is_customized": false + * } + * }, + * { + * "id": 48, + * "name": "Openhouse Magazine", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/openhouse-magazine/", + * "is_customized": false + * } + * }, + * { + * "id": 49, + * "name": "Smith Journal", + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "description", + * "image_url": "", + * "search_keywords": "", + * "custom_url": { + * "url": "/smith-journal/", + * "is_customized": false + * } + * } + * ], + * "meta": { + * "pagination": { + * "total": 15, + * "count": 15, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["brand_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1094,6 +1343,25 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 50, + * "name": "Common Good", + * "meta_keywords": [ + * "modern", + * "clean", + * "contemporary" + * ], + * "meta_description": "Common Good is a modern brand", + * "image_url": "", + * "search_keywords": "kitchen, laundry, cart, storage", + * "custom_url": { + * "url": "/brands/Common-Good.html", + * "is_customized": false + * } + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Brand @@ -1269,6 +1537,25 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 50, + * "name": "Common Good", + * "meta_keywords": [ + * "modern", + * "clean", + * "contemporary" + * ], + * "meta_description": "Common Good is a modern brand", + * "image_url": "", + * "search_keywords": "kitchen, laundry, cart, storage", + * "custom_url": { + * "url": "/brands/Common-Good.html", + * "is_customized": false + * } + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["brand_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1388,6 +1675,25 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 50, + * "name": "Common Good", + * "meta_keywords": [ + * "modern", + * "clean", + * "contemporary" + * ], + * "meta_description": "Common Good is a modern brand", + * "image_url": "", + * "search_keywords": "kitchen, laundry, cart, storage", + * "custom_url": { + * "url": "/brands/Common-Good.html", + * "is_customized": false + * } + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Brand @@ -1595,6 +1901,48 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 6, + * "key": "Location", + * "value": "4HG", + * "namespace": "Warehouse Locations", + * "permission_set": "app_only", + * "resource_type": "brand", + * "resource_id": 111, + * "description": "Location in the warehouse", + * "date_created": "1973-01-20T21:34:57.903Z", + * "date_modified": "1990-12-30T00:29:23.515Z", + * "owner_client_id": "e8o0nm9ujew7byzu6x5dwjqe2rya2fv" + * }, + * { + * "id": 7, + * "key": "Brand location", + * "value": "4HG", + * "namespace": "Warehouse Locations", + * "permission_set": "read", + * "resource_type": "brand", + * "resource_id": 111, + * "description": "Location in the warehouse", + * "date_created": "1973-01-20T21:34:57.903Z", + * "date_modified": "1990-12-30T00:29:23.515Z", + * "owner_client_id": "e8o0nm9ujew7byzu6x5dwjqe2rya2fv" + * } + * ], + * "meta": { + * "pagination": { + * "total": 2, + * "count": 2, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["metafield_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1646,6 +1994,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1731,6 +2085,22 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "product", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00", + * "owner_client_id": "e8o0nm9ujew7byzu6x5dwjqe2rya2fv" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1787,6 +2157,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "product", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1799,6 +2184,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1900,6 +2291,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/product_images/k/group_1545334669__76009.png" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: { readonly image_url?: string; @@ -2079,6 +2476,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "errors": {} + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2145,6 +2548,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2198,6 +2607,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/catalog/categories_catalog.v3.ts b/src/internal/reference/generated/catalog/categories_catalog.v3.ts index 2beaff8..e6c3af3 100644 --- a/src/internal/reference/generated/catalog/categories_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/categories_catalog.v3.ts @@ -1244,6 +1244,154 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 19, + * "parent_id": 0, + * "name": "Garden", + * "description": "

This is the garden description

", + * "views": 0, + * "sort_order": 2, + * "page_title": "page title", + * "meta_keywords": [ + * "meta keyword" + * ], + * "meta_description": "meta description", + * "layout_file": "category.html", + * "image_url": "", + * "is_visible": true, + * "search_keywords": "search keywords", + * "default_product_sort": "use_store_settings", + * "custom_url": { + * "url": "/garden/", + * "is_customized": false + * } + * }, + * { + * "id": 20, + * "parent_id": 0, + * "name": "Publications", + * "description": "", + * "views": 0, + * "sort_order": 4, + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "layout_file": "category_with_facets.html", + * "image_url": "", + * "is_visible": true, + * "search_keywords": "", + * "default_product_sort": "use_store_settings", + * "custom_url": { + * "url": "/publications/", + * "is_customized": false + * } + * }, + * { + * "id": 21, + * "parent_id": 0, + * "name": "Kitchen", + * "description": "", + * "views": 0, + * "sort_order": 3, + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "layout_file": "category_with_facets.html", + * "image_url": "", + * "is_visible": true, + * "search_keywords": "", + * "default_product_sort": "use_store_settings", + * "custom_url": { + * "url": "/kitchen/", + * "is_customized": false + * } + * }, + * { + * "id": 22, + * "parent_id": 0, + * "name": "Utility", + * "description": "", + * "views": 0, + * "sort_order": 5, + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "layout_file": "category_with_facets.html", + * "image_url": "", + * "is_visible": true, + * "search_keywords": "", + * "default_product_sort": "use_store_settings", + * "custom_url": { + * "url": "/utility/", + * "is_customized": false + * } + * }, + * { + * "id": 23, + * "parent_id": 0, + * "name": "Shop All", + * "description": "", + * "views": 0, + * "sort_order": 0, + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "layout_file": "category_with_facets.html", + * "image_url": "", + * "is_visible": true, + * "search_keywords": "", + * "default_product_sort": "use_store_settings", + * "custom_url": { + * "url": "/shop-all/", + * "is_customized": false + * } + * }, + * { + * "id": 39, + * "parent_id": 19, + * "name": "Bath", + * "description": "", + * "views": 0, + * "sort_order": 0, + * "page_title": "", + * "meta_keywords": [ + * "" + * ], + * "meta_description": "", + * "layout_file": "category.html", + * "image_url": "", + * "is_visible": true, + * "search_keywords": "", + * "default_product_sort": "use_store_settings", + * "custom_url": { + * "url": "/garden/bath/", + * "is_customized": false + * } + * } + * ], + * "meta": { + * "pagination": { + * "total": 6, + * "count": 6, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["Category"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1869,6 +2017,46 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 6, + * "key": "Location", + * "value": "4HG", + * "namespace": "Warehouse Locations", + * "permission_set": "app_only", + * "resource_type": "category", + * "resource_id": 111, + * "description": "Location in the warehouse", + * "date_created": "1973-01-20T21:34:57.903Z", + * "date_modified": "1990-12-30T00:29:23.515Z" + * }, + * { + * "id": 7, + * "key": "Location", + * "value": "4HG", + * "namespace": "Warehouse Locations", + * "permission_set": "read", + * "resource_type": "category", + * "resource_id": 111, + * "description": "Location in the warehouse", + * "date_created": "1973-01-20T21:34:57.903Z", + * "date_modified": "1990-12-30T00:29:23.515Z" + * } + * ], + * "meta": { + * "pagination": { + * "total": 2, + * "count": 2, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["metafield_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1904,6 +2092,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "category", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1916,6 +2119,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2001,6 +2210,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "category", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2056,6 +2280,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "category", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2068,6 +2307,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2169,6 +2414,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/product_images/k/group_1545334669__76009.png" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: { readonly image_url?: string; @@ -2477,6 +2728,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2538,6 +2795,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2591,6 +2854,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts b/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts index dfcedd3..aeb60db 100644 --- a/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts @@ -101,6 +101,9 @@ export interface paths { /** * Get a category tree * @description Returns a category tree. + * + * **Note:** + * The default rate limit for this endpoint is 1 concurrent request. */ readonly get: operations["getCategoryTree"]; }; @@ -767,6 +770,30 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 0, + * "name": "string", + * "channels": [ + * 0 + * ] + * } + * ], + * "meta": { + * "pagination": { + * "total": 246, + * "count": 5, + * "per_page": 5, + * "current_page": 1, + * "total_pages": 50, + * "links": { + * "next": "?limit=5&page=2", + * "current": "?limit=5&page=1" + * } + * } + * } + * } */ readonly "application/json": components["schemas"]["CategoryTreeList"]; }; }; @@ -799,6 +826,18 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 0, + * "name": "string", + * "channels": [ + * 0 + * ] + * } + * ], + * "meta": {} + * } */ readonly "application/json": components["schemas"]["CategoryTree"]; }; }; @@ -810,6 +849,17 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 0, + * "title": "string", + * "type": "string", + * "instance": "string", + * "errors": { + * "additionalProp1": "string", + * "additionalProp2": "string", + * "additionalProp3": "string" + * } + * } */ readonly "application/json": components["schemas"]["beta4ErrorResponse"]; }; }; @@ -866,6 +916,29 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 0, + * "parent_id": 0, + * "depth": 0, + * "path": [ + * 0 + * ], + * "name": "string", + * "is_visible": true, + * "children": [ + * "string" + * ], + * "url": "/bath/" + * } + * ], + * "meta": { + * "type": "object", + * "properties": {}, + * "description": "Empty meta object; reserved for use later." + * } + * } */ readonly "application/json": components["schemas"]["CategoryNodeTree"]; }; }; @@ -877,6 +950,17 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 0, + * "title": "string", + * "type": "string", + * "instance": "string", + * "errors": { + * "additionalProp1": "string", + * "additionalProp2": "string", + * "additionalProp3": "string" + * } + * } */ readonly "application/json": components["schemas"]["beta4ErrorResponse"]; }; }; diff --git a/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts b/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts index 0e94aab..3658b46 100644 --- a/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts @@ -611,6 +611,74 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 206, + * "product_id": 158, + * "name": "Insurance", + * "display_name": "Insurance", + * "type": "checkbox", + * "required": true, + * "config": { + * "checkbox_label": "$5 for insurance", + * "checked_by_default": false + * }, + * "option_values": [ + * { + * "id": 183, + * "option_id": 206, + * "label": "Yes", + * "sort_order": 0, + * "value_data": { + * "checked_value": true + * }, + * "is_default": false, + * "adjusters": { + * "price": {}, + * "weight": {}, + * "image_url": "", + * "purchasing_disabled": { + * "status": false, + * "message": "" + * } + * } + * }, + * { + * "id": 184, + * "option_id": 206, + * "label": "No", + * "sort_order": 1, + * "value_data": { + * "checked_value": false + * }, + * "is_default": true, + * "adjusters": { + * "price": {}, + * "weight": {}, + * "image_url": "", + * "purchasing_disabled": { + * "status": false, + * "message": "" + * } + * } + * } + * ] + * } + * ], + * "meta": { + * "pagination": { + * "total": 1, + * "count": 1, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["productModifier_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -694,6 +762,67 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 164, + * "product_id": 161, + * "name": "Test-name1716906851-161", + * "display_name": "Test name", + * "type": "radio_buttons", + * "required": true, + * "sort_order": 0, + * "config": [], + * "option_values": [ + * { + * "id": 199, + * "option_id": 164, + * "label": "+5", + * "sort_order": 0, + * "value_data": null, + * "is_default": false, + * "adjusters": { + * "price": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "weight": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "image_url": "", + * "purchasing_disabled": { + * "status": true, + * "message": "string" + * } + * } + * }, + * { + * "id": 200, + * "option_id": 164, + * "label": "+10", + * "sort_order": 0, + * "value_data": null, + * "is_default": false, + * "adjusters": { + * "price": { + * "adjuster": "relative", + * "adjuster_value": 10 + * }, + * "weight": { + * "adjuster": "relative", + * "adjuster_value": 10 + * }, + * "image_url": "", + * "purchasing_disabled": { + * "status": true, + * "message": "string" + * } + * } + * } + * ] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: { readonly items?: components["schemas"]["productModifier_Full"]; @@ -1361,6 +1490,63 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 190, + * "option_id": 222, + * "label": "Yes", + * "sort_order": 0, + * "value_data": { + * "checked_value": true + * }, + * "is_default": false, + * "adjusters": { + * "price": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "weight": {}, + * "image_url": "", + * "purchasing_disabled": { + * "status": false, + * "message": "" + * } + * } + * }, + * { + * "id": 191, + * "option_id": 222, + * "label": "No", + * "sort_order": 1, + * "value_data": { + * "checked_value": false + * }, + * "is_default": true, + * "adjusters": { + * "price": {}, + * "weight": {}, + * "image_url": "", + * "purchasing_disabled": { + * "status": false, + * "message": "" + * } + * } + * } + * ], + * "meta": { + * "pagination": { + * "total": 2, + * "count": 2, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["productModifierOptionValue_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1474,6 +1660,29 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 190, + * "option_id": 222, + * "label": "Yes", + * "sort_order": 0, + * "value_data": {}, + * "is_default": false, + * "adjusters": { + * "price": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "weight": {}, + * "image_url": "", + * "purchasing_disabled": { + * "status": false, + * "message": "" + * } + * } + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Modifier Value @@ -1620,6 +1829,29 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 190, + * "option_id": 222, + * "label": "Yes", + * "sort_order": 0, + * "value_data": {}, + * "is_default": false, + * "adjusters": { + * "price": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "weight": {}, + * "image_url": "", + * "purchasing_disabled": { + * "status": false, + * "message": "" + * } + * } + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["productModifierOptionValue_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1758,6 +1990,29 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 190, + * "option_id": 222, + * "label": "Yes", + * "sort_order": 0, + * "value_data": {}, + * "is_default": false, + * "adjusters": { + * "price": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "weight": {}, + * "image_url": "", + * "purchasing_disabled": { + * "status": false, + * "message": "" + * } + * } + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Modifier Value @@ -1936,6 +2191,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "image_url": "https://cdn8.bigcommerce.com/s-id30h7ohwf/product_images/attribute_rule_images/85_source_1536863430.png" + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Resource Image diff --git a/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts b/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts index 097ad5b..ee3b3e2 100644 --- a/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts @@ -1286,6 +1286,64 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 220, + * "product_id": 192, + * "name": "Color (Colors only)", + * "display_name": "Color", + * "type": "swatch", + * "sort_order": 0, + * "option_values": [ + * { + * "id": 174, + * "label": "Beige", + * "sort_order": 1, + * "value_data": { + * "colors": [ + * "#FAFAEB" + * ] + * }, + * "is_default": false + * }, + * { + * "id": 175, + * "label": "Grey", + * "sort_order": 2, + * "value_data": { + * "colors": [ + * "#BDBDBD" + * ] + * }, + * "is_default": false + * }, + * { + * "id": 176, + * "label": "Black", + * "sort_order": 3, + * "value_data": { + * "colors": [ + * "#000000" + * ] + * }, + * "is_default": false + * }, + * { + * "id": 189, + * "label": "Black-Walnut", + * "sort_order": 4, + * "value_data": { + * "colors": [ + * "#e80ee8" + * ] + * }, + * "is_default": false + * } + * ], + * "config": {} + * }, + * "meta": {} + * } */ readonly "application/json": { /** Option */ readonly data?: { @@ -1595,6 +1653,66 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 174, + * "label": "Beige", + * "sort_order": 1, + * "value_data": { + * "colors": [ + * "#FAFAEB" + * ] + * }, + * "is_default": false + * }, + * { + * "id": 175, + * "label": "Grey", + * "sort_order": 2, + * "value_data": { + * "colors": [ + * "#BDBDBD" + * ] + * }, + * "is_default": false + * }, + * { + * "id": 176, + * "label": "Black", + * "sort_order": 3, + * "value_data": { + * "colors": [ + * "#000000" + * ] + * }, + * "is_default": false + * }, + * { + * "id": 189, + * "label": "Black-Walnut", + * "sort_order": 4, + * "value_data": { + * "colors": [ + * "#e80ee8" + * ] + * }, + * "is_default": false + * } + * ], + * "meta": { + * "pagination": { + * "total": 4, + * "count": 4, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly ({ /** @@ -1681,6 +1799,19 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 44, + * "label": "Pick a color", + * "sort_order": 9, + * "value_data": { + * "colors": [ + * "#123c91, #FFFF00, #397a44" + * ] + * }, + * "is_default": false + * } + * } */ readonly "application/json": { /** Option Value */ readonly data?: { @@ -1771,6 +1902,19 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 44, + * "label": "Pick a color", + * "sort_order": 9, + * "value_data": { + * "colors": [ + * "#123c91, #FFFF00, #397a44" + * ] + * }, + * "is_default": false + * } + * } */ readonly "application/json": { /** Option Value */ readonly data?: { @@ -1885,6 +2029,19 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 44, + * "label": "Pick a color", + * "sort_order": 9, + * "value_data": { + * "colors": [ + * "#123c91, #FFFF00, #397a44" + * ] + * }, + * "is_default": false + * } + * } */ readonly "application/json": { /** Option Value */ readonly data?: { diff --git a/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts b/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts index 6cf01fd..a7ca047 100644 --- a/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts @@ -1168,6 +1168,130 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 382, + * "product_id": 192, + * "sku": "SMIT", + * "sku_id": 348, + * "price": 10, + * "calculated_price": 10, + * "sale_price": 8, + * "retail_price": 10, + * "map_price": {}, + * "weight": 4, + * "calculated_weight": 2, + * "width": 5, + * "height": 5, + * "depth": 5, + * "is_free_shipping": false, + * "fixed_cost_shipping_price": 10, + * "purchasing_disabled": false, + * "purchasing_disabled_message": "", + * "image_url": "", + * "cost_price": 0, + * "upc": "", + * "mpn": "", + * "gtin": "", + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "bin_picking_number": "", + * "option_values": [ + * { + * "id": 174, + * "label": "Beige", + * "option_id": 220, + * "option_display_name": "Color" + * } + * ] + * }, + * { + * "id": 383, + * "product_id": 192, + * "sku": "SMIT-1", + * "sku_id": 349, + * "price": 25, + * "calculated_price": 25, + * "sale_price": 20, + * "retail_price": 25, + * "map_price": {}, + * "weight": 2, + * "calculated_weight": 1, + * "width": 5, + * "height": 5, + * "depth": 5, + * "is_free_shipping": false, + * "fixed_cost_shipping_price": 10, + * "purchasing_disabled": false, + * "purchasing_disabled_message": "", + * "image_url": "", + * "cost_price": 25, + * "upc": "", + * "mpn": "", + * "gtin": "", + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "bin_picking_number": "", + * "option_values": [ + * { + * "id": 175, + * "label": "Grey", + * "option_id": 220, + * "option_display_name": "Color" + * } + * ] + * }, + * { + * "id": 384, + * "product_id": 192, + * "sku": "SMIT-2", + * "sku_id": 350, + * "price": 25, + * "calculated_price": 25, + * "sale_price": 20, + * "retail_price": 25, + * "map_price": {}, + * "weight": 2, + * "calculated_weight": 1, + * "width": 5, + * "height": 5, + * "depth": 5, + * "is_free_shipping": false, + * "fixed_cost_shipping_price": 10, + * "purchasing_disabled": false, + * "purchasing_disabled_message": "", + * "image_url": "", + * "cost_price": 25, + * "upc": "", + * "mpn": "", + * "gtin": "", + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "bin_picking_number": "", + * "option_values": [ + * { + * "id": 176, + * "label": "Black", + * "option_id": 220, + * "option_display_name": "Color" + * } + * ] + * } + * ], + * "meta": { + * "pagination": { + * "total": 3, + * "count": 3, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["productVariant_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1287,6 +1411,45 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 384, + * "product_id": 192, + * "sku": "SMIT-2", + * "sku_id": 350, + * "price": 25, + * "calculated_price": 25, + * "sale_price": 20, + * "retail_price": 25, + * "map_price": {}, + * "weight": 2, + * "calculated_weight": 1, + * "width": 5, + * "height": 5, + * "depth": 5, + * "is_free_shipping": false, + * "fixed_cost_shipping_price": 10, + * "purchasing_disabled": false, + * "purchasing_disabled_message": "", + * "image_url": "", + * "cost_price": 25, + * "upc": "", + * "mpn": "", + * "gtin": "", + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "bin_picking_number": "", + * "option_values": [ + * { + * "id": 176, + * "label": "Black", + * "option_id": 220, + * "option_display_name": "Color" + * } + * ] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["productVariant_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1343,6 +1506,37 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "bin_picking_number": "0", + * "calculated_price": 85, + * "calculated_weight": 1, + * "cost_price": 0, + * "depth": 22, + * "fixed_cost_shipping_price": 0, + * "gtin": "", + * "height": 14.6, + * "id": 65, + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "is_free_shipping": false, + * "map_price": 0, + * "mpn": "TR-SML02", + * "option_values": [], + * "price": 89, + * "product_id": 81, + * "purchasing_disabled": true, + * "purchasing_disabled_message": "This item is not available.", + * "retail_price": 89, + * "sale_price": 85, + * "sku": "OTS", + * "sku_id": 10, + * "upc": "", + * "weight": 1, + * "width": 2 + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["productVariant_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1484,6 +1678,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "variant", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1496,6 +1705,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1584,6 +1799,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 8, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "Inventory Namespace", + * "permission_set": "read", + * "resource_type": "variant", + * "resource_id": 158, + * "description": "Where products are located", + * "date_created": "2018-09-13T16:42:37+00:00", + * "date_modified": "2018-09-13T16:42:37+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1643,6 +1873,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 8, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "Inventory Namespace", + * "permission_set": "read", + * "resource_type": "variant", + * "resource_id": 158, + * "description": "Where products are located", + * "date_created": "2018-09-13T16:42:37+00:00", + * "date_modified": "2018-09-13T16:42:37+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1655,6 +1900,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1769,6 +2020,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "image_url": "https://cdn8.bigcommerce.com/s-id30h7ohwf/product_images/attribute_rule_images/85_source_1536863430.png" + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Resource Image @@ -2303,6 +2560,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "errors": {}, + * "status": 413, + * "title": "The request payload is too large. The maximum items allowed in the array is 50", + * "type": "/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": unknown; }; }; @@ -2431,6 +2694,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2492,6 +2761,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2545,6 +2820,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/catalog/products_catalog.v3.ts b/src/internal/reference/generated/catalog/products_catalog.v3.ts index 0411859..0202f4a 100644 --- a/src/internal/reference/generated/catalog/products_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/products_catalog.v3.ts @@ -4037,6 +4037,113 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 0, + * "name": "Smith Journal 13", + * "type": "physical", + * "sku": "SM-13", + * "description": "

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.

", + * "weight": 0, + * "width": 0, + * "depth": 0, + * "height": 0, + * "price": 0, + * "cost_price": 0, + * "retail_price": 0, + * "sale_price": 0, + * "map_price": 0, + * "tax_class_id": 0, + * "product_tax_code": "string", + * "categories": [ + * 0 + * ], + * "brand_id": 37, + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "inventory_tracking": "none", + * "fixed_cost_shipping_price": 0, + * "is_free_shipping": true, + * "is_visible": true, + * "is_featured": true, + * "related_products": [ + * 0 + * ], + * "warranty": "string", + * "bin_picking_number": "string", + * "layout_file": "string", + * "upc": "string", + * "search_keywords": "string", + * "availability": "available", + * "availability_description": "string", + * "gift_wrapping_options_type": "any", + * "gift_wrapping_options_list": [ + * 0 + * ], + * "sort_order": -2147483648, + * "condition": "New", + * "is_condition_shown": true, + * "order_quantity_minimum": 0, + * "order_quantity_maximum": 0, + * "page_title": "string", + * "meta_keywords": [ + * "string" + * ], + * "meta_description": "string", + * "view_count": 0, + * "preorder_release_date": "2019-08-24T14:15:22Z", + * "preorder_message": "string", + * "is_preorder_only": true, + * "is_price_hidden": true, + * "price_hidden_label": "string", + * "custom_url": { + * "url": "string", + * "is_customized": true + * }, + * "open_graph_type": "product", + * "open_graph_title": "string", + * "open_graph_description": "string", + * "open_graph_use_meta_description": true, + * "open_graph_use_product_name": true, + * "open_graph_use_image": true, + * "gtin": "string", + * "mpn": "string", + * "date_last_imported": "2015-07-03T18:16:02+00:00", + * "reviews_rating_sum": 3, + * "reviews_count": 4, + * "total_sold": 80, + * "custom_fields": [ + * { + * "id": 6, + * "name": "ISBN", + * "value": "1234567890123" + * } + * ], + * "bulk_pricing_rules": [ + * { + * "id": 0, + * "quantity_min": 10, + * "quantity_max": 50, + * "type": "price", + * "amount": 10 + * } + * ], + * "images": [ + * { + * "image_file": "string", + * "is_thumbnail": true, + * "sort_order": -2147483648, + * "description": "string", + * "image_url": "string", + * "id": 0, + * "product_id": 0, + * "url_zoom": "string", + * "url_standard": "string", + * "url_thumbnail": "string", + * "url_tiny": "string", + * "date_modified": "2019-08-24T14:15:22Z" + * } + * ] + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["product_Full"][]; readonly meta?: unknown; @@ -4094,6 +4201,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "errors": {}, + * "status": 413, + * "title": "The request payload is too large. The maximum items allowed in the array is 10.", + * "type": "/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": components["schemas"]["error_Base"]; }; }; @@ -4134,6 +4247,113 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 0, + * "name": "Smith Journal 13", + * "type": "physical", + * "sku": "SM-13", + * "description": "

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.

", + * "weight": 0, + * "width": 0, + * "depth": 0, + * "height": 0, + * "price": 0, + * "cost_price": 0, + * "retail_price": 0, + * "sale_price": 0, + * "map_price": 0, + * "tax_class_id": 0, + * "product_tax_code": "string", + * "categories": [ + * 0 + * ], + * "brand_id": 37, + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "inventory_tracking": "none", + * "fixed_cost_shipping_price": 0, + * "is_free_shipping": true, + * "is_visible": true, + * "is_featured": true, + * "related_products": [ + * 0 + * ], + * "warranty": "string", + * "bin_picking_number": "string", + * "layout_file": "string", + * "upc": "string", + * "search_keywords": "string", + * "availability": "available", + * "availability_description": "string", + * "gift_wrapping_options_type": "any", + * "gift_wrapping_options_list": [ + * 0 + * ], + * "sort_order": -2147483648, + * "condition": "New", + * "is_condition_shown": true, + * "order_quantity_minimum": 0, + * "order_quantity_maximum": 0, + * "page_title": "string", + * "meta_keywords": [ + * "string" + * ], + * "meta_description": "string", + * "view_count": 0, + * "preorder_release_date": "2019-08-24T14:15:22Z", + * "preorder_message": "string", + * "is_preorder_only": true, + * "is_price_hidden": true, + * "price_hidden_label": "string", + * "custom_url": { + * "url": "string", + * "is_customized": true + * }, + * "open_graph_type": "product", + * "open_graph_title": "string", + * "open_graph_description": "string", + * "open_graph_use_meta_description": true, + * "open_graph_use_product_name": true, + * "open_graph_use_image": true, + * "gtin": "string", + * "mpn": "string", + * "date_last_imported": "2015-07-03T18:16:02+00:00", + * "reviews_rating_sum": 3, + * "reviews_count": 4, + * "total_sold": 80, + * "custom_fields": [ + * { + * "id": 6, + * "name": "ISBN", + * "value": "1234567890123" + * } + * ], + * "bulk_pricing_rules": [ + * { + * "id": 0, + * "quantity_min": 10, + * "quantity_max": 50, + * "type": "price", + * "amount": 10 + * } + * ], + * "images": [ + * { + * "image_file": "string", + * "is_thumbnail": true, + * "sort_order": -2147483648, + * "description": "string", + * "image_url": "string", + * "id": 0, + * "product_id": 0, + * "url_zoom": "string", + * "url_standard": "string", + * "url_thumbnail": "string", + * "url_tiny": "string", + * "date_modified": "2019-08-24T14:15:22Z" + * } + * ] + * } */ readonly "application/json": { readonly data?: components["schemas"]["product_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -4305,6 +4525,86 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 174, + * "name": "1L Le Parfait Jar", + * "type": "physical", + * "sku": "", + * "description": "

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.

", + * "weight": 1, + * "width": 0, + * "depth": 0, + * "height": 0, + * "price": 7.95, + * "cost_price": 0, + * "retail_price": 10, + * "sale_price": 0, + * "map_price": 0, + * "tax_class_id": 0, + * "product_tax_code": "", + * "calculated_price": 7.95, + * "categories": [ + * 23, + * 21 + * ], + * "brand_id": 36, + * "option_set_id": 55, + * "option_set_display": "right", + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "inventory_tracking": "none", + * "reviews_rating_sum": 0, + * "reviews_count": 0, + * "total_sold": 7, + * "fixed_cost_shipping_price": 0, + * "is_free_shipping": false, + * "is_visible": true, + * "is_featured": false, + * "related_products": [ + * -1 + * ], + * "warranty": "", + * "bin_picking_number": "", + * "layout_file": "product.html", + * "upc": "", + * "mpn": "", + * "gtin": "", + * "search_keywords": "jar, glass", + * "availability": "available", + * "availability_description": "", + * "gift_wrapping_options_type": "any", + * "gift_wrapping_options_list": [], + * "sort_order": 0, + * "condition": "New", + * "is_condition_shown": false, + * "order_quantity_minimum": 0, + * "order_quantity_maximum": 0, + * "page_title": "", + * "meta_keywords": [], + * "meta_description": "", + * "date_created": "2018-08-15T14:48:46+00:00", + * "date_modified": "2018-09-05T20:42:07+00:00", + * "view_count": 10, + * "preorder_release_date": "2018-09-05T20:42:07+00:00", + * "preorder_message": "", + * "is_preorder_only": false, + * "is_price_hidden": false, + * "price_hidden_label": "", + * "custom_url": { + * "url": "/all/1l-le-parfait-jar/", + * "is_customized": true + * }, + * "base_variant_id": 345, + * "open_graph_type": "product", + * "open_graph_title": "", + * "open_graph_description": "", + * "open_graph_use_meta_description": true, + * "open_graph_use_product_name": true, + * "open_graph_use_image": true + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["product_Full"] & { /** @description The channels to which the product is assigned. This field only appears in the response if you include `channels` in the `include` query parameter. */ @@ -4368,6 +4668,280 @@ export interface operations { readonly data?: components["schemas"]["product_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; + /** @example { + * "name": "Smith Journal 13", + * "type": "physical", + * "sku": "SM-13", + * "description": "

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.

", + * "weight": 0, + * "width": 0, + * "depth": 0, + * "height": 0, + * "price": 0, + * "cost_price": 0, + * "retail_price": 0, + * "sale_price": 0, + * "map_price": 0, + * "tax_class_id": 0, + * "product_tax_code": "string", + * "categories": [ + * 0 + * ], + * "brand_id": 0, + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "inventory_tracking": "none", + * "fixed_cost_shipping_price": 0, + * "is_free_shipping": true, + * "is_visible": true, + * "is_featured": true, + * "related_products": [ + * 0 + * ], + * "warranty": "string", + * "bin_picking_number": "string", + * "layout_file": "string", + * "upc": "string", + * "search_keywords": "string", + * "availability": "available", + * "availability_description": "string", + * "gift_wrapping_options_type": "any", + * "gift_wrapping_options_list": [ + * 0 + * ], + * "sort_order": -2147483648, + * "condition": "New", + * "is_condition_shown": true, + * "order_quantity_minimum": 0, + * "order_quantity_maximum": 0, + * "page_title": "string", + * "meta_keywords": [ + * "string" + * ], + * "meta_description": "string", + * "view_count": 0, + * "preorder_release_date": "2019-08-24T14:15:22+00:00", + * "preorder_message": "string", + * "is_preorder_only": true, + * "is_price_hidden": true, + * "price_hidden_label": "string", + * "custom_url": { + * "url": "string", + * "is_customized": true + * }, + * "open_graph_type": "product", + * "open_graph_title": "string", + * "open_graph_description": "string", + * "open_graph_use_meta_description": true, + * "open_graph_use_product_name": true, + * "open_graph_use_image": true, + * "brand_name": "Common Good", + * "gtin": "string", + * "mpn": "string", + * "reviews_rating_sum": 3.2, + * "reviews_count": 4, + * "total_sold": 80, + * "custom_fields": [ + * { + * "id": 6, + * "name": "ISBN", + * "value": "1234567890123" + * } + * ], + * "bulk_pricing_rules": [ + * { + * "id": 0, + * "quantity_min": 10, + * "quantity_max": 50, + * "type": "price", + * "amount": 10 + * } + * ], + * "images": [ + * { + * "image_file": "string", + * "is_thumbnail": true, + * "sort_order": -2147483648, + * "description": "string", + * "image_url": "string", + * "id": 0, + * "product_id": 0, + * "url_zoom": "string", + * "url_standard": "string", + * "url_thumbnail": "string", + * "url_tiny": "string", + * "date_modified": "2019-08-24T14:15:22+00:00" + * } + * ], + * "videos": [ + * { + * "title": "string", + * "description": "string", + * "sort_order": -2147483648, + * "type": "youtube", + * "video_id": "string", + * "id": 0, + * "product_id": 0, + * "length": "string" + * } + * ], + * "date_created": "2018-08-15T14:49:05+00:00", + * "date_modified": "2018-08-24T14:41:00+00:00", + * "id": 1, + * "base_variant_id": 0, + * "calculated_price": 0, + * "options": [ + * { + * "id": 55, + * "product_id": 4, + * "display_name": "Add-a-$5-Donation1535042499-187", + * "type": "radio_buttons", + * "config": { + * "default_value": "string", + * "checked_by_default": true, + * "checkbox_label": "string", + * "date_limited": true, + * "date_limit_mode": "range", + * "date_earliest_value": "2019-08-24T00:00:00+00:00", + * "date_latest_value": "2019-08-24T00:00:00+00:00", + * "file_types_mode": "specific", + * "file_types_supported": [ + * "images, documents, other" + * ], + * "file_types_other": [ + * "pdf" + * ], + * "file_max_size": 5, + * "text_characters_limited": true, + * "text_min_length": 1, + * "text_max_length": 55, + * "text_lines_limited": true, + * "text_max_lines": 4, + * "number_limited": true, + * "number_limit_mode": "lowest", + * "number_lowest_value": 100, + * "number_highest_value": 0, + * "number_integers_only": false, + * "product_list_adjusts_inventory": true, + * "product_list_adjusts_pricing": true, + * "product_list_shipping_calc": "weight" + * }, + * "sort_order": 1, + * "option_values": { + * "is_default": false, + * "label": "Green", + * "sort_order": 0, + * "value_data": {}, + * "id": 0 + * } + * } + * ], + * "modifiers": [ + * { + * "type": "date", + * "required": true, + * "sort_order": 0, + * "config": { + * "default_value": "string", + * "checked_by_default": true, + * "checkbox_label": "string", + * "date_limited": true, + * "date_limit_mode": "range", + * "date_earliest_value": "2019-08-24T00:00:00+00:00", + * "date_latest_value": "2019-08-24T00:00:00+00:00", + * "file_types_mode": "specific", + * "file_types_supported": [ + * "images, documents, other" + * ], + * "file_types_other": [ + * "pdf" + * ], + * "file_max_size": 5, + * "text_characters_limited": true, + * "text_min_length": 1, + * "text_max_length": 55, + * "text_lines_limited": true, + * "text_max_lines": 4, + * "number_limited": true, + * "number_limit_mode": "lowest", + * "number_lowest_value": 100, + * "number_highest_value": 0, + * "number_integers_only": false, + * "product_list_adjusts_inventory": true, + * "product_list_adjusts_pricing": true, + * "product_list_shipping_calc": "weight" + * }, + * "display_name": "string", + * "id": 12, + * "product_id": 77, + * "name": "Add-a-$5-Donation1535039590-191", + * "option_values": [ + * { + * "is_default": false, + * "label": "Green", + * "sort_order": 0, + * "value_data": {}, + * "adjusters": { + * "price": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "weight": { + * "adjuster": "relative", + * "adjuster_value": 5 + * }, + * "image_url": "https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2", + * "purchasing_disabled": { + * "status": true, + * "message": "string" + * } + * }, + * "id": 0, + * "option_id": 0 + * } + * ] + * } + * ], + * "option_set_id": 0, + * "option_set_display": "string", + * "variants": [ + * { + * "cost_price": 0, + * "price": 0, + * "sale_price": 0, + * "retail_price": 0, + * "weight": 0, + * "width": 0, + * "height": 0, + * "depth": 0, + * "is_free_shipping": true, + * "fixed_cost_shipping_price": 0, + * "purchasing_disabled": true, + * "purchasing_disabled_message": "string", + * "upc": "string", + * "inventory_level": 0, + * "inventory_warning_level": 0, + * "bin_picking_number": "string", + * "mpn": "string", + * "gtin": 12345678905, + * "id": 0, + * "product_id": 0, + * "sku": "string", + * "sku_id": 0, + * "option_values": [ + * { + * "option_display_name": "Color", + * "label": "Beige", + * "id": 146, + * "option_id": 151 + * } + * ], + * "calculated_price": 0, + * "calculated_weight": 0 + * } + * ], + * "meta": {} + * } */ readonly "example-1": unknown; }; }; @@ -4512,6 +5086,48 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 382, + * "product_id": 158, + * "is_thumbnail": true, + * "sort_order": 0, + * "description": "", + * "image_file": "a/521/foglinenbeigestripetowel1b_1024x1024__83011__60806.jpg", + * "url_zoom": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.1280.1280.jpg?c=2", + * "url_standard": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.560.850.jpg?c=2", + * "url_thumbnail": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "url_tiny": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.66.100.jpg?c=2", + * "date_modified": "2018-08-15T14:48:31+00:00" + * }, + * { + * "id": 383, + * "product_id": 158, + * "is_thumbnail": false, + * "sort_order": 0, + * "description": "", + * "image_file": "k/050/foglinenbeigestripetowel2b_1024x1024__16082__46564.jpg", + * "url_zoom": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/383/foglinenbeigestripetowel2b_1024x1024__16082__46564.1534344511.1280.1280.jpg?c=2", + * "url_standard": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/383/foglinenbeigestripetowel2b_1024x1024__16082__46564.1534344511.560.850.jpg?c=2", + * "url_thumbnail": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/383/foglinenbeigestripetowel2b_1024x1024__16082__46564.1534344511.330.500.jpg?c=2", + * "url_tiny": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/383/foglinenbeigestripetowel2b_1024x1024__16082__46564.1534344511.66.100.jpg?c=2", + * "date_modified": "2018-08-15T14:48:31+00:00" + * } + * ], + * "meta": { + * "pagination": { + * "total": 2, + * "count": 2, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["productImage_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -4715,6 +5331,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 422, + * "title": "image_url must be present if uploading by url", + * "type": "/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": { readonly status: number; readonly title: string; @@ -4753,6 +5374,22 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 485, + * "product_id": 158, + * "is_thumbnail": false, + * "sort_order": 1, + * "description": "", + * "image_file": "o/381/product-image__98178.png", + * "url_zoom": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/485/product-image__98178.1536854227.1280.1280.png?c=2", + * "url_standard": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/485/product-image__98178.1536854227.560.850.png?c=2", + * "url_thumbnail": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/485/product-image__98178.1536854227.330.500.png?c=2", + * "url_tiny": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/485/product-image__98178.1536854227.66.100.png?c=2", + * "date_modified": "2018-09-13T15:57:07+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["productImage_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -5015,6 +5652,52 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 6, + * "type": "youtube", + * "video_id": "PqBTp23RLhI", + * "product_id": 192, + * "sort_order": 1, + * "title": "Creating and Editing Banners | BigCommerce Tutorials", + * "description": "Learn how to create and edit marketing banners. Marketing banners are a great way to advertise sales, display coupon codes, and add design elements. Let’s take a look at how you can leverage banners to convert your store’s visitors into paying customers.", + * "length": "01:54" + * }, + * { + * "id": 7, + * "type": "youtube", + * "video_id": "EhYBjzqd-nI", + * "product_id": 192, + * "sort_order": 2, + * "title": "BigCommerce Company Values", + * "description": "These are the core principles upon which BigCommerce was built, guiding what we do and how we do it. Each employee learns them, loves them and lives them. Our merchants benefit from them every time they use our product or get help from our support team.\n\nJoin the BigCommerce team and help us build software that changes lives!\n\nhttps://www.bigcommerce.com/careers/", + * "length": "03:30" + * }, + * { + * "id": 8, + * "type": "youtube", + * "video_id": "vAUdo4kRjrU", + * "product_id": 192, + * "sort_order": 3, + * "title": "TOP WORKPLACES 2016 - Austin American Statesman + BigCommerce", + * "description": "We've been named one of Austin American-Statesmanʼs Top WorkPlaces for the 5th year in a row! Hereʼs what some employees have to say:\n\n“I am given the freedom and trust to make a difference.”\n\n“Everyone believes in the product and growing the company.”\n\n“I'm appreciated for the work I do and there is room to grown within the company.”\n\nWork With Us!\nhttp://www.bigcommerce.com/careers.php", + * "length": "01:37" + * } + * ], + * "meta": { + * "pagination": { + * "total": 3, + * "count": 3, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["productVideo_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -5082,6 +5765,13 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "title": "Your Video", + * "description": "Company Values", + * "sort_order": 1, + * "type": "youtube", + * "video_id": "123345AA" + * } */ readonly "application/json": { /** * Product Video @@ -5170,6 +5860,13 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "title": "Your Video", + * "description": "Company Values", + * "sort_order": 1, + * "type": "youtube", + * "video_id": "123345AA" + * } */ readonly "application/json": { readonly data?: components["schemas"]["productVideo_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -5245,6 +5942,13 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "title": "Your Video", + * "description": "Company Values", + * "sort_order": 1, + * "type": "youtube", + * "video_id": "123345AA" + * } */ readonly "application/json": { /** * Product Video @@ -5363,6 +6067,72 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 82, + * "product_id": 195, + * "sort_order": 0, + * "enabled": true, + * "stop": false, + * "price_adjuster": { + * "adjuster": "relative", + * "adjuster_value": 8 + * }, + * "weight_adjuster": {}, + * "purchasing_disabled": false, + * "purchasing_disabled_message": "", + * "purchasing_hidden": false, + * "image_url": "", + * "conditions": [ + * { + * "rule_id": 82, + * "modifier_id": 221, + * "modifier_value_id": 175, + * "variant_id": 1, + * "combination_id": 0 + * } + * ] + * }, + * { + * "id": 83, + * "product_id": 195, + * "sort_order": 1, + * "enabled": true, + * "stop": false, + * "price_adjuster": {}, + * "weight_adjuster": { + * "adjuster": "relative", + * "adjuster_value": 3 + * }, + * "purchasing_disabled": false, + * "purchasing_disabled_message": "", + * "purchasing_hidden": false, + * "image_url": "", + * "conditions": [ + * { + * "rule_id": 83, + * "modifier_id": 221, + * "modifier_value_id": 174, + * "variant_id": 1, + * "combination_id": 0 + * } + * ] + * } + * ], + * "meta": { + * "pagination": { + * "total": 2, + * "count": 2, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["complexRule_Base"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -6313,6 +7083,27 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 83, + * "quantity_min": 1, + * "quantity_max": 3, + * "type": "price", + * "amount": 1 + * }, + * "meta": { + * "pagination": { + * "total": 2, + * "count": 2, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -6351,6 +7142,16 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 83, + * "quantity_min": 1, + * "quantity_max": 3, + * "type": "price", + * "amount": 1 + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -6391,6 +7192,16 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 83, + * "quantity_min": 1, + * "quantity_max": 3, + * "type": "price", + * "amount": 1 + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -6453,6 +7264,16 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 83, + * "quantity_min": 1, + * "quantity_max": 3, + * "type": "price", + * "amount": 1 + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -6609,6 +7430,46 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 6, + * "key": "Location", + * "value": "4HG", + * "namespace": "Warehouse Locations", + * "permission_set": "app_only", + * "resource_type": "product", + * "resource_id": 111, + * "description": "Location in the warehouse", + * "date_created": "1973-01-20T21:34:57.903Z", + * "date_modified": "1990-12-30T00:29:23.515Z" + * }, + * { + * "id": 7, + * "key": "Sublocation", + * "value": "4HG", + * "namespace": "Warehouse Locations", + * "permission_set": "read", + * "resource_type": "product", + * "resource_id": 111, + * "description": "Location in the warehouse", + * "date_created": "1973-01-20T21:34:57.903Z", + * "date_modified": "1990-12-30T00:29:23.515Z" + * } + * ], + * "meta": { + * "pagination": { + * "total": 2, + * "count": 2, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1, + * "links": { + * "current": "?page=1&limit=50" + * } + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["metafield_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -6644,6 +7505,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 8, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "Inventory Namespace", + * "permission_set": "read", + * "resource_type": "product", + * "resource_id": 158, + * "description": "Where products are located", + * "date_created": "2018-09-13T16:42:37+00:00", + * "date_modified": "2018-09-13T16:42:37+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -6656,6 +7532,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -6739,6 +7621,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "product", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -6795,6 +7692,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "key": "location_id", + * "value": "Shelf 3, Bin 5", + * "namespace": "App Namespace", + * "permission_set": "app_only", + * "resource_type": "product", + * "resource_id": 137, + * "description": "Where products are located", + * "date_created": "2021-08-06T19:15:35+00:00", + * "date_modified": "2021-08-06T19:15:35+00:00" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -6807,6 +7719,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -7050,6 +7968,22 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "title": "irur", + * "text": "anim aute", + * "status": "Lorem ad sed voluptate", + * "rating": 3, + * "email": "esse Lorem laborum aute", + * "name": "ut in ", + * "date_reviewed": "2011-12-31T13:40:42.971Z", + * "id": 82495037, + * "product_id": 22609026, + * "date_created": "1985-01-17T07:37:20.439Z", + * "date_modified": "2004-09-28T14:38:21.973Z" + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Product Review @@ -7148,6 +8082,22 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "title": "irur", + * "text": "anim aute", + * "status": "Lorem ad sed voluptate", + * "rating": 3, + * "email": "esse Lorem laborum aute", + * "name": "ut in ", + * "date_reviewed": "2011-12-31T13:40:42.971Z", + * "id": 82495037, + * "product_id": 22609026, + * "date_created": "1985-01-17T07:37:20.439Z", + * "date_modified": "2004-09-28T14:38:21.973Z" + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Product Review @@ -7271,6 +8221,22 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "title": "irur", + * "text": "anim aute", + * "status": "Lorem ad sed voluptate", + * "rating": 3, + * "email": "esse Lorem laborum aute", + * "name": "ut in ", + * "date_reviewed": "2011-12-31T13:40:42.971Z", + * "id": 82495037, + * "product_id": 22609026, + * "date_created": "1985-01-17T07:37:20.439Z", + * "date_modified": "2004-09-28T14:38:21.973Z" + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Product Review @@ -7753,6 +8719,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -7809,6 +8781,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -7859,6 +8837,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/channels.v3.ts b/src/internal/reference/generated/channels.v3.ts index d522c6d..0e7aaeb 100644 --- a/src/internal/reference/generated/channels.v3.ts +++ b/src/internal/reference/generated/channels.v3.ts @@ -2541,6 +2541,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2629,6 +2635,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2762,6 +2774,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2811,6 +2829,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2860,6 +2884,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/checkouts.sf.ts b/src/internal/reference/generated/checkouts.sf.ts index e347e8a..674f064 100644 --- a/src/internal/reference/generated/checkouts.sf.ts +++ b/src/internal/reference/generated/checkouts.sf.ts @@ -1210,6 +1210,11 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 409, + * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1301,6 +1306,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1349,6 +1759,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1385,6 +2200,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1415,6 +2635,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1446,6 +3071,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1494,6 +3524,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1553,6 +3988,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1600,6 +4440,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1632,6 +4877,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1664,6 +5314,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1738,6 +5793,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1770,6 +6230,411 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "billingAddress": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "id": "5ba11e4a10fb5", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "cart": { + * "baseAmount": 119.93, + * "cartAmount": 112.93, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "coupons": [ + * { + * "id": 1, + * "code": "S2549JM0Y", + * "displayName": "$5.00 off the order total", + * "couponType": "per_total_discount", + * "discountedAmount": 5 + * } + * ], + * "currency": { + * "name": "US Dollars", + * "code": "USD", + * "symbol": "$", + * "decimalPlaces": 2 + * }, + * "customerId": 11, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.59 + * }, + * { + * "id": 2, + * "discountedAmount": 1.06 + * }, + * { + * "id": 3, + * "discountedAmount": 2.12 + * }, + * { + * "id": 4, + * "discountedAmount": 0.8 + * }, + * { + * "id": 5, + * "discountedAmount": 0.43 + * } + * ], + * "email": "janedoe@example.com", + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isTaxIncluded": false, + * "lineItems": { + * "physicalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 2, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.59 + * }, + * { + * "id": 2, + * "discountedAmount": 2 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 15.99, + * "extendedSalePrice": 13.99, + * "giftWrapping": {}, + * "id": "69791a88-85c9-4c19-8042-e537621e8a55", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 15.99, + * "name": "Canvas Laundry Cart", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 17.99, + * "productId": 184, + * "parentId": "", + * "quantity": 1, + * "variantId": 364, + * "salePrice": 13.99, + * "sku": "SMA-RED", + * "url": "https://{store_domain}/all/canvas-laundry-cart/" + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "extendedComparisonPrice": 0, + * "extendedListPrice": 25, + * "extendedSalePrice": 25, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 1.06 + * } + * ], + * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 25, + * "name": "Ceramic Measuring Spoons", + * "originalPrice": 25, + * "parentId": "", + * "productId": 170, + * "quantity": 1, + * "salePrice": 25, + * "sku": "", + * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", + * "variantId": 341, + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "giftWrapping": {} + * }, + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 2.12 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 49.99, + * "extendedSalePrice": 49.99, + * "giftWrapping": {}, + * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", + * "isShippingRequired": true, + * "isTaxable": true, + * "listPrice": 49.99, + * "name": "Chambray Towel", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 49.99, + * "parentId": "", + * "productId": 158, + * "salePrice": 49.99, + * "sku": "SKU-A0C8A203", + * "quantity": 1, + * "url": "https://{store_domain}/all/chambray-towel/", + * "variantId": 376 + * } + * ], + * "digitalItems": [ + * { + * "addedByPromotion": false, + * "brand": "OFS", + * "categoryNames": [ + * "Essentials", + * "Just arrived" + * ], + * "comparisonPrice": 0, + * "couponAmount": 0, + * "discountAmount": 0, + * "discounts": [ + * { + * "id": 1, + * "discountedAmount": 0.8 + * } + * ], + * "extendedComparisonPrice": 0, + * "extendedListPrice": 18.95, + * "extendedSalePrice": 18.95, + * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", + * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", + * "isShippingRequired": false, + * "isTaxable": true, + * "listPrice": 18.95, + * "name": "Gather Journal Issue 7 - Digital", + * "options": [ + * { + * "name": "Color", + * "nameId": 1, + * "value": "Red", + * "valueId": "2" + * } + * ], + * "originalPrice": 18.95, + * "parentId": "", + * "productId": 189, + * "quantity": 1, + * "salePrice": 18.95, + * "type": "digital", + * "variantId": 360, + * "url": "https://{store_domain}/all/gather-journal-issue-7/" + * } + * ], + * "giftCertificates": [ + * { + * "amount": 10, + * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", + * "message": "Thank you!", + * "name": "$10.00 Gift Certificate", + * "recipient": { + * "name": "John Doe", + * "email": "johndoe@example.com" + * }, + * "sender": { + * "name": "Jane Doe", + * "email": "janedoe@example.com" + * }, + * "taxable": false, + * "theme": "Celebration", + * "type": "giftCertificate" + * } + * ], + * "customItems": [] + * }, + * "locale": "en", + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * }, + * "channelId": 1, + * "createdTime": "2018-09-18T15:48:26+00:00", + * "consignments": [ + * { + * "address": { + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "company": "", + * "country": "United States", + * "countryCode": "US", + * "customFields": [ + * { + * "fieldId": "field_25", + * "fieldValue": "Leave in backyard" + * } + * ], + * "email": "janedoe@example.com", + * "firstName": "Jane", + * "lastName": "Doe", + * "phone": "1234567890", + * "postalCode": "78751", + * "stateOrProvince": "Texas", + * "stateOrProvinceCode": "TX" + * }, + * "availableShippingOptions": [ + * { + * "additionalDescription": "Fragile items", + * "cost": 8, + * "description": "Ship by Weight", + * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", + * "imageUrl": "", + * "transitTime": "", + * "type": "shipping_byweight" + * } + * ], + * "couponDiscounts": [], + * "discounts": [], + * "handlingCost": 0, + * "id": "5ba121929619b", + * "lineItemIds": [ + * "69791a88-85c9-4c19-8042-e537621e8a55", + * "ba2c619d-e6b4-48c2-8809-d88e424ed450", + * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" + * ], + * "selectedShippingOption": { + * "additionalDescription": "Fragile items", + * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "imageUrl": "", + * "cost": 69.94, + * "transitTime": "1 business day" + * }, + * "shippingCost": 69.94 + * } + * ], + * "coupons": [ + * { + * "code": "S2549JM0Y", + * "couponType": 2, + * "discountedAmount": 5, + * "displayName": "$5.00 off the order total", + * "id": 1 + * } + * ], + * "fees": [ + * { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "type": "custom_fee", + * "name": "AAINS", + * "displayName": "Package Protection Insurance", + * "cost": 12.02, + * "source": "AA", + * "taxClassId": 12 + * } + * ], + * "customer": { + * "addresses": [ + * {} + * ], + * "customerGroup": { + * "id": 1, + * "name": "Wholesale customers" + * }, + * "email": "string", + * "firstName": "string", + * "fullName": "string", + * "id": 1, + * "isGuest": false, + * "lastName": "string", + * "shouldEncourageSignIn": false, + * "storeCredit": 1 + * }, + * "customerMessage": "Thank you, BigCommerce", + * "giftCertificates": [ + * { + * "balance": 4, + * "code": "1234ABC", + * "purchaseDate": "string", + * "remaining": 2, + * "used": 5 + * } + * ], + * "giftWrappingCostTotal": 0, + * "grandTotal": 211.49, + * "handlingCostTotal": 0, + * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", + * "isStoreCreditApplied": false, + * "orderId": null, + * "outstandingBalance": 0, + * "payments": [ + * {} + * ], + * "promotions": [], + * "shippingCostBeforeDiscount": 69.94, + * "shippingCostTotal": 69.94, + * "shouldExecuteSpamCheck": false, + * "subtotal": 117.93, + * "taxTotal": 28.62, + * "taxes": [ + * { + * "name": "Store Tax", + * "amount": 28.62 + * } + * ], + * "updatedTime": "2018-09-18T16:59:45+00:00", + * "version": 1 + * } + * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; diff --git a/src/internal/reference/generated/checkouts.v3.ts b/src/internal/reference/generated/checkouts.v3.ts index 35566c6..f880fc7 100644 --- a/src/internal/reference/generated/checkouts.v3.ts +++ b/src/internal/reference/generated/checkouts.v3.ts @@ -1122,11 +1122,950 @@ export interface components { readonly "application/json": { readonly data?: components["schemas"]["Checkout"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1136,6 +2075,11 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 409, + * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1148,10 +2092,27 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "custom_checkout_script_url": "https://example.com/custom-checkout-script.js", + * "order_confirmation_use_custom_checkout_script": false, + * "custom_order_confirmation_script_url": "https://example.com/custom-order-confirmation-script.js", + * "custom_checkout_supports_uco_settings": false + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["CheckoutsSettings"]; readonly meta?: Record; }; + /** @example { + * "data": { + * "custom_checkout_script_url": "webdav:vtz-checkout/dist/auto-loader.js", + * "order_confirmation_use_custom_checkout_script": false, + * "custom_order_confirmation_script_url": "webdav:vtz-order-confirmation/dist/auto-loader.js" + * }, + * "meta": {} + * } */ readonly "WebDAV protocol": unknown; }; }; @@ -1160,6 +2121,12 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 75 + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["Order"]; readonly meta?: Record; @@ -1222,11 +2189,950 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1280,11 +3186,955 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1348,15 +4198,1053 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "tax_included": false, + * "base_amount": 31.95, + * "discount_amount": 0, + * "manual_discount_amount": 10, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 13.6 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [ + * { + * "id": 18, + * "discounted_amount": 13.6 + * }, + * { + * "id": 49, + * "discounted_amount": 2.4 + * }, + * { + * "id": "manual-discount", + * "discounted_amount": 10 + * } + * ], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "comparison_price": 33.23, + * "extended_comparison_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {}, + * "is_mutable": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [], + * "order_id": null, + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "", + * "staff_note": " ", + * "fees": [] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1393,11 +5281,955 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1435,11 +6267,955 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "version": 1 + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1479,11 +7255,950 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1524,11 +8239,950 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1564,11 +9218,950 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "20% Off", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1604,11 +10197,950 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; + /** @example { + * "data": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "cart": { + * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + * "customer_id": 0, + * "email": "string@example.com", + * "currency": { + * "code": "string" + * }, + * "base_amount": 0, + * "channel_id": 0, + * "discount_amount": 0, + * "cart_amount_inc_tax": 0, + * "cart_amount_ex_tax": 0, + * "coupons": [ + * { + * "code": "string", + * "id": 0, + * "coupon_type": "string", + * "display_name": "string", + * "discounted_amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0, + * "is_require_shipping": true, + * "is_mutable": true, + * "parent_id": 0, + * "gift_wrapping": { + * "name": "string", + * "message": "string", + * "amount": 0, + * "amount_as_integer": 0 + * } + * } + * ], + * "digital_items": [ + * { + * "quantity": 0, + * "id": "string", + * "variant_id": 0, + * "parent_id": 0, + * "product_id": 0, + * "sku": "string", + * "name": "string", + * "url": "string", + * "is_mutable": true, + * "is_require_shipping": true, + * "is_taxable": true, + * "image_url": "string", + * "discounts": [ + * { + * "id": "string", + * "discounted_amount": 0 + * } + * ], + * "coupons": 0, + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 0, + * "list_price": 0, + * "sale_price": 0, + * "extended_list_price": 0, + * "extended_sale_price": 0 + * } + * ], + * "gift_certificates": [ + * { + * "theme": "string", + * "amount": 0, + * "sender": { + * "name": "string", + * "email": "string" + * }, + * "recipient": { + * "name": "string", + * "email": "string" + * }, + * "id": "string", + * "name": "string", + * "taxable": true, + * "message": "string" + * } + * ], + * "custom_items": [ + * { + * "quantity": 0, + * "id": "string", + * "extended_list_price": 0, + * "list_price": 0, + * "sku": "string", + * "name": "string", + * "image_url": "string" + * } + * ] + * }, + * "created_time": "string", + * "updated_time": "string" + * }, + * "billing_address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12128565555", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "consignments": [ + * { + * "id": "string", + * "shippingAddress": {}, + * "address": { + * "first_name": "string", + * "last_name": "string", + * "email": "string", + * "company": "string", + * "address1": "string", + * "address2": "string", + * "city": "string", + * "state_or_province": "string", + * "state_or_province_code": "string", + * "country_code": "string", + * "postal_code": "string", + * "phone": "12125556858", + * "custom_fields": [ + * { + * "field_id": "string", + * "field_value": "string" + * } + * ], + * "id": "string" + * }, + * "available_shipping_options": [ + * { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * } + * ], + * "selected_shipping_option": { + * "description": "string", + * "id": "string", + * "type": "string", + * "image_url": "string", + * "cost": 0, + * "transit_time": "string", + * "additional_description": "string" + * }, + * "coupon_discounts": [ + * { + * "code": "string", + * "amount": 0 + * } + * ], + * "discounts": [ + * { + * "id": 0 + * } + * ], + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "line_item_ids": [ + * "string" + * ] + * } + * ], + * "taxes": [ + * { + * "name": "string", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "code": "SHOPNOW", + * "id": 1, + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "order_id": "string", + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 0, + * "subtotal_ex_tax": 0, + * "grand_total": 0, + * "created_time": "string", + * "updated_time": "string", + * "customer_message": "string", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ], + * "version": 1 + * } + * } */ readonly "example-1": unknown; }; }; @@ -1645,10 +11177,680 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 0.9 + * } + * ], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true, + * "gift_wrapping": {} + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125685555", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 0, + * "shipping_cost_ex_tax": 0, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * }, + * "available_shipping_options": [ + * { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "722d78b5120de60a725e41be9bb8d999", + * "type": "shipping_flatrate", + * "description": "Flat Rate", + * "image_url": "", + * "cost": 12, + * "transit_time": "", + * "additional_description": "" + * }, + * { + * "id": "71090fa93c8985348892543c3f4887b6", + * "type": "shipping_upsready", + * "description": "UPS® (UPS Next Day Air®)", + * "image_url": "", + * "cost": 43.9, + * "transit_time": "1 business day", + * "additional_description": "" + * } + * ] + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.28 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.28, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 33.23, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Available Shipping Options": unknown; + /** @example { + * "data": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "cart": { + * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", + * "customer_id": 11, + * "channel_id": 1, + * "email": "janedoe@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 31.95, + * "discount_amount": 0, + * "cart_amount_inc_tax": 33.23, + * "cart_amount_ex_tax": 31.95, + * "coupons": [], + * "discounts": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "8edef915-8e8e-4ebd-bece-31fbb1191a7e", + * "parent_id": 123, + * "variant_id": 359, + * "product_id": 188, + * "sku": "DUST1", + * "name": "Hello", + * "url": "https://{store_hash}/all/dustpan-brush/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/products/188/images/460/dustpan1_1024x1024_1024x1024__43447__69128.1534344539.330.500.jpg?c=2", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35.95, + * "list_price": 31.95, + * "sale_price": 33.23, + * "extended_list_price": 31.95, + * "extended_sale_price": 33.23, + * "is_require_shipping": true + * } + * ], + * "digital_items": [], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00" + * }, + * "billing_address": { + * "id": "5d484d668e5aa", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "janedoe@example.com", + * "company": "BigCommerce", + * "address1": "123 Main Street", + * "address2": "Apt 1", + * "city": "Austin", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "", + * "phone": "12125559659", + * "custom_fields": [] + * }, + * "consignments": [ + * { + * "id": "5d484e28d20a8", + * "shipping_cost_inc_tax": 8.32, + * "shipping_cost_ex_tax": 8, + * "handling_cost_inc_tax": 0, + * "handling_cost_ex_tax": 0, + * "coupon_discounts": [], + * "discounts": [], + * "line_item_ids": [ + * "8edef915-8e8e-4ebd-bece-31fbb1191a7e" + * ], + * "selected_shipping_option": { + * "id": "006a58a98c9a844225552ee2a9c60ca8", + * "type": "shipping_byweight", + * "description": "Ship by Weight", + * "image_url": "", + * "cost": 8, + * "transit_time": "", + * "additional_description": "" + * }, + * "address": { + * "first_name": "BigCommerce", + * "last_name": "Cart/Checkout", + * "email": "jane2@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "Austin", + * "state_or_province": "Texas", + * "state_or_province_code": "TX", + * "country": "United States", + * "country_code": "US", + * "postal_code": "78751", + * "phone": "688546", + * "customFields": [ + * { + * "field_id": "field_25", + * "field_value": "Great!" + * } + * ] + * } + * } + * ], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 1.6 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 8.32, + * "shipping_cost_total_ex_tax": 8, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 1.6, + * "subtotal_inc_tax": 33.23, + * "subtotal_ex_tax": 31.95, + * "grand_total": 41.55, + * "created_time": "2019-08-05T15:38:14+00:00", + * "updated_time": "2019-08-05T15:41:28+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Selected Shipping Options": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 25, + * "channel_id": 1, + * "email": "customer@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 53.6, + * "cart_amount_ex_tax": 53.6, + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 7 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 6.4 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 6.4 + * } + * ], + * "coupons": 6.4, + * "discount_amount": 0, + * "coupon_amount": 6.4, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [ + * { + * "id": "coupon", + * "discounted_amount": 7 + * } + * ], + * "coupons": 7, + * "discount_amount": 0, + * "coupon_amount": 7, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00" + * }, + * "billing_address": { + * "id": "618a9ce18173e", + * "first_name": "Jane", + * "last_name": "Doe", + * "email": "customer@example.com", + * "company": "", + * "address1": "123 Main Street", + * "address2": "", + * "city": "", + * "state_or_province": "", + * "state_or_province_code": "", + * "country": "", + * "country_code": "", + * "postal_code": "29681", + * "phone": "12125556895", + * "custom_fields": [] + * }, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [ + * { + * "id": 1, + * "code": "SHOP20", + * "coupon_type": "percentage_discount", + * "display_name": "20% Off", + * "discounted_amount": 13.4 + * } + * ], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 53.6, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:08:01+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "" + * }, + * "meta": {} + * } */ readonly "No Coupon Applied": unknown; + /** @example { + * "data": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "cart": { + * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", + * "customer_id": 0, + * "channel_id": 1, + * "email": "example@example.com", + * "currency": { + * "code": "USD" + * }, + * "base_amount": 67, + * "discount_amount": 0, + * "cart_amount_inc_tax": 67, + * "cart_amount_ex_tax": 67, + * "coupons": [], + * "discounts": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "discounted_amount": 0 + * }, + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "discounted_amount": 0 + * } + * ], + * "line_items": { + * "physical_items": [ + * { + * "id": "b0adf3a7-7a92-44d9-ad46-87235b118e48", + * "variant_id": 528, + * "product_id": 145, + * "sku": "htltwl-001", + * "name": "Hotel Towel", + * "url": "https://example.com/hotel-towel/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/145/images/422/Marriott-towel-set-MAR-320-01-SET-BT-WH_xlrg__70357.1636473771.220.290.jpg?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 32, + * "list_price": 32, + * "sale_price": 32, + * "extended_list_price": 32, + * "extended_sale_price": 32, + * "is_require_shipping": true, + * "is_mutable": true + * } + * ], + * "digital_items": [ + * { + * "id": "985c79a3-4c94-4104-923a-2e3d4572e72d", + * "variant_id": 182, + * "product_id": 138, + * "sku": "ebk-001", + * "name": "eBook Download", + * "url": "https://example.com/digital/", + * "quantity": 1, + * "is_taxable": true, + * "image_url": "https://cdn11.bigcommerce.com/s-29iql3rwa6/products/138/images/420/thebridgebetween__54934.1636473557.220.290.png?c=1", + * "discounts": [], + * "coupons": [], + * "discount_amount": 0, + * "coupon_amount": 0, + * "original_price": 35, + * "list_price": 35, + * "sale_price": 35, + * "extended_list_price": 35, + * "extended_sale_price": 35, + * "is_require_shipping": false, + * "is_mutable": true + * } + * ], + * "gift_certificates": [], + * "custom_items": [] + * }, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00" + * }, + * "billing_address": {}, + * "consignments": [], + * "taxes": [ + * { + * "name": "Tax", + * "amount": 0 + * } + * ], + * "coupons": [], + * "shipping_cost_total_inc_tax": 0, + * "shipping_cost_total_ex_tax": 0, + * "handling_cost_total_inc_tax": 0, + * "handling_cost_total_ex_tax": 0, + * "tax_total": 0, + * "subtotal_inc_tax": 67, + * "subtotal_ex_tax": 67, + * "grand_total": 67, + * "created_time": "2021-11-08T22:46:23+00:00", + * "updated_time": "2021-11-09T16:06:56+00:00", + * "customer_message": "", + * "promotions": [ + * { + * "banners": [ + * { + * "id": "3", + * "type": "applied", + * "page": [ + * "homepage", + * "cartpage" + * ], + * "text": "Some text" + * } + * ] + * } + * ] + * }, + * "meta": {} + * } */ readonly "Include promotions": unknown; }; }; @@ -1775,6 +11977,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 75 + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["Order"]; readonly meta?: components["schemas"]["MetaOpen"]; @@ -1800,10 +12008,29 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "custom_checkout_script_url": "https://example.com/custom-checkout-script.js", + * "order_confirmation_use_custom_checkout_script": false, + * "custom_order_confirmation_script_url": "https://example.com/custom-order-confirmation-script.js", + * "custom_checkout_supports_uco_settings": false, + * "custom_checkout_sri_hash": "sha256-1234567890", + * "order_confirmation_sri_hash": "sha256-0987654321" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["CheckoutsSettings"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "custom_checkout_script_url": "webdav:vtz-checkout/dist/auto-loader.js", + * "order_confirmation_use_custom_checkout_script": false, + * "custom_order_confirmation_script_url": "webdav:vtz-order-confirmation/dist/auto-loader.js" + * }, + * "meta": {} + * } */ readonly "WebDAV protocol": unknown; }; }; @@ -1832,10 +12059,29 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "custom_checkout_script_url": "https://example.com/custom-checkout-script.js", + * "order_confirmation_use_custom_checkout_script": false, + * "custom_order_confirmation_script_url": "https://example.com/custom-order-confirmation-script.js", + * "custom_checkout_supports_uco_settings": false, + * "custom_checkout_sri_hash": "sha256-1234567890", + * "order_confirmation_sri_hash": "sha256-0987654321" + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["CheckoutsSettings"]; readonly meta?: components["schemas"]["MetaOpen"]; }; + /** @example { + * "data": { + * "custom_checkout_script_url": "webdav:vtz-checkout/dist/auto-loader.js", + * "order_confirmation_use_custom_checkout_script": false, + * "custom_order_confirmation_script_url": "webdav:vtz-order-confirmation/dist/auto-loader.js" + * }, + * "meta": {} + * } */ readonly "WebDAV protocol": unknown; }; }; diff --git a/src/internal/reference/generated/customers.v2.ts b/src/internal/reference/generated/customers.v2.ts index 8e6ce8c..eb7f1fa 100644 --- a/src/internal/reference/generated/customers.v2.ts +++ b/src/internal/reference/generated/customers.v2.ts @@ -1215,6 +1215,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": components["schemas"]["count_Full"]; }; }; @@ -1249,6 +1252,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "success": false + * } */ readonly "application/json": components["schemas"]["validatePassword"]; }; }; @@ -1526,6 +1532,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": components["schemas"]["count_Full"]; }; }; @@ -1767,6 +1776,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": components["schemas"]["count_Full"]; }; }; diff --git a/src/internal/reference/generated/customers.v3.ts b/src/internal/reference/generated/customers.v3.ts index 678a69a..02ca953 100644 --- a/src/internal/reference/generated/customers.v3.ts +++ b/src/internal/reference/generated/customers.v3.ts @@ -3139,6 +3139,10 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "code": 401, + * "message": "Unauthorized" + * } */ readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; @@ -3148,6 +3152,10 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "code": 403, + * "message": "Missing scope" + * } */ readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; @@ -3210,6 +3218,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3319,6 +3333,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3457,6 +3477,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3512,6 +3538,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3557,6 +3589,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/geography.v2.ts b/src/internal/reference/generated/geography.v2.ts index c61b65b..35cc6e8 100644 --- a/src/internal/reference/generated/geography.v2.ts +++ b/src/internal/reference/generated/geography.v2.ts @@ -223,6 +223,28 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 1, + * "country": "Afghanistan", + * "country_iso2": "AF", + * "country_iso3": "AFG", + * "states": { + * "url": "https://api.bigcommerce.com/stores/store_hash/v2/countries/1/states", + * "resource": "/countries/1/states" + * } + * }, + * { + * "id": 2, + * "country": "Albania", + * "country_iso2": "AL", + * "country_iso3": "ALB", + * "states": { + * "url": "https://api.bigcommerce.com/stores/store_hash/v2/countries/2/states", + * "resource": "/countries/2/states" + * } + * } + * ] */ readonly "application/json": readonly components["schemas"]["country_Full"][]; }; }; diff --git a/src/internal/reference/generated/locations.v3.ts b/src/internal/reference/generated/locations.v3.ts index c36208f..dc4235b 100644 --- a/src/internal/reference/generated/locations.v3.ts +++ b/src/internal/reference/generated/locations.v3.ts @@ -1296,6 +1296,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1416,6 +1422,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1575,6 +1587,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1631,6 +1649,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/marketing.v2.ts b/src/internal/reference/generated/marketing.v2.ts index 3ffb833..8b0a299 100644 --- a/src/internal/reference/generated/marketing.v2.ts +++ b/src/internal/reference/generated/marketing.v2.ts @@ -678,6 +678,34 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 1, + * "name": "This is a banner", + * "content": "

This is a banner

", + * "page": "home_page", + * "item_id": "0", + * "location": "top", + * "date_created": "1522169082", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * }, + * { + * "id": 2, + * "name": "Banner #2", + * "content": "

Banner # 2

", + * "page": "category_page", + * "item_id": "23", + * "location": "top", + * "date_created": "1522169169", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * } + * ] */ readonly "application/json": readonly components["schemas"]["banner_Full"][]; }; }; @@ -686,6 +714,19 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "name": "Sale Banner", + * "content": "

Sale! Tuesday at 9am!

", + * "page": "home_page", + * "item_id": "0", + * "location": "top", + * "date_created": "1522169082", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * } */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -694,6 +735,9 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": { readonly count?: number; }; @@ -704,6 +748,28 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "name": "$5 off", + * "type": "per_total_discount", + * "amount": "5.0000", + * "min_purchase": "0.0000", + * "expires": "", + * "enabled": true, + * "code": "S2549JM0Y", + * "applies_to": { + * "entity": "categories", + * "ids": [ + * 0 + * ] + * }, + * "num_uses": 2, + * "max_uses": 0, + * "max_uses_per_customer": 0, + * "restricted_to": {}, + * "shipping_methods": [], + * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" + * } */ readonly "application/json": components["schemas"]["coupon_Full"]; }; }; @@ -712,6 +778,56 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 1, + * "name": "$5 off", + * "type": "per_total_discount", + * "amount": "5.0000", + * "min_purchase": "0.0000", + * "expires": "", + * "enabled": true, + * "code": "S2549JM0Y", + * "applies_to": { + * "entity": "categories", + * "ids": [ + * 0 + * ] + * }, + * "num_uses": 2, + * "max_uses": 0, + * "max_uses_per_customer": 0, + * "restricted_to": {}, + * "shipping_methods": [], + * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" + * }, + * { + * "id": 2, + * "name": "Limit by Location", + * "type": "per_total_discount", + * "amount": "5.0000", + * "min_purchase": "25.0000", + * "expires": "", + * "enabled": true, + * "code": "E3JC79S0I", + * "applies_to": { + * "entity": "categories", + * "ids": [ + * 0 + * ] + * }, + * "num_uses": 0, + * "max_uses": 25, + * "max_uses_per_customer": 0, + * "restricted_to": { + * "countries": "AU" + * }, + * "shipping_methods": [ + * "shipping_endicia" + * ], + * "date_created": "Tue, 12 Jun 2018 20:22:19 +0000" + * } + * ] */ readonly "application/json": readonly components["schemas"]["coupon_Full"][]; }; }; @@ -720,6 +836,59 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 24, + * "code": "10R-5E2-BO4-RWT", + * "amount": "1000.0000", + * "status": "active", + * "balance": "500.0000", + * "to_name": "Alyss", + * "order_id": 1281, + * "template": "girl.html", + * "to_email": "test@test.com", + * "from_name": "Noland", + * "from_email": "test1@test.com", + * "customer_id": 5, + * "expiry_date": "1694738", + * "purchase_date": "1603306", + * "currency_code": "USD" + * }, + * { + * "id": 25, + * "code": "10R-6E3-AO4-RST", + * "amount": "700.0000", + * "status": "active", + * "balance": "700.0000", + * "to_name": "Alyss", + * "order_id": 0, + * "template": "boy.html", + * "to_email": "test@test.com", + * "from_name": "Noland", + * "from_email": "test1@test.com", + * "customer_id": 0, + * "expiry_date": "1694738", + * "purchase_date": "1603306", + * "currency_code": "USD" + * }, + * { + * "id": 27, + * "code": "15R-6E3-AO4-RST", + * "amount": "50.0000", + * "status": "active", + * "balance": "50.0000", + * "to_name": "Lyss", + * "order_id": 0, + * "template": "christmas.html", + * "to_email": "test5@test.com", + * "from_name": "Somethingelse", + * "from_email": "test15@test.com", + * "customer_id": 0, + * "expiry_date": "1694738", + * "purchase_date": "1603306", + * "currency_code": "USD" + * } + * ] */ readonly "application/json": readonly components["schemas"]["giftCertificate_Full"][]; }; }; @@ -728,6 +897,24 @@ export interface components { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "customer_id": 5, + * "order_id": 116, + * "code": "FFZ-5N4-C7M-S78", + * "to_name": "John Doe", + * "to_email": "johndoe@example.com", + * "from_name": "Jane Doe", + * "from_email": "janedoe@example.com", + * "amount": "10", + * "balance": "0", + * "status": "active", + * "template": "birthday.html", + * "message": "Happy Birthday!", + * "purchase_date": "1603306", + * "expiry_date": "1694738", + * "currency_code": "USD" + * } */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; @@ -780,6 +967,56 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 1, + * "name": "$5 off", + * "type": "per_total_discount", + * "amount": "5.0000", + * "min_purchase": "0.0000", + * "expires": "", + * "enabled": true, + * "code": "S2549JM0Y", + * "applies_to": { + * "entity": "categories", + * "ids": [ + * 0 + * ] + * }, + * "num_uses": 2, + * "max_uses": 0, + * "max_uses_per_customer": 0, + * "restricted_to": {}, + * "shipping_methods": [], + * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" + * }, + * { + * "id": 2, + * "name": "Limit by Location", + * "type": "per_total_discount", + * "amount": "5.0000", + * "min_purchase": "25.0000", + * "expires": "", + * "enabled": true, + * "code": "E3JC79S0I", + * "applies_to": { + * "entity": "categories", + * "ids": [ + * 0 + * ] + * }, + * "num_uses": 0, + * "max_uses": 25, + * "max_uses_per_customer": 0, + * "restricted_to": { + * "countries": "AU" + * }, + * "shipping_methods": [ + * "shipping_endicia" + * ], + * "date_created": "Tue, 12 Jun 2018 20:22:19 +0000" + * } + * ] */ readonly "application/json": readonly components["schemas"]["coupon_Full"][]; }; }; @@ -808,6 +1045,28 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "name": "$5 off", + * "type": "per_total_discount", + * "amount": "5.0000", + * "min_purchase": "0.0000", + * "expires": "", + * "enabled": true, + * "code": "S2549JM0Y", + * "applies_to": { + * "entity": "categories", + * "ids": [ + * 0 + * ] + * }, + * "num_uses": 2, + * "max_uses": 0, + * "max_uses_per_customer": 0, + * "restricted_to": {}, + * "shipping_methods": [], + * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" + * } */ readonly "application/json": components["schemas"]["coupon_Full"]; }; }; @@ -853,6 +1112,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": { readonly count?: number; }; @@ -886,6 +1148,28 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "name": "$5 off", + * "type": "per_total_discount", + * "amount": "5.0000", + * "min_purchase": "0.0000", + * "expires": "", + * "enabled": true, + * "code": "S2549JM0Y", + * "applies_to": { + * "entity": "categories", + * "ids": [ + * 0 + * ] + * }, + * "num_uses": 2, + * "max_uses": 0, + * "max_uses_per_customer": 0, + * "restricted_to": {}, + * "shipping_methods": [], + * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" + * } */ readonly "application/json": components["schemas"]["coupon_Full"]; }; }; @@ -940,6 +1224,34 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 1, + * "name": "This is a banner", + * "content": "

This is a banner

", + * "page": "home_page", + * "item_id": "0", + * "location": "top", + * "date_created": "1522169082", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * }, + * { + * "id": 2, + * "name": "Banner #2", + * "content": "

Banner # 2

", + * "page": "category_page", + * "item_id": "23", + * "location": "top", + * "date_created": "1522169169", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * } + * ] */ readonly "application/json": readonly components["schemas"]["banner_Full"][]; }; }; @@ -968,6 +1280,19 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "name": "Sale Banner", + * "content": "

Sale! Tuesday at 9am!

", + * "page": "home_page", + * "item_id": "0", + * "location": "top", + * "date_created": "1522169082", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * } */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -1013,6 +1338,19 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "name": "Sale Banner", + * "content": "

Sale! Tuesday at 9am!

", + * "page": "home_page", + * "item_id": "0", + * "location": "top", + * "date_created": "1522169082", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * } */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -1044,6 +1382,19 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "name": "Sale Banner", + * "content": "

Sale! Tuesday at 9am!

", + * "page": "home_page", + * "item_id": "0", + * "location": "top", + * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000", + * "date_type": "always", + * "date_from": "0", + * "date_to": "0", + * "visible": "1" + * } */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -1089,6 +1440,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": { readonly count?: number; }; @@ -1116,6 +1470,24 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "customer_id": 5, + * "order_id": 116, + * "code": "FFZ-5N4-C7M-S78", + * "to_name": "John Doe", + * "to_email": "johndoe@example.com", + * "from_name": "Jane Doe", + * "from_email": "janedoe@example.com", + * "amount": "10", + * "balance": "0", + * "status": "active", + * "template": "birthday.html", + * "message": "Happy Birthday!", + * "purchase_date": "1603306", + * "expiry_date": "1694738", + * "currency_code": "USD" + * } */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; @@ -1147,6 +1519,24 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "customer_id": 5, + * "order_id": 116, + * "code": "FFZ-5N4-C7M-S78", + * "to_name": "John Doe", + * "to_email": "johndoe@example.com", + * "from_name": "Jane Doe", + * "from_email": "janedoe@example.com", + * "amount": "10", + * "balance": "0", + * "status": "active", + * "template": "birthday.html", + * "message": "Happy Birthday!", + * "purchase_date": "1603306", + * "expiry_date": "1672670738", + * "currency_code": "USD" + * } */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; @@ -1203,6 +1593,62 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 24, + * "code": "10R-5E2-BO4-RWT", + * "amount": "1000.0000", + * "status": "active", + * "balance": "500.0000", + * "to_name": "Alyss", + * "order_id": 1281, + * "template": "celebration.html", + * "message": "Celebrate", + * "to_email": "test@test.com", + * "from_name": "Noland", + * "from_email": "test1@test.com", + * "customer_id": 0, + * "expiry_date": "1603306", + * "purchase_date": "1672670738", + * "currency_code": "USD" + * }, + * { + * "id": 25, + * "code": "10R-6E3-AO4-RST", + * "amount": "700.0000", + * "status": "active", + * "balance": "700.0000", + * "to_name": "Alyss", + * "order_id": 0, + * "template": "general.html", + * "message": "Test", + * "to_email": "test@test.com", + * "from_name": "Noland", + * "from_email": "test1@test.com", + * "customer_id": 0, + * "expiry_date": "1603306", + * "purchase_date": "1672670738", + * "currency_code": "USD" + * }, + * { + * "id": 27, + * "code": "15R-6E3-AO4-RST", + * "amount": "50.0000", + * "status": "active", + * "balance": "50.0000", + * "to_name": "Lyss", + * "order_id": 0, + * "template": "celebration.html", + * "message": "Celebrate", + * "to_email": "test5@test.com", + * "from_name": "Somethingelse", + * "from_email": "test15@test.com", + * "customer_id": 0, + * "expiry_date": "1603306", + * "purchase_date": "1672670738", + * "currency_code": "USD" + * } + * ] */ readonly "application/json": readonly components["schemas"]["giftCertificate_Full"][]; }; }; @@ -1231,6 +1677,24 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "customer_id": 5, + * "order_id": 116, + * "code": "FFZ-5N4-C7M-S78", + * "to_name": "John Doe", + * "to_email": "johndoe@example.com", + * "from_name": "Jane Doe", + * "from_email": "janedoe@example.com", + * "amount": "10", + * "balance": "0", + * "status": "active", + * "template": "birthday.html", + * "message": "Happy Birthday!", + * "purchase_date": "1603306", + * "expiry_date": "1694738", + * "currency_code": "USD" + * } */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; diff --git a/src/internal/reference/generated/orders.v2.oas2.ts b/src/internal/reference/generated/orders.v2.oas2.ts index 25ca07c..f2c0eff 100644 --- a/src/internal/reference/generated/orders.v2.oas2.ts +++ b/src/internal/reference/generated/orders.v2.oas2.ts @@ -43,6 +43,9 @@ export interface paths { * * The values for cost_ex_tax, cost_inc_tax and cost_tax in the fees payload should reflect the tax rate associated with the tax_class_id. For a 10% tax rate, the difference between cost_inc_tax and cost_ex_tax should be 10%. If no tax_class_id is provided, the store's default "tax class for fee" will apply. Incorrect data may lead to issues in downstream operations like refunds. * * To learn more about creating or updating orders, see [Orders Overview](/docs/store-operations/orders). + * + * > #### Note + * > * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s GMV/order count, which factors into pricing. */ readonly put: operations["updateOrder"]; /** @@ -166,6 +169,9 @@ export interface paths { * * The values for cost_ex_tax, cost_inc_tax and cost_tax in the fees payload should reflect the tax rate associated with the tax_class_id. For a 10% tax rate, the difference between cost_inc_tax and cost_ex_tax should be 10%. If no tax_class_id is provided, the store's default "tax class for fee" will apply. Incorrect data may lead to issues in downstream operations like refunds. * * The V2 Orders API will not trigger the typical [Order Email](https://support.bigcommerce.com/s/article/Customizing-Emails?language=en_US) when creating orders. To create an order that does trigger this email, you can instead [create a cart](/docs/rest-management/carts/carts-single#create-a-cart) and [convert that cart into an order](/docs/rest-management/checkouts/checkout-orders#create-an-order). + * + * > #### Note + * > * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s GMV/order count, which factors into pricing. */ readonly post: operations["createOrder"]; /** diff --git a/src/internal/reference/generated/orders.v3.ts b/src/internal/reference/generated/orders.v3.ts index a0fbe6e..638adb4 100644 --- a/src/internal/reference/generated/orders.v3.ts +++ b/src/internal/reference/generated/orders.v3.ts @@ -2821,6 +2821,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2935,6 +2941,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3257,6 +3269,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3313,6 +3331,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3363,6 +3387,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/pages.v3.ts b/src/internal/reference/generated/pages.v3.ts index 988a553..dce0f7d 100644 --- a/src/internal/reference/generated/pages.v3.ts +++ b/src/internal/reference/generated/pages.v3.ts @@ -399,13 +399,13 @@ export interface components { * * @default "" */ - readonly meta_keywords: string; + readonly meta_keywords: string | null; /** * @description Description contained within the element of this page. * * @default "" */ - readonly meta_description: string; + readonly meta_description: string | null; }; readonly searchKeywords: { /** @@ -414,7 +414,7 @@ export interface components { * @default "" * @example trousers,pockets,luxury */ - readonly search_keywords: string; + readonly search_keywords: string | null; }; }; responses: { diff --git a/src/internal/reference/generated/price_lists.v3.ts b/src/internal/reference/generated/price_lists.v3.ts index 48fb547..3de6018 100644 --- a/src/internal/reference/generated/price_lists.v3.ts +++ b/src/internal/reference/generated/price_lists.v3.ts @@ -599,6 +599,47 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 1, + * "name": "Warehouse", + * "date_created": "2022-02-26T17:33:11Z", + * "date_modified": "2022-05-08T14:05:27Z", + * "active": true + * }, + * { + * "id": 2, + * "name": "B2B", + * "date_created": "2022-02-26T17:37:01Z", + * "date_modified": "2022-02-26T17:37:01Z", + * "active": true + * }, + * { + * "id": 3, + * "name": "Wholesale", + * "date_created": "2022-04-05T16:05:12Z", + * "date_modified": "2022-04-05T16:05:12Z", + * "active": true + * } + * ], + * "meta": { + * "pagination": { + * "total": 3, + * "count": 3, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1 + * }, + * "cursor_pagination": { + * "count": 8, + * "per_page": 50, + * "start_cursor": "Nw==", + * "end_cursor": "MTQ=", + * "links": {} + * } + * } + * } */ readonly "application/json": { readonly data?: readonly ({ /** @@ -745,6 +786,16 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 4, + * "name": "Wholesale Group - Trade Show", + * "date_created": "2022-09-17T18:41:59Z", + * "date_modified": "2022-09-17T18:41:59Z", + * "active": false + * }, + * "meta": {} + * } */ readonly "application/json": { /** Price List */ readonly data?: { @@ -886,6 +937,16 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 2, + * "name": "B2B", + * "date_created": "2022-02-26T17:37:01Z", + * "date_modified": "2022-09-17T18:34:36Z", + * "active": true + * }, + * "meta": {} + * } */ readonly "application/json": { /** * Price List @@ -969,6 +1030,16 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 2, + * "name": "BigCommerce", + * "date_created": "2022-02-26T17:37:01Z", + * "date_modified": "2022-09-17T18:45:17Z", + * "active": false + * }, + * "meta": {} + * } */ readonly "application/json": { /** Price List */ readonly data?: { @@ -1218,6 +1289,317 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "price_list_id": 3, + * "variant_id": 358, + * "price": 25.48, + * "sale_price": 18.57, + * "retail_price": 25.48, + * "map_price": 18.57, + * "calculated_price": 25.48, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 187, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 359, + * "price": 31.31, + * "sale_price": 31.31, + * "retail_price": 31.31, + * "map_price": 31.31, + * "calculated_price": 31.31, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 188, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 360, + * "price": 18.57, + * "sale_price": 18.57, + * "retail_price": 18.57, + * "map_price": 18.57, + * "calculated_price": 18.57, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 189, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 361, + * "price": 22.54, + * "sale_price": 22.54, + * "retail_price": 22.54, + * "map_price": 22.54, + * "calculated_price": 22.54, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 190, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 362, + * "price": 27.39, + * "sale_price": 27.39, + * "retail_price": 27.39, + * "map_price": 27.39, + * "calculated_price": 27.39, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:51:26Z", + * "currency": "usd", + * "product_id": 191, + * "bulk_pricing_tiers": [ + * { + * "quantity_min": 10, + * "quantity_max": 19, + * "type": "percent", + * "amount": 1 + * }, + * { + * "quantity_min": 20, + * "quantity_max": 29, + * "type": "percent", + * "amount": 3 + * }, + * { + * "quantity_min": 30, + * "quantity_max": 2147483647, + * "type": "percent", + * "amount": 5 + * } + * ] + * }, + * { + * "price_list_id": 3, + * "variant_id": 382, + * "price": 9.8, + * "sale_price": 9.8, + * "retail_price": 9.8, + * "map_price": 9.8, + * "calculated_price": 9.8, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 192, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 383, + * "price": 24.5, + * "sale_price": 24.5, + * "retail_price": 24.5, + * "map_price": 24.5, + * "calculated_price": 24.5, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 192, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 384, + * "price": 24.5, + * "sale_price": 24.5, + * "retail_price": 24.5, + * "map_price": 24.5, + * "calculated_price": 24.5, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 192, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 385, + * "price": 9.8, + * "sale_price": 9.8, + * "retail_price": 9.8, + * "map_price": 9.8, + * "calculated_price": 9.8, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 193, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 386, + * "price": 10.78, + * "sale_price": 10.78, + * "retail_price": 10.78, + * "map_price": 10.78, + * "calculated_price": 10.78, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:33:14Z", + * "currency": "usd", + * "product_id": 194, + * "bulk_pricing_tiers": [] + * }, + * { + * "price_list_id": 3, + * "variant_id": 388, + * "price": 10.78, + * "sale_price": 10.78, + * "retail_price": 10.78, + * "map_price": 10.78, + * "calculated_price": 10.78, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:35:42Z", + * "currency": "usd", + * "product_id": 195, + * "bulk_pricing_tiers": [ + * { + * "quantity_min": 2, + * "quantity_max": 9, + * "type": "percent", + * "amount": 1 + * }, + * { + * "quantity_min": 10, + * "quantity_max": 19, + * "type": "percent", + * "amount": 2 + * }, + * { + * "quantity_min": 20, + * "quantity_max": 2147483647, + * "type": "percent", + * "amount": 3 + * } + * ] + * }, + * { + * "price_list_id": 3, + * "variant_id": 389, + * "price": 18.62, + * "sale_price": 18.62, + * "retail_price": 18.62, + * "map_price": 18.62, + * "calculated_price": 18.62, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:35:42Z", + * "currency": "usd", + * "product_id": 195, + * "bulk_pricing_tiers": [ + * { + * "quantity_min": 2, + * "quantity_max": 9, + * "type": "percent", + * "amount": 1 + * }, + * { + * "quantity_min": 10, + * "quantity_max": 19, + * "type": "percent", + * "amount": 2 + * }, + * { + * "quantity_min": 20, + * "quantity_max": 2147483647, + * "type": "percent", + * "amount": 3 + * } + * ] + * }, + * { + * "price_list_id": 3, + * "variant_id": 390, + * "price": 10.78, + * "sale_price": 10.78, + * "retail_price": 10.78, + * "map_price": 10.78, + * "calculated_price": 10.78, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:35:42Z", + * "currency": "usd", + * "product_id": 195, + * "bulk_pricing_tiers": [ + * { + * "quantity_min": 2, + * "quantity_max": 9, + * "type": "percent", + * "amount": 1 + * }, + * { + * "quantity_min": 10, + * "quantity_max": 19, + * "type": "percent", + * "amount": 2 + * }, + * { + * "quantity_min": 20, + * "quantity_max": 2147483647, + * "type": "percent", + * "amount": 3 + * } + * ] + * }, + * { + * "price_list_id": 3, + * "variant_id": 391, + * "price": 10.78, + * "sale_price": 10.78, + * "retail_price": 10.78, + * "map_price": 10.78, + * "calculated_price": 10.78, + * "date_created": "2022-09-17T20:33:14Z", + * "date_modified": "2022-09-17T20:35:42Z", + * "currency": "usd", + * "product_id": 195, + * "bulk_pricing_tiers": [ + * { + * "quantity_min": 2, + * "quantity_max": 9, + * "type": "percent", + * "amount": 1 + * }, + * { + * "quantity_min": 10, + * "quantity_max": 19, + * "type": "percent", + * "amount": 2 + * }, + * { + * "quantity_min": 20, + * "quantity_max": 2147483647, + * "type": "percent", + * "amount": 3 + * } + * ] + * } + * ], + * "meta": { + * "pagination": { + * "total": 14, + * "count": 14, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 1 + * }, + * "cursor_pagination": { + * "count": 1, + * "per_page": 50, + * "start_cursor": "MTUsMjEx", + * "end_cursor": "MTUsMjEx", + * "links": {} + * } + * } + * } */ readonly "application/json": { readonly data?: readonly ({ /** @@ -1905,6 +2287,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "price_list_id": 4, + * "variant_id": 356, + * "price": 22.544, + * "sale_price": 22.544, + * "retail_price": 22.544, + * "map_price": 22.544, + * "calculated_price": 22.544, + * "date_created": "2022-09-18T13:18:15Z", + * "date_modified": "2022-09-18T13:18:15Z", + * "currency": "eur", + * "product_id": 185 + * } + * } */ readonly "application/json": { /** * Price Record diff --git a/src/internal/reference/generated/pricing.sf.ts b/src/internal/reference/generated/pricing.sf.ts index a8e0ff1..354552a 100644 --- a/src/internal/reference/generated/pricing.sf.ts +++ b/src/internal/reference/generated/pricing.sf.ts @@ -473,6 +473,111 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "product_id": 1, + * "variant_id": 1, + * "options": [ + * { + * "option_id": 1, + * "value_id": 1 + * } + * ], + * "reference_request": { + * "product_id": 1, + * "variant_id": 1, + * "options": [ + * { + * "option_id": 1, + * "value_id": 1 + * } + * ] + * }, + * "retail_price": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "sale_price": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "minimum_advertised_price": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "saved": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "price": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "calculated_price": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "price_range": { + * "minimum": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "maximum": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * } + * }, + * "retail_price_range": { + * "minimum": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * }, + * "maximum": { + * "as_entered": 1.5, + * "entered_inclusive": true, + * "tax_exclusive": 1.1, + * "tax_inclusive": 1.5 + * } + * }, + * "bulk_pricing": [ + * { + * "minimum": 1, + * "maximum": 1, + * "discount_amount": 1, + * "discount_type": "percent", + * "tax_discount_amount": [ + * { + * "as_entered": 10, + * "tax_inclusive": 10, + * "tax_exclusive": 10, + * "entered_inclusive": false + * } + * ] + * } + * ] + * } + * ], + * "meta": {} + * } */ readonly "application/json": { readonly data?: readonly (components["schemas"]["ReferenceRequest"] & { readonly reference_request?: components["schemas"]["ReferenceRequest"]; diff --git a/src/internal/reference/generated/promotion_settings.v3.ts b/src/internal/reference/generated/promotion_settings.v3.ts index a7e178f..6fb4114 100644 --- a/src/internal/reference/generated/promotion_settings.v3.ts +++ b/src/internal/reference/generated/promotion_settings.v3.ts @@ -133,6 +133,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "promotions_triggered_by_products_with_zero_product_price": true, + * "promotions_apply_on_products_with_custom_product_price": false, + * "number_of_coupons_allowed_at_checkout": 1, + * "promotions_applied_on_original_product_price": true + * } */ readonly "application/json": components["schemas"]["GlobalPromotionSettings"]; }; }; diff --git a/src/internal/reference/generated/promotions.v3.ts b/src/internal/reference/generated/promotions.v3.ts index 474c7fa..ef777ff 100644 --- a/src/internal/reference/generated/promotions.v3.ts +++ b/src/internal/reference/generated/promotions.v3.ts @@ -139,6 +139,11 @@ export interface paths { export type webhooks = Record; export interface components { schemas: { + /** + * @description Describes which client originally created the promotion + * @enum {unknown} + */ + readonly CreatedFrom: "react_ui" | "legacy_ui" | "api"; /** * PromotionBase * @description **Promotion** @@ -159,7 +164,7 @@ export interface components { * @description An internal name for this rule that the merchant can refer to. * @example Buy Product X Get Free Shipping */ - readonly name: string; + readonly name?: string; /** * @description Customer-facing name for this rule, that the merchant want to display to customers. * @example WOW!!! FREE SHIPPING for Product X @@ -169,7 +174,7 @@ export interface components { readonly channels?: readonly components["schemas"]["Channel"][]; readonly customer?: components["schemas"]["Customer"]; /** @description An ordered list of rules to be executed until the first applicable one applies a discount successfully and the rest will be skipped. */ - readonly rules: readonly components["schemas"]["Rule"][]; + readonly rules?: readonly components["schemas"]["Rule"][]; /** * @description A read-only count of the times this rule has been used by customers. A rule is considered to be used when a customer successfully checks out with a rule that has applied a discount to their cart. * @example 2 @@ -217,26 +222,106 @@ export interface components { readonly schedule?: components["schemas"]["AvailabilityByWeekDay"]; }; /** - * Coupon Promotion + * Patch Coupon Promotion + * @description A Partial **Coupon Promotion** that contains properties to patch. + */ + readonly PatchCouponPromotion: components["schemas"]["PromotionBase"] & { + readonly codes?: components["schemas"]["CouponCode"]; + /** + * @description This field only has effect when `can_be_used_with_other_promotions` is `false`: + * - When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount. + * - When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied. + * Trying to set the value of this field to `true` when `can_be_used_with_other_promotions` is `true` will yield a 422 error response. + * @default false + * @example false + */ + readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; + }; + readonly DraftCouponPromotion: components["schemas"]["PromotionBase"] & { + readonly codes?: components["schemas"]["CouponCode"]; + /** + * @description This field only has effect when `can_be_used_with_other_promotions` is `false`: + * - When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount. + * - When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied. + * Trying to set the value of this field when `can_be_used_with_other_promotions` is `true` will yield a 422 error response. + * @default false + * @example false + */ + readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; + /** + * @description The type of the promotion. Promotions applied automatically have a value of `AUTOMATIC` whereas promotions requiring a coupon have a value of `COUPON`. + * @enum {string} + */ + readonly redemption_type: "COUPON"; + }; + /** + * Saved Coupon Promotion * @description **Coupon Promotion** A shopper must manually apply a *coupon promotion* to their cart. */ - readonly PromotionCoupon: components["schemas"]["PromotionBase"] & { + readonly SavedCouponPromotion: WithRequired & { + /** + * @description An auto-generated unique identifier for the discount rule. + * @example 1 + */ + readonly id: number; + readonly created_from: components["schemas"]["CreatedFrom"]; + readonly codes?: components["schemas"]["CouponCode"]; /** * @description This field only has effect when the `redemption_type` is `COUPON` and `can_be_used_with_other_promotions` is `false`: - * - When the property is set to "true", the coupon will override the applied automatic promotions if it provides a greater discount. - * - When the property is set to "false", the coupon will not be applied if automatic promotions are already applied. + * - When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount. + * - When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied. * - * Trying to set the value of this field to "true" when the `redemption_type` is not `COUPON`, or when `can_be_used_with_other_promotions` is `true` will yield a 422 error response. + * Trying to set the value of this field to `true` when the `redemption_type` is not `COUPON`, or when `can_be_used_with_other_promotions` is `true` will yield a 422 error response. * @default false * @example false */ readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; + /** + * @description The type of the promotion. Promotions applied automatically have a value of `AUTOMATIC` whereas promotions requiring a coupon have a value of `COUPON`. + * @enum {string} + */ + readonly redemption_type: "COUPON"; + readonly multiple_codes?: { + /** + * @default false + * @example false + */ + readonly has_multiple_codes: boolean; + }; }; /** - * Automatic Promotion - * @description The store applies *automatic promotions* to a shopper’s cart once the promotion criteria are satisfied. The shopper cannot manually apply an *automatic promotion*. + * Patch Automatic Promotion + * @description A Partial **Automatic Promotion** that contains properties to patch. */ - readonly PromotionAutomatic: components["schemas"]["PromotionBase"]; + readonly PatchAutomaticPromotion: components["schemas"]["PromotionBase"]; + /** + * Draft Automatic Promotion + * @description A draft **Automatic Promotion** to be created. The store applies *automatic promotions* to a shopper’s cart once the promotion criteria are satisfied. The shopper cannot manually apply an *automatic promotion*. + */ + readonly DraftAutomaticPromotion: WithRequired & { + /** + * @description The type of the promotion. Promotions applied automatically have a value of `AUTOMATIC` whereas promotions requiring a coupon have a value of `COUPON`. + * @enum {string} + */ + readonly redemption_type: "AUTOMATIC"; + }; + /** + * Saved Automatic Promotion + * @description The store applies *Automatic promotions* to a shopper’s cart once the promotion criteria are satisfied. The shopper cannot manually apply an *automatic promotion*. + */ + readonly SavedAutomaticPromotion: WithRequired & { + /** + * @description The type of the promotion. Promotions applied automatically have a value of `AUTOMATIC` whereas promotions requiring a coupon have a value of `COUPON`. + * @enum {string} + */ + readonly redemption_type: "AUTOMATIC"; + /** + * @description An auto-generated unique identifier for the discount rule. + * @example 1 + */ + readonly id: number; + readonly created_from: components["schemas"]["CreatedFrom"]; + }; /** @description Specifies the requirements which make the customer eligible for the promotion. * * Note: @@ -604,7 +689,7 @@ export interface components { * @description Contains data about the response including pagination and collection totals. */ readonly CollectionMeta: { - readonly pagination?: components["schemas"]["Pagination"]; + readonly pagination: components["schemas"]["Pagination"]; }; /** * Pagination @@ -612,17 +697,17 @@ export interface components { */ readonly Pagination: { /** @description Total number of items in the result set. */ - readonly total?: number; + readonly total: number; /** @description Total number of items in the collection response. */ - readonly count?: number; + readonly count: number; /** @description The amount of items returned in the collection per page, controlled by the limit of items per page parameter. */ - readonly per_page?: number; + readonly per_page: number; /** @description The page you are currently on within the collection. */ - readonly current_page?: number; + readonly current_page: number; /** @description The total number of pages in the collection. */ - readonly total_pages?: number; + readonly total_pages: number; /** @description Pagination links for the previous and next parts of the whole collection. */ - readonly links?: { + readonly links: { /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** @description Link to the current page returned in the response. */ @@ -799,7 +884,7 @@ export interface components { * @description An auto-generated unique identifier for the coupon code. * @example 1 */ - readonly id?: number; + readonly id: number; /** * @description A unique code that can be used to manually apply a discount. Only letters, numbers, white spaces, underscores and hyphens are allowed. * @example TEST-COUPON-CODE @@ -809,7 +894,7 @@ export interface components { * @description A read-only count of the times this coupon code has been used. * @example 2 */ - readonly current_uses?: number; + readonly current_uses: number; /** * @description The maximum number of times you can use this coupon code. The default value is 0, which represents unlimited uses. * @example 10 @@ -825,7 +910,7 @@ export interface components { * @description The date and time when this coupon code was created. * @example 2019-01-20T22:00:00.000Z */ - readonly created?: string; + readonly created: string; }; /** * Bulk Action Response Meta @@ -989,7 +1074,39 @@ export interface components { readonly errors?: readonly components["schemas"]["BulkActionResponseError"][]; readonly meta?: components["schemas"]["BulkActionResponseMeta"]; }; + /** @example { + * "errors": [ + * { + * "status": 422, + * "title": "Parameter id:in is required", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } + * ], + * "meta": { + * "total": 0, + * "success": 0, + * "failed": 0 + * } + * } */ readonly "422 - Missing Parameter": unknown; + /** @example { + * "errors": [ + * { + * "status": 422, + * "title": "Errors occurred in bulk delete action.", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "errors": { + * "0.constraint": "Failed for id=12. Error: constraint reference error.", + * "2.code": "Failed for id=14. Error: some relating codes are still present." + * } + * } + * ], + * "meta": { + * "total": 5, + * "success": 3, + * "failed": 2 + * } + * } */ readonly "422 - Error Deleting": unknown; }; }; @@ -1022,8 +1139,8 @@ export interface components { }; content: { readonly "application/json": { - readonly data?: readonly (components["schemas"]["PromotionAutomatic"] | components["schemas"]["PromotionCoupon"])[]; - readonly meta?: components["schemas"]["CollectionMeta"]; + readonly data: readonly (components["schemas"]["SavedAutomaticPromotion"] | components["schemas"]["SavedCouponPromotion"])[]; + readonly meta: components["schemas"]["CollectionMeta"]; }; }; }; @@ -1033,7 +1150,7 @@ export interface components { }; content: { readonly "application/json": { - readonly data?: components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; + readonly data?: components["schemas"]["SavedCouponPromotion"] | components["schemas"]["SavedAutomaticPromotion"]; /** @description Empty meta object, which may be used at a later time. */ readonly meta?: { readonly [key: string]: unknown; @@ -1070,6 +1187,8 @@ export interface components { readonly LimitQuery: number; /** @description Filter items by `name`. */ readonly NameQuery: string; + /** @description Filter items by both name or code. */ + readonly Query: string; /** @description Filter items by `code`. */ readonly CodeQuery: string; /** @description Filter items by `currency_code`. */ @@ -1125,6 +1244,8 @@ export interface operations { readonly direction?: components["parameters"]["DirectionQuery"]; /** @description Filter promotions that target those `channel IDs`. Example: **?channels=1,2**. Note: promotions that target all the channels are included in the filtering result. */ readonly channels?: components["parameters"]["ChannelQuery"]; + /** @description Filter items by both name or code. */ + readonly query?: components["parameters"]["Query"]; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ @@ -1161,7 +1282,7 @@ export interface operations { }; readonly requestBody?: { readonly content: { - readonly "application/json": components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; + readonly "application/json": components["schemas"]["DraftCouponPromotion"] | components["schemas"]["DraftAutomaticPromotion"]; }; }; readonly responses: { @@ -1266,7 +1387,7 @@ export interface operations { }; readonly requestBody?: { readonly content: { - readonly "application/json": components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; + readonly "application/json": components["schemas"]["PatchCouponPromotion"] | components["schemas"]["PatchAutomaticPromotion"]; }; }; readonly responses: { @@ -1434,3 +1555,6 @@ export interface operations { }; }; } +type WithRequired = T & { + [P in K]-?: T[P]; +}; diff --git a/src/internal/reference/generated/shipping.v3.ts b/src/internal/reference/generated/shipping.v3.ts index 5c249cb..fe01f14 100644 --- a/src/internal/reference/generated/shipping.v3.ts +++ b/src/internal/reference/generated/shipping.v3.ts @@ -536,6 +536,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -550,6 +556,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 422, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -625,6 +636,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -639,6 +656,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 422, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/store_content.v2.ts b/src/internal/reference/generated/store_content.v2.ts index d12a034..5886285 100644 --- a/src/internal/reference/generated/store_content.v2.ts +++ b/src/internal/reference/generated/store_content.v2.ts @@ -1101,6 +1101,81 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 3, + * "title": "Hello Again", + * "url": "/blog/hello-again/", + * "preview_url": "/blog/hello-again/", + * "body": "

Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar chocolate bar tiramisu chocolate lemon drops candy.

Marshmallow cupcake sweet roll candy marshmallow caramels cotton candy pie icing. Powder jelly beans chupa chups lollipop liquorice marzipan dessert soufflé sesame snaps. Macaroon chupa chups gummies cheesecake ice cream caramels sesame snaps cotton candy gingerbread. Chocolate cake fruitcake tart bear claw lemon drops tart dragée tart apple pie. Halvah chupa chups soufflé jelly soufflé marshmallow. Croissant tart tart. Gingerbread apple pie biscuit.

Wafer lemon drops tart pastry brownie chocolate bar jelly. Dragée muffin cupcake liquorice caramels marzipan gingerbread marzipan. Apple pie pudding jelly sweet roll croissant bonbon wafer. Cookie chocolate bar sesame snaps bonbon macaroon candy canes donut sugar plum. Bear claw bonbon tootsie roll bonbon. Apple pie gummies donut sweet. Marzipan bear claw cotton candy topping dragée bonbon danish powder.

", + * "tags": [ + * "sugar", + * "sweet", + * "spice", + * "everything", + * "nice" + * ], + * "summary": "Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar [...]", + * "is_published": true, + * "published_date": { + * "date": "2018-05-18 08:26:42.000000", + * "timezone_type": 1, + * "timezone": "+00:00" + * }, + * "published_date_iso8601": "2018-05-18T13:26:42+0000", + * "meta_description": "Cupcakes post 2", + * "meta_keywords": "sugar,sweet,spice,everything,nice", + * "author": "", + * "thumbnail_path": "" + * }, + * { + * "id": 2, + * "title": "Hello", + * "url": "/blog/hello/", + * "preview_url": "/blog/hello/", + * "body": "

Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar chocolate bar tiramisu chocolate lemon drops candy.

Marshmallow cupcake sweet roll candy marshmallow caramels cotton candy pie icing. Powder jelly beans chupa chups lollipop liquorice marzipan dessert soufflé sesame snaps. Macaroon chupa chups gummies cheesecake ice cream caramels sesame snaps cotton candy gingerbread. Chocolate cake fruitcake tart bear claw lemon drops tart dragée tart apple pie. Halvah chupa chups soufflé jelly soufflé marshmallow. Croissant tart tart. Gingerbread apple pie biscuit.

Wafer lemon drops tart pastry brownie chocolate bar jelly. Dragée muffin cupcake liquorice caramels marzipan gingerbread marzipan. Apple pie pudding jelly sweet roll croissant bonbon wafer. Cookie chocolate bar sesame snaps bonbon macaroon candy canes donut sugar plum. Bear claw bonbon tootsie roll bonbon. Apple pie gummies donut sweet. Marzipan bear claw cotton candy topping dragée bonbon danish powder.

", + * "tags": [ + * "cupcakes", + * "sugar", + * "sweet" + * ], + * "summary": "Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar [...]", + * "is_published": true, + * "published_date": { + * "date": "2018-05-18 08:26:00.000000", + * "timezone_type": 1, + * "timezone": "+00:00" + * }, + * "published_date_iso8601": "2018-05-18T13:26:00+0000", + * "meta_description": "cupcake blog post", + * "meta_keywords": "cupcakes,sugar,sweet", + * "author": "", + * "thumbnail_path": "" + * }, + * { + * "id": 1, + * "title": "Your first blog post!", + * "url": "/your-first-blog-post/", + * "preview_url": "/your-first-blog-post/", + * "body": "

Welcome to your blog!
A blog is a great place to share details on your products, business and whatever else you think your shoppers might like to hear from you. You can include photos in your blog posts and even videos. For ideas and inspiration on how to structure your blog, take a look at the BigCommerce ecommerce blog.

How can I delete this post?
To delete this post and add your own, login to your admin area and go to Storefront > Blog in the left hand menu.

Powered by BigCommerce
Your website, online store and blog are powered by BigCommerce ecommerce software. It includes everything you need to run a beautiful online store including ecommerce website templates, ecommerce hosting, an online shopping cart and more.

", + * "tags": [ + * "Blog", + * "SEO" + * ], + * "summary": " Welcome to your blog! A blog is a great place to share details on your products, business and whatever else you think your shoppers might like to hear from you. You can include photos in your blog posts and even videos. For ideas and inspiration on how to structure your blog, take a look [...]", + * "is_published": true, + * "published_date": { + * "date": "2014-02-15 14:46:34.000000", + * "timezone_type": 1, + * "timezone": "+00:00" + * }, + * "published_date_iso8601": "2014-02-15T19:46:34+0000", + * "meta_description": "", + * "meta_keywords": "Blog,SEO", + * "author": "", + * "thumbnail_path": "" + * } + * ] */ readonly "application/json": readonly components["schemas"]["blogPost_Full"][]; }; }; @@ -1129,6 +1204,30 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 3, + * "title": "Welcome to BigCommerce", + * "url": "/blog/welcome-bigcommerce/", + * "preview_url": "/blog/welcome-bigcommerce/", + * "body": "

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

", + * "tags": [ + * "BigCommerce", + * "welcome", + * "ecommerce" + * ], + * "summary": "

We power ecommerce websites for successful retailers all over the world

", + * "is_published": true, + * "published_date": { + * "date": "2018-05-18T08:26:42.000Z", + * "timezone_type": 1, + * "timezone": "+00:00" + * }, + * "published_date_iso8601": "2018-05-18T13:26:42.000Z", + * "meta_description": "Welcome Post", + * "meta_keywords": "BigCommerce, welcome, ecommerce", + * "author": "BigCommerce", + * "thumbnail_path": "" + * } */ readonly "application/json": components["schemas"]["blogPost_Base_Res"]; }; }; @@ -1190,6 +1289,30 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 3, + * "title": "Welcome to BigCommerce", + * "url": "/blog/welcome-bigcommerce/", + * "preview_url": "/blog/welcome-bigcommerce/", + * "body": "

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

", + * "tags": [ + * "BigCommerce", + * "welcome", + * "ecommerce" + * ], + * "summary": "

We power ecommerce websites for successful retailers all over the world

", + * "is_published": true, + * "published_date": { + * "date": "2018-05-18T08:26:42.000Z", + * "timezone_type": 1, + * "timezone": "+00:00" + * }, + * "published_date_iso8601": "2018-05-18T13:26:42.000Z", + * "meta_description": "Welcome Post", + * "meta_keywords": "BigCommerce, welcome, ecommerce", + * "author": "BigCommerce", + * "thumbnail_path": "" + * } */ readonly "application/json": components["schemas"]["blogPost_Full"]; }; }; @@ -1221,6 +1344,30 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 3, + * "title": "Welcome to BigCommerce", + * "url": "/blog/welcome-bigcommerce/", + * "preview_url": "/blog/welcome-bigcommerce/", + * "body": "

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

", + * "tags": [ + * "BigCommerce", + * "welcome", + * "ecommerce" + * ], + * "summary": "

We power ecommerce websites for successful retailers all over the world

", + * "is_published": true, + * "published_date": { + * "date": "2018-05-18T08:26:42.000Z", + * "timezone_type": 1, + * "timezone": "+00:00" + * }, + * "published_date_iso8601": "2018-05-18T13:26:42.000Z", + * "meta_description": "Welcome Post", + * "meta_keywords": "BigCommerce, welcome, ecommerce", + * "author": "BigCommerce", + * "thumbnail_path": "" + * } */ readonly "application/json": components["schemas"]["blogPost_Base_Res"]; }; }; @@ -1277,6 +1424,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": components["schemas"]["count_Response"]; }; }; @@ -1304,6 +1454,30 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": 6, + * "channel_id": 11, + * "name": "Contact Form", + * "meta_title": "", + * "email": "janedoe@example.com", + * "body": "We are happy to answer questions or help you with...", + * "is_visible": true, + * "parent_id": 5, + * "sort_order": 3, + * "meta_keywords": "", + * "type": "page", + * "contact_fields": "fullname,companyname,phone,orderno,rma", + * "meta_description": "", + * "is_homepage": false, + * "layout_file": "page.html", + * "is_customers_only": false, + * "search_keywords": "", + * "has_mobile_version": false, + * "mobile_body": "", + * "url": "/contact-us/" + * } + * ] */ readonly "application/json": readonly components["schemas"]["page_Full"][]; }; }; @@ -1351,6 +1525,26 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 6, + * "channel_id": 11, + * "name": "Contact Form", + * "meta_title": "", + * "body": "We're happy to answer questions or help you with returns.
Please fill out the form below if you need assistance.", + * "is_visible": true, + * "parent_id": 5, + * "sort_order": 3, + * "meta_keywords": "", + * "type": "page", + * "meta_description": "", + * "is_homepage": false, + * "layout_file": "page.html", + * "is_customers_only": true, + * "search_keywords": "", + * "has_mobile_version": false, + * "mobile_body": "", + * "url": "/contact-us/" + * } */ readonly "application/json": components["schemas"]["page_Full"]; }; }; @@ -1387,6 +1581,28 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "channel_id": 11, + * "name": "RSS Syndication", + * "meta_title": "", + * "body": "%%Syndicate%%", + * "is_visible": true, + * "parent_id": 0, + * "sort_order": 5, + * "meta_keywords": "0", + * "type": "page", + * "meta_description": "", + * "is_homepage": false, + * "layout_file": "", + * "is_customers_only": false, + * "search_keywords": "0", + * "has_mobile_version": false, + * "feed": "", + * "link": "", + * "mobile_body": "0", + * "url": "/rss-syndication/" + * } */ readonly "application/json": components["schemas"]["page_Full"]; }; }; @@ -1418,6 +1634,28 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 2, + * "channel_id": 11, + * "name": "Shipping & Returns", + * "meta_title": "", + * "body": "To edit this page simply login to the control panel, click the Website Content tab and choose the View Web Pages option. Click Edit next to the Shipping & Returns page and you can change this text. A sample returns policy is shown below which you can edit as needed.

Returns Policy

You may return most new, unopened items within 30 days of delivery for a full refund. We'll also pay the return shipping costs if the return is a result of our error (you received an incorrect or defective item, etc.).

You should expect to receive your refund within four weeks of giving your package to the return shipper, however, in many cases you will receive a refund more quickly. This time period includes the transit time for us to receive your return from the shipper (5 to 10 business days), the time it takes us to process your return once we receive it (3 to 5 business days), and the time it takes your bank to process our refund request (5 to 10 business days).

If you need to return an item, please Contact Us with your order number and details about the product you would like to return. We will respond quickly with instructions for how to return items from your order.

Shipping

We can ship to virtually any address in the world. Note that there are restrictions on some products, and some products cannot be shipped to international destinations.

When you place an order, we will estimate shipping and delivery dates for you based on the availability of your items and the shipping options you choose. Depending on the shipping provider you choose, shipping date estimates may appear on the shipping quotes page.

Please also note that the shipping rates for many items we sell are weight-based. The weight of any such item can be found on its detail page. To reflect the policies of the shipping companies we use, all weights will be rounded up to the next full pound.
", + * "is_visible": true, + * "parent_id": 0, + * "sort_order": 2, + * "meta_keywords": "", + * "type": "page", + * "meta_description": "", + * "is_homepage": false, + * "layout_file": "page.html", + * "is_customers_only": false, + * "search_keywords": "", + * "has_mobile_version": false, + * "feed": "", + * "link": "", + * "mobile_body": "", + * "url": "/shipping-returns/" + * } */ readonly "application/json": components["schemas"]["page_Full"]; }; }; @@ -1480,6 +1718,7 @@ export interface operations { }; content: { readonly "application/json": readonly components["schemas"]["redirect"][]; + /** @example */ readonly "Response Schema": unknown; }; }; @@ -1508,6 +1747,15 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 3, + * "path": "/mens_clothing", + * "forward": { + * "type": "category", + * "ref": 3 + * }, + * "url": "http://store.example.com/mens" + * } */ readonly "application/json": components["schemas"]["redirect"]; }; }; @@ -1553,6 +1801,15 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "path": "/smith-journal-13/", + * "forward": { + * "type": "product", + * "ref": 111 + * }, + * "url": "http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/" + * } */ readonly "application/json": components["schemas"]["redirect"]; }; }; @@ -1613,6 +1870,15 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": 1, + * "path": "/smith-journal-13/", + * "forward": { + * "type": "product", + * "ref": 111 + * }, + * "url": "http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/" + * } */ readonly "application/json": components["schemas"]["redirect"]; }; }; @@ -1658,6 +1924,9 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "count": 27 + * } */ readonly "application/json": components["schemas"]["count_Response"]; }; }; diff --git a/src/internal/reference/generated/store_information.v2.ts b/src/internal/reference/generated/store_information.v2.ts index 480a938..7f7d1c0 100644 --- a/src/internal/reference/generated/store_information.v2.ts +++ b/src/internal/reference/generated/store_information.v2.ts @@ -869,6 +869,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "status": 400, + * "title": "Input is invalid", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", + * "detail": "Syntax error" + * } */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1033,6 +1039,13 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "value": { + * "status": 404, + * "title": "There was no metafield found with ID 1010", + * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" + * } + * } */ readonly "application/json": components["schemas"]["NotFound"]; }; }; diff --git a/src/internal/reference/generated/tax_classes.v2.ts b/src/internal/reference/generated/tax_classes.v2.ts index 3fa6a07..a8fb108 100644 --- a/src/internal/reference/generated/tax_classes.v2.ts +++ b/src/internal/reference/generated/tax_classes.v2.ts @@ -103,6 +103,26 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example [ + * { + * "id": "1", + * "name": "Non-Taxable Products", + * "created_at": "1973-01-20T21:34:57.903+00:00", + * "updated_at": "1990-12-30T00:29:23.515+00:00" + * }, + * { + * "id": "2", + * "name": "Shipping", + * "created_at": "1973-01-20T21:34:57.903+00:00", + * "updated_at": "1990-12-30T00:29:23.515+00:00" + * }, + * { + * "id": "3", + * "name": "Gift Wrapping", + * "created_at": "1973-01-20T21:34:57.903+00:00", + * "updated_at": "1990-12-30T00:29:23.515+00:00" + * } + * ] */ readonly "application/json": readonly components["schemas"]["taxClass_Full"][]; }; }; @@ -128,6 +148,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "id": "1", + * "name": "Shipping", + * "created_at": "1973-01-20T21:34:57.903+00:00", + * "updated_at": "1990-12-30T00:29:23.515+00:00" + * } */ readonly "application/json": components["schemas"]["taxClass_Full"]; }; }; diff --git a/src/internal/reference/generated/wishlists.v3.ts b/src/internal/reference/generated/wishlists.v3.ts index 145aff0..19825cb 100644 --- a/src/internal/reference/generated/wishlists.v3.ts +++ b/src/internal/reference/generated/wishlists.v3.ts @@ -311,6 +311,95 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": [ + * { + * "id": 1, + * "customer_id": 4, + * "name": "My Wish List", + * "is_public": false, + * "token": "02d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [] + * }, + * { + * "id": 2, + * "customer_id": 11, + * "name": "Christmas", + * "is_public": false, + * "token": "02d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 1, + * "product_id": 167 + * }, + * { + * "id": 2, + * "product_id": 174 + * }, + * { + * "id": 3, + * "product_id": 184 + * } + * ] + * }, + * { + * "id": 3, + * "customer_id": 20, + * "name": "Birthday", + * "is_public": false, + * "token": "02d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 4, + * "product_id": 184 + * }, + * { + * "id": 5, + * "product_id": 183 + * } + * ] + * }, + * { + * "id": 4, + * "customer_id": 20, + * "name": "Christmas", + * "is_public": false, + * "token": "02d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 6, + * "product_id": 201 + * } + * ] + * }, + * { + * "id": 5, + * "customer_id": 19, + * "name": "Wish List", + * "is_public": false, + * "token": "02d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 7, + * "product_id": 173 + * }, + * { + * "id": 8, + * "product_id": 176 + * } + * ] + * } + * ], + * "meta": { + * "pagination": { + * "total": 0, + * "count": 5, + * "per_page": 50, + * "current_page": 1, + * "total_pages": 0 + * } + * } + * } */ readonly "application/json": { readonly data?: readonly components["schemas"]["wishlist_Full"][]; readonly meta?: components["schemas"]["metaCollection"]; @@ -370,6 +459,43 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 30, + * "customer_id": 10, + * "name": "Christmas List", + * "is_public": true, + * "token": "d2d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 44, + * "product_id": 77, + * "variant_id": 1 + * }, + * { + * "id": 45, + * "product_id": 80, + * "variant_id": 1 + * }, + * { + * "id": 46, + * "product_id": 81, + * "variant_id": 1 + * }, + * { + * "id": 47, + * "product_id": 86, + * "variant_id": 1 + * }, + * { + * "id": 48, + * "product_id": 88, + * "variant_id": 1 + * } + * ] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -430,6 +556,43 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 30, + * "customer_id": 10, + * "name": "Christmas List", + * "is_public": true, + * "token": "d2d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 44, + * "product_id": 77, + * "variant_id": 1 + * }, + * { + * "id": 45, + * "product_id": 80, + * "variant_id": 1 + * }, + * { + * "id": 46, + * "product_id": 81, + * "variant_id": 1 + * }, + * { + * "id": 47, + * "product_id": 86, + * "variant_id": 1 + * }, + * { + * "id": 48, + * "product_id": 88, + * "variant_id": 1 + * } + * ] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -498,6 +661,43 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 30, + * "customer_id": 10, + * "name": "Christmas List", + * "is_public": true, + * "token": "d2d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 44, + * "product_id": 77, + * "variant_id": 1 + * }, + * { + * "id": 45, + * "product_id": 80, + * "variant_id": 1 + * }, + * { + * "id": 46, + * "product_id": 81, + * "variant_id": 1 + * }, + * { + * "id": 47, + * "product_id": 86, + * "variant_id": 1 + * }, + * { + * "id": 48, + * "product_id": 88, + * "variant_id": 1 + * } + * ] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -572,6 +772,43 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 30, + * "customer_id": 10, + * "name": "Christmas List", + * "is_public": true, + * "token": "d2d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 44, + * "product_id": 77, + * "variant_id": 1 + * }, + * { + * "id": 45, + * "product_id": 80, + * "variant_id": 1 + * }, + * { + * "id": 46, + * "product_id": 81, + * "variant_id": 1 + * }, + * { + * "id": 47, + * "product_id": 86, + * "variant_id": 1 + * }, + * { + * "id": 48, + * "product_id": 88, + * "variant_id": 1 + * } + * ] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -688,6 +925,43 @@ export interface operations { readonly [name: string]: unknown; }; content: { + /** @example { + * "data": { + * "id": 30, + * "customer_id": 10, + * "name": "Christmas List", + * "is_public": true, + * "token": "d2d55481-13eb-4d1e-9d79-9062b518570d", + * "items": [ + * { + * "id": 44, + * "product_id": 77, + * "variant_id": 1 + * }, + * { + * "id": 45, + * "product_id": 80, + * "variant_id": 1 + * }, + * { + * "id": 46, + * "product_id": 81, + * "variant_id": 1 + * }, + * { + * "id": 47, + * "product_id": 86, + * "variant_id": 1 + * }, + * { + * "id": 48, + * "product_id": 88, + * "variant_id": 1 + * } + * ] + * }, + * "meta": {} + * } */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ From 77ac5b1e6aaf731a326c06c8e38415dd4a6e2c1b Mon Sep 17 00:00:00 2001 From: Torbjorn van Heeswijck Date: Mon, 23 Jun 2025 17:06:47 +0930 Subject: [PATCH 3/3] Use defineconfig for eslint, ignore .tmp-generate directory --- eslint.config.js | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/eslint.config.js b/eslint.config.js index da3bf11..5a7e32a 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -1,6 +1,9 @@ import { eslintConfigs } from '@aligent/ts-code-standards'; +import { defineConfig } from 'eslint/config'; -export default [ +export default defineConfig([ ...eslintConfigs.base, - { ignores: ['**/*.{js,mjs}', '**/generated', '**/dist'] }, -]; + { + ignores: ['**/*.{js,mjs}', '**/generated', '**/.tmp-generate', '**/dist'], + }, +]);