Master API
New Merchant Sub Account
Create a new Standalone Merchant account.
Post Fields
| Field | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| company | Array | Y | Company details | |
| user | Array | N | Optionally create a new user for this merchant. | |
| wms | Array | N | Order Destination Info |
Company Array
| Field | Data Type | Length | Required | Description |
|---|---|---|---|---|
| company | String | 45 | Y | Company Name |
| phone | String | 45 | N | Company Phone Number |
User Array
| Field | Data Type | Length | Required | Description |
|---|---|---|---|---|
| name | String | 45 | Y | User Name |
| String | 255 | Y | User email | |
| password | String | 45 | N | Account activation will be sent if you send the user object with no password. |
| repeat_password | String | 45 | N | Must match the password |
wms Array
| Field | Data Type | Length | Required | Description |
|---|---|---|---|---|
| wms_name | String | Y | Which WMS should be setup? | |
| merchant_params | Array | N | Array of WMS Merchant level param values to set for this merchant. You can get a list of valid values from the merchant section of the /wms/params endpoint. | |
| wms_params | Array | N | Array of WMS level param values to set for this account. You can get a list of valid values from the wms section of the /wms/params endpoint. NOTE: This section only usable by independant Merchant accounts, not ones that belong to a warehouse account. | |
| schedules | Array | N | A list of schedules to update with the keys: order, confirm, inventory. Pass "ON" or "OFF" for each value. |
Array Response Fields
| Field | Data Type | Length | Description |
|---|---|---|---|
| merchant_pk | Int | Unique identifier for this merchant account |
post/v1/master/merchant
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Content-Typestring
Request body */*
string required
Example request
"\"{\\r\\n \\\"company\\\": {\\r\\n \\\"company\\\": \\\"My Company Name\\\",\\r\\n \\\"phone\\\": \\\"1-805-399-2278\\\"\\r\\n },\\r\\n \\\"user\\\": {\\r\\n \\\"name\\\": \\\"Mrs. Bigglesworth\\\",\\r\\n \\\"email\\\": \\\"biggle@evil.com\\\",\\r\\n \\\"password\\\": \\\"Optional Password\\\",\\r\\n \\\"repeat_password\\\": \\\"Optional Password\\\"\\r\\n }\\r\\n}\""Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.