Merchants API
The Merchants API is used to store information about a merchant (retailer), their stores and their staff. This functionality is useful for defining inventory locations and for when The Wishlist Platform is extended into the stores, as retailers can attribute actions to particular stores and staff and analyse performance of stores and staff.
Index
- Merchants API
- Index
- Representations
- REST Endpoints
- Merchant Resource
- Register Merchant
- Update Merchant
- Deactivate Merchant
- Find Merchant
- Plan Resource
- Create a Plan
- Update a Plan
- Delete a Plan
- Find Plan
- Find All Plans
- Store Resource
- Create a Store
- Update a Store
- Find a Store
- Find a Store
- Deactivate Store
- Create Subscription plan
- Update Subscription plan
- Cancel Subscription plan
- Store Config Resource
- Get Additional Config
- Get All Config
- Get Entity Config
- Get Store Tenant Config
- Create Additional Config
- Update Additional Config
- Create App Config Entity Config
- Update App Config Entity Config
- Create Customer Entity Config
- Update Customer Entity Config
- Create Email Template Entity Config
- Update Email Template Entity Config
- Create Inventory Entity Config
- Update Inventory Entity Config
- Create Location Entity Config
- Update Location Entity Config
- Create Order Entity Config
- Update Order Entity Config
- Create Price Entity Config
- Update Price Entity Config
- Create Product Entity Config
- Update Product Entity Config
- Create Store Entity Config
- Update Store Entity Config
- Create Wishlist Entity Config
- Update Wishlist Entity Config
- Get Notification Config
- Create Notification Config
- Create BackInStock Notification Settings
- Update BackInStock Notification Settings
- Delete BackInStock Notification Settings
- Create LowInStock Notification Settings
- Update LowInStock Notification Settings
- Delete LowInStock Notification Settings
- Create PriceDrop Notification Settings
- Update PriceDrop Notification Settings
- Delete PriceDrop Notification Settings
- Create ReminderEmail Notification Settings
- Update ReminderEmail Notification Settings
- Delete ReminderEmail Notification Settings
Representations
All requests or responses are JSON objects.
activated_date
- Datetime
active
- boolean - to indicate the merchant is active or not
admin_email
- string - admin email details
company_code
- string
billing_address
- string
contact_address
- string
contact_person
- string
created_at
- Datetime
deleted
- boolean
deleted_date
- Datetime
id
- string
merchant_name
- string
modified_by
- string
trading_as
- string
updated_at
- Datetime
plan_name
- string
id
- string
name
- string
id
- string
request_limit
-number -admin email details
amount
-number
currency_code
- string
deactivated_at
- Datetime
deactivated
- boolean - to indicate the merchant is active or not
default_country
- string
media_url
- string
merchant_id
- string
plan_id
- string
store_key
- string
created_at
- Datetime
deleted
- boolean
deleted_date
- Datetime
id
- string
store_name
- string
modified_by
- string
store_state
- string
store_url
- string
targeted_countries
- string
updated_at
- Datetime
backInStockThreshold
- Minimum stock level valve where a product or variant is considered to be back in stock at store level.
lowStockThreshold
- Minimum stock level valve where a product or variant is considered to be in low stock at store level.
REST Endpoints
Merchant Resource
Register Merchant
Register a merchant (retailer)
Method: POST
Endpoint: /api/v1/merchant
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Sample Request :
{
"activated_date": "2022-06-20T15:40:14.465Z",
"active": true,
"admin_email": "string",
"attributes": [
{
"attribute_group": "string",
"attributes": [
{
"attribute_name": "string",
"attribute_value": "string",
"value_type": "INTEGER"
}
],
"is_obsolete": true
}
],
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"company_code": "string",
"contact_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"contact_person": {
"additional_notes": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"created_at": "2022-06-20T15:40:14.465Z",
"deleted": true,
"deleted_date": "2022-06-20T15:40:14.465Z",
"id": "string",
"merchant_name": "string",
"modified_by": "string",
"trading_as": "string",
"updated_at": "2022-06-20T15:40:14.465Z"
}
{
"activated_date": "2022-06-27T09:02:43.112Z",
"active": true,
"admin_email": "string",
"attributes": [
{
"attribute_group": "string",
"attributes": [
{
"attribute_name": "string",
"attribute_value": "string",
"value_type": "INTEGER"
}
],
"is_obsolete": true
}
],
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"company_code": "string",
"contact_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"contact_person": {
"additional_notes": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"created_at": "2022-06-27T09:02:43.112Z",
"deleted": true,
"deleted_date": "2022-06-27T09:02:43.112Z",
"id": "string",
"merchant_name": "string",
"modified_by": "string",
"trading_as": "string",
"updated_at": "2022-06-27T09:02:43.112Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Merchant
Update the meta fileds for a Merchant (retailer)
Method: PUT
Endpoint: /api/v1/merchant
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Sample Request :
{
"activated_date": "2022-06-20T16:04:31.656Z",
"active": true,
"admin_email": "string",
"attributes": [
{
"attribute_group": "string",
"attributes": [
{
"attribute_name": "string",
"attribute_value": "string",
"value_type": "INTEGER"
}
],
"is_obsolete": true
}
],
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"company_code": "string",
"contact_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"contact_person": {
"additional_notes": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"created_at": "2022-06-20T16:04:31.656Z",
"deleted": true,
"deleted_date": "2022-06-20T16:04:31.656Z",
"id": "string",
"merchant_name": "string",
"modified_by": "string",
"trading_as": "string",
"updated_at": "2022-06-20T16:04:31.656Z"
}
{
"activated_date": "2022-06-27T09:15:10.775Z",
"active": true,
"admin_email": "string",
"attributes": [
{
"attribute_group": "string",
"attributes": [
{
"attribute_name": "string",
"attribute_value": "string",
"value_type": "INTEGER"
}
],
"is_obsolete": true
}
],
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"company_code": "string",
"contact_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"contact_person": {
"additional_notes": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"created_at": "2022-06-27T09:15:10.775Z",
"deleted": true,
"deleted_date": "2022-06-27T09:15:10.775Z",
"id": "string",
"merchant_name": "string",
"modified_by": "string",
"trading_as": "string",
"updated_at": "2022-06-27T09:15:10.775Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Deactivate Merchant
Deactivate a merchant (retailer)
Endpoint: /api/v1/merchant/{id}/deactivate
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: id : Merchant Id
{
"activated_date": "2022-06-27T09:16:52.246Z",
"active": true,
"admin_email": "string",
"attributes": [
{
"attribute_group": "string",
"attributes": [
{
"attribute_name": "string",
"attribute_value": "string",
"value_type": "INTEGER"
}
],
"is_obsolete": true
}
],
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"company_code": "string",
"contact_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"contact_person": {
"additional_notes": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"created_at": "2022-06-27T09:16:52.246Z",
"deleted": true,
"deleted_date": "2022-06-27T09:16:52.246Z",
"id": "string",
"merchant_name": "string",
"modified_by": "string",
"trading_as": "string",
"updated_at": "2022-06-27T09:16:52.246Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Merchant
Find a merchant (retailer)
Endpoint: /api/v1/merchant/{id}
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: id : Mechant Id
{
"activated_date": "2022-06-27T09:18:12.280Z",
"active": true,
"admin_email": "string",
"attributes": [
{
"attribute_group": "string",
"attributes": [
{
"attribute_name": "string",
"attribute_value": "string",
"value_type": "INTEGER"
}
],
"is_obsolete": true
}
],
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"company_code": "string",
"contact_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"email": "string",
"is_address": true,
"is_default_address": true,
"phone": "string",
"postal_code": "string",
"state_or_province_code": "string",
"state_or_province_name": "string",
"street": "string",
"street_number": "string",
"unit": "string"
},
"contact_person": {
"additional_notes": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phone": "string"
},
"created_at": "2022-06-27T09:18:12.280Z",
"deleted": true,
"deleted_date": "2022-06-27T09:18:12.280Z",
"id": "string",
"merchant_name": "string",
"modified_by": "string",
"trading_as": "string",
"updated_at": "2022-06-27T09:18:12.280Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Plan Resource
Create a Plan
Create a subscription plan for The Wishlist platform
Endpoint: /api/v1/plan/
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Sample Request:
{
"id": "string",
"plan_name": "string",
"plan_type": {
"id": "string",
"name": "string",
"request_limit": 0
},
"subscription_price": {
"amount": 0,
"currency_code": "string"
}
}
{
"id": "string",
"plan_name": "string",
"plan_type": {
"id": "string",
"name": "string",
"request_limit": 0
},
"subscription_price": {
"amount": 0,
"currency_code": "string"
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update a Plan
Update the subscription plan for The Wishlist platform
Endpoint: /api/v1/plan/
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Sample Request:
{
"id": "string",
"plan_name": "string",
"plan_type": {
"id": "string",
"name": "string",
"request_limit": 0
},
"subscription_price": {
"amount": 0,
"currency_code": "string"
}
}
{
"id": "string",
"plan_name": "string",
"plan_type": {
"id": "string",
"name": "string",
"request_limit": 0
},
"subscription_price": {
"amount": 0,
"currency_code": "string"
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete a Plan
Delete a subscription plan
Endpoint: /api/v1/plan/{planId}/
Method: DELETE
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: planId : unique Plan Id
{
"id": "string",
"plan_name": "string",
"plan_type": {
"id": "string",
"name": "string",
"request_limit": 0
},
"subscription_price": {
"amount": 0,
"currency_code": "string"
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Plan
Find a subscription plan in The Wishlist platform
Endpoint: /api/v1/plan/{planId}/
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: planId : Unique plan Id
{
"id": "string",
"plan_name": "string",
"plan_type": {
"id": "string",
"name": "string",
"request_limit": 0
},
"subscription_price": {
"amount": 0,
"currency_code": "string"
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Find All Plans
Returns an array of all subscription plans in the TWC platform.
Endpoint: /api/v1/plans/
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
[
{
"id": "string",
"plan_name": "string",
"plan_type": {
"id": "string",
"name": "string",
"request_limit": 0
},
"subscription_price": {
"amount": 0,
"currency_code": "string"
}
}
]
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Store Resource
Create a Store
Use this API to create a store. A store belongs to a merchant.
Endpoint: /api/v1/store
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Sample Request:
{
"created_at": "2022-06-20T15:55:58.309Z",
"deactivated": true,
"deactivated_at": "2022-06-20T15:55:58.309Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-20T15:55:58.309Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-20T15:55:58.309Z"
}
{
"created_at": "2022-06-27T09:27:20.501Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:27:20.501Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:27:20.501Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:27:20.501Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update a Store
Update a store belonging to a merchant.
Endpoint: /api/v1/store/{id}
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Sample Request:
{
"created_at": "2022-06-20T16:26:50.951Z",
"deactivated": true,
"deactivated_at": "2022-06-20T16:26:50.951Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-20T16:26:50.951Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-20T16:26:50.951Z"
}
{
"created_at": "2022-06-27T09:29:01.615Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:29:01.615Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:29:01.615Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:29:01.615Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Store
Find a store belonging to a merchant.
Endpoint: /api/v1/store
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,storeKey: store key
{
"created_at": "2022-06-27T09:29:40.889Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:29:40.889Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:29:40.889Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:29:40.889Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get a Store
Endpoint: /api/v1/store/{storeId}
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id
{
"created_at": "2022-06-27T09:30:48.827Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:30:48.827Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:30:48.827Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:30:48.827Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Deactivate Store
Deactivate a store belonging to a merchant.
Endpoint: /api/v1/stores/{storeId}/deactivate
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique Store Id
{
"created_at": "2022-06-27T09:31:20.371Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:31:20.371Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:31:20.371Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:31:20.371Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Subscription plan
Create a subscription plan for a given merchant.
Endpoint: /api/v1/merchant/{merchantId}/store/{storeId}/plan/{planId}/
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: merchantId : Unique Merchant Id,storeId: Unique store id,planId: Unique plan id
{
"created_at": "2022-06-27T09:32:18.709Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:32:18.709Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:32:18.709Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:32:18.709Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Subscription plan
Update a subscription plan for a given merchant in the TWC platform.
Endpoint: /api/v1/merchant/{merchantId}/store/{storeId}/plan/{planId}
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: merchantId : Unique Merchant Id,storeId: Unique store id,planId: Unique plan id
{
"created_at": "2022-06-27T09:33:59.429Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:33:59.429Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:33:59.429Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:33:59.429Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Cancel Subscription plan
Cancel a subscription plan for a given merchant.
Endpoint: /api/v1/merchant/{merchantId}/store/{storeId}
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: merchantId : Unique Merchant Id,storeId: Unique store id
{
"created_at": "2022-06-27T09:34:38.716Z",
"deactivated": true,
"deactivated_at": "2022-06-27T09:34:38.716Z",
"default_country": {
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
},
"deleted": true,
"deleted_date": "2022-06-27T09:34:38.716Z",
"id": "string",
"media_url": "string",
"merchant_id": "string",
"modified_by": "string",
"plan_id": "string",
"store_key": "string",
"store_name": "string",
"backInStockThreshold":0,
"lowStockThreshold": 0,
"store_state": "CREATED",
"store_url": "string",
"targeted_countries": [
{
"code": "string",
"is_default_country": true,
"language_isocode": "string",
"name": "string"
}
],
"updated_at": "2022-06-27T09:34:38.716Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Store Config Resource
Get Additional Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/additionalConfigs
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"wishlistConfigs": {
"allowMultipleWishlist": true,
"allowWishlistSharing": true
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get All Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/allConfig
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
{
"additionalConfigs": {
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"wishlistConfigs": {
"allowMultipleWishlist": true,
"allowWishlistSharing": true
}
},
"entityConfigurations": {
"additionalProp1": {
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
},
"additionalProp2": {
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
},
"additionalProp3": {
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
},
"id": "string",
"notificationConfig": {
"backInStock": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"lowInStock": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"priceDrop": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"reminderEmail": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
},
"storeId": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityConfig
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
{
"additionalProp1": {
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
},
"additionalProp2": {
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
},
"additionalProp3": {
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Store Tenant Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/tenantConfig
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
{
"bucketName": "string",
"defaultClientGuid": "string",
"defaultClientId": "string",
"defaultClientSecret": "string",
"realmId": "string",
"realmName": "string",
"storeId": "string",
"tenantId": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Additional Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/additionalConfigs
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"wishlistConfigs": {
"allowMultipleWishlist": true,
"allowWishlistSharing": true
}
}
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"wishlistConfigs": {
"allowMultipleWishlist": true,
"allowWishlistSharing": true
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Additional Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/additionalConfigs
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"wishlistConfigs": {
"allowMultipleWishlist": true,
"allowWishlistSharing": true
}
}
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"wishlistConfigs": {
"allowMultipleWishlist": true,
"allowWishlistSharing": true
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create App Config Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/appconfig
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update App Config Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/appconfig
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Customer Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/customer
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Customer Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/customer
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Email Template Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/emailtemplate
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Email Template Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/emailtemplate
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Inventory Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/inventory
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Inventory Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/inventory
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Location Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/location
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Location Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/location
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Order Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/order
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Order Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/order
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Price Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/price
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Price Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/price
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Product Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/product
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Product Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/product
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Store Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/store
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Store Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/store
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Wishlist Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/wishlist
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update Wishlist Entity Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/entityconfig/wishlist
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
{
"active": true,
"entityName": "string",
"topics": {
"additionalProp1": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp2": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
},
"additionalProp3": {
"limit": 0,
"topic": "string",
"type": 0,
"value": "string"
}
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Notification Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification
Method: GET
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create Notification Config
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"backInStock": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"lowInStock": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"priceDrop": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"reminderEmail": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
}
{
"backInStock": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"lowInStock": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"priceDrop": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
},
"reminderEmail": {
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create BackInStock Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/backInStock
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update BackInStock Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/backInStock
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete BackInStock Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/backInStock
Method: DELETE
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create LowInStock Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/lowInStock
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update LowInStock Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/lowInStock
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete LowInStock Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/lowInStock
Method: DELETE
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create PriceDrop Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/priceDrop
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update PriceDrop Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/priceDrop
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete PriceDrop Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/priceDrop
Method: DELETE
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Create ReminderEmail Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/reminderEmail
Method: POST
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update ReminderEmail Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/reminderEmail
Method: PUT
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
Sample Request:
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
{
"deActivated": true,
"emailTemplate": "string",
"frequency": "string",
"realtime": "string"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete ReminderEmail Notification Settings
Endpoint: /api/v1/merchant/{merchId}/store/{storeId}/notification/reminderEmail
Method: DELETE
OAuth 2.0 Scopes : Tenant authentication
- authentication
Key | Value |
---|---|
Content-Type | application/json |
X-TWC-Tenant | {Tenant Name} |
Request Parameters: storeId : Unique store Id,merchId: Unique merchant Id
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input