Boarding API / order_configurator / AddSalesPackage

Introduction

This endpoint adds a new sales package to the newly created order template.

Request

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

  Field	Required	Format	Description
  isPurchased	true	boolean
  packageName	true	string
  sku	true	string
  periodPricingDetails{}	true
  - period	true	string	Enum OneOff,Monthly,Yearly
  - exludingTax	true	number($double)
  - singleExludingTax	true	number($double)
  - includingTax	true	number($double)
  - taxAmountsPerTaxRate{}	true
  - - taxRate	true	number($double)	The tax rate, e.g. 6 or 21
  - - taxAmount	true	number($double)	The amount of tax
  order{}	true		The order template created with startorder

Response

Examples

Example for CCV Online Payment

{
  "isPurchased": true,
  "packageName": "Online Payments",
  "sku": "Online payments",
  "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": null,
    "cddInformation": null
   }
}