There are a number of methods that can be used on the ShopifyPOS integrations. The following table links to example code, and displays which integrations can access which methods. For the different types of errors that you can expect for these methods, refer to the Errors table.

You can use the following list of standard browser dialogs:

• alert()
• confirm()
• prompt().

They will be styled slightly differently depending on your version of iOS.

Many of the methods in the POS App SDK include support for callback methods that are automatically invoked when the requested action has succeeded or failed. They can be passed to a function in the following format:

Success callbacks receive a single argument, which is different depending on the method invoked. In all of the functions defined on Cart, the argument to success will be the latest state of the cart. Methods that do not pass a Cart back will explicitly state what they pass in the documentation below.

Error callbacks receive a single argument, errors, on invocation. This is an array of Error objects, each of which contains the following keys:

Should be called immediately after the script file has loaded, as early as possible on the page (not in a jQuery.ready() or similar). It will initialize data values, and setup our initializers.

The config hash can contain the following keys:

Works similarly to jQuery's ready() function. It can be called many times on a page, it accepts functions, and when the app is presented in POS, it will call the functions in order.

Dispatches away from the app to a remote URL. The path must be an absolute URL prefixed with http or https. Context will shift from third party (within an iframe) to first party at the end of the redirect until ShopifyPOS.init() is called again.

Displays a message in Shopify POS styled as a notice. Use only for successful or neutral messages. Available in all integrations.

Displays a message in Shopify POS styled as an error. Use only for errors or failures. Available in all integrations.

Corresponds to the user who entered their PIN on the POS. Available in all integrations. The result passed to the success callback is an object with the following properties:

Corresponds to the currently-set location of the POS. Available in all integrations. The result passed to the success callback is an object with the following properties:

Closes the currently open app, and returns the user to Shopify POS.

Retrieves the currently active cart on the POS. Only available in the Edit Cart integration. The result passed to the success callback is an object with the following properties:

Example usage:

Sets a customer on the current cart. This method is available only in the Edit Cart integration. The expected behavior of this method depends on the customer information that's provided.

When providing a customer id from the Shopify Admin API:

• Setting an invalid id will throw an error.
• If an ID is provided, the ID is for an existing customer, and a valid email is provided, then the existing customer email will be updated. If the specified email is already taken by an existing customer, then an error will be thrown.
• If an ID is provided, the ID is for an existing customer, and the first_name, last_name, or note is provided, then the existing customer will be updated with the provided fields.

When providing a customer email without an id:

• Setting a unique email will create a new customer. If the first_name, last_name, or note are provided, then the new customer will have those attributes.
• If the specified email is invalid or already taken by an existing customer, then an error will be thrown.
• If an existing customer email is provided, then setting the first_name, last_name, or note will update the existing customer with the provided fields.

When providing a customer without an id or email:

• Setting a first_name or last_name will create a new customer.
• Since first_name or last_name are not required to be unique, setting a customer with these fields will generate a new customer each time the method is invoked.

Example usage:

Removes the customer on the current cart. Only available in the Edit Cart integration.

Adds a new address for the customer associated with the current cart. This method will fail if there is no customer on the cart. It's available only in the Edit Cart integration.

Example usage:

Updates an address for the customer associated with the current cart. index is the position of the address in cart.customer.addresses, and is required. For the list of valid attributes, see the description of addCustomerAddress(). This method is available only in the Edit Cart integration. Provide null or empty string as values to clear out fields.

Example usage:

Adds a discount to the current cart. Only available in the Edit Cart integration.

Example usage:

Removes the discount on the current cart. Only available in the Edit Cart integration.

Adds String properties to the current cart. These are similar to line item properties, but are applied to the entire cart. This method is available only in the Edit Cart integration. Adding null keys or values will be ignored.

Example usage:

Removes one or more properties from the current cart. propKeys is an array of properties to be removed based on their key. This method is available only in the Edit Cart integration.

Example usage:

Removes all line items, properties, discounts, and customer information from the cart. Only available in the Edit Cart integration.

Adds a new line item to the current cart. Only available in the Edit Cart integration. This method allows you to add a new custom line item to the cart, or update an existing line item quantity if conditions are met:

When adding new line items:

• Product variant: Providing an existing variant_id with quantity will add that variant to the cart and set its quantity.
• Custom sale: Providing price, quantity, title will create a new custom sale line item and add it to the cart.

When updating existing line items:

• Product variant: Providing an existing variant_id (already in the cart), and quantity will increment the line item's quantity.
• Custom sale: Providing an existing price and title will increment the line item's quantity.

Example usage:

Updates an existing line item quantity in the cart. index is the position of the line item in cart.line_items and is required. We only support updating the quantity for line items in the cart. You must add a new custom sale line item that is a duplicate of an existing cart line item if you wish to change the price and title, then manually remove the duplicated (outdated) line item from the cart. See the description of addLineItem() for the list of valid attributes. Only available in the Edit Cart integration.

Example usage:

Removes an existing item from the cart. index is the position of the line item in cart.line_items and is required. Only available in the Edit Cart integration.

Example usage:

Sets the discount on a line item in the current cart. index is the position of the line item in cart.line_items and is required. Only available in the Edit Cart integration.

Example usage:

Removes a line item discount in the current cart. index is the position of the line item in cart.line_items, and is required. This method is available only in the Edit Cart integration.

Adds a String property to a given line item in the current cart. index is the position of the line item in cart.line_items, and is required. This method is available only in the Edit Cart integration. Adding null keys or values will be ignored.

Example usage:

Removes a property from a given line item in the current cart. index is the position of the line item in cart.line_items and is required. propKeys is an array of properties to be removed based on their key. Only available in the Edit Cart integration.

Example usage: