Boarding API / order_configurator / SetShoppingCartPricingDetails

Introduction

This endpoint sets the total costs of the current order

Prices

You have to agree with CCV about the prices that you deliver in this endpoint. If you deliver the wrong prices you (as a partner) will be invoiced by CCV.

Request

• Resource: /api/ordercompletion/reseller/orderconfigurator/SetShoppingCardPricingDetails
• Method: PATCH
• Content-Type: application/json
• Authentication: Required
• Parameters

  Field	Required	Format	Description
  currency	true	string	Enum EUR
  shippingCost	true	number($double)	The total shipping costs if there are any
  oneOffPriceCouponCode	true	string	The coupon code used for the price discount. If no CouponCode is applicable fill it with “”. If a PriceDiscount is submitted, fill the CouponCode with the applicable code.
  oneOffPriceDiscount	true	number($double)	The one off price discount given to the order
  totalAmountToBePaidImmediately	true	number($double)	The total amount to be paid immediately during checkout
  totalRevenueForFullYear	true	number($double)
  periodPricingDetails{}	true		This is the sum of your pricing details that are in your order, per period (oneoff, monthly or yearly)
  - period	true	string	Enum OneOff,Monthly,Yearly
  - exludingTax	true	number($double)
  - singleExludingTax	true	number($double)
  - includingTax	true	number($double)
  - taxAmountsPerTaxRate{}	false
  - - taxRate	true	number($double)	The tax rate, e.g. 6 or 21
  - - taxAmount	true	number($double)	The amount of tax
  order{}	true		The order with a Salespackage and products, created in the previous steps

Response

Examples

Example for CCV Online Payment

{
  "currency": "EUR",
  "shippingCost": 0,
  "oneOffPriceCouponCode": "",
  "oneOffPriceDiscount": 0,
  "totalAmountToBePaidImmediately": 0,
  "totalRevenueForFullYear": 0,
  "periodPricingDetails": [
    {
      "period": "OneOff",
      "excludingTax": 0,
      "singleExcludingTax": 0,
      "includingTax": 0,
      "taxAmountsPerTaxRate": [
        {
          "taxRate": 0,
          "taxAmount": 0
        }
      ]
    }
  ],
  "order": {
     "orderDate": "2021-02-23T14:34:37.528+00:00",
     "orderNotes": null,
     "cartUrl": "http://myccv-local:8008/merchant/",
     "storeUrl": "http://myccv-local:8008/merchant/",
     "statusUrl": "http://myccv-local:8008/merchant/",
     "storeInformation": {
       "companyName": null,
       "tradingName": null,
       "cocNumber": "12345678",
       "cocRegistry": "Kvk",
       "taxNumber": null,
       "storeAddress": {
         "country": "NL",
         "city": null,
         "streetName": null,
         "postalCode": null,
         "houseNumber": null,
         "houseNumberExt": null
       },
       "deliveryAddress": null,
       "eBillingEmailAddress": null,
       "reportingEmailAddress": null
     },
     "companyContactPerson": {
       "firstName": null,
       "lastName": null,
       "prefix": null,
       "emailAddress": "ccvtarobot+John-Baker1@gmail.com",
       "gender": "Male",
       "phoneNumber": null,
       "dateOfBirth": null,
       "language": "nl-NL"
     },
     "invoiceAccount": null,
     "payoutAccount": null,
     "shoppingCart": {
       "currency": null,
       "shippingCost": null,
       "oneOffPriceCouponCode": null,
       "oneOffPriceDiscount": null,
       "totalAmountToBePaidImmediately": null,
       "totalRevenueForFullYear": null,
       "periodPricingDetails": null,
       "salesPackages": [
         {
           "isPurchased": true,
           "packageName": "Online Payments",
           "sku": "Online payments",
           "periodPricingDetails": [
             {
               "period": "OneOff",
               "excludingTax": 0,
               "singleExcludingTax": 0,
               "includingTax": 0,
               "taxAmountsPerTaxRate": [
                 {
                   "taxRate": 0,
                   "taxAmount": 0
                 }
               ]
             }
           ],
           "products": [
             {
               "id": null,
               "storeProductId": null,
               "name": "PSP Contract",
               "description": "PSP Contract",
               "sku": "PSPEcomm",
               "quantity": 1,
               "isAddedProduct": false,
               "isFree": false,
               "toBePaidImmediately": null,
               "totalRevenueForFullYear": null,
               "periodPricingDetails": [
                 {
                   "period": "OneOff",
                   "excludingTax": 0,
                   "singleExcludingTax": 0,
                   "includingTax": 0,
                   "taxAmountsPerTaxRate": [
                     {
                       "taxRate": 21,
                       "taxAmount": 0
                     }
                   ]
                 }
               ],
               "productType": "PSP",
               "productOptions": {
                 "pspPaymentMethods": [
                   "bancontact",
                   "ideal",
                   "paypal",
                   "visa",
                   "mastercard",
                   "maestro",
                   "banktransfer",
                   "giropay",
                   "sofort",
                   "amex"
                 ],
                 "terminalType": null,
                 "terminalTmsId": null,
                 "terminalCtNumbers": null,
                 "terminalInternetConnectionType": null,
                 "pfProductOptions": null,
                 "pfProductTransactionFeePrice": null,
                 "externalWebshopProductOptions": null,
                 "webshopProductOptions": null,
                 "splitPayoutsSuperMerchantWebShopProductOptions": null,
                 "splitPayoutsSubMerchantWebShopProductOptions": null
               }
             },
             {
               "id": "af7e1d86-55d7-4060-b3cf-fb2eebf5c4ec",
               "storeProductId": null,
               "name": "PSP Online Betalingen",
               "description": "Online Betalingen - Externe Webshop",
               "sku": "ExternalWebshop",
               "quantity": 1,
               "isAddedProduct": false,
               "isFree": false,
               "toBePaidImmediately": null,
               "totalRevenueForFullYear": null,
               "periodPricingDetails": [
                 {
                   "period": "OneOff",
                   "excludingTax": 0,
                   "singleExcludingTax": 0,
                   "includingTax": 0,
                   "taxAmountsPerTaxRate": [
                     {
                       "taxRate": 21,
                       "taxAmount": 0
                     }
                   ]
                 }
               ],
               "productType": "ExternalWebShop",
               "productOptions": {
                 "pspPaymentMethods": null,
                 "terminalType": null,
                 "terminalTmsId": null,
                 "terminalCtNumbers": null,
                 "terminalInternetConnectionType": null,
                 "pfProductOptions": null,
                 "pfProductTransactionFeePrice": null,
                 "externalWebshopProductOptions": {
                   "urls": [
                     "https://www.mywebshop.nl"
                   ]
                 },
                 "webshopProductOptions": null,
                 "splitPayoutsSuperMerchantWebShopProductOptions": null,
                 "splitPayoutsSubMerchantWebShopProductOptions": null
               }
             }
           ]
         }
       ]
     },
     "cddInformation": null
   }
}