Merchant API
Edit Merchant
Edit merchant info including name, wms parameters, and schedules. Any fields left off will be left as-is.
Post Fields
| Field | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| name | String | 80 | Y | Name of Merchant |
| 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 field only usable by independant Merchant accounts, not ones that belong to a warehouse account. | |
| wms_name | String | N | Change which WMS System to connect this account to. NOTE: This field 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. | |
| discontinued | Boolean | N | true to discontinue Merchant. false to re-enable merchant. |
post/v1/merchant/edit
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 \\\"name\\\": \\\"Test API Merch\\\",\\r\\n \\\"wms_params\\\": {\\r\\n \\t\\\"ownerCode\\\": \\\"123\\\"\\r\\n }\\r\\n}\""Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.