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 Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | MERCHANT_BRANDING |
| enabled | yes | boolean | true |
| value | yes | array | An array containing the merchant branding parameters |
Value array Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| displayName | no | string | Name you want displayed to shoppers for this merchant if different than the business Name |
| logoSrc | no | string/URI | A valid URl where the merchant logo can be accessed |
| color | no | string | Hex Color Code i.e. #000000 |
| useLogoForPurchaseDetails | no | boolean | Display 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 Name | Type | Description |
|---|---|---|
| enabled | boolean | Is this Config enabled? |
| name | string | The name of this Config, i.e. - "MERCHANT_BRANDING" |
| value | array | An array containing the merchant branding parameters |
| type | string | The type of config this is, i.e. "Checkout" |
| configId | string | The UniqueId for this configuration |
| createdAt | string, dateTime | The created date/time for this configuration Ex: `2024-06-02T21:48:02Z |
| updatedAt | string, dateTime | The 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 Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | TERMS_LINKS |
| enabled | yes | boolean | true |
| value | yes | array | An array containing the Terms Links parameters |
Value array Body Parameters
| Parameter Name | Required | Type | Description/Value |
|---|---|---|---|
| privacyPolicy {"url": } | no | string | The URL for the merchant's Privacy Policy |
| termsAndConditions {url": } | no | string | The URL for the merchant's Terms and Conditions |
| termsOfUse {"url": } | no | string | The 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 Name | Type | Description |
|---|---|---|
| merchantId | string | The Skipify Merchant Identifier |
| name | string | The Name of the Configuration |
| value | array, integers | The values of terms links |
| type | string, nullable | The Type of configuration if applicable |
| enabled | boolean | The current status of the configuration |
| schemaVersion | integer | The version of the schema |
| isDeleted | boolean | Is this configuration active or not |
| configId | string | the Id of this configuration |
| createdAt | string, dateTime | The created date/time for this configuration Ex: `2024-06-02T21:48:02Z |
| updatedAt | string, dateTime | The 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 Name | Required | Type | Description/Value |
|---|---|---|---|
| name | yes | string | DISALLOW_CART_EDITS |
| enabled | yes | boolean | true |
| value | yes | boolean | true |
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 Name | Type | Description |
|---|---|---|
| merchantId | string | The Skipify Merchant Identifier |
| name | string | The Name of the Configuration |
| value | boolean | The Value of the Configuration |
| type | string, nullable | The Type of configuration if applicable |
| enabled | boolean | The current status of the configuration |
| schemaversion | integer | The version of the schema |
| isDeleted | boolean | Is this configuration active or not |
| _id | string | The id of this request |
| configId | string | the Id of this configuratoin |
| createdAt | string, dateTime | The created date/time for this configuration Ex: `2024-06-02T21:48:02Z |
| updatedAt | string, dateTime | The date/time this configuration was last updated Ex: `2024-06-02T21:48:02Z |
| _v | integer | 0 |
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",
}
Updated about 1 month ago
What’s Next