ConsignmentSelector.md

@bigcommerce/checkout-sdk / ConsignmentSelector

Interface: ConsignmentSelector

Table of contents

Methods

• getConsignmentByAddress
• getConsignmentById
• getConsignments
• getConsignmentsOrThrow
• getCreateError
• getDeleteError
• getItemAssignmentError
• getLoadError
• getLoadShippingOptionsError
• getShippingOption
• getUnassignedItems
• getUpdateError
• getUpdateShippingOptionError
• isAssigningItems
• isCreating
• isDeleting
• isLoading
• isLoadingShippingOptions
• isUpdating
• isUpdatingShippingOption

Methods

getConsignmentByAddress

▸ getConsignmentByAddress(address): undefined | Consignment

Parameters

Name	Type
address	AddressRequestBody

Returns

undefined | Consignment

---

getConsignmentById

▸ getConsignmentById(id): undefined | Consignment

Parameters

Name	Type
id	string

Returns

undefined | Consignment

---

getConsignments

▸ getConsignments(): undefined | Consignment[]

Returns

undefined | Consignment[]

---

getConsignmentsOrThrow

▸ getConsignmentsOrThrow(): Consignment[]

Returns

Consignment[]

---

getCreateError

▸ getCreateError(): undefined | Error

Returns

undefined | Error

---

getDeleteError

▸ getDeleteError(consignmentId?): undefined | Error

Parameters

Name	Type
consignmentId?	string

Returns

undefined | Error

---

getItemAssignmentError

▸ getItemAssignmentError(address): undefined | Error

Parameters

Name	Type
address	AddressRequestBody

Returns

undefined | Error

---

getLoadError

▸ getLoadError(): undefined | Error

Returns

undefined | Error

---

getLoadShippingOptionsError

▸ getLoadShippingOptionsError(): undefined | Error

Returns

undefined | Error

---

getShippingOption

▸ getShippingOption(): undefined | ShippingOption

Returns

undefined | ShippingOption

---

getUnassignedItems

▸ getUnassignedItems(): PhysicalItem[]

Returns

PhysicalItem[]

---

getUpdateError

▸ getUpdateError(consignmentId?): undefined | Error

Parameters

Name	Type
consignmentId?	string

Returns

undefined | Error

---

getUpdateShippingOptionError

▸ getUpdateShippingOptionError(consignmentId?): undefined | Error

Parameters

Name	Type
consignmentId?	string

Returns

undefined | Error

---

isAssigningItems

▸ isAssigningItems(address): boolean

Parameters

Name	Type
address	AddressRequestBody

Returns

boolean

---

isCreating

▸ isCreating(): boolean

Returns

boolean

---

isDeleting

▸ isDeleting(consignmentId?): boolean

Parameters

Name	Type
consignmentId?	string

Returns

boolean

---

isLoading

▸ isLoading(): boolean

Returns

boolean

---

isLoadingShippingOptions

▸ isLoadingShippingOptions(): boolean

Returns

boolean

---

isUpdating

▸ isUpdating(consignmentId?): boolean

Parameters

Name	Type
consignmentId?	string

Returns

boolean

---

isUpdatingShippingOption

▸ isUpdatingShippingOption(consignmentId?): boolean

Parameters

Name	Type
consignmentId?	string

Returns

boolean