@bigcommerce/checkout-sdk 1.215.0 → 1.215.1

package/dist/internal-mappers.d.ts

@@ -562,6 +562,7 @@ declare interface Order {
     billingAddress: BillingAddress;
     cartId: string;
     coupons: Coupon[];
+    consignments: OrderConsignment[];
     currency: Currency;
     customerCanBeCreated: boolean;
     customerId: number;
@@ -586,6 +587,10 @@ declare interface Order {
     mandateUrl?: string;
 }
 
+declare interface OrderConsignment {
+    shipping: OrderShippingConsignment[];
+}
+
 declare interface OrderMetaState extends InternalOrderMeta {
     token?: string;
     orderToken?: string;
@@ -603,6 +608,44 @@ declare interface OrderPayment {
 
 declare type OrderPayments = Array<GatewayOrderPayment | GiftCertificateOrderPayment>;
 
+declare interface OrderShippingConsignment {
+    lineItems: Array<{
+        id: number;
+    }>;
+    shippingAddressId: number;
+    firstName: string;
+    lastName: string;
+    company: string;
+    address1: string;
+    address2: string;
+    city: string;
+    stateOrProvince: string;
+    postalCode: string;
+    country: string;
+    countryCode: string;
+    email: string;
+    phone: string;
+    itemsTotal: number;
+    itemsShipped: number;
+    shippingMethod: string;
+    baseCost: number;
+    costExTax: number;
+    costIncTax: number;
+    costTax: number;
+    costTaxClassId: number;
+    baseHandlingCost: number;
+    handlingCostExTax: number;
+    handlingCostIncTax: number;
+    handlingCostTax: number;
+    handlingCostTaxClassId: number;
+    shippingZoneId: number;
+    shippingZoneName: string;
+    customFields: Array<{
+        name: string;
+        value: string | null;
+    }>;
+}
+
 declare interface PhysicalItem extends LineItem {
     isShippingRequired: boolean;
     giftWrapping?: {

package/docs/README.md

@@ -226,9 +226,11 @@
 * [NonceInstrument](interfaces/nonceinstrument.md)
 * [OptionsResponse](interfaces/optionsresponse.md)
 * [Order](interfaces/order.md)
+* [OrderConsignment](interfaces/orderconsignment.md)
 * [OrderPayment](interfaces/orderpayment.md)
 * [OrderPaymentRequestBody](interfaces/orderpaymentrequestbody.md)
 * [OrderRequestBody](interfaces/orderrequestbody.md)
+* [OrderShippingConsignment](interfaces/ordershippingconsignment.md)
 * [PasswordRequirements](interfaces/passwordrequirements.md)
 * [PayPalInstrument](interfaces/paypalinstrument.md)
 * [PaymentInitializeOptions](interfaces/paymentinitializeoptions.md)

package/docs/interfaces/order.md

@@ -13,6 +13,7 @@
 * [baseAmount](order.md#baseamount)
 * [billingAddress](order.md#billingaddress)
 * [cartId](order.md#cartid)
+* [consignments](order.md#consignments)
 * [coupons](order.md#coupons)
 * [currency](order.md#currency)
 * [customerCanBeCreated](order.md#customercanbecreated)
@@ -57,6 +58,12 @@ ___
 
 ___
 
+###  consignments
+
+• **consignments**: *[OrderConsignment](orderconsignment.md)[]*
+
+___
+
 ###  coupons
 
 • **coupons**: *[Coupon](coupon.md)[]*

package/docs/interfaces/orderconsignment.md

@@ -0,0 +1,19 @@
+[@bigcommerce/checkout-sdk](../README.md) › [OrderConsignment](orderconsignment.md)
+
+# Interface: OrderConsignment
+
+## Hierarchy
+
+* **OrderConsignment**
+
+## Index
+
+### Properties
+
+* [shipping](orderconsignment.md#shipping)
+
+## Properties
+
+###  shipping
+
+• **shipping**: *[OrderShippingConsignment](ordershippingconsignment.md)[]*

package/docs/interfaces/ordershippingconsignment.md

@@ -0,0 +1,222 @@
+[@bigcommerce/checkout-sdk](../README.md) › [OrderShippingConsignment](ordershippingconsignment.md)
+
+# Interface: OrderShippingConsignment
+
+## Hierarchy
+
+* **OrderShippingConsignment**
+
+## Index
+
+### Properties
+
+* [address1](ordershippingconsignment.md#address1)
+* [address2](ordershippingconsignment.md#address2)
+* [baseCost](ordershippingconsignment.md#basecost)
+* [baseHandlingCost](ordershippingconsignment.md#basehandlingcost)
+* [city](ordershippingconsignment.md#city)
+* [company](ordershippingconsignment.md#company)
+* [costExTax](ordershippingconsignment.md#costextax)
+* [costIncTax](ordershippingconsignment.md#costinctax)
+* [costTax](ordershippingconsignment.md#costtax)
+* [costTaxClassId](ordershippingconsignment.md#costtaxclassid)
+* [country](ordershippingconsignment.md#country)
+* [countryCode](ordershippingconsignment.md#countrycode)
+* [customFields](ordershippingconsignment.md#customfields)
+* [email](ordershippingconsignment.md#email)
+* [firstName](ordershippingconsignment.md#firstname)
+* [handlingCostExTax](ordershippingconsignment.md#handlingcostextax)
+* [handlingCostIncTax](ordershippingconsignment.md#handlingcostinctax)
+* [handlingCostTax](ordershippingconsignment.md#handlingcosttax)
+* [handlingCostTaxClassId](ordershippingconsignment.md#handlingcosttaxclassid)
+* [itemsShipped](ordershippingconsignment.md#itemsshipped)
+* [itemsTotal](ordershippingconsignment.md#itemstotal)
+* [lastName](ordershippingconsignment.md#lastname)
+* [lineItems](ordershippingconsignment.md#lineitems)
+* [phone](ordershippingconsignment.md#phone)
+* [postalCode](ordershippingconsignment.md#postalcode)
+* [shippingAddressId](ordershippingconsignment.md#shippingaddressid)
+* [shippingMethod](ordershippingconsignment.md#shippingmethod)
+* [shippingZoneId](ordershippingconsignment.md#shippingzoneid)
+* [shippingZoneName](ordershippingconsignment.md#shippingzonename)
+* [stateOrProvince](ordershippingconsignment.md#stateorprovince)
+
+## Properties
+
+###  address1
+
+• **address1**: *string*
+
+___
+
+###  address2
+
+• **address2**: *string*
+
+___
+
+###  baseCost
+
+• **baseCost**: *number*
+
+___
+
+###  baseHandlingCost
+
+• **baseHandlingCost**: *number*
+
+___
+
+###  city
+
+• **city**: *string*
+
+___
+
+###  company
+
+• **company**: *string*
+
+___
+
+###  costExTax
+
+• **costExTax**: *number*
+
+___
+
+###  costIncTax
+
+• **costIncTax**: *number*
+
+___
+
+###  costTax
+
+• **costTax**: *number*
+
+___
+
+###  costTaxClassId
+
+• **costTaxClassId**: *number*
+
+___
+
+###  country
+
+• **country**: *string*
+
+___
+
+###  countryCode
+
+• **countryCode**: *string*
+
+___
+
+###  customFields
+
+• **customFields**: *Array‹object›*
+
+___
+
+###  email
+
+• **email**: *string*
+
+___
+
+###  firstName
+
+• **firstName**: *string*
+
+___
+
+###  handlingCostExTax
+
+• **handlingCostExTax**: *number*
+
+___
+
+###  handlingCostIncTax
+
+• **handlingCostIncTax**: *number*
+
+___
+
+###  handlingCostTax
+
+• **handlingCostTax**: *number*
+
+___
+
+###  handlingCostTaxClassId
+
+• **handlingCostTaxClassId**: *number*
+
+___
+
+###  itemsShipped
+
+• **itemsShipped**: *number*
+
+___
+
+###  itemsTotal
+
+• **itemsTotal**: *number*
+
+___
+
+###  lastName
+
+• **lastName**: *string*
+
+___
+
+###  lineItems
+
+• **lineItems**: *Array‹object›*
+
+___
+
+###  phone
+
+• **phone**: *string*
+
+___
+
+###  postalCode
+
+• **postalCode**: *string*
+
+___
+
+###  shippingAddressId
+
+• **shippingAddressId**: *number*
+
+___
+
+###  shippingMethod
+
+• **shippingMethod**: *string*
+
+___
+
+###  shippingZoneId
+
+• **shippingZoneId**: *number*
+
+___
+
+###  shippingZoneName
+
+• **shippingZoneName**: *string*
+
+___
+
+###  stateOrProvince
+
+• **stateOrProvince**: *string*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.215.0",
+  "version": "1.215.1",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",