Skip to main content
Matrix42 Self-Service Help Center

3. Partner Center API Contracts

MplSubscriptionInterval Enum-Value

0

None

1

Month

2

Year

 

 

 

 

 

 

MplCurrencyCode Enum-Value

 

0

None

1

EUR

MplProductStatus Enum-Value

0

None

1

Published

MplContractKind Enum-Value

0

Unspecified

1

Subscription

2

Hardware

3

Service

 

 

 

 

 

 

 

 

 

 

MplMetric Enum-Value

0

None

1

Offsite Service

2

One Time

3

Onsite Service

4

Per Agent

5

Per Customer Entity

6

Per Device

7

Per Installation

8

Per User

9

Remote Service

10

Per Server

11

Per Business Application

12

None

13

Offsite Service

14

One Time

15

Onsite Service

MplProduct

This is the contract that defines the properties of a Product that can be ordered from the Marketplace.

{
  Id (integer, optional),
  Name (string, optional),
  Key (string, optional),
  ShortDescription (string, optional),
  Description (string, optional),
  SignupFee (number, optional),
  RegularPrice (number, optional),
  SubscriptionPrice (number, optional),
  SalesPrice (number, optional),
  SubscriptionPriceInterval (EnumValue[MplSubscriptionInterval], optional),
  CurrencyCode (EnumValue[MplCurrencyCode], optional),
  ProductLogoUrl (string, optional),
  Status (EnumValue[MplProductStatus], optional),
  Tags (Array[string], optional),
  Categories (Array[string], optional),
  ContractType (EnumValue[MplContractKind], optional),
  Metric (EnumValue[MplMetric], optional),
  ProductTypeName (string, optional),
  PublishingDate (string, optional),
  LastUpdate (string, optional),
  SkuSubscription (string, optional),
  SkuSignupFee (string, optional),
  SkuRegularPrice (string, optional),
  Vendor (Vendor, optional)
}

 

MplOrderRequestAddress

This is the contract to carry address information for a location included as the shipping or billing address of an Order.

{
  FirstName (string, optional),
  LastName (string, optional),
  Company (string, optional),
  Address1 (string, optional),
  Address2 (string, optional),
  City (string, optional),
  State (string, optional),
  Postcode (string, optional),
  Country (string, optional),
  Email (string, optional)
}

 
 

MplOrderRequestItemSku

This is the contract to carry the SKU Identifiers for the three kind of prices referenced in an Order-Item.

{
  SubscriptionPrice (string, optional),
  SignUpFee (string, optional),
  RegularPrice (string, optional)
}

 
 

MplOrderRequestItem

This contract carries the information about the item of an Order including the identification of the Product that is being ordered.

{
  ProductId (integer, optional),
  ProductName (string, optional),
  Quantity (integer, optional),
  VariationId (integer, optional),
  SKU (MplOrderRequestItemSku, optional)
}

 

MplOrderRequest    

This contract is the container structure to carry the information about an Order that is placed in the Marketplace via the API.    

{
  CustomerId (integer, optional),
  CustomerName (string, optional),
  Notes (string, optional),
  ShippingInfo (MplOrderRequestAddress, optional),
  OrderItems (Array[MplOrderRequestItem], optional),
  meta_data (Array[MplOrderMeta], optional)
}

 

MplOrderRequestResponseSubscription

This contract defines the structure of a Subscription that was derived and returned from an Order placed in the Marketplace.

{
  SubscriptionId (integer, optional),
  Period (string, optional),
  Interval (string, optional),
  Status (string, optional),
  StartDate (string, optional),
  NextPaymentDate (string, optional),
  EndDate (string, optional),
  LastOperationSuccess (boolean, optional),
  LastOperationMessage (string, optional),
  Items (Array[MplOrderRequestItem], optional)
}

 

MplOrderRequestResponse

This contract represents the data returned from the placement of an Order in the Marketplace at the moment of its creation as well as at later requests.

{
  Id (integer, optional),
  OrderKey (string, optional), 
  CreationTimeUtc (string, optional),
  CustomerName (string, optional),
  Status (string, optional),
  TotalTax (number, optional),
  Total (number, optional),
  ShippingTax (number, optional),
  ShippingTotal (number, optional),
  DiscountTax (number, optional),
  DiscountTotal (number, optional),
  ItemsCount (integer, optional),
  Subscriptions (Array[MplOrderRequestResponseSubscription], optional)
}

 

Vendor

This small contract contains the basic information about a Vendor of a particular Product that can be ordered from the Marketplace.

{
  Id (integer, optional),
  Name (string, optional),
  Key (string, optional)
}

 

MplOrderCancellationSubscription

The result of a Subscription cancellation is carried with this contract. It contains information about the success and remaining run-time of a Subscription.

{
  Id (integer, optional),
  Success (boolean, optional),
  Message (string, optional),
  StartDate (string, optional),
  NextPaymentDate (string, optional),
  EndDate (string, optional)
}

 
 

MplOrderCancellationResult

This is the container contract that is returned upon the cancellation of Subscriptions, and which aggregates these Subscriptions according to the Order from which they derived originally.    

{
  Id (integer, optional),
  Success (boolean, optional),
  Message (string, optional),
  Subscriptions (Array[MplOrderCancellationSubscription], optional)
}

 

 

MplPartnerCustomer    

This is the contract that holds information about a Customer that is serviced by the requesting partner. It can be used to simplify the creation of data for the placement of an Order by providing the individual Customer-Number and the data to be filled into the Shipping-address.

{
  Id (integer, optional),
  Name (string, optional),
  CustomerNumber (string, optional),
  BillingName (string, optional),
  Street1 (string, optional),
  Street2 (string, optional),
  Zip (string, optional),
  City (string, optional),
  Country (string, optional),
  Mail (string, optional)
}

 

Thank you.

 

 

 

  • Was this article helpful?