Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 998 Bytes

orderrequestbody.md

File metadata and controls

37 lines (22 loc) · 998 Bytes

@bigcommerce/checkout-sdkOrderRequestBody

Interface: OrderRequestBody

An object that contains the information required for submitting an order.

Hierarchy

  • OrderRequestBody

Index

Properties

Properties

Optional payment

payment? : OrderPaymentRequestBody

An object that contains the payment details of a customer. In some cases, you can omit this object if the order does not require further payment. For example, the customer is able to use their store credit to pay for the entire order. Or they have already submitted their payment details using PayPal.


Optional useStoreCredit

useStoreCredit? : undefined | false | true

If true, apply the store credit of the customer to the order. It only works if the customer has previously signed in.