POST api/{version}/StudentProductShipment/StudentProductShipmentCharges?ShippingTypeCode={ShippingTypeCode}

API call to

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ShippingTypeCode

string

Required

version

string

None.

Body Parameters

Collection of StudentProducts
NameDescriptionTypeAdditional information
StudentProductId

integer

None.

OrderId

integer

None.

ProductType

string

None.

ProductPrice

decimal number

None.

AllowAccess

boolean

None.

isCorporateOffered

boolean

None.

PaymentId

integer

None.

PartialPaymentId

integer

None.

ProcessImmediately

boolean

None.

ProductDetail

ProductDetail

None.

CourseDetail

CourseDetail

None.

CorporateInfo

CorporateInfo

None.

FeeAdjustmentList

Collection of StudentsFeeAdjustments

None.

FeeAdjustmentLogList

Collection of StudentFeeAdjustmentLog

None.

PromoCode

StudentProductPromoCode

None.

IsProductDuplicate

boolean

None.

IsRegistered

boolean

None.

CourseRegistrationDetail

CourseRegistrationInfo

None.

CourseRegistrationDetailWithoutCorporate

CourseRegistrationInfo

None.

ProductDetailWithoutCorporate

ProductDetail

None.

StudentSubscriptionId

integer

None.

ProductCount

integer

None.

IsApplicablePromoCode

boolean

None.

IsTaxApplicable

boolean

None.

StudentOrderItemTaxInfoId

integer

None.

CorporateCodeDetails

CorporateCodeInfo

None.

IsDontShowInCart

boolean

None.

IsFreeProduct

boolean

None.

ProductCurrentSubscriptionId

integer

None.

IsPriceReducedFromCourse

boolean

None.

IsShippingTaxApplicable

boolean

None.

IsPurchasedCoursesFreeProduct

boolean

None.

IsPurchasedCourseTaxExempted

boolean

None.

FinalProductPrice

decimal number

None.

IsHavePurchasedFreeProduct

boolean

None.

PurchasedProductPrice

decimal number

None.

IsSendZeroAmountProduct

boolean

None.

PurchasedProductPriceAfterDiscount

decimal number

None.

ProductSkuId

integer

None.

ImmediateProcessAmount

decimal number

None.

HaveMutipleSubscription

boolean

None.

IsTaxCollected

boolean

None.

IsShipTaxCollected

boolean

None.

IsProductTaxCollected

boolean

None.

SubscriptionFee

decimal number

None.

LaterProcessAmount

decimal number

None.

ActualPaymentAmount

decimal number

None.

CalculatedFeeWithoutDiscounts

decimal number

None.

ListPromotionalDiscountInfo

Collection of PromotionalDiscount

None.

UpdatedTaxablePrice

decimal number

None.

StudentDiscountCount

integer

None.

MilitaryDiscountCount

integer

None.

SpecialDiscounts

Collection of StudentsFeeAdjustments

None.

PolicyInformation

which is used for holding the policy information of the item

PolicyInformation

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'ImsApi.Models.StudentsFeeAdjustments'. Path '[0].FeeAdjustmentList[0].StudentFeeAdjustmentList'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'ImsApi.Models.StudentsFeeAdjustments'. Path '[0].FeeAdjustmentList[0].StudentFeeAdjustmentList'.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

StudentProductShipments
NameDescriptionTypeAdditional information
ListOrderShipment

get or set ordershipment list

Collection of OrderShipment

None.

Response Formats

application/json, text/json

Sample:
{
  "ListOrderShipment": [
    {
      "ShippingTypeCode": "sample string 1",
      "ShippingType": "sample string 2",
      "ProductId": [
        1,
        2
      ],
      "WeightInLbs": 3.0,
      "OrderShippingAmount": 4.0,
      "ListPackageShiement": [
        {
          "ShippingTypeCode": "sample string 1",
          "ShipementReference": "sample string 2",
          "ProductId": [
            1,
            2
          ],
          "WeightInLbs": 3.0,
          "PackageShippingAmount": 4.0,
          "IsCorporate": true,
          "UsedWeightInLbs": 6.0,
          "ListProductPackageShipment": [
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            },
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            }
          ]
        },
        {
          "ShippingTypeCode": "sample string 1",
          "ShipementReference": "sample string 2",
          "ProductId": [
            1,
            2
          ],
          "WeightInLbs": 3.0,
          "PackageShippingAmount": 4.0,
          "IsCorporate": true,
          "UsedWeightInLbs": 6.0,
          "ListProductPackageShipment": [
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            },
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            }
          ]
        }
      ]
    },
    {
      "ShippingTypeCode": "sample string 1",
      "ShippingType": "sample string 2",
      "ProductId": [
        1,
        2
      ],
      "WeightInLbs": 3.0,
      "OrderShippingAmount": 4.0,
      "ListPackageShiement": [
        {
          "ShippingTypeCode": "sample string 1",
          "ShipementReference": "sample string 2",
          "ProductId": [
            1,
            2
          ],
          "WeightInLbs": 3.0,
          "PackageShippingAmount": 4.0,
          "IsCorporate": true,
          "UsedWeightInLbs": 6.0,
          "ListProductPackageShipment": [
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            },
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            }
          ]
        },
        {
          "ShippingTypeCode": "sample string 1",
          "ShipementReference": "sample string 2",
          "ProductId": [
            1,
            2
          ],
          "WeightInLbs": 3.0,
          "PackageShippingAmount": 4.0,
          "IsCorporate": true,
          "UsedWeightInLbs": 6.0,
          "ListProductPackageShipment": [
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            },
            {
              "ShipementReference": "sample string 1",
              "ProductId": 2,
              "WeightInLbs": 3.0,
              "ShippingAmount": 4.0,
              "isAdded": true
            }
          ]
        }
      ]
    }
  ]
}