Shipment Provider Configuration Collection Resource

This resource can handle the modification / set up of different types of configurations related to a Shipment Provider.

Endpoint

https://SELLERCENTER-API/shop-api/v1/shipment-provider-configurations

eg:

https://SELLERCENTER-API/shop-api/v1/shipment-provider-configurations/?ServiceName=SHOP&Timestamp=2013-08-27T15%3A56%3A11%2B0200&Signature=2c93bd83586b212f9f29a3af4bc25f5ba4d0b754687b3082ed821be1d92b993

Structure of a Configuration

ShipmentProvider

Name of the Shipment Provider that is due to be configured

Kerry

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 a Shipment Provider. The following rules will be observed:

  • Value will consist of an object stating the activation / deactivation of all the Leadtime types
  • If some of the Leadtime types is missing or some unexpected type is present in the request, and error response will be issued

Structure:

{
	'Express': true,
	'Standard': false,
	'Economy': true
}

Request Example

{
    "Request": {
        "ShipmentProviderConfigurations": [
            {
                "ShipmentProvider": "Kerry",
                "Type": "Leadtime",
                "Value": {
                    "Express": true,
                    "Standard": false,
                    "Economy": true
                }
            },
            {
                "ShipmentProvider": "DHL",
                "Type": "Leadtime",
                "Value": {
                    "Express": true,
                    "Standard": false,
                    "Economy": false
                }
            }
        ]  
    }
}

Success response

All the configurations have been applied

{
  "SuccessResponse": {
    "Head": {
      "RequestId": "",
      "RequestAction": "ShipmentProviderConfigurationCollection",
      "ResponseType": "",
      "Timestamp": "2015-07-02T12:26:03+0200"
    },
    "Body": ""
}

Error response

Error responses will follow the same approach as the Seller Configuration Collection error responses.