{"_id":"5beec5a5f95d82011c6f36b7","category":{"_id":"5beec5a5f95d82011c6f367e","version":"5beec5a5f95d82011c6f3714","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5beec5a5f95d82011c6f3714","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf37dfadc5b905136a39f4","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5beec5a5f95d82011c6f3672","5beec5a5f95d82011c6f3673","5beec5a5f95d82011c6f3674","5beec5a5f95d82011c6f3675","5beec5a5f95d82011c6f3676","5beec5a5f95d82011c6f3677","5beec5a5f95d82011c6f3678","5beec5a5f95d82011c6f3679","5beec5a5f95d82011c6f367a","5beec5a5f95d82011c6f367b","5beec5a5f95d82011c6f367c","5beec5a5f95d82011c6f367d","5beec5a5f95d82011c6f367e","5beec5a5f95d82011c6f367f","5beec5a5f95d82011c6f3680","5beec5a5f95d82011c6f3681"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-28T16:18:48.747Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":50,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"commission-percent\",\n    \"1-0\": \"account-status\",\n    \"0-1\": \"decimal\",\n    \"1-1\": \"string\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"Optional\",\n    \"0-3\": \"Defines the vendor's commission percentage for marketplace transactions. \\n\\nThis value should be between 0-100.\",\n    \"1-3\": \"Indicates vendor [account status](/docs/vendor-onboarding#section-account-status). \\n\\nPossible values:\\n**ACTIVE**\\n**INACTIVE**\",\n    \"2-0\": \"recurring-commission\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Indicates if commissions will be included as part of a recurring transaction (subscription)\\n\\nValid values:\\n**Y**\\n**N**\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"commission-percent\",\n    \"0-1\": \"decimal\",\n    \"1-0\": \"account-status\",\n    \"1-1\": \"string\",\n    \"0-2\": \"Indicates commission value set as a value between 0-100\",\n    \"1-2\": \"Indicates vendor [account status](/docs/vendor-onboarding#section-account-status). \\n\\nValues returned:\\n**ACTIVE**\\n**INACTIVE**\",\n    \"2-0\": \"recurring-commission\",\n    \"2-1\": \"string\",\n    \"2-2\": \"be included as part of a recurring transaction (subscription)\\n\\nValid values:\\n**Y**\\n**N**\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"vendor-agreement","type":"basic","title":"vendor-agreement"}

Request

Property Name
Type
Required
Description

commission-percent

decimal

Required

Defines the vendor's commission percentage for marketplace transactions.

This value should be between 0-100.

account-status

string

Optional

Indicates vendor account status.

Possible values:
ACTIVE
INACTIVE

recurring-commission

string

Optional

Indicates if commissions will be included as part of a recurring transaction (subscription)

Valid values:
Y
N

Response

Property Name
Type
Description

commission-percent

decimal

Indicates commission value set as a value between 0-100

account-status

string

Indicates vendor account status.

Values returned:
ACTIVE
INACTIVE

recurring-commission

string

be included as part of a recurring transaction (subscription)

Valid values:
Y
N