Merchant API
New Cart
Set up a new Order Source connection to CartRover
Post Fields
| Field | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| cart_id | String | Y | Which cart to set up. See /cart/listall | |
| user_key | String | N | User name/id for this API connection, if needed. | |
| password | String | N | User password for this API connection, if needed. | |
| server_id | String | 250 | N | Server URL for this connection, if needed. |
| description | String | 100 | N | Optional brief description for this connection |
| extra_params | Array | Array of additional settings to set for this cart. You can get a list of valid settings for each cart from the /cart/listall endpoint and valid WMS options from the /wms/params endpoint. | ||
| schedules | Array | A list of schedules to set with the keys: order, confirm, inventory. Pass "ON" or "OFF" for each value. |
Array Response Fields
| Field | Data Type | Length | Description |
|---|---|---|---|
| order_source | String | Order Source assigned to this connection | |
| oauth_link | String | If this connection requires the user to grant access using oauth, it will be provided here. | |
| test_success | Boolean | Did we successfully connect to the cart. | |
| test_message | String | A testing result message will be returned. It may be an error message, or brief instructions if additional setup is needed. | |
| extra_params | Array | List of all params set and their values, even if they are the system default. | |
| schedules | Array | List of service schedules: order, confirm, inventory. A value of 0 is OFF, anything else means ON. |
post/v1/cart/new
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
object required
Example request
{
"cart_id": "Amazon_US",
"user_key": "123AMAZONSELLERID456",
"password": "123MWSAUTHTOKEN456",
"description": "USA Seller Fulfilled",
"schedules": {
"order": "OFF",
"confirm": "ON",
"inventory": "ON"
},
"extra_params": {
"item_field": "ASIN",
"refund_delay": "N",
"prime_ship_code": "PrimeOrder"
}
}Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.