Seller Configuration Collection Resource
This resource can handle the modification / set up of different types of configurations related to a Seller.
Endpoint
https://SELLERCENTER-API/shop-api/v1/seller-configurations
eg:
Structure of a Configuration
SellerID |
Id of the Seller for whom the configuration is to be set. This must be the Id of the seller in the Shop System, which in SellerCenter is stored as "src_id" |
563 |
Type |
Type of configuration |
Leadtime |
Value |
Data assigned to the configuration. Each type of configuration will have a different structure for this field. |
{ "Param1": 77, "Param2": 88 } |
Leadtime configuration
This configuration sets up the Leadtime types that are enabled or disabled for the Seller. The following rules will be observed:
- Value will consist of an object stating the activation / deactivation of at least one Leadtime Type
- If a non recognized Leadtime Type is provided, the API will respond with an error code.
- The Leadtime Types which are not explicitly set in the to "true" / "false" will remain unchanged in sellercenter
Structure:
{
'Express': true,
'Standard': false,
'Economy': true
}
ShipmentProvider configuration
This configuration sets up the Shipment Providers for the Seller:
- Value will consist on an array of objects containing the configuration for every Shipment Provider addressed
- Only configuration for Shipment Providers included in the request will be modified
- If any of the addressed Shipment Providers do not exists in Seller Center at the moment of the call, or it has been deleted from Seller Center, the configuration fail altogether.
Structure:
[
{
'Name': 'Kerry',
'Enabled': true
},
{
'Name': CGLS,
'Enabled': false
}
]
Request Example
{
"Request": {
"SellerConfigurations": [
{
"SellerID": "123",
"Type": "Leadtime",
"Value": {
"Express": true,
"Standard": false,
"Economy": true
}
},
{
"SellerID": "123",
"Type": "ShipmentProvider",
"Value": [
{
"Name": "Kerry",
"Enabled": true
},
{
"Name": "CGLS",
"Enabled": false
}
]
},
{
"SellerID": "345",
"Type": "Leadtime",
"Value": {
"Express": false,
"Standard": true,
"Economy": true
}
}
]
}
}
Success response
All the configurations have been applied
{
"SuccessResponse": {
"Head": {
"RequestId": "",
"RequestAction": "SellerConfigurationCollection",
"ResponseType": "",
"Timestamp": "2015-07-02T12:26:03+0200"
},
"Body": ""
}
Error response
Some failed configurations
{
"ErrorResponse": {
"Head": {
"RequestAction": "SellerConfigurationCollection",
"ErrorType": "",
"ErrorCode": "1001",
"ErrorMessage": "Global error message"
},
"Body": ""
}