Shopify SDK for Unity
Public Member Functions | Static Public Attributes | Properties | List of all members
Shopify.Unity.CheckoutCreateInput Class Reference

Specifies the fields required to create a checkout. More...

Inheritance diagram for Shopify.Unity.CheckoutCreateInput:
Shopify.Unity.SDK.InputBase

Public Member Functions

 CheckoutCreateInput (string email=null, List< CheckoutLineItemInput > lineItems=null, MailingAddressInput shippingAddress=null, string note=null, List< AttributeInput > customAttributes=null, bool? allowPartialAddresses=null, CurrencyCode? presentmentCurrencyCode=null)
 
 CheckoutCreateInput (Dictionary< string, object > dataJSON)
 
- Public Member Functions inherited from Shopify.Unity.SDK.InputBase
override string ToString ()
 Returns a string representing a GraphQL input object. More...
 

Static Public Attributes

const string emailFieldKey = "email"
 
const string lineItemsFieldKey = "lineItems"
 
const string shippingAddressFieldKey = "shippingAddress"
 
const string noteFieldKey = "note"
 
const string customAttributesFieldKey = "customAttributes"
 
const string allowPartialAddressesFieldKey = "allowPartialAddresses"
 
const string presentmentCurrencyCodeFieldKey = "presentmentCurrencyCode"
 

Properties

string email [get, set]
 The email with which the customer wants to checkout. More...
 
List< CheckoutLineItemInputlineItems [get, set]
 A list of line item objects, each one containing information about an item in the checkout. More...
 
MailingAddressInput shippingAddress [get, set]
 The shipping address to where the line items will be shipped. More...
 
string note [get, set]
 The text of an optional note that a shop owner can attach to the checkout. More...
 
List< AttributeInputcustomAttributes [get, set]
 A list of extra information that is added to the checkout. More...
 
bool? allowPartialAddresses [get, set]
 Allows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of addresses is still done at complete time. More...
 
CurrencyCode?? presentmentCurrencyCode [get, set]
 The three-letter currency code of one of the shop's enabled presentment currencies. Including this field creates a checkout in the specified currency. By default, new checkouts are created in the shop's primary currency. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Shopify.Unity.SDK.InputBase
void Set (string key, object value)
 
object Get (string key)
 

Detailed Description

Specifies the fields required to create a checkout.

Constructor & Destructor Documentation

◆ CheckoutCreateInput() [1/2]

Shopify.Unity.CheckoutCreateInput.CheckoutCreateInput ( string  email = null,
List< CheckoutLineItemInput lineItems = null,
MailingAddressInput  shippingAddress = null,
string  note = null,
List< AttributeInput customAttributes = null,
bool?  allowPartialAddresses = null,
CurrencyCode presentmentCurrencyCode = null 
)
inline
Parameters
emailThe email with which the customer wants to checkout.
lineItemsA list of line item objects, each one containing information about an item in the checkout.
shippingAddressThe shipping address to where the line items will be shipped.
noteThe text of an optional note that a shop owner can attach to the checkout.
customAttributesA list of extra information that is added to the checkout.
allowPartialAddressesAllows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of addresses is still done at complete time.
presentmentCurrencyCodeThe three-letter currency code of one of the shop's enabled presentment currencies. Including this field creates a checkout in the specified currency. By default, new checkouts are created in the shop's primary currency.

◆ CheckoutCreateInput() [2/2]

Shopify.Unity.CheckoutCreateInput.CheckoutCreateInput ( Dictionary< string, object >  dataJSON)
inline
Parameters
emailThe email with which the customer wants to checkout.
lineItemsA list of line item objects, each one containing information about an item in the checkout.
shippingAddressThe shipping address to where the line items will be shipped.
noteThe text of an optional note that a shop owner can attach to the checkout.
customAttributesA list of extra information that is added to the checkout.
allowPartialAddressesAllows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of addresses is still done at complete time.
presentmentCurrencyCodeThe three-letter currency code of one of the shop's enabled presentment currencies. Including this field creates a checkout in the specified currency. By default, new checkouts are created in the shop's primary currency.

Property Documentation

◆ allowPartialAddresses

bool? Shopify.Unity.CheckoutCreateInput.allowPartialAddresses
getset

Allows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of addresses is still done at complete time.

◆ customAttributes

List<AttributeInput> Shopify.Unity.CheckoutCreateInput.customAttributes
getset

A list of extra information that is added to the checkout.

◆ email

string Shopify.Unity.CheckoutCreateInput.email
getset

The email with which the customer wants to checkout.

◆ lineItems

List<CheckoutLineItemInput> Shopify.Unity.CheckoutCreateInput.lineItems
getset

A list of line item objects, each one containing information about an item in the checkout.

◆ note

string Shopify.Unity.CheckoutCreateInput.note
getset

The text of an optional note that a shop owner can attach to the checkout.

◆ presentmentCurrencyCode

CurrencyCode?? Shopify.Unity.CheckoutCreateInput.presentmentCurrencyCode
getset

The three-letter currency code of one of the shop's enabled presentment currencies. Including this field creates a checkout in the specified currency. By default, new checkouts are created in the shop's primary currency.

◆ shippingAddress

MailingAddressInput Shopify.Unity.CheckoutCreateInput.shippingAddress
getset

The shipping address to where the line items will be shipped.


The documentation for this class was generated from the following file: