Create Merchant Configs - Checkout and Cart

Use these endpoints to set Configs related to Checkout and Cart preferences

👍

This endpoint uses HMAC with SHA-256

Check out our API Authentication section to learn more

To Add Merchant Configurations to a Skipify Merchant Account, send an API call to:

Staging: POST https://stage-merchants.skipify.com/merchants/{MerchantId}/configs

Production: POST https://merchants.skipify.com/merchants/{MerchantId}/configs

Create Merchant Branding Config

Use this configuration to set the merchant's Display Name for Shoppers if different than their business name, Add a Logo and color scheme for checkout orders for this merchant.

Request Body Parameters

Parameter NameRequiredTypeDescription/Value
nameyesstringMERCHANT_BRANDING
enabledyesbooleantrue
valueyesarrayAn array containing the merchant branding parameters

Value array Body Parameters

Parameter NameRequiredTypeDescription/Value
displayNamenostringName you want displayed to shoppers for this merchant if different than the business Name
logoSrcnostring/URIA valid URl where the merchant logo can be accessed
colornostringHex Color Code i.e. #000000
useLogoForPurchaseDetailsnobooleanDisplay the logo for purchase details or not.

Request Body Example

{
    "name": "MERCHANT_BRANDING",
    "enabled": true,
    "value": {
        "displayName": "string", // Optional
        "logoSrc": "string", // Optional should be a valid URL
        "color": "string", // Optional should be a color code ex. #000000
        "useLogoForPurchaseDetails": boolean // Optional
  }
}

API Response

Response Body Parameters

Parameter NameTypeDescription
enabledbooleanIs this Config enabled?
namestringThe name of this Config, i.e. - "MERCHANT_BRANDING"
valuearrayAn array containing the merchant branding parameters
typestringThe type of config this is, i.e. "Checkout"
configIdstringThe UniqueId for this configuration
createdAtstring, dateTimeThe created date/time for this configuration
Ex:
`2024-06-02T21:48:02Z
updatedAtstring, dateTimeThe date/time this configuration was last updated
Ex:
`2024-06-03T21:48:02Z

Response Body Example

{
    "enabled": true,
    "name": "MERCHANT_BRANDING",
    "value": {
        "displayName": "The Best Business",
        "logoSrc": "https://url.com"
        "color": "#000000",
        "useLogoForPurchaseDetails": true
    },
    "type": "checkout",
    "configId": "string",
    "merchantId": "string",
    "createdAt": "2024-05-25T17:02:24.240Z",
    "updatedAt": "2024-05-25T17:02:24.240Z"
}

Create Terms Links Config

Use this configuration to set links (URLs) to the merchant's specific Privacy Policy, Terms and Conditions and Terms of Use if applicable.

Request Body Parameters

Parameter NameRequiredTypeDescription/Value
nameyesstringTERMS_LINKS
enabledyesbooleantrue
valueyesarrayAn array containing the Terms Links parameters

Value array Body Parameters

Parameter NameRequiredTypeDescription/Value
privacyPolicy {"url": }nostringThe URL for the merchant's Privacy Policy
termsAndConditions {url": }nostringThe URL for the merchant's Terms and Conditions
termsOfUse {"url": }nostringThe URL for the merchant's Terms of Use

Note: The links require approval by Skipify once configured before they will take affect. Please contact your Skipify Implementation Engineer if setting Terms Links so approval can be completed appropriately.

Request Body Example

{
    "name": "TERMS_LINKS",
    "enabled": true,
    "value": {
        "privacyPolicy": { // Optional
        "url": "string" // Should be a valid URL
        },
        "termsAndConditions": { // Optional
        "url": "string" // Should be a valid URL
        },
        "termsOfUse": { // Optional
        "url": "string" // Should be a valid URL
        }
}
}

API Response

Response Body Parameters

Parameter NameTypeDescription
merchantIdstringThe Skipify Merchant Identifier
namestringThe Name of the Configuration
valuearray, integersThe values of terms links
typestring, nullableThe Type of configuration if applicable
enabledbooleanThe current status of the configuration
schemaVersionintegerThe version of the schema
isDeletedbooleanIs this configuration active or not
configIdstringthe Id of this configuration
createdAtstring, dateTimeThe created date/time for this configuration
Ex:
`2024-06-02T21:48:02Z
updatedAtstring, dateTimeThe date/time this configuration was last updated
Ex:
`2024-06-02T21:48:02Z

Response Body Example

{
    "merchantId": "string",
    "name": "TERMS_LINKS",
     "value": {
        "privacyPolicy": 
        "url": "string" 
        },
        "termsAndConditions": { 
        "url": "string" 
        },
        "termsOfUse": { 
        "url": "string" 
        }
    "enabled": true,
    "schemaVersion": 1,
    "isDeleted": false,
 	  "configId": "string",
    "createdAt": "2024-04-26T19:54:07.050Z",
    "updatedAt": "2024-04-26T19:54:07.050Z",
    
    "__v": 0
}

Create Disallow Cart Edits Config

Use this configuration to prevent shoppers from editing their cart quantity within the Skipify experience.

Request Body Parameters

Parameter NameRequiredTypeDescription/Value
nameyesstringDISALLOW_CART_EDITS
enabledyesbooleantrue
valueyesbooleantrue

Note* - This Configuration is set if you do not want to allow the Shopper to edit their cart after the Skipify modal has been triggered.

Request Body Example

{
    "name": "DISALLOW_CART_EDITS",
    "enabled": true,
    "value": true
}

API Response

Response Body Parameters

Parameter NameTypeDescription
merchantIdstringThe Skipify Merchant Identifier
namestringThe Name of the Configuration
valuebooleanThe Value of the Configuration
typestring, nullableThe Type of configuration if applicable
enabledbooleanThe current status of the configuration
schemaversionintegerThe version of the schema
isDeletedbooleanIs this configuration active or not
_idstringThe id of this request
configIdstringthe Id of this configuratoin
createdAtstring, dateTimeThe created date/time for this configuration
Ex:
`2024-06-02T21:48:02Z
updatedAtstring, dateTimeThe date/time this configuration was last updated
Ex:
`2024-06-02T21:48:02Z
_vinteger0

Response Body Example

{
    "merchantId": "string",
    "name": "DISALLOW_CART_EDITS",
    "value": true,
    "type": null,
    "enabled": true,
    "schemaVersion": 1,
    "isDeleted": false,
    "_id": "string",
    "configId": "string",
    "createdAt": "2024-04-24T23:24:36.479Z",
    "updatedAt": "2024-04-24T23:24:36.479Z",
 
}