Documentation
Documentation
    • English (United States)
Shopify Integration
Close API Documentation
Shopify Integration

A Shopify Integration allows to connect a Shopify shop.

States
  • Create
    The create state indicates that the Shopify Integration is in creation.
  • Active
    The active state indicates that the Shopify Integration is active and may be used.
  • Inactive
    The inactive state indicates that the Shopify Integration is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Shopify Integration is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Additional Line Item Data
  • Allow Invoice Download
  • Allowed Payment Method Configurations
  • Checkout Language
    The checkout language forces a specific language in the checkout. Without a checkout language the browser setting of the buyer is used to determine the language.
  • Currency
  • ID
    A unique identifier for the object.
  • Integrated Payment Form
    Enabling the integrated payment form will embed the payment form in the Shopify shop. The app needs to be installed for this to be possible.
  • Integration Name
    The integration name is used internally to identify a specific integration.For example the name is used withinsearch fields and hence it should be distinct and descriptive.
  • Login Name
    The login name is used to link a specific Shopify payment gateway to this integration.This login name is to be filled into the appropriate field in the shop's payment gateway configuration.
  • Payment App Proxy Path
    Define the path of the proxy URL. This only needs to be changed if the app's proxy URL is overwritten in the Shopify store.
  • Payment App Version
  • Payment Installed
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Replace Payment Method Image
  • Show Payment Information
  • Show Subscription Information
  • Space Id
  • Space View ID
    The ID of the space view this object is linked to.
  • State
    The object's current state.
  • Store Address
    The store address is used to link a specific Shopify shop to this integration. This is the name used in the Shopify's admin URL: [storeAddress].myshopify.com
  • Subscription App Proxy Path
    Define the path of the proxy URL. This only needs to be changed if the app's proxy URL is overwritten in the Shopify store.
  • Subscription App Version
  • Subscription Installed
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.