GET v2/ShippingTemplate/Carriers/{carrierId}/Products

Retrieves a list of Carrier Products from the provided Carrier id.

Request Information

URI Parameters

Name Description Type Additional information
carrierId

integer

Optional

Body Parameters

None.

Response Information

Resource Description

A list of Carrier Products

Collection of CarrierProduct

Name Description Type
CarrierProductId

Unique identifier of the Carrier Product

 integer
Name

Name of the Carrier Product

 string
MinimumDeliveryTime

Minimum delivery time of the Carrier Product

 time interval
MaximumDeliveryTime

Maximum delivery time of the Carrier Product

 time interval
IsRural

If the product is rural

 boolean
IsCombined

If the product is combined shipping

 boolean
Addons

List of Addons available to the product

 Collection of CarrierAddon

Response Formats

application/json

Sample: 

[
  {
    "CarrierProductId": 1,
    "Name": "sample string 2",
    "MinimumDeliveryTime": "PT0.1234567S",
    "MaximumDeliveryTime": "PT0.1234567S",
    "IsRural": true,
    "IsCombined": true,
    "Addons": [
      {
        "CarrierAddonId": 1,
        "Name": "sample string 2",
        "Type": 0
      },
      {
        "CarrierAddonId": 1,
        "Name": "sample string 2",
        "Type": 0
      }
    ]
  },
  {
    "CarrierProductId": 1,
    "Name": "sample string 2",
    "MinimumDeliveryTime": "PT0.1234567S",
    "MaximumDeliveryTime": "PT0.1234567S",
    "IsRural": true,
    "IsCombined": true,
    "Addons": [
      {
        "CarrierAddonId": 1,
        "Name": "sample string 2",
        "Type": 0
      },
      {
        "CarrierAddonId": 1,
        "Name": "sample string 2",
        "Type": 0
      }
    ]
  }
]